File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPServlet/ERBHandler.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPServlet::ERBHandler - 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 id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="AbstractServlet.html">WEBrick::HTTPServlet::AbstractServlet</a>
</div>
<!-- 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-new">::new</a>
<li ><a href="#method-i-do_GET">#do_GET</a>
<li ><a href="#method-i-do_POST">#do_POST</a>
<li ><a href="#method-i-evaluate">#evaluate</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPServlet::ERBHandler">
<h1 id="class-WEBrick::HTTPServlet::ERBHandler" class="class">
class WEBrick::HTTPServlet::ERBHandler
</h1>
<section class="description">
<p><a href="ERBHandler.html"><code>ERBHandler</code></a> evaluates an <a href="../../ERB.html"><code>ERB</code></a> file and returns the result. This handler is automatically used if there are .rhtml files in a directory served by the <a href="FileHandler.html"><code>FileHandler</code></a>.</p>
<p><a href="ERBHandler.html"><code>ERBHandler</code></a> supports GET and POST methods.</p>
<p>The <a href="../../ERB.html"><code>ERB</code></a> file is evaluated with the local variables <code>servlet_request</code> and <code>servlet_response</code> which are a <a href="../HTTPRequest.html"><code>WEBrick::HTTPRequest</code></a> and <a href="../HTTPResponse.html"><code>WEBrick::HTTPResponse</code></a> respectively.</p>
<p>Example .rhtml file:</p>
<pre>Request to <%= servlet_request.request_uri %>
Query params <%= servlet_request.query.inspect %></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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(server, name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="ERBHandler.html"><code>ERBHandler</code></a> on <code>server</code> that will evaluate and serve the <a href="../../ERB.html"><code>ERB</code></a> file <code>name</code></p>
<div class="method-calls-super">
Calls superclass method
<a href="AbstractServlet.html#method-c-new"><code>WEBrick::HTTPServlet::AbstractServlet::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/erbhandler.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">name</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@script_filename</span> = <span class="ruby-identifier">name</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-do_GET" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_GET</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Handles GET requests</p>
<div class="method-source-code" id="do_GET-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/erbhandler.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_GET</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">ERB</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{self.class}: ERB not defined."</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">Forbidden</span>, <span class="ruby-string">"ERBHandler cannot work."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">data</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@script_filename</span>, <span class="ruby-operator">&</span><span class="ruby-value">:read</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">evaluate</span>(<span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">data</span>), <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">res</span>[<span class="ruby-string">'content-type'</span>] <span class="ruby-operator">||=</span>
<span class="ruby-constant">HTTPUtils</span><span class="ruby-operator">::</span><span class="ruby-identifier">mime_type</span>(<span class="ruby-ivar">@script_filename</span>, <span class="ruby-ivar">@config</span>[<span class="ruby-value">:MimeTypes</span>])
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalServerError</span>, <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="ERBHandler.html#method-i-do_POST">do_POST</a>
</div>
</div>
<div id="method-i-do_POST" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">do_POST</span><span
class="method-args">(req, res)</span>
</div>
<div class="method-description">
<p>Handles POST requests</p>
</div>
<div class="aliases">
Alias for: <a href="ERBHandler.html#method-i-do_GET">do_GET</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-evaluate" class="method-detail ">
<div class="method-heading">
<span class="method-name">evaluate</span><span
class="method-args">(erb, servlet_request, servlet_response)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Evaluates <code>erb</code> providing <code>servlet_request</code> and <code>servlet_response</code> as local variables.</p>
<div class="method-source-code" id="evaluate-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/erbhandler.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">evaluate</span>(<span class="ruby-identifier">erb</span>, <span class="ruby-identifier">servlet_request</span>, <span class="ruby-identifier">servlet_response</span>)
<span class="ruby-constant">Module</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">module_eval</span>{
<span class="ruby-identifier">servlet_request</span>.<span class="ruby-identifier">meta_vars</span>
<span class="ruby-identifier">servlet_request</span>.<span class="ruby-identifier">query</span>
<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</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>