File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Rss.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RSS::Rss - 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 class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-RSS::Rss-label-RSS+2.0+support">RSS 2.0 support</a>
<li><a href="#class-RSS::Rss-label-Producing+RSS+2.0">Producing RSS 2.0</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Element
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="RSS09.html">RSS::RSS09</a>
<li><a class="include" href="RootElementMixin.html">RSS::RootElementMixin</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-_attrs">#_attrs</a>
<li ><a href="#method-i-image">#image</a>
<li ><a href="#method-i-items">#items</a>
<li class="calls-super" ><a href="#method-i-setup_maker_elements">#setup_maker_elements</a>
<li ><a href="#method-i-textinput">#textinput</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RSS::Rss">
<h1 id="class-RSS::Rss" class="class">
class RSS::Rss
</h1>
<section class="description">
<h1 id="class-RSS::Rss-label-RSS+2.0+support"><a href="../RSS.html"><code>RSS</code></a> 2.0 support<span><a href="#class-RSS::Rss-label-RSS+2.0+support">¶</a> <a href="#top">↑</a></span></h1>
<p><a href="../RSS.html"><code>RSS</code></a> has three different versions. This module contains support for version <a href="http://www.rssboard.org/rss-specification">2.0</a></p>
<h2 id="class-RSS::Rss-label-Producing+RSS+2.0">Producing <a href="../RSS.html"><code>RSS</code></a> 2.0<span><a href="#class-RSS::Rss-label-Producing+RSS+2.0">¶</a> <a href="#top">↑</a></span></h2>
<p>Producing our own <a href="../RSS.html"><code>RSS</code></a> feeds is easy as well. Let's make a very basic feed:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"rss"</span>
<span class="ruby-identifier">rss</span> = <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Maker</span>.<span class="ruby-identifier">make</span>(<span class="ruby-string">"2.0"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">maker</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">language</span> = <span class="ruby-string">"en"</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">author</span> = <span class="ruby-string">"matz"</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">updated</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">link</span> = <span class="ruby-string">"http://www.ruby-lang.org/en/feeds/news.rss"</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">title</span> = <span class="ruby-string">"Example Feed"</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">description</span> = <span class="ruby-string">"A longer description of my feed."</span>
<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">items</span>.<span class="ruby-identifier">new_item</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">item</span>.<span class="ruby-identifier">link</span> = <span class="ruby-string">"http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"</span>
<span class="ruby-identifier">item</span>.<span class="ruby-identifier">title</span> = <span class="ruby-string">"Ruby 1.9.2-p136 is released"</span>
<span class="ruby-identifier">item</span>.<span class="ruby-identifier">updated</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">rss</span>
</pre>
<p>As you can see, this is a very Builder-like DSL. This code will spit out an <a href="../RSS.html"><code>RSS</code></a> 2.0 feed with one item. If we needed a second item, we'd make another block with maker.items.new_item and build a second one.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-feed_version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">feed_version</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-rss_version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">rss_version</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</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">(feed_version, version=nil, encoding=nil, standalone=nil)</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="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/0.9.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">feed_version</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-ivar">@feed_type</span> = <span class="ruby-string">"rss"</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-image" class="method-detail ">
<div class="method-heading">
<span class="method-name">image</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="image-source">
<pre><span class="ruby-comment"># File lib/rss/0.9.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">image</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@channel</span>
<span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">image</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-items" class="method-detail ">
<div class="method-heading">
<span class="method-name">items</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="items-source">
<pre><span class="ruby-comment"># File lib/rss/0.9.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">items</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@channel</span>
<span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">items</span>
<span class="ruby-keyword">else</span>
[]
<span class="ruby-keyword">end</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">(maker)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="setup_maker_elements-source">
<pre><span class="ruby-comment"># File lib/rss/0.9.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_maker_elements</span>(<span class="ruby-identifier">maker</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">items</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">item</span>.<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">maker</span>.<span class="ruby-identifier">items</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">image</span>.<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">maker</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">image</span>
<span class="ruby-identifier">textinput</span>.<span class="ruby-identifier">setup_maker</span>(<span class="ruby-identifier">maker</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">textinput</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-textinput" class="method-detail ">
<div class="method-heading">
<span class="method-name">textinput</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="textinput-source">
<pre><span class="ruby-comment"># File lib/rss/0.9.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">textinput</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@channel</span>
<span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">textInput</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</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-_attrs" class="method-detail ">
<div class="method-heading">
<span class="method-name">_attrs</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="_attrs-source">
<pre><span class="ruby-comment"># File lib/rss/0.9.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_attrs</span>
[
[<span class="ruby-string">"version"</span>, <span class="ruby-keyword">true</span>, <span class="ruby-string">"feed_version"</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>