File: C:/Ruby27-x64/share/doc/ruby/html/ERB/Util.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module ERB::Util - 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-h">::h</a>
<li ><a href="#method-c-html_escape">::html_escape</a>
<li ><a href="#method-c-u">::u</a>
<li ><a href="#method-c-url_encode">::url_encode</a>
<li ><a href="#method-i-h">#h</a>
<li ><a href="#method-i-html_escape">#html_escape</a>
<li ><a href="#method-i-u">#u</a>
<li ><a href="#method-i-url_encode">#url_encode</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-ERB::Util">
<h1 id="module-ERB::Util" class="module">
module ERB::Util
</h1>
<section class="description">
<p>A utility module for conversion routines, often handy in HTML generation.</p>
</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-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="Util.html#method-i-html_escape">html_escape</a>
</div>
</div>
<div id="method-c-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>A utility method for escaping HTML tag characters in <em>s</em>.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">html_escape</span>(<span class="ruby-string">"is a > 0 & a < 10?"</span>)
</pre>
<p><em>Generates</em></p>
<pre>is a &gt; 0 &amp; a &lt; 10?</pre>
<div class="method-source-code" id="html_escape-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1001</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-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Util.html#method-i-h">h</a>
</div>
</div>
<div id="method-c-u" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">u</span><span
class="method-args">(s)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Util.html#method-i-url_encode">url_encode</a>
</div>
</div>
<div id="method-c-url_encode" class="method-detail ">
<div class="method-heading">
<span class="method-name">url_encode</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A utility method for encoding the <a href="../String.html"><code>String</code></a> <em>s</em> as a URL.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">url_encode</span>(<span class="ruby-string">"Programming Ruby: The Pragmatic Programmer's Guide"</span>)
</pre>
<p><em>Generates</em></p>
<pre>Programming%20Ruby%3A%20%20The%20Pragmatic%20Programmer%27s%20Guide</pre>
<div class="method-source-code" id="url_encode-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1020</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">url_encode</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">b</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[^a-zA-Z0-9_\-.~]/n</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">sprintf</span>(<span class="ruby-string">"%%%02X"</span>, <span class="ruby-identifier">m</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"C"</span>))
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Util.html#method-i-u">u</a>
</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-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="Util.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>A utility method for escaping HTML tag characters in <em>s</em>.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">html_escape</span>(<span class="ruby-string">"is a > 0 & a < 10?"</span>)
</pre>
<p><em>Generates</em></p>
<pre>is a &gt; 0 &amp; a &lt; 10?</pre>
<div class="method-source-code" id="html_escape-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1001</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-constant">CGI</span>.<span class="ruby-identifier">escapeHTML</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Util.html#method-i-h">h</a>
</div>
</div>
<div id="method-i-u" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">u</span><span
class="method-args">(s)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Util.html#method-i-url_encode">url_encode</a>
</div>
</div>
<div id="method-i-url_encode" class="method-detail ">
<div class="method-heading">
<span class="method-name">url_encode</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A utility method for encoding the <a href="../String.html"><code>String</code></a> <em>s</em> as a URL.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"erb"</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ERB</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">url_encode</span>(<span class="ruby-string">"Programming Ruby: The Pragmatic Programmer's Guide"</span>)
</pre>
<p><em>Generates</em></p>
<pre>Programming%20Ruby%3A%20%20The%20Pragmatic%20Programmer%27s%20Guide</pre>
<div class="method-source-code" id="url_encode-source">
<pre><span class="ruby-comment"># File lib/erb.rb, line 1020</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">url_encode</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">b</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[^a-zA-Z0-9_\-.~]/n</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">sprintf</span>(<span class="ruby-string">"%%%02X"</span>, <span class="ruby-identifier">m</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"C"</span>))
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Util.html#method-i-u">u</a>
</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>