2012-11-26 21:40:21 +01:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
<title>
|
|
|
|
|
Class: Zero::Renderer
|
|
|
|
|
|
|
|
|
|
— Documentation by YARD 0.8.3
|
|
|
|
|
|
|
|
|
|
</title>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
|
|
|
hasFrames = window.top.frames.main ? true : false;
|
|
|
|
|
relpath = '../';
|
|
|
|
|
framesUrl = "../frames.html#!" + escape(window.location.href);
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div id="header">
|
|
|
|
|
<div id="menu">
|
|
|
|
|
|
|
|
|
|
<a href="../_index.html">Index (R)</a> »
|
|
|
|
|
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
|
|
|
|
|
»
|
|
|
|
|
<span class="title">Renderer</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="search">
|
|
|
|
|
|
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
|
|
|
href="../class_list.html">
|
|
|
|
|
Class List
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a class="full_list_link" id="method_list_link"
|
|
|
|
|
href="../method_list.html">
|
|
|
|
|
Method List
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a class="full_list_link" id="file_list_link"
|
|
|
|
|
href="../file_list.html">
|
|
|
|
|
File List
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clear"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<iframe id="search_frame"></iframe>
|
|
|
|
|
|
|
|
|
|
<div id="content"><h1>Class: Zero::Renderer
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
<dl class="box">
|
|
|
|
|
|
|
|
|
|
<dt class="r1">Inherits:</dt>
|
|
|
|
|
<dd class="r1">
|
|
|
|
|
<span class="inheritName">Object</span>
|
|
|
|
|
|
|
|
|
|
<ul class="fullTree">
|
|
|
|
|
<li>Object</li>
|
|
|
|
|
|
|
|
|
|
<li class="next">Zero::Renderer</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="r2 last">Defined in:</dt>
|
|
|
|
|
<dd class="r2 last">lib/zero/renderer.rb</dd>
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
<div class="clear"></div>
|
|
|
|
|
|
|
|
|
|
<h2>Overview</h2><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>the base renderer for getting render containers</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>This class handles templates and render coontainers, which can be used for
|
|
|
|
|
the actual rendering.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>To use this renderer you have to give it a template path and optionally a
|
|
|
|
|
map of shorthand type descriptions to fully types. This will then be used
|
|
|
|
|
to extend the internal map of templates to possible formats in a way, that
|
|
|
|
|
you will be able to answer xhtml and html requests with the same template.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>When the object is initialized and you are sure, everything is loaded, call
|
|
|
|
|
#read_template_path! and the template tree will be built. Without this
|
|
|
|
|
step, you will probably don't get any output.</p>
|
|
|
|
|
|
|
|
|
|
<p>After the setup, the renderer can be used to build render containers, which
|
|
|
|
|
then can be used to actually render something.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
<li class="public ">
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<a href="#template_path-instance_method" title="#template_path (instance method)">- (String) <strong>template_path</strong> </a>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span class="note title readonly">readonly</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>get the path to the templates.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<li class="public ">
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<a href="#templates-instance_method" title="#templates (instance method)">- (Hash) <strong>templates</strong> </a>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span class="note title readonly">readonly</span>
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class="private note title">private</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>get the tree of templates.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<li class="public ">
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<a href="#type_map-instance_method" title="#type_map (instance method)">- (Hash) <strong>type_map</strong> </a>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span class="note title readonly">readonly</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>returns the hash of type conversions.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
<h2>
|
|
|
|
|
Instance Method Summary
|
|
|
|
|
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
<li class="public ">
|
|
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Renderer) <strong>initialize</strong>(template_path, type_map = {}) </a>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="note title constructor">constructor</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>initializes a new Renderer.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="public ">
|
|
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<a href="#read_template_path%21-instance_method" title="#read_template_path! (instance method)">- (Self) <strong>read_template_path!</strong> </a>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>load the template tree.</p>
|
|
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="public ">
|
|
|
|
|
<span class="summary_signature">
|
|
|
|
|
|
|
|
|
|
<a href="#render-instance_method" title="#render (instance method)">- (String) <strong>render</strong>(name, type, context) </a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
|
|
|
<p>render a template.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div></span>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="constructor_details" class="method_details_list">
|
|
|
|
|
<h2>Constructor Details</h2>
|
|
|
|
|
|
|
|
|
|
<div class="method_details first">
|
|
|
|
|
<h3 class="signature first" id="initialize-instance_method">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
- (<tt><span class='object_link'><a href="" title="Zero::Renderer (class)">Renderer</a></span></tt>) <strong>initialize</strong>(template_path, type_map = {})
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>initializes a new Renderer</p>
|
|
|
|
|
|
|
|
|
|
<p>This method takes a path to the base template directory and a type map.
|
|
|
|
|
This type map is used to extend the possible renderings for different
|
|
|
|
|
types, which the clients sends.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<div class="examples">
|
|
|
|
|
<p class="tag_title">Examples:</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="example_title"><div class='inline'>
|
|
|
|
|
<p>create a simple renderer</p>
|
|
|
|
|
</div></p>
|
|
|
|
|
|
|
|
|
|
<pre class="example code"><span class='rubyid_Renderer constant id'>Renderer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'app/templates'</span><span class='rparen token'>)</span>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="example_title"><div class='inline'>
|
|
|
|
|
<p>create a renderer with a small map</p>
|
|
|
|
|
</div></p>
|
|
|
|
|
|
|
|
|
|
<pre class="example code"><span class='rubyid_Renderer constant id'>Renderer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'app'</span><span class='comma token'>,</span> <span class='lbrace token'>{</span>
|
|
|
|
|
<span class='string val'>'html'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>'text/html'</span><span class='comma token'>,</span> <span class='string val'>'application/html+xml'</span><span class='rbrack token'>]</span><span class='comma token'>,</span>
|
|
|
|
|
<span class='string val'>'json'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>'application/json'</span><span class='comma token'>,</span> <span class='string val'>'application/aweomse+json'</span><span class='rbrack token'>]</span>
|
|
|
|
|
<span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<p class="tag_title">Parameters:</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
<ul class="param">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='name'>template_path</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>a string to templates</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='name'>type_map</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>a map of simple types to complex ones</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
36
|
|
|
|
|
37
|
|
|
|
|
38
|
|
|
|
|
39</pre>
|
2012-11-26 21:40:21 +01:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2012-11-26 21:45:33 +01:00
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 36</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_template_path identifier id'>template_path</span><span class='comma token'>,</span> <span class='rubyid_type_map identifier id'>type_map</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
|
|
|
<span class='rubyid_@template_path ivar id'>@template_path</span> <span class='assign token'>=</span> <span class='rubyid_template_path identifier id'>template_path</span> <span class='plus op'>+</span> <span class='string val'>'/'</span>
|
|
|
|
|
<span class='rubyid_@type_map ivar id'>@type_map</span> <span class='assign token'>=</span> <span class='rubyid_type_map identifier id'>type_map</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<div id="instance_attr_details" class="attr_details">
|
|
|
|
|
<h2>Instance Attribute Details</h2>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span id=""></span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<div class="method_details first">
|
2012-11-26 21:45:33 +01:00
|
|
|
<h3 class="signature first" id="template_path-instance_method">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
- (<tt>String</tt>) <strong>template_path</strong> <span class="extras">(readonly)</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>get the path to the templates</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
|
|
|
<ul class="return">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>the base template path</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
46
|
|
|
|
|
47
|
|
|
|
|
48</pre>
|
2012-11-26 21:40:21 +01:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2012-11-26 21:45:33 +01:00
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 46</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_template_path identifier id'>template_path</span>
|
|
|
|
|
<span class='rubyid_@template_path ivar id'>@template_path</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span id=""></span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<div class="method_details ">
|
2012-11-26 21:45:33 +01:00
|
|
|
<h3 class="signature " id="templates-instance_method">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
- (<tt>Hash</tt>) <strong>templates</strong> <span class="extras">(readonly)</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
2012-11-26 21:45:33 +01:00
|
|
|
<p class="note private">
|
|
|
|
|
<strong>This method is part of a private API.</strong>
|
|
|
|
|
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>get the tree of templates</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
|
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
|
|
|
<ul class="return">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>the template tree</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
50
|
|
|
|
|
51
|
|
|
|
|
52</pre>
|
2012-11-26 21:40:21 +01:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2012-11-26 21:45:33 +01:00
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 50</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_templates identifier id'>templates</span>
|
|
|
|
|
<span class='rubyid_@templates ivar id'>@templates</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
|
|
|
|
<span id=""></span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<div class="method_details ">
|
2012-11-26 21:45:33 +01:00
|
|
|
<h3 class="signature " id="type_map-instance_method">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
- (<tt>Hash</tt>) <strong>type_map</strong> <span class="extras">(readonly)</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>returns the hash of type conversions</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p class="tag_title">Returns:</p>
|
|
|
|
|
<ul class="return">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>type conversion</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
43
|
|
|
|
|
44
|
|
|
|
|
45</pre>
|
2012-11-26 21:40:21 +01:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2012-11-26 21:45:33 +01:00
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 43</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_type_map identifier id'>type_map</span>
|
|
|
|
|
<span class='rubyid_@type_map ivar id'>@type_map</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
|
2012-11-26 21:40:21 +01:00
|
|
|
<div id="instance_method_details" class="method_details_list">
|
|
|
|
|
<h2>Instance Method Details</h2>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method_details first">
|
2012-11-26 21:45:33 +01:00
|
|
|
<h3 class="signature first" id="read_template_path!-instance_method">
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
- (<tt>Self</tt>) <strong>read_template_path!</strong>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>load the template tree</p>
|
|
|
|
|
|
|
|
|
|
<p>This method gets all templates in the `template_path` and builds an
|
|
|
|
|
internal tree structure, where templates and types direct the request to
|
|
|
|
|
the wanted template.</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
|
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
|
|
|
<ul class="return">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='type'>(<tt>Self</tt>)</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
2012-11-26 21:45:33 +01:00
|
|
|
<p>returns the object</p>
|
2012-11-26 21:40:21 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
58
|
2012-11-26 21:45:33 +01:00
|
|
|
59
|
|
|
|
|
60
|
|
|
|
|
61
|
|
|
|
|
62
|
|
|
|
|
63
|
|
|
|
|
64
|
|
|
|
|
65
|
|
|
|
|
66
|
|
|
|
|
67
|
|
|
|
|
68
|
|
|
|
|
69
|
|
|
|
|
70
|
|
|
|
|
71
|
|
|
|
|
72</pre>
|
|
|
|
|
</td>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 58</span>
|
|
|
|
|
|
|
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_read_template_path! fid id'>read_template_path!</span>
|
|
|
|
|
<span class='comment val'># TODO clean up later</span>
|
|
|
|
|
<span class='rubyid_@templates ivar id'>@templates</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
|
|
|
|
|
<span class='rubyid_search_files identifier id'>search_files</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_file identifier id'>file</span><span class='bitor op'>|</span>
|
|
|
|
|
<span class='rubyid_parts identifier id'>parts</span> <span class='assign token'>=</span> <span class='rubyid_file identifier id'>file</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='dregexp node'>/#{template_path}/</span><span class='comma token'>,</span> <span class='string val'>''</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span>
|
|
|
|
|
<span class='rubyid_@templates ivar id'>@templates</span><span class='lbrack token'>[</span><span class='rubyid_parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
|
|
|
|
|
<span class='rubyid_if if kw'>if</span> <span class='rubyid_parts identifier id'>parts</span><span class='dot token'>.</span><span class='rubyid_count identifier id'>count</span> <span class='gt op'>></span> <span class='integer val'>2</span> <span class='rubyid_then then kw'>then</span>
|
|
|
|
|
<span class='rubyid_read_type identifier id'>read_type</span><span class='lparen token'>(</span><span class='rubyid_parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_type identifier id'>type</span><span class='bitor op'>|</span>
|
|
|
|
|
<span class='rubyid_@templates ivar id'>@templates</span><span class='lbrack token'>[</span><span class='rubyid_parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='rubyid_type identifier id'>type</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_file identifier id'>file</span>
|
|
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
<span class='rubyid_else else kw'>else</span>
|
|
|
|
|
<span class='rubyid_@templates ivar id'>@templates</span><span class='lbrack token'>[</span><span class='rubyid_parts identifier id'>parts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>''</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_file identifier id'>file</span>
|
|
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="method_details ">
|
|
|
|
|
<h3 class="signature " id="render-instance_method">
|
|
|
|
|
|
|
|
|
|
- (<tt>String</tt>) <strong>render</strong>(name, type, context)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
|
|
|
<div class="discussion">
|
|
|
|
|
|
|
|
|
|
<p>render a template</p>
|
|
|
|
|
|
|
|
|
|
<p>This method will render the given template, based on the type in the given
|
|
|
|
|
context.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tags">
|
|
|
|
|
<p class="tag_title">Parameters:</p>
|
|
|
|
|
<ul class="param">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>name</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>the name of the template</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>type</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>Array</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>a list of accept types used to find the template</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
<span class='name'>context</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>Object</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>the context in which to evaluate the template</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
|
|
|
<ul class="return">
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class='type'>(<tt>String</tt>)</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
—
|
|
|
|
|
<div class='inline'>
|
|
|
|
|
<p>the rendered content</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div><table class="source_code">
|
|
|
|
|
<tr>
|
|
|
|
|
<td>
|
|
|
|
|
<pre class="lines">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
82
|
|
|
|
|
83
|
|
|
|
|
84</pre>
|
2012-11-26 21:40:21 +01:00
|
|
|
</td>
|
|
|
|
|
<td>
|
2012-11-26 21:45:33 +01:00
|
|
|
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 82</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
|
2012-11-26 21:45:33 +01:00
|
|
|
<span class='rubyid_def def kw'>def</span> <span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_name identifier id'>name</span><span class='comma token'>,</span> <span class='rubyid_type identifier id'>type</span><span class='comma token'>,</span> <span class='rubyid_context identifier id'>context</span><span class='rparen token'>)</span>
|
|
|
|
|
<span class='rubyid_template identifier id'>template</span><span class='lparen token'>(</span><span class='rubyid_name identifier id'>name</span><span class='comma token'>,</span> <span class='rubyid_type identifier id'>type</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_render identifier id'>render</span><span class='lparen token'>(</span><span class='rubyid_context identifier id'>context</span><span class='rparen token'>)</span>
|
2012-11-26 21:40:21 +01:00
|
|
|
<span class='rubyid_end end kw'>end</span>
|
|
|
|
|
</pre>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
2012-11-26 21:45:33 +01:00
|
|
|
Generated on Mon Nov 26 21:45:20 2012 by
|
2012-11-26 21:40:21 +01:00
|
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
|
|
|
0.8.3 (ruby-1.9.3).
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
