File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Parser.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RSS::Parser - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="../Forwardable.html">Forwardable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-boolean_argument">::boolean_argument</a>
<li ><a href="#method-c-default_parser">::default_parser</a>
<li ><a href="#method-c-default_parser-3D">::default_parser=</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-parse">::parse</a>
<li ><a href="#method-i-maybe_xml-3F">#maybe_xml?</a>
<li ><a href="#method-i-normalize_rss">#normalize_rss</a>
<li ><a href="#method-i-to_uri">#to_uri</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RSS::Parser">
<h1 id="class-RSS::Parser" class="class">
class RSS::Parser
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-default_parser" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_parser</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="default_parser-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_parser</span>
<span class="ruby-identifier">@@default_parser</span> <span class="ruby-operator">||</span> <span class="ruby-constant">AVAILABLE_PARSERS</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-default_parser-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_parser=</span><span
class="method-args">(new_value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> @@default_parser to new_value if it is one of the available parsers. Else raise <a href="NotValidXMLParser.html"><code>NotValidXMLParser</code></a> error.</p>
<div class="method-source-code" id="default_parser-3D-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_parser=</span>(<span class="ruby-identifier">new_value</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">AVAILABLE_PARSERS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">new_value</span>)
<span class="ruby-identifier">@@default_parser</span> = <span class="ruby-identifier">new_value</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotValidXMLParser</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">new_value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(rss, parser_class=self.class.default_parser)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">rss</span>, <span class="ruby-identifier">parser_class</span>=<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">default_parser</span>)
<span class="ruby-ivar">@parser</span> = <span class="ruby-identifier">parser_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">normalize_rss</span>(<span class="ruby-identifier">rss</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-parse" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse</span><span
class="method-args">(rss, *args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">rss</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">options</span> = {}
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">do_validate</span> = <span class="ruby-identifier">boolean_argument</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value">:validate</span>], <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">ignore_unknown_element</span> =
<span class="ruby-identifier">boolean_argument</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value">:ignore_unknown_element</span>], <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">parser_class</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:parser_class</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">default_parser</span>
<span class="ruby-identifier">parser</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">rss</span>, <span class="ruby-identifier">parser_class</span>)
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">do_validate</span> = <span class="ruby-identifier">do_validate</span>
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">ignore_unknown_element</span> = <span class="ruby-identifier">ignore_unknown_element</span>
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Class Methods</h3>
</header>
<div id="method-c-boolean_argument" class="method-detail ">
<div class="method-heading">
<span class="method-name">boolean_argument</span><span
class="method-args">(positioned_value, option_value, default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="boolean_argument-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">boolean_argument</span>(<span class="ruby-identifier">positioned_value</span>, <span class="ruby-identifier">option_value</span>, <span class="ruby-identifier">default</span>)
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">positioned_value</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">option_value</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">option_value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">default</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-maybe_xml-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">maybe_xml?</span><span
class="method-args">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>maybe_xml? tests if source is a string that looks like <a href="XML.html"><code>XML</code></a>.</p>
<div class="method-source-code" id="maybe_xml-3F-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">maybe_xml?</span>(<span class="ruby-identifier">source</span>)
<span class="ruby-identifier">source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-keyword">and</span> <span class="ruby-regexp">/</</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-normalize_rss" class="method-detail ">
<div class="method-heading">
<span class="method-name">normalize_rss</span><span
class="method-args">(rss)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Try to get the <a href="XML.html"><code>XML</code></a> associated with <code>rss</code>. Return <code>rss</code> if it already looks like <a href="XML.html"><code>XML</code></a>, or treat it as a <a href="../URI.html"><code>URI</code></a>, or a file to get the <a href="XML.html"><code>XML</code></a>,</p>
<div class="method-source-code" id="normalize_rss-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 116</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">normalize_rss</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rss</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">maybe_xml?</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">to_uri</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:read</span>)
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">read</span>
<span class="ruby-keyword">elsif</span> (<span class="ruby-constant">RUBY_VERSION</span> <span class="ruby-operator">>=</span> <span class="ruby-string">'2.7'</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-identifier">rss</span>.<span class="ruby-identifier">tainted?</span>) <span class="ruby-keyword">and</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">rss</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">read</span>}
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">rss</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_uri" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_uri</span><span
class="method-args">(rss)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Attempt to convert rss to a <a href="../URI.html"><code>URI</code></a>, but just return it if there's a <a href="../URI/Error.html"><code>::URI::Error</code></a></p>
<div class="method-source-code" id="to_uri-source">
<pre><span class="ruby-comment"># File lib/rss/parser.rb, line 137</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_uri</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rss</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">rss</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-operator">::</span><span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">rss</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>
<span class="ruby-identifier">rss</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>