File: C:/Ruby27-x64/share/doc/ruby/html/ERB/DefMethod.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module ERB::DefMethod - 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-c-def_erb_method">::def_erb_method</a>
<li ><a href="#method-i-def_erb_method">#def_erb_method</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-ERB::DefMethod">
<h1 id="module-ERB::DefMethod" class="module">
module ERB::DefMethod
</h1>
<section class="description">
<p>Utility module to define eRuby script as instance method.</p>
<h3 id="module-ERB::DefMethod-label-Example">Example<span><a href="#module-ERB::DefMethod-label-Example">¶</a> <a href="#top">↑</a></span></h3>
<p>example.rhtml:</p>
<pre><% for item in @items %>
<b><%= item %></b>
<% end %></pre>
<p>example.rb:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'erb'</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">MyClass</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">DefMethod</span>
<span class="ruby-identifier">def_erb_method</span>(<span class="ruby-string">'render()'</span>, <span class="ruby-string">'example.rhtml'</span>)
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">items</span>)
<span class="ruby-ivar">@items</span> = <span class="ruby-identifier">items</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">print</span> <span class="ruby-constant">MyClass</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">10</span>,<span class="ruby-value">20</span>,<span class="ruby-value">30</span>]).<span class="ruby-identifier">render</span>()
</pre>
<p>result:</p>
<pre><b>10</b>
<b>20</b>
<b>30</b></pre>
</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-def_erb_method" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_erb_method</span><span
class="method-args">(methodname, erb_or_fname)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>define <em>methodname</em> as instance method of current module, using <a href="../ERB.html"><code>ERB</code></a> object or eRuby file</p>
<div class="method-source-code" id="def_erb_method-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1066</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_erb_method</span>(<span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">erb_or_fname</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">erb_or_fname</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">fname</span> = <span class="ruby-identifier">erb_or_fname</span>
<span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">fname</span>))
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_method</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">fname</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">erb</span> = <span class="ruby-identifier">erb_or_fname</span>
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_method</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">erb</span>.<span class="ruby-identifier">filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">'(ERB)'</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-def_erb_method" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_erb_method</span><span
class="method-args">(methodname, erb_or_fname)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>define <em>methodname</em> as instance method of current module, using <a href="../ERB.html"><code>ERB</code></a> object or eRuby file</p>
<div class="method-source-code" id="def_erb_method-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1066</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_erb_method</span>(<span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">erb_or_fname</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">erb_or_fname</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">String</span>
<span class="ruby-identifier">fname</span> = <span class="ruby-identifier">erb_or_fname</span>
<span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">fname</span>))
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_method</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">fname</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">erb</span> = <span class="ruby-identifier">erb_or_fname</span>
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_method</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">erb</span>.<span class="ruby-identifier">filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">'(ERB)'</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>