File: C:/Ruby27-x64/share/doc/ruby/html/RSS/Utils.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RSS::Utils - 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 ><a href="#method-i-element_initialize_arguments-3F">#element_initialize_arguments?</a>
<li ><a href="#method-i-get_file_and_line_from_caller">#get_file_and_line_from_caller</a>
<li ><a href="#method-i-h">#h</a>
<li ><a href="#method-i-html_escape">#html_escape</a>
<li ><a href="#method-i-new_with_value_if_need">#new_with_value_if_need</a>
<li ><a href="#method-i-to_class_name">#to_class_name</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RSS::Utils">
<h1 id="module-RSS::Utils" class="module">
module RSS::Utils
</h1>
<section class="description">
<p><a href="Utils.html"><code>RSS::Utils</code></a> is a module that holds various utility functions that are used across many parts of the rest of the <a href="../RSS.html"><code>RSS</code></a> library. Like most modules named some variant of 'util', its methods are probably not particularly useful to those who aren't developing the library itself.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-element_initialize_arguments-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">element_initialize_arguments?</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This method is used inside of several different objects to determine if special behavior is needed in the constructor.</p>
<p>Special behavior is needed if the array passed in as <code>args</code> has <code>true</code> or <code>false</code> as its value, and if the second element of <code>args</code> is a hash.</p>
<div class="method-source-code" id="element_initialize_arguments-3F-source">
<pre><span class="ruby-comment"># File lib/rss/utils.rb, line 124</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">element_initialize_arguments?</span>(<span class="ruby-identifier">args</span>)
[<span class="ruby-keyword">true</span>, <span class="ruby-keyword">false</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]) <span class="ruby-keyword">and</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_file_and_line_from_caller" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_file_and_line_from_caller</span><span
class="method-args">(i=0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of two elements: the filename where the calling method is located, and the line number where it is defined.</p>
<p>Takes an optional argument <code>i</code>, which specifies how many callers up the stack to look.</p>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rss/utils'</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">get_file_and_line_from_caller</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">get_file_and_line_from_caller</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bar</span>
<span class="ruby-identifier">foo</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">baz</span>
<span class="ruby-identifier">bar</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">baz</span>
<span class="ruby-comment"># => ["test.rb", 5]</span>
<span class="ruby-comment"># => ["test.rb", 9]</span>
</pre>
<p>If <code>i</code> is not given, or is the default value of 0, it attempts to figure out the correct value. This is useful when in combination with instance_eval. For example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rss/utils'</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">p</span> <span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">get_file_and_line_from_caller</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bar</span>
<span class="ruby-identifier">foo</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">instance_eval</span> <span class="ruby-identifier"><<-RUBY</span>, <span class="ruby-operator">*</span><span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">get_file_and_line_from_caller</span>
<span class="ruby-value">def baz
bar
end
</span><span class="ruby-identifier">RUBY</span>
<span class="ruby-identifier">baz</span>
<span class="ruby-comment"># => ["test.rb", 8]</span>
</pre>
<div class="method-source-code" id="get_file_and_line_from_caller-source">
<pre><span class="ruby-comment"># File lib/rss/utils.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_file_and_line_from_caller</span>(<span class="ruby-identifier">i</span>=<span class="ruby-value">0</span>)
<span class="ruby-identifier">file</span>, <span class="ruby-identifier">line</span>, = <span class="ruby-identifier">caller</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">':'</span>)
<span class="ruby-identifier">line</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-identifier">line</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">zero?</span>
[<span class="ruby-identifier">file</span>, <span class="ruby-identifier">line</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-h" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">h</span><span
class="method-args">(s)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Utils.html#method-i-html_escape">html_escape</a>
</div>
</div>
<div id="method-i-html_escape" class="method-detail ">
<div class="method-heading">
<span class="method-name">html_escape</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Takes a string <code>s</code> with some HTML in it, and escapes '&', '“', '<' and '>', by replacing them with the appropriate entities.</p>
<p>This method is also aliased to h, for convenience.</p>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rss/utils'</span>
<span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">html_escape</span>(<span class="ruby-string">"Dungeons & Dragons"</span>)
<span class="ruby-comment"># => "Dungeons &amp; Dragons"</span>
<span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">h</span>(<span class="ruby-string">">_>"</span>)
<span class="ruby-comment"># => "&gt;_&gt;"</span>
</pre>
<div class="method-source-code" id="html_escape-source">
<pre><span class="ruby-comment"># File lib/rss/utils.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">html_escape</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/&/</span>, <span class="ruby-string">"&amp;"</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\"/</span>, <span class="ruby-string">"&quot;"</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/>/</span>, <span class="ruby-string">"&gt;"</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/</</span>, <span class="ruby-string">"&lt;"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Utils.html#method-i-h">h</a>
</div>
</div>
<div id="method-i-new_with_value_if_need" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_with_value_if_need</span><span
class="method-args">(klass, value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If <code>value</code> is an instance of class <code>klass</code>, return it, else create a new instance of <code>klass</code> with value <code>value</code>.</p>
<div class="method-source-code" id="new_with_value_if_need-source">
<pre><span class="ruby-comment"># File lib/rss/utils.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_with_value_if_need</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">value</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-identifier">klass</span>)
<span class="ruby-identifier">value</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_class_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_class_name</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Given a <code>name</code> in a name_with_underscores or a name-with-dashes format, returns the CamelCase version of <code>name</code>.</p>
<p>If the <code>name</code> is already CamelCased, nothing happens.</p>
<p>Examples:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rss/utils'</span>
<span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">to_class_name</span>(<span class="ruby-string">"sample_name"</span>)
<span class="ruby-comment"># => "SampleName"</span>
<span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">to_class_name</span>(<span class="ruby-string">"with-dashes"</span>)
<span class="ruby-comment"># => "WithDashes"</span>
<span class="ruby-constant">RSS</span><span class="ruby-operator">::</span><span class="ruby-constant">Utils</span>.<span class="ruby-identifier">to_class_name</span>(<span class="ruby-string">"CamelCase"</span>)
<span class="ruby-comment"># => "CamelCase"</span>
</pre>
<div class="method-source-code" id="to_class_name-source">
<pre><span class="ruby-comment"># File lib/rss/utils.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_class_name</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/[_\-]/</span>).<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
<span class="ruby-node">"#{part[0, 1].upcase}#{part[1..-1]}"</span>
<span class="ruby-keyword">end</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">""</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>