0
0
Fork 0

refreshed documentation

This commit is contained in:
Gibheer 2012-11-26 21:45:33 +01:00
parent 43a6ada2ed
commit be1afcd114
17 changed files with 566 additions and 386 deletions

View File

@ -92,7 +92,7 @@
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Zero/Controller.html" title="Zero::Controller (class)">Controller</a></span>, <span class='object_link'><a href="Zero/FileNotFoundError.html" title="Zero::FileNotFoundError (class)">FileNotFoundError</a></span>, <span class='object_link'><a href="Zero/Renderer.html" title="Zero::Renderer (class)">Renderer</a></span>, <span class='object_link'><a href="Zero/Request.html" title="Zero::Request (class)">Request</a></span>, <span class='object_link'><a href="Zero/Response.html" title="Zero::Response (class)">Response</a></span>, <span class='object_link'><a href="Zero/Router.html" title="Zero::Router (class)">Router</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Zero/Controller.html" title="Zero::Controller (class)">Controller</a></span>, <span class='object_link'><a href="Zero/Renderer.html" title="Zero::Renderer (class)">Renderer</a></span>, <span class='object_link'><a href="Zero/Request.html" title="Zero::Request (class)">Request</a></span>, <span class='object_link'><a href="Zero/Response.html" title="Zero::Response (class)">Response</a></span>, <span class='object_link'><a href="Zero/Router.html" title="Zero::Router (class)">Router</a></span>
</p>
@ -121,7 +121,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -607,7 +607,7 @@ the request before rendering stuff.</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -102,22 +102,22 @@
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class helps with rendering of content.</p>
<p>the base renderer for getting render containers</p>
<p>The purpose of this class is to render templates. All variables pushed into
the renderer should be already processed, so that the raw data can be used.</p>
<p>This class handles templates and render coontainers, which can be used for
the actual rendering.</p>
<p>The workflow of this class is like the following.</p>
<ul><li>
<p>setup the type mapping</p>
</li><li>
<p>create a new instance of the class to prepare rendering</p>
</li><li>
<p>call #render to process the template</p>
</li></ul>
<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>
<p>The call to #render will return the String representation of the template
with all data given.</p>
<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>
</div>
@ -129,21 +129,13 @@ with all data given.</p>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#template_path%3D-class_method" title="template_path= (class method)">+ (Object) <strong>template_path=</strong>(path) </a>
<a href="#template_path-instance_method" title="#template_path (instance method)">- (String) <strong>template_path</strong> </a>
@ -151,6 +143,11 @@ with all data given.</p>
<span class="note title readonly">readonly</span>
@ -158,16 +155,16 @@ with all data given.</p>
<span class="summary_desc"><div class='inline'>
<p>set a base path for template search.</p>
<p>get the path to the templates.</p>
</div></span>
</li>
<li class="public ">
<li class="public ">
<span class="summary_signature">
<a href="#type_map-class_method" title="type_map (class method)">+ (Hash) <strong>type_map</strong> </a>
<a href="#templates-instance_method" title="#templates (instance method)">- (Hash) <strong>templates</strong> </a>
@ -175,6 +172,40 @@ with all data given.</p>
<span class="note title readonly">readonly</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>get the tree of templates.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type_map-instance_method" title="#type_map (instance method)">- (Hash) <strong>type_map</strong> </a>
</span>
<span class="note title readonly">readonly</span>
@ -182,37 +213,17 @@ with all data given.</p>
<span class="summary_desc"><div class='inline'>
<p>returns the type map.</p>
<p>returns the hash of type conversions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type_map%3D-class_method" title="type_map= (class method)">+ (Object) <strong>type_map=</strong>(map) </a>
</ul>
</span>
<span class="summary_desc"><div class='inline'>
<p>save a mapping hash for the type.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
@ -224,7 +235,7 @@ with all data given.</p>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Renderer) <strong>initialize</strong>(path, context, accept_types) </a>
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Renderer) <strong>initialize</strong>(template_path, type_map = {}) </a>
@ -241,7 +252,7 @@ with all data given.</p>
<span class="summary_desc"><div class='inline'>
<p>take the path and render the template within the context.</p>
<p>initializes a new Renderer.</p>
</div></span>
</li>
@ -250,7 +261,7 @@ with all data given.</p>
<li class="public ">
<span class="summary_signature">
<a href="#render-instance_method" title="#render (instance method)">- (String) <strong>render</strong> </a>
<a href="#read_template_path%21-instance_method" title="#read_template_path! (instance method)">- (Self) <strong>read_template_path!</strong> </a>
@ -265,7 +276,31 @@ with all data given.</p>
<span class="summary_desc"><div class='inline'>
<p>render the template within the context.</p>
<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>
</div></span>
</li>
@ -280,7 +315,7 @@ with all data given.</p>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Zero::Renderer (class)">Renderer</a></span></tt>) <strong>initialize</strong>(path, context, accept_types)
- (<tt><span class='object_link'><a href="" title="Zero::Renderer (class)">Renderer</a></span></tt>) <strong>initialize</strong>(template_path, type_map = {})
@ -289,7 +324,410 @@ with all data given.</p>
</h3><div class="docstring">
<div class="discussion">
<p>take the path and render the template within the context</p>
<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>
</div>
</div>
<div class="tags">
<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'>&gt;</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'>&gt;</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>
<ul class="param">
<li>
<span class='name'>template_path</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>a string to templates</p>
</div>
</li>
<li>
<span class='name'>type_map</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>a map of simple types to complex ones</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 36</span>
<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>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="template_path-instance_method">
- (<tt>String</tt>) <strong>template_path</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the path to the templates</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the base template path</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 46</span>
<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>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="templates-instance_method">
- (<tt>Hash</tt>) <strong>templates</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<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>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>the template tree</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 50</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_templates identifier id'>templates</span>
<span class='rubyid_@templates ivar id'>@templates</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type_map-instance_method">
- (<tt>Hash</tt>) <strong>type_map</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>returns the hash of type conversions</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>type conversion</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 43</span>
<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>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="read_template_path!-instance_method">
- (<tt>Self</tt>) <strong>read_template_path!</strong>
</h3><div class="docstring">
<div class="discussion">
<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>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Self</tt>)</span>
&mdash;
<div class='inline'>
<p>returns the object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
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'>&gt;</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>
@ -300,7 +738,7 @@ with all data given.</p>
<li>
<span class='name'>path</span>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
@ -309,7 +747,23 @@ with all data given.</p>
&mdash;
<div class='inline'>
<p>the relative path to the template</p>
<p>the name of the template</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt>Array</tt>)</span>
&mdash;
<div class='inline'>
<p>a list of accept types used to find the template</p>
</div>
</li>
@ -325,280 +779,13 @@ with all data given.</p>
&mdash;
<div class='inline'>
<p>the object to process on</p>
</div>
</li>
<li>
<span class='name'>accept_types</span>
<span class='type'></span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 49</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_context identifier id'>context</span><span class='comma token'>,</span> <span class='rubyid_accept_types identifier id'>accept_types</span><span class='rparen token'>)</span>
<span class='rubyid_accept_types identifier id'>accept_types</span> <span class='opasgn op'>||=</span> <span class='rubyid_Request constant id'>Request</span><span class='colon2 op'>::</span><span class='rubyid_Accept constant id'>Accept</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='string val'>'text/html'</span><span class='rparen token'>)</span>
<span class='rubyid_@path ivar id'>@path</span> <span class='assign token'>=</span> <span class='rubyid_find_template identifier id'>find_template</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_accept_types identifier id'>accept_types</span><span class='rparen token'>)</span>
<span class='rubyid_@context ivar id'>@context</span> <span class='assign token'>=</span> <span class='rubyid_context identifier id'>context</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="template_path=-class_method">
+ (<tt>Object</tt>) <strong>template_path=</strong>(path)
</h3><div class="docstring">
<div class="discussion">
<p>set a base path for template search</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the path to the template base dir</p>
<p>the context in which to evaluate the template</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 20</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_template_path= identifier id'>template_path=</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
<span class='rubyid_@@path ivar id'>@@path</span> <span class='assign token'>=</span> <span class='rubyid_path identifier id'>path</span> <span class='plus op'>+</span> <span class='string val'>'/'</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="type_map-class_method">
+ (<tt>Hash</tt>) <strong>type_map</strong>
</h3><div class="docstring">
<div class="discussion">
<p>returns the type map</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>the mapping for types</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 40</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_type_map identifier id'>type_map</span>
<span class='rubyid_@@map ivar id'>@@map</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="type_map=-class_method">
+ (<tt>Object</tt>) <strong>type_map=</strong>(map)
</h3><div class="docstring">
<div class="discussion">
<p>save a mapping hash for the type</p>
<p>With that it is possible to map long and complex contant types to simpler
representations. These get then used in the finding process for the best
fitting template.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><span class='rubyid_Zero constant id'>Zero</span><span class='colon2 op'>::</span><span class='rubyid_Renderer constant id'>Renderer</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='string val'>'text/html'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'html'</span><span class='rbrace token'>}</span>
</pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>map</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>maps the content type to a simple representation</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 34</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_type_map= identifier id'>type_map=</span><span class='lparen token'>(</span><span class='rubyid_map identifier id'>map</span><span class='rparen token'>)</span>
<span class='rubyid_@@map ivar id'>@@map</span> <span class='assign token'>=</span> <span class='rubyid_map identifier id'>map</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="render-instance_method">
- (<tt>String</tt>) <strong>render</strong>
</h3><div class="docstring">
<div class="discussion">
<p>render the template within the context</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
@ -611,7 +798,7 @@ fitting template.</p>
&mdash;
<div class='inline'>
<p>the rendered template</p>
<p>the rendered content</p>
</div>
</li>
@ -624,15 +811,15 @@ fitting template.</p>
<pre class="lines">
57
58
59</pre>
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 57</span>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 82</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_render identifier id'>render</span>
<span class='rubyid_Tilt constant id'>Tilt</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_@path ivar id'>@path</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 ivar id'>@context</span><span class='rparen token'>)</span>
<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>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
@ -645,7 +832,7 @@ fitting template.</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -1467,7 +1467,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -603,7 +603,7 @@ from sinatra</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -394,7 +394,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:02 2012 by
Generated on Mon Nov 26 21:45:21 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -570,7 +570,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -480,7 +480,7 @@ parameters) and payload parameters (or POST parameters).</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:21 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -678,7 +678,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -714,7 +714,7 @@ Content-Type, Content-Length and body on status code 204 and 304.</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 2012 by
Generated on Mon Nov 26 21:45:20 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -324,7 +324,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -124,21 +124,6 @@
</ul>
<ul id="alpha_F" class="alpha">
<li class="letter">F</li>
<ul>
<li>
<span class='object_link'><a href="Zero/FileNotFoundError.html" title="Zero::FileNotFoundError (class)">FileNotFoundError</a></span>
<small>(Zero)</small>
</li>
</ul>
</ul>
<ul id="alpha_P" class="alpha">
<li class="letter">P</li>
<ul>
@ -226,7 +211,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -45,7 +45,7 @@
<ul id="full_list" class="class">
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
<li><a class='toggle'></a> <span class='object_link'><a href="Zero.html" title="Zero (module)">Zero</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Zero/Controller.html" title="Zero::Controller (class)">Controller</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><span class='object_link'><a href="Zero/FileNotFoundError.html" title="Zero::FileNotFoundError (class)">FileNotFoundError</a></span> &lt; IOError<small class='search_info'>Zero</small></li><li><span class='object_link'><a href="Zero/Renderer.html" title="Zero::Renderer (class)">Renderer</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Zero/Request.html" title="Zero::Request (class)">Request</a></span> &lt; Object<small class='search_info'>Zero</small></li><ul><li><span class='object_link'><a href="Zero/Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/AcceptType.html" title="Zero::Request::AcceptType (class)">AcceptType</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Client.html" title="Zero::Request::Client (class)">Client</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Server.html" title="Zero::Request::Server (class)">Server</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li></ul><li><span class='object_link'><a href="Zero/Response.html" title="Zero::Response (class)">Response</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><span class='object_link'><a href="Zero/Router.html" title="Zero::Router (class)">Router</a></span> &lt; Object<small class='search_info'>Zero</small></li></ul>
<li><a class='toggle'></a> <span class='object_link'><a href="Zero.html" title="Zero (module)">Zero</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Zero/Controller.html" title="Zero::Controller (class)">Controller</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><span class='object_link'><a href="Zero/Renderer.html" title="Zero::Renderer (class)">Renderer</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Zero/Request.html" title="Zero::Request (class)">Request</a></span> &lt; Object<small class='search_info'>Zero</small></li><ul><li><span class='object_link'><a href="Zero/Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/AcceptType.html" title="Zero::Request::AcceptType (class)">AcceptType</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Client.html" title="Zero::Request::Client (class)">Client</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li><li><span class='object_link'><a href="Zero/Request/Server.html" title="Zero::Request::Server (class)">Server</a></span> &lt; Object<small class='search_info'>Zero::Request</small></li></ul><li><span class='object_link'><a href="Zero/Response.html" title="Zero::Response (class)">Response</a></span> &lt; Object<small class='search_info'>Zero</small></li><li><span class='object_link'><a href="Zero/Router.html" title="Zero::Router (class)">Router</a></span> &lt; Object<small class='search_info'>Zero</small></li></ul>
</ul>
</div>

View File

@ -67,7 +67,7 @@
web applications.</p></div></div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -67,7 +67,7 @@
web applications.</p></div></div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>

View File

@ -391,7 +391,7 @@
<li class="r2 ">
<span class='object_link'><a href="Zero/Renderer.html#render-instance_method" title="Zero::Renderer#render (method)">#render</a></span>
<span class='object_link'><a href="Zero/Renderer.html#read_template_path%21-instance_method" title="Zero::Renderer#read_template_path! (method)">#read_template_path!</a></span>
<small>Zero::Renderer</small>
@ -399,6 +399,14 @@
<li class="r1 ">
<span class='object_link'><a href="Zero/Renderer.html#render-instance_method" title="Zero::Renderer#render (method)">#render</a></span>
<small>Zero::Renderer</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Controller.html#renderer-class_method" title="Zero::Controller.renderer (method)">renderer</a></span>
<small>Zero::Controller</small>
@ -406,7 +414,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<span class='object_link'><a href="Zero/Controller.html#renderer-instance_method" title="Zero::Controller#renderer (method)">#renderer</a></span>
<small>Zero::Controller</small>
@ -414,7 +422,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<span class='object_link'><a href="Zero/Controller.html#renderer%3D-class_method" title="Zero::Controller.renderer= (method)">renderer=</a></span>
<small>Zero::Controller</small>
@ -422,7 +430,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<span class='object_link'><a href="Zero/Controller.html#response-instance_method" title="Zero::Controller#response (method)">#response</a></span>
<small>Zero::Controller</small>
@ -430,7 +438,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#server-instance_method" title="Zero::Request#server (method)">#server</a></span>
<small>Zero::Request</small>
@ -438,7 +446,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Server.html#software-instance_method" title="Zero::Request::Server#software (method)">#software</a></span>
<small>Zero::Request::Server</small>
@ -446,7 +454,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<span class='object_link'><a href="Zero/Response.html#status-instance_method" title="Zero::Response#status (method)">#status</a></span>
<small>Zero::Response</small>
@ -454,8 +462,16 @@
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Renderer.html#template_path-instance_method" title="Zero::Renderer#template_path (method)">#template_path</a></span>
<small>Zero::Renderer</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Renderer.html#template_path%3D-class_method" title="Zero::Renderer.template_path= (method)">template_path=</a></span>
<span class='object_link'><a href="Zero/Renderer.html#templates-instance_method" title="Zero::Renderer#templates (method)">#templates</a></span>
<small>Zero::Renderer</small>
@ -471,7 +487,7 @@
<li class="r2 ">
<span class='object_link'><a href="Zero/Renderer.html#type_map-class_method" title="Zero::Renderer.type_map (method)">type_map</a></span>
<span class='object_link'><a href="Zero/Renderer.html#type_map-instance_method" title="Zero::Renderer#type_map (method)">#type_map</a></span>
<small>Zero::Renderer</small>
@ -479,14 +495,6 @@
<li class="r1 ">
<span class='object_link'><a href="Zero/Renderer.html#type_map%3D-class_method" title="Zero::Renderer.type_map= (method)">type_map=</a></span>
<small>Zero::Renderer</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Accept.html#types-instance_method" title="Zero::Request::Accept#types (method)">#types</a></span>
<small>Zero::Request::Accept</small>
@ -494,7 +502,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Client.html#user_agent-instance_method" title="Zero::Request::Client#user_agent (method)">#user_agent</a></span>
<small>Zero::Request::Client</small>

View File

@ -103,7 +103,7 @@
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 2012 by
Generated on Mon Nov 26 21:45:19 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>