File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Atom/Feed.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RSS::Atom::Feed - 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="../Element.html">RSS::Element</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../RootElementMixin.html">RSS::RootElementMixin</a>
<li><a class="include" href="CommonModel.html">RSS::Atom::CommonModel</a>
<li><a class="include" href="DuplicateLinkChecker.html">RSS::Atom::DuplicateLinkChecker</a>
<li><a class="include" href="../DublinCoreModel.html">RSS::DublinCoreModel</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-atom_validate">#atom_validate</a>
<li ><a href="#method-i-have_author-3F">#have_author?</a>
<li class="calls-super" ><a href="#method-i-have_required_elements-3F">#have_required_elements?</a>
<li ><a href="#method-i-maker_target">#maker_target</a>
<li class="calls-super" ><a href="#method-i-setup_maker_element">#setup_maker_element</a>
<li class="calls-super" ><a href="#method-i-setup_maker_elements">#setup_maker_elements</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RSS::Atom::Feed">
<h1 id="class-RSS::Atom::Feed" class="class">
class RSS::Atom::Feed
</h1>
<section class="description">
<p>Defines the top-level element of an <a href="../Atom.html"><code>Atom</code></a> <a href="Feed.html"><code>Feed</code></a> Document. It consists of a number of children <a href="Feed/Entry.html"><code>Entry</code></a> elements, and has the following attributes:</p>
<ul><li>
<p>author</p>
</li><li>
<p>categories</p>
</li><li>
<p>category</p>
</li><li>
<p>content</p>
</li><li>
<p>contributor</p>
</li><li>
<p>entries (aliased as items)</p>
</li><li>
<p>entry</p>
</li><li>
<p>generator</p>
</li><li>
<p>icon</p>
</li><li>
<p>id</p>
</li><li>
<p>link</p>
</li><li>
<p>logo</p>
</li><li>
<p>rights</p>
</li><li>
<p>subtitle</p>
</li><li>
<p>title</p>
</li><li>
<p>updated</p>
</li></ul>
<p>Reference: <a href="https://validator.w3.org/feed/docs/rfc4287.html#element.feed">validator.w3.org/feed/docs/rfc4287.html#element.feed</a></p>
</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(version=nil, encoding=nil, standalone=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="../Atom.html"><code>Atom</code></a> feed</p>
<div class="method-calls-super">
Calls superclass method
<a href="../RootElementMixin.html#method-c-new"><code>RSS::RootElementMixin::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 313</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">version</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">encoding</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">standalone</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-string">"1.0"</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">encoding</span>, <span class="ruby-identifier">standalone</span>)
<span class="ruby-ivar">@feed_type</span> = <span class="ruby-string">"atom"</span>
<span class="ruby-ivar">@feed_subtype</span> = <span class="ruby-string">"feed"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-have_author-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_author?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if there are any authors for the feed or any of the <a href="Feed/Entry.html"><code>Entry</code></a> child elements have an author</p>
<div class="method-source-code" id="have_author-3F-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 323</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_author?</span>
<span class="ruby-identifier">authors</span>.<span class="ruby-identifier">any?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">author</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">author</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">empty?</span>} <span class="ruby-keyword">or</span>
<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">any?</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">have_author?</span>(<span class="ruby-keyword">false</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-atom_validate" class="method-detail ">
<div class="method-heading">
<span class="method-name">atom_validate</span><span
class="method-args">(ignore_unknown_element, tags, uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="atom_validate-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 329</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">atom_validate</span>(<span class="ruby-identifier">ignore_unknown_element</span>, <span class="ruby-identifier">tags</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">have_author?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingTagError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"author"</span>, <span class="ruby-identifier">tag_name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">validate_duplicate_links</span>(<span class="ruby-identifier">links</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-have_required_elements-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_required_elements?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../Element.html#method-i-have_required_elements-3F"><code>RSS::Element#have_required_elements?</code></a>
</div>
<div class="method-source-code" id="have_required_elements-3F-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 336</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_required_elements?</span>
<span class="ruby-keyword">super</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">have_author?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-maker_target" class="method-detail ">
<div class="method-heading">
<span class="method-name">maker_target</span><span
class="method-args">(maker)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="maker_target-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 340</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">maker_target</span>(<span class="ruby-identifier">maker</span>)
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_maker_element" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_maker_element</span><span
class="method-args">(channel)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../SetupMaker.html#method-i-setup_maker_element"><code>RSS::SetupMaker#setup_maker_element</code></a>
</div>
<div class="method-source-code" id="setup_maker_element-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 344</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_maker_element</span>(<span class="ruby-identifier">channel</span>)
<span class="ruby-identifier">prev_dc_dates</span> = <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">dc_dates</span>.<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">about</span> = <span class="ruby-identifier">id</span>.<span class="ruby-identifier">content</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">dc_dates</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">prev_dc_dates</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_maker_elements" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_maker_elements</span><span
class="method-args">(channel)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="../SetupMaker.html#method-i-setup_maker_elements"><code>RSS::SetupMaker#setup_maker_elements</code></a>
</div>
<div class="method-source-code" id="setup_maker_elements-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 351</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_maker_elements</span>(<span class="ruby-identifier">channel</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">items</span> = <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">items</span>
<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">items</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>