File: C:/Ruby27-x64/share/doc/ruby/html/ERB.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class ERB - 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-ERB-label-ERB+--+Ruby+Templating">ERB – Ruby Templating</a>
<li><a href="#class-ERB-label-Introduction">Introduction</a>
<li><a href="#class-ERB-label-Recognized+Tags">Recognized Tags</a>
<li><a href="#class-ERB-label-Options">Options</a>
<li><a href="#class-ERB-label-Character+encodings">Character encodings</a>
<li><a href="#class-ERB-label-Examples">Examples</a>
<li><a href="#class-ERB-label-Plain+Text">Plain Text</a>
<li><a href="#class-ERB-label-Ruby+in+HTML">Ruby in HTML</a>
<li><a href="#class-ERB-label-Notes">Notes</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-version">::version</a>
<li ><a href="#method-i-def_class">#def_class</a>
<li ><a href="#method-i-def_method">#def_method</a>
<li ><a href="#method-i-def_module">#def_module</a>
<li ><a href="#method-i-location-3D">#location=</a>
<li ><a href="#method-i-make_compiler">#make_compiler</a>
<li ><a href="#method-i-new_toplevel">#new_toplevel</a>
<li ><a href="#method-i-result">#result</a>
<li ><a href="#method-i-result_with_hash">#result_with_hash</a>
<li ><a href="#method-i-run">#run</a>
<li ><a href="#method-i-set_eoutvar">#set_eoutvar</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-ERB">
<h1 id="class-ERB" class="class">
class ERB
</h1>
<section class="description">
<h1 id="class-ERB-label-ERB+--+Ruby+Templating"><a href="ERB.html"><code>ERB</code></a> – Ruby Templating<span><a href="#class-ERB-label-ERB+--+Ruby+Templating">¶</a> <a href="#top">↑</a></span></h1>
<h2 id="class-ERB-label-Introduction">Introduction<span><a href="#class-ERB-label-Introduction">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="ERB.html"><code>ERB</code></a> provides an easy to use but powerful templating system for Ruby. Using <a href="ERB.html"><code>ERB</code></a>, actual Ruby code can be added to any plain text document for the purposes of generating document information details and/or flow control.</p>
<p>A very simple example is this:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'erb'</span>
<span class="ruby-identifier">x</span> = <span class="ruby-value">42</span>
<span class="ruby-identifier">template</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier"><<-EOF</span>
<span class="ruby-value"> The value of x is: <%= x %>
</span><span class="ruby-identifier">EOF</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
</pre>
<p><em>Prints:</em> The value of x is: 42</p>
<p>More complex examples are given below.</p>
<h2 id="class-ERB-label-Recognized+Tags">Recognized Tags<span><a href="#class-ERB-label-Recognized+Tags">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="ERB.html"><code>ERB</code></a> recognizes certain tags in the provided template and converts them based on the rules below:</p>
<pre><% Ruby code -- inline with output %>
<%= Ruby expression -- replace with result %>
<%# comment -- ignored -- useful in testing %>
% a line of Ruby code -- treated as <% line %> (optional -- see ERB.new)
%% replaced with % if first thing on a line and % processing is used
<%% or %%> -- replace with <% or %> respectively</pre>
<p>All other text is passed through <a href="ERB.html"><code>ERB</code></a> filtering unchanged.</p>
<h2 id="class-ERB-label-Options">Options<span><a href="#class-ERB-label-Options">¶</a> <a href="#top">↑</a></span></h2>
<p>There are several settings you can change when you use ERB:</p>
<ul><li>
<p>the nature of the tags that are recognized;</p>
</li><li>
<p>the binding used to resolve local variables in the template.</p>
</li></ul>
<p>See the <a href="ERB.html#method-c-new"><code>ERB.new</code></a> and <a href="ERB.html#method-i-result"><code>ERB#result</code></a> methods for more detail.</p>
<h2 id="class-ERB-label-Character+encodings">Character encodings<span><a href="#class-ERB-label-Character+encodings">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="ERB.html"><code>ERB</code></a> (or Ruby code generated by <a href="ERB.html"><code>ERB</code></a>) returns a string in the same character encoding as the input string. When the input string has a magic comment, however, it returns a string in the encoding specified by the magic comment.</p>
<pre class="ruby"><span class="ruby-comment"># -*- coding: utf-8 -*-</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'erb'</span>
<span class="ruby-identifier">template</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier"><<EOF</span>
<span class="ruby-value"><%#-*- coding: Big5 -*-%>
\_\_ENCODING\_\_ is <%= \_\_ENCODING\_\_ %>.
</span><span class="ruby-identifier">EOF</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">result</span>
</pre>
<p><em>Prints:</em> _<em>ENCODING</em>_ is Big5.</p>
<h2 id="class-ERB-label-Examples">Examples<span><a href="#class-ERB-label-Examples">¶</a> <a href="#top">↑</a></span></h2>
<h3 id="class-ERB-label-Plain+Text">Plain Text<span><a href="#class-ERB-label-Plain+Text">¶</a> <a href="#top">↑</a></span></h3>
<p><a href="ERB.html"><code>ERB</code></a> is useful for any generic templating situation. Note that in this example, we use the convenient “% at start of line” tag, and we quote the template literally with <code>%q{...}</code> to avoid trouble with the backslash.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-comment"># Create template.</span>
<span class="ruby-identifier">template</span> = <span class="ruby-string">%q{
From: James Edward Gray II <james@grayproductions.net>
To: <%= to %>
Subject: Addressing Needs
<%= to[/\w+/] %>:
Just wanted to send a quick note assuring that your needs are being
addressed.
I want you to know that my team will keep working on the issues,
especially:
<%# ignore numerous minor requests -- focus on priorities %>
% priorities.each do |priority|
* <%= priority %>
% end
Thanks for your patience.
James Edward Gray II
}</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^ /</span>, <span class="ruby-string">''</span>)
<span class="ruby-identifier">message</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">template</span>, <span class="ruby-value">trim_mode:</span> <span class="ruby-string">"%<>"</span>)
<span class="ruby-comment"># Set up template data.</span>
<span class="ruby-identifier">to</span> = <span class="ruby-string">"Community Spokesman <spokesman@ruby_community.org>"</span>
<span class="ruby-identifier">priorities</span> = [ <span class="ruby-string">"Run Ruby Quiz"</span>,
<span class="ruby-string">"Document Modules"</span>,
<span class="ruby-string">"Answer Questions on Ruby Talk"</span> ]
<span class="ruby-comment"># Produce result.</span>
<span class="ruby-identifier">email</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">result</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">email</span>
</pre>
<p><em>Generates:</em></p>
<pre>From: James Edward Gray II <james@grayproductions.net>
To: Community Spokesman <spokesman@ruby_community.org>
Subject: Addressing Needs
Community:
Just wanted to send a quick note assuring that your needs are being addressed.
I want you to know that my team will keep working on the issues, especially:
* Run Ruby Quiz
* Document Modules
* Answer Questions on Ruby Talk
Thanks for your patience.
James Edward Gray II</pre>
<h3 id="class-ERB-label-Ruby+in+HTML">Ruby in HTML<span><a href="#class-ERB-label-Ruby+in+HTML">¶</a> <a href="#top">↑</a></span></h3>
<p><a href="ERB.html"><code>ERB</code></a> is often used in <code>.rhtml</code> files (HTML with embedded Ruby). Notice the need in this example to provide a special binding when the template is run, so that the instance variables in the Product object can be resolved.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-comment"># Build template data class.</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">Product</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">code</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">cost</span> )
<span class="ruby-ivar">@code</span> = <span class="ruby-identifier">code</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@desc</span> = <span class="ruby-identifier">desc</span>
<span class="ruby-ivar">@cost</span> = <span class="ruby-identifier">cost</span>
<span class="ruby-ivar">@features</span> = [ ]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_feature</span>( <span class="ruby-identifier">feature</span> )
<span class="ruby-ivar">@features</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">feature</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># Support templating of member data.</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_binding</span>
<span class="ruby-identifier">binding</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># Create template.</span>
<span class="ruby-identifier">template</span> = <span class="ruby-string">%{
<html>
<head><title>Ruby Toys -- <%= @name %></title></head>
<body>
<h1><%= @name %> (<%= @code %>)</h1>
<p><%= @desc %></p>
<ul>
<% @features.each do |f| %>
<li><b><%= f %></b></li>
<% end %>
</ul>
<p>
<% if @cost < 10 %>
<b>Only <%= @cost %>!!!</b>
<% else %>
Call for a price, today!
<% end %>
</p>
</body>
</html>
}</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^ /</span>, <span class="ruby-string">''</span>)
<span class="ruby-identifier">rhtml</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-comment"># Set up template data.</span>
<span class="ruby-identifier">toy</span> = <span class="ruby-constant">Product</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">"TZ-1002"</span>,
<span class="ruby-string">"Rubysapien"</span>,
<span class="ruby-string">"Geek's Best Friend! Responds to Ruby commands..."</span>,
<span class="ruby-value">999.95</span> )
<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">add_feature</span>(<span class="ruby-string">"Listens for verbal commands in the Ruby language!"</span>)
<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">add_feature</span>(<span class="ruby-string">"Ignores Perl, Java, and all C variants."</span>)
<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">add_feature</span>(<span class="ruby-string">"Karate-Chop Action!!!"</span>)
<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">add_feature</span>(<span class="ruby-string">"Matz signature on left leg."</span>)
<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">add_feature</span>(<span class="ruby-string">"Gem studded eyes... Rubies, of course!"</span>)
<span class="ruby-comment"># Produce result.</span>
<span class="ruby-identifier">rhtml</span>.<span class="ruby-identifier">run</span>(<span class="ruby-identifier">toy</span>.<span class="ruby-identifier">get_binding</span>)
</pre>
<p><em>Generates (some blank lines removed):</em></p>
<pre><html>
<head><title>Ruby Toys -- Rubysapien</title></head>
<body>
<h1>Rubysapien (TZ-1002)</h1>
<p>Geek's Best Friend! Responds to Ruby commands...</p>
<ul>
<li><b>Listens for verbal commands in the Ruby language!</b></li>
<li><b>Ignores Perl, Java, and all C variants.</b></li>
<li><b>Karate-Chop Action!!!</b></li>
<li><b>Matz signature on left leg.</b></li>
<li><b>Gem studded eyes... Rubies, of course!</b></li>
</ul>
<p>
Call for a price, today!
</p>
</body>
</html></pre>
<h2 id="class-ERB-label-Notes">Notes<span><a href="#class-ERB-label-Notes">¶</a> <a href="#top">↑</a></span></h2>
<p>There are a variety of templating solutions available in various Ruby projects. For example, <a href="RDoc.html"><code>RDoc</code></a>, distributed with Ruby, uses its own template engine, which can be reused elsewhere.</p>
<p>Other popular engines could be found in the corresponding <a href="https://www.ruby-toolbox.com/categories/template_engines">Category</a> of The Ruby Toolbox.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="NOT_GIVEN">NOT_GIVEN
<dd>
<dt id="ZERO_SAFE_LEVELS">ZERO_SAFE_LEVELS
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-encoding" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">encoding</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The encoding to eval</p>
</div>
</div>
<div id="attribute-i-filename" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">filename</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The optional <em>filename</em> argument passed to <a href="Kernel.html#method-i-eval"><code>Kernel#eval</code></a> when the <a href="ERB.html"><code>ERB</code></a> code is run</p>
</div>
</div>
<div id="attribute-i-lineno" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">lineno</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The optional <em>lineno</em> argument passed to <a href="Kernel.html#method-i-eval"><code>Kernel#eval</code></a> when the <a href="ERB.html"><code>ERB</code></a> code is run</p>
</div>
</div>
<div id="attribute-i-src" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">src</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The Ruby code generated by <a href="ERB.html"><code>ERB</code></a></p>
</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">(str, safe_level=NOT_GIVEN, legacy_trim_mode=NOT_GIVEN, legacy_eoutvar=NOT_GIVEN, trim_mode: nil, eoutvar: '_erbout')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Constructs a new <a href="ERB.html"><code>ERB</code></a> object with the template specified in <em>str</em>.</p>
<p>An <a href="ERB.html"><code>ERB</code></a> object works by building a chunk of Ruby code that will output the completed template when run.</p>
<p>If <em>trim_mode</em> is passed a <a href="String.html"><code>String</code></a> containing one or more of the following modifiers, <a href="ERB.html"><code>ERB</code></a> will adjust its code generation as listed:</p>
<pre>% enables Ruby code processing for lines beginning with %
<> omit newline for lines starting with <% and ending in %>
> omit newline for lines ending in %>
- omit blank lines ending in -%></pre>
<p><em>eoutvar</em> can be used to set the name of the variable <a href="ERB.html"><code>ERB</code></a> will build up its output in. This is useful when you need to run multiple <a href="ERB.html"><code>ERB</code></a> templates through the same binding and/or when you want to control where output ends up. Pass the name of the variable to be used inside a <a href="String.html"><code>String</code></a>.</p>
<h3 id="method-c-new-label-Example">Example<span><a href="#method-c-new-label-Example">¶</a> <a href="#top">↑</a></span></h3>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-comment"># build data class</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">Listings</span>
<span class="ruby-constant">PRODUCT</span> = { <span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Chicken Fried Steak"</span>,
<span class="ruby-value">:desc</span> <span class="ruby-operator">=></span> <span class="ruby-string">"A well messages pattie, breaded and fried."</span>,
<span class="ruby-value">:cost</span> <span class="ruby-operator">=></span> <span class="ruby-value">9.95</span> }
<span class="ruby-identifier">attr_reader</span> <span class="ruby-value">:product</span>, <span class="ruby-value">:price</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">product</span> = <span class="ruby-string">""</span>, <span class="ruby-identifier">price</span> = <span class="ruby-string">""</span> )
<span class="ruby-ivar">@product</span> = <span class="ruby-identifier">product</span>
<span class="ruby-ivar">@price</span> = <span class="ruby-identifier">price</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build</span>
<span class="ruby-identifier">b</span> = <span class="ruby-identifier">binding</span>
<span class="ruby-comment"># create and run templates, filling member data variables</span>
<span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier"><<-'END_PRODUCT'</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^\s+/</span>, <span class="ruby-string">""</span>), <span class="ruby-value">trim_mode:</span> <span class="ruby-string">""</span>, <span class="ruby-value">eoutvar:</span> <span class="ruby-string">"@product"</span>).<span class="ruby-identifier">result</span> <span class="ruby-identifier">b</span>
<span class="ruby-value"> <%= PRODUCT[:name] %>
<%= PRODUCT[:desc] %>
</span><span class="ruby-identifier"> END_PRODUCT</span>
<span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier"><<-'END_PRICE'</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^\s+/</span>, <span class="ruby-string">""</span>), <span class="ruby-value">trim_mode:</span> <span class="ruby-string">""</span>, <span class="ruby-value">eoutvar:</span> <span class="ruby-string">"@price"</span>).<span class="ruby-identifier">result</span> <span class="ruby-identifier">b</span>
<span class="ruby-value"> <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
<%= PRODUCT[:desc] %>
</span><span class="ruby-identifier"> END_PRICE</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># setup template data</span>
<span class="ruby-identifier">listings</span> = <span class="ruby-constant">Listings</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">listings</span>.<span class="ruby-identifier">build</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">listings</span>.<span class="ruby-identifier">product</span> <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">listings</span>.<span class="ruby-identifier">price</span>
</pre>
<p><em>Generates</em></p>
<pre>Chicken Fried Steak
A well messages pattie, breaded and fried.
Chicken Fried Steak -- 9.95
A well messages pattie, breaded and fried.</pre>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 808</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">str</span>, <span class="ruby-identifier">safe_level</span>=<span class="ruby-constant">NOT_GIVEN</span>, <span class="ruby-identifier">legacy_trim_mode</span>=<span class="ruby-constant">NOT_GIVEN</span>, <span class="ruby-identifier">legacy_eoutvar</span>=<span class="ruby-constant">NOT_GIVEN</span>, <span class="ruby-value">trim_mode:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">eoutvar:</span> <span class="ruby-string">'_erbout'</span>)
<span class="ruby-comment"># Complex initializer for $SAFE deprecation at [Feature #14256]. Use keyword arguments to pass trim_mode or eoutvar.</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">safe_level</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">NOT_GIVEN</span>
<span class="ruby-identifier">warn</span> <span class="ruby-string">'Passing safe_level with the 2nd argument of ERB.new is deprecated. Do not use it, and specify other arguments as keyword arguments.'</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-constant">ZERO_SAFE_LEVELS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">safe_level</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">legacy_trim_mode</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">NOT_GIVEN</span>
<span class="ruby-identifier">warn</span> <span class="ruby-string">'Passing trim_mode with the 3rd argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, trim_mode: ...) instead.'</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span>
<span class="ruby-identifier">trim_mode</span> = <span class="ruby-identifier">legacy_trim_mode</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">legacy_eoutvar</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">NOT_GIVEN</span>
<span class="ruby-identifier">warn</span> <span class="ruby-string">'Passing eoutvar with the 4th argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, eoutvar: ...) instead.'</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span>
<span class="ruby-identifier">eoutvar</span> = <span class="ruby-identifier">legacy_eoutvar</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">compiler</span> = <span class="ruby-identifier">make_compiler</span>(<span class="ruby-identifier">trim_mode</span>)
<span class="ruby-identifier">set_eoutvar</span>(<span class="ruby-identifier">compiler</span>, <span class="ruby-identifier">eoutvar</span>)
<span class="ruby-ivar">@src</span>, <span class="ruby-ivar">@encoding</span>, <span class="ruby-ivar">@frozen_string</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">compiler</span>.<span class="ruby-identifier">compile</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-ivar">@filename</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@lineno</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@_init</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">singleton_class</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-version" class="method-detail ">
<div class="method-heading">
<span class="method-name">version</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns revision information for the erb.rb module.</p>
<div class="method-source-code" id="version-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 261</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">version</span>
<span class="ruby-node">"erb.rb [2.2.0 #{ERB::Revision.split[1]}]"</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-def_class" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_class</span><span
class="method-args">(superklass=Object, methodname='result')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Define unnamed class which has <em>methodname</em> as instance method, and return it.</p>
<p>example:</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">MyClass_</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">arg1</span>, <span class="ruby-identifier">arg2</span>)
<span class="ruby-ivar">@arg1</span> = <span class="ruby-identifier">arg1</span>; <span class="ruby-ivar">@arg2</span> = <span class="ruby-identifier">arg2</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">filename</span> = <span class="ruby-string">'example.rhtml'</span> <span class="ruby-comment"># @arg1 and @arg2 are used in example.rhtml</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">filename</span>))
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">filename</span> = <span class="ruby-identifier">filename</span>
<span class="ruby-constant">MyClass</span> = <span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_class</span>(<span class="ruby-constant">MyClass_</span>, <span class="ruby-string">'render()'</span>)
<span class="ruby-identifier">print</span> <span class="ruby-constant">MyClass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'foo'</span>, <span class="ruby-value">123</span>).<span class="ruby-identifier">render</span>()
</pre>
<div class="method-source-code" id="def_class-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 976</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_class</span>(<span class="ruby-identifier">superklass</span>=<span class="ruby-constant">Object</span>, <span class="ruby-identifier">methodname</span>=<span class="ruby-string">'result'</span>)
<span class="ruby-identifier">cls</span> = <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">superklass</span>)
<span class="ruby-identifier">def_method</span>(<span class="ruby-identifier">cls</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-ivar">@filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">'(ERB)'</span>)
<span class="ruby-identifier">cls</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-def_method" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_method</span><span
class="method-args">(mod, methodname, fname='(ERB)')</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 <em>mod</em> from compiled Ruby source.</p>
<p>example:</p>
<pre class="ruby"><span class="ruby-identifier">filename</span> = <span class="ruby-string">'example.rhtml'</span> <span class="ruby-comment"># 'arg1' and 'arg2' are used in example.rhtml</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">filename</span>))
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_method</span>(<span class="ruby-constant">MyClass</span>, <span class="ruby-string">'render(arg1, arg2)'</span>, <span class="ruby-identifier">filename</span>)
<span class="ruby-identifier">print</span> <span class="ruby-constant">MyClass</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">render</span>(<span class="ruby-string">'foo'</span>, <span class="ruby-value">123</span>)
</pre>
<div class="method-source-code" id="def_method-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 940</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_method</span>(<span class="ruby-identifier">mod</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-identifier">fname</span>=<span class="ruby-string">'(ERB)'</span>)
<span class="ruby-identifier">src</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">src</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/^(?!#|$)/</span>) {<span class="ruby-node">"def #{methodname}\n"</span>} <span class="ruby-operator"><<</span> <span class="ruby-string">"\nend\n"</span>
<span class="ruby-identifier">mod</span>.<span class="ruby-identifier">module_eval</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">eval</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">binding</span>, <span class="ruby-identifier">fname</span>, <span class="ruby-value">-1</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-def_module" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_module</span><span
class="method-args">(methodname='erb')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create unnamed module, define <em>methodname</em> as instance method of it, and return it.</p>
<p>example:</p>
<pre class="ruby"><span class="ruby-identifier">filename</span> = <span class="ruby-string">'example.rhtml'</span> <span class="ruby-comment"># 'arg1' and 'arg2' are used in example.rhtml</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">filename</span>))
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">filename</span> = <span class="ruby-identifier">filename</span>
<span class="ruby-constant">MyModule</span> = <span class="ruby-identifier">erb</span>.<span class="ruby-identifier">def_module</span>(<span class="ruby-string">'render(arg1, arg2)'</span>)
<span class="ruby-keyword">class</span> <span class="ruby-constant">MyClass</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">MyModule</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="def_module-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 957</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_module</span>(<span class="ruby-identifier">methodname</span>=<span class="ruby-string">'erb'</span>)
<span class="ruby-identifier">mod</span> = <span class="ruby-constant">Module</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">def_method</span>(<span class="ruby-identifier">mod</span>, <span class="ruby-identifier">methodname</span>, <span class="ruby-ivar">@filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">'(ERB)'</span>)
<span class="ruby-identifier">mod</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-location-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">location=</span><span
class="method-args">((filename, lineno))</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets optional filename and line number that will be used in <a href="ERB.html"><code>ERB</code></a> code evaluation and error reporting. See also <a href="ERB.html#attribute-i-filename"><code>filename=</code></a> and <a href="ERB.html#attribute-i-lineno"><code>lineno=</code></a></p>
<pre class="ruby"><span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'<%= some_x %>'</span>)
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">render</span>
<span class="ruby-comment"># undefined local variable or method `some_x'</span>
<span class="ruby-comment"># from (erb):1</span>
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">location</span> = [<span class="ruby-string">'file.erb'</span>, <span class="ruby-value">3</span>]
<span class="ruby-comment"># All subsequent error reporting would use new location</span>
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">render</span>
<span class="ruby-comment"># undefined local variable or method `some_x'</span>
<span class="ruby-comment"># from file.erb:4</span>
</pre>
<div class="method-source-code" id="location-3D-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 870</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">location=</span>((<span class="ruby-identifier">filename</span>, <span class="ruby-identifier">lineno</span>))
<span class="ruby-ivar">@filename</span> = <span class="ruby-identifier">filename</span>
<span class="ruby-ivar">@lineno</span> = <span class="ruby-identifier">lineno</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">lineno</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-make_compiler" class="method-detail ">
<div class="method-heading">
<span class="method-name">make_compiler</span><span
class="method-args">(trim_mode)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new compiler for <a href="ERB.html"><code>ERB</code></a>. See ERB::Compiler.new for details</p>
<div class="method-source-code" id="make_compiler-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 837</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">make_compiler</span>(<span class="ruby-identifier">trim_mode</span>)
<span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">Compiler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">trim_mode</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-result" class="method-detail ">
<div class="method-heading">
<span class="method-name">result</span><span
class="method-args">(b=new_toplevel)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Executes the generated <a href="ERB.html"><code>ERB</code></a> code to produce a completed template, returning the results of that code. (See <a href="ERB.html#method-c-new"><code>ERB::new</code></a> for details on how this process can be affected by <em>safe_level</em>.)</p>
<p><em>b</em> accepts a <a href="Binding.html"><code>Binding</code></a> object which is used to set the context of code evaluation.</p>
<div class="method-source-code" id="result-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 900</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">result</span>(<span class="ruby-identifier">b</span>=<span class="ruby-identifier">new_toplevel</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@_init</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">singleton_class</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"not initialized"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">eval</span>(<span class="ruby-ivar">@src</span>, <span class="ruby-identifier">b</span>, (<span class="ruby-ivar">@filename</span> <span class="ruby-operator">||</span> <span class="ruby-string">'(erb)'</span>), <span class="ruby-ivar">@lineno</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-result_with_hash" class="method-detail ">
<div class="method-heading">
<span class="method-name">result_with_hash</span><span
class="method-args">(hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Render a template on a new toplevel binding with local variables specified by a <a href="Hash.html"><code>Hash</code></a> object.</p>
<div class="method-source-code" id="result_with_hash-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 909</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">result_with_hash</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-identifier">b</span> = <span class="ruby-identifier">new_toplevel</span>(<span class="ruby-identifier">hash</span>.<span class="ruby-identifier">keys</span>)
<span class="ruby-identifier">hash</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">b</span>.<span class="ruby-identifier">local_variable_set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">result</span>(<span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-run" class="method-detail ">
<div class="method-heading">
<span class="method-name">run</span><span
class="method-args">(b=new_toplevel)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generate results and print them. (see <a href="ERB.html#method-i-result"><code>ERB#result</code></a>)</p>
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 888</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">b</span>=<span class="ruby-identifier">new_toplevel</span>)
<span class="ruby-identifier">print</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_eoutvar" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_eoutvar</span><span
class="method-args">(compiler, eoutvar = '_erbout')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Can be used to set <em>eoutvar</em> as described in <a href="ERB.html#method-c-new"><code>ERB::new</code></a>. It's probably easier to just use the constructor though, since calling this method requires the setup of an <a href="ERB.html"><code>ERB</code></a> <em>compiler</em> object.</p>
<div class="method-source-code" id="set_eoutvar-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 880</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_eoutvar</span>(<span class="ruby-identifier">compiler</span>, <span class="ruby-identifier">eoutvar</span> = <span class="ruby-string">'_erbout'</span>)
<span class="ruby-identifier">compiler</span>.<span class="ruby-identifier">put_cmd</span> = <span class="ruby-node">"#{eoutvar}.<<"</span>
<span class="ruby-identifier">compiler</span>.<span class="ruby-identifier">insert_cmd</span> = <span class="ruby-node">"#{eoutvar}.<<"</span>
<span class="ruby-identifier">compiler</span>.<span class="ruby-identifier">pre_cmd</span> = [<span class="ruby-node">"#{eoutvar} = +''"</span>]
<span class="ruby-identifier">compiler</span>.<span class="ruby-identifier">post_cmd</span> = [<span class="ruby-identifier">eoutvar</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-new_toplevel" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_toplevel</span><span
class="method-args">(vars = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new binding each time <strong>near</strong> TOPLEVEL_BINDING for runs that do not specify a binding.</p>
<div class="method-source-code" id="new_toplevel-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 921</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_toplevel</span>(<span class="ruby-identifier">vars</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">b</span> = <span class="ruby-constant">TOPLEVEL_BINDING</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">vars</span>
<span class="ruby-identifier">vars</span> = <span class="ruby-identifier">vars</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">local_variable_defined?</span>(<span class="ruby-identifier">v</span>)}
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">vars</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">eval</span>(<span class="ruby-node">"tap {|;#{vars.join(',')}| break binding}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">b</span>.<span class="ruby-identifier">dup</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>