File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Atom/TextConstruct.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RSS::Atom::TextConstruct - 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="module">
<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">
<!-- 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-append_features">::append_features</a>
<li ><a href="#method-c-xml_getter">::xml_getter</a>
<li ><a href="#method-c-xml_setter">::xml_setter</a>
<li ><a href="#method-i-atom_validate">#atom_validate</a>
<li ><a href="#method-i-have_xml_content-3F">#have_xml_content?</a>
<li ><a href="#method-i-maker_target">#maker_target</a>
<li ><a href="#method-i-setup_maker_attributes">#setup_maker_attributes</a>
<li ><a href="#method-i-xhtml">#xhtml</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RSS::Atom::TextConstruct">
<h1 id="module-RSS::Atom::TextConstruct" class="module">
module RSS::Atom::TextConstruct
</h1>
<section class="description">
<p>The <a href="TextConstruct.html"><code>TextConstruct</code></a> module is used to define a Text construct <a href="../Atom.html"><code>Atom</code></a> element, which is used to store small quantities of human-readable text.</p>
<p>The <a href="TextConstruct.html"><code>TextConstruct</code></a> has a type attribute, e.g. text, html, xhtml</p>
<p>Reference: <a href="https://validator.w3.org/feed/docs/rfc4287.html#text.constructs">validator.w3.org/feed/docs/rfc4287.html#text.constructs</a></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-xhtml" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">xhtml</span><span
class="attribute-access-type">[W]</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-append_features" class="method-detail ">
<div class="method-heading">
<span class="method-name">append_features</span><span
class="method-args">(klass)</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="append_features-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">append_features</span>(<span class="ruby-identifier">klass</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword">do</span>
[
[<span class="ruby-string">"type"</span>, <span class="ruby-string">""</span>],
].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">required</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">install_get_attribute</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">required</span>, <span class="ruby-value">:text_type</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">content_setup</span>
<span class="ruby-identifier">add_need_initialize_variable</span>(<span class="ruby-string">"xhtml"</span>)
<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xml_getter</span>
<span class="ruby-string">"xhtml"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xml_setter</span>
<span class="ruby-string">"xhtml="</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-xml_getter" class="method-detail ">
<div class="method-heading">
<span class="method-name">xml_getter</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="xml_getter-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 116</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xml_getter</span>
<span class="ruby-string">"xhtml"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-xml_setter" class="method-detail ">
<div class="method-heading">
<span class="method-name">xml_setter</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="xml_setter-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 120</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xml_setter</span>
<span class="ruby-string">"xhtml="</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-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">
<p>Raises a <a href="../MissingTagError.html"><code>MissingTagError</code></a> or <a href="../NotExpectedTagError.html"><code>NotExpectedTagError</code></a> if the element is not properly formatted.</p>
<div class="method-source-code" id="atom_validate-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 150</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">if</span> <span class="ruby-identifier">have_xml_content?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingTagError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"div"</span>, <span class="ruby-identifier">tag_name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> [<span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">uri</span>] <span class="ruby-operator">==</span> [<span class="ruby-string">"div"</span>, <span class="ruby-constant">XHTML_URI</span>]
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotExpectedTagError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">tag_name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-have_xml_content-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">have_xml_content?</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 type is “xhtml”.</p>
<div class="method-source-code" id="have_xml_content-3F-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 144</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">have_xml_content?</span>
<span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"xhtml"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-xhtml" class="method-detail ">
<div class="method-heading">
<span class="method-name">xhtml</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns or builds the XHTML content.</p>
<div class="method-source-code" id="xhtml-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 130</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xhtml</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@xhtml</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>) <span class="ruby-keyword">and</span>
[<span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@xhtml</span>.<span class="ruby-identifier">uri</span>] <span class="ruby-operator">==</span> [<span class="ruby-string">"div"</span>, <span class="ruby-constant">XHTML_URI</span>]
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@xhtml</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">children</span> = <span class="ruby-ivar">@xhtml</span>
<span class="ruby-identifier">children</span> = [<span class="ruby-identifier">children</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">children</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
<span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"div"</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-constant">XHTML_URI</span>,
{<span class="ruby-string">"xmlns"</span> <span class="ruby-operator">=></span> <span class="ruby-constant">XHTML_URI</span>}, <span class="ruby-identifier">children</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-maker_target" class="method-detail ">
<div class="method-heading">
<span class="method-name">maker_target</span><span
class="method-args">(target)</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 162</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">maker_target</span>(<span class="ruby-identifier">target</span>)
<span class="ruby-identifier">target</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/::/</span>).<span class="ruby-identifier">last</span>.<span class="ruby-identifier">downcase</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-setup_maker_attributes" class="method-detail ">
<div class="method-heading">
<span class="method-name">setup_maker_attributes</span><span
class="method-args">(target)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="setup_maker_attributes-source">
<pre><span class="ruby-comment"># File lib/rss/atom.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup_maker_attributes</span>(<span class="ruby-identifier">target</span>)
<span class="ruby-identifier">target</span>.<span class="ruby-identifier">type</span> = <span class="ruby-identifier">type</span>
<span class="ruby-identifier">target</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">content</span>
<span class="ruby-identifier">target</span>.<span class="ruby-identifier">xml_content</span> = <span class="ruby-ivar">@xhtml</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>