0
0
Fork 0

added the first set of documentation

This commit is contained in:
Gibheer 2012-11-26 21:40:21 +01:00
parent 77a2cbe6d4
commit 37a4a28dee
26 changed files with 8745 additions and 0 deletions

130
doc/Zero.html Normal file
View File

@ -0,0 +1,130 @@
<!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>
Module: Zero
&mdash; 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 (Z)</a> &raquo;
<span class="title">Zero</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>Module: Zero
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/zero.rb<span class="defines">,<br />
lib/zero/router.rb,<br /> lib/zero/version.rb,<br /> lib/zero/request.rb,<br /> lib/zero/renderer.rb,<br /> lib/zero/response.rb,<br /> lib/zero/controller.rb,<br /> lib/zero/request/server.rb,<br /> lib/zero/request/client.rb,<br /> lib/zero/request/accept.rb,<br /> lib/zero/request/parameter.rb,<br /> lib/zero/request/accept_type.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<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>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
</dt>
<dd><pre class="code"><span class='string val'>'0.0.1'</span><span class='dot token'>.</span><span class='rubyid_freeze identifier id'>freeze</span>
</pre></dd>
</dl>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

616
doc/Zero/Controller.html Normal file
View File

@ -0,0 +1,616 @@
<!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::Controller
&mdash; 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 (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
&raquo;
<span class="title">Controller</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::Controller
</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::Controller</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/controller.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>abstract class to make creation of controllers easier</p>
<p>This abstract class creates an interface to make it easier to write rack
compatible controllers. It catches #call and creates a new instance with
the environment and calls #render on it.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#call-class_method" title="call (class method)">+ (Object) <strong>call</strong>(env) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>initialize a new instance of the controller and call response on it.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#renderer-class_method" title="renderer (class method)">+ (Object) <strong>renderer</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>get the renderer set in the controller.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#renderer%3D-class_method" title="renderer= (class method)">+ (Object) <strong>renderer=</strong>(renderer) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>set the renderer to use in the controller.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Controller) <strong>initialize</strong>(request) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>initialize the controller.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#renderer-instance_method" title="#renderer (instance method)">- (Object) <strong>renderer</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>a small helper to get the actual renderer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>build the response and return it.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Controller (class)">Controller</a></span></tt>) <strong>initialize</strong>(request)
</h3><div class="docstring">
<div class="discussion">
<p>initialize the controller</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Zero::Request (class)">Request</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>a request object</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 30</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_request identifier id'>request</span><span class='rparen token'>)</span>
<span class='rubyid_@request ivar id'>@request</span> <span class='assign token'>=</span> <span class='rubyid_request identifier id'>request</span>
<span class='rubyid_@response ivar id'>@response</span> <span class='assign token'>=</span> <span class='rubyid_Zero constant id'>Zero</span><span class='colon2 op'>::</span><span class='rubyid_Response constant id'>Response</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</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="call-class_method">
+ (<tt>Object</tt>) <strong>call</strong>(env)
</h3><div class="docstring">
<div class="discussion">
<p>initialize a new instance of the controller and call response on it</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 9</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
<span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_Zero constant id'>Zero</span><span class='colon2 op'>::</span><span class='rubyid_Request constant id'>Request</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_response identifier id'>response</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="renderer-class_method">
+ (<tt>Object</tt>) <strong>renderer</strong>
</h3><div class="docstring">
<div class="discussion">
<p>get the renderer set in the controller</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 19</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_renderer identifier id'>renderer</span>
<span class='rubyid_@@renderer ivar id'>@@renderer</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="renderer=-class_method">
+ (<tt>Object</tt>) <strong>renderer=</strong>(renderer)
</h3><div class="docstring">
<div class="discussion">
<p>set the renderer to use in the controller</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 14</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_renderer identifier id'>renderer</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_renderer identifier id'>renderer</span><span class='rparen token'>)</span>
<span class='rubyid_@@renderer ivar id'>@@renderer</span> <span class='assign token'>=</span> <span class='rubyid_renderer identifier id'>renderer</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="renderer-instance_method">
- (<tt>Object</tt>) <strong>renderer</strong>
</h3><div class="docstring">
<div class="discussion">
<p>a small helper to get the actual renderer</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 24</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_renderer identifier id'>renderer</span>
<span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_renderer identifier id'>renderer</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="response-instance_method">
- (<tt>Object</tt>) <strong>response</strong>
</h3><div class="docstring">
<div class="discussion">
<p>build the response and return it</p>
<p>This method calls #process if it was defined so make it easier to process
the request before rendering stuff.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>Response a rack conform response</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/controller.rb', line 40</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_response identifier id'>response</span>
<span class='rubyid_process identifier id'>process</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:process</span><span class='rparen token'>)</span>
<span class='rubyid_render identifier id'>render</span>
<span class='rubyid_@response ivar id'>@response</span><span class='dot token'>.</span><span class='rubyid_to_a identifier id'>to_a</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

View File

@ -0,0 +1,123 @@
<!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>
Exception: Zero::FileNotFoundError
&mdash; 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 (F)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
&raquo;
<span class="title">FileNotFoundError</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>Exception: Zero::FileNotFoundError
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">IOError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">IOError</li>
<li class="next">Zero::FileNotFoundError</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>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

654
doc/Zero/Renderer.html Normal file
View File

@ -0,0 +1,654 @@
<!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
&mdash; 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> &raquo;
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
&raquo;
<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">
<p>This class helps with rendering of content.</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>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>The call to #render will return the String representation of the template
with all data given.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method 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>
</span>
<span class="summary_desc"><div class='inline'>
<p>set a base path for template search.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type_map-class_method" title="type_map (class method)">+ (Hash) <strong>type_map</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>returns the type map.</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>
</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
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<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>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>take the path and render the template within the context.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#render-instance_method" title="#render (instance method)">- (String) <strong>render</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>render the template within the context.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Renderer (class)">Renderer</a></span></tt>) <strong>initialize</strong>(path, context, accept_types)
</h3><div class="docstring">
<div class="discussion">
<p>take the path and render the template within the context</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 relative path to the template</p>
</div>
</li>
<li>
<span class='name'>context</span>
<span class='type'>(<tt>Object</tt>)</span>
&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>
</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">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the rendered template</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/renderer.rb', line 57</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_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

1476
doc/Zero/Request.html Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,612 @@
<!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::Request::Accept
&mdash; 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 (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">Accept</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::Request::Accept
</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::Request::Accept</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/accept.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>encapsulates the accept header to easier work with this is partly copied
from sinatra</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>','</span>
</pre></dd>
<dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>';'</span>
</pre></dd>
<dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX =
</dt>
<dd><pre class="code"><span class='regexp val'>/q=[01]\./</span>
</pre></dd>
<dt id="KEY_HTTP_ACCEPT-constant" class="">KEY_HTTP_ACCEPT =
</dt>
<dd><pre class="code"><span class='string val'>'HTTP_ACCEPT'</span>
</pre></dd>
<dt id="KEY_HTTP_ACCEPT_LANGUAGE-constant" class="">KEY_HTTP_ACCEPT_LANGUAGE =
</dt>
<dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_LANGUAGE'</span>
</pre></dd>
<dt id="KEY_HTTP_ACCEPT_ENCODING-constant" class="">KEY_HTTP_ACCEPT_ENCODING =
</dt>
<dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_ENCODING'</span>
</pre></dd>
</dl>
<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="#encoding-instance_method" title="#encoding (instance method)">- (Object) <strong>encoding</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute encoding.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#language-instance_method" title="#language (instance method)">- (Object) <strong>language</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute language.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#types-instance_method" title="#types (instance method)">- (Object) <strong>types</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute types.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#map-class_method" title="map (class method)">+ (Object) <strong>map</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#map%3D-class_method" title="map= (class method)">+ (Object) <strong>map=</strong>(map) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Accept) <strong>initialize</strong>(environment) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>create a new accept object.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Request::Accept (class)">Accept</a></span></tt>) <strong>initialize</strong>(environment)
</h3><div class="docstring">
<div class="discussion">
<p>create a new accept object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 25</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_environment identifier id'>environment</span><span class='rparen token'>)</span>
<span class='rubyid_@types ivar id'>@types</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT constant id'>KEY_HTTP_ACCEPT</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
<span class='rubyid_@language ivar id'>@language</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_LANGUAGE constant id'>KEY_HTTP_ACCEPT_LANGUAGE</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
<span class='rubyid_@encoding ivar id'>@encoding</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_ENCODING constant id'>KEY_HTTP_ACCEPT_ENCODING</span><span class='rbrack token'>]</span><span class='rparen token'>)</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="encoding-instance_method">
- (<tt>Object</tt>) <strong>encoding</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute encoding</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 33</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_encoding identifier id'>encoding</span>
<span class='rubyid_@encoding ivar id'>@encoding</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="language-instance_method">
- (<tt>Object</tt>) <strong>language</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute language</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 32</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_language identifier id'>language</span>
<span class='rubyid_@language ivar id'>@language</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="types-instance_method">
- (<tt>Object</tt>) <strong>types</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute types</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 31</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_types identifier id'>types</span>
<span class='rubyid_@types ivar id'>@types</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="map-class_method">
+ (<tt>Object</tt>) <strong>map</strong>
</h3><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/request/accept.rb', line 20</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>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="map=-class_method">
+ (<tt>Object</tt>) <strong>map=</strong>(map)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 16</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span><span class='assign token'>=</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>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

View File

@ -0,0 +1,403 @@
<!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::Request::AcceptType
&mdash; 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 (A)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">AcceptType</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::Request::AcceptType
</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::Request::AcceptType</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/accept_type.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class provides an interface to access information of accept schemas.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>','</span>
</pre></dd>
<dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR =
</dt>
<dd><pre class="code"><span class='string val'>';'</span>
</pre></dd>
<dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX =
</dt>
<dd><pre class="code"><span class='regexp val'>/q=[01]\./</span>
</pre></dd>
</dl>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>iterate over all media types.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AcceptType) <strong>initialize</strong>(string) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>create a new instance of AcceptType.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preferred-instance_method" title="#preferred (instance method)">- (Object) <strong>preferred</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>return the preferred type.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Request::AcceptType (class)">AcceptType</a></span></tt>) <strong>initialize</strong>(string)
</h3><div class="docstring">
<div class="discussion">
<p>create a new instance of AcceptType</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 10</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_string identifier id'>string</span><span class='rparen token'>)</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_string identifier id'>string</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
<span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='rubyid_else else kw'>else</span>
<span class='rubyid_@elements ivar id'>@elements</span> <span class='assign token'>=</span> <span class='rubyid_parse_elements identifier id'>parse_elements</span><span class='lparen token'>(</span><span class='rubyid_string identifier id'>string</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</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="each-instance_method">
- (<tt>Object</tt>) <strong>each</strong>
</h3><div class="docstring">
<div class="discussion">
<p>iterate over all media types</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/accept_type.rb', line 25</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_each identifier id'>each</span>
<span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='rubyid_element identifier id'>element</span><span class='bitor op'>|</span> <span class='rubyid_yield yield kw'>yield</span> <span class='rubyid_element identifier id'>element</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="preferred-instance_method">
- (<tt>Object</tt>) <strong>preferred</strong>
</h3><div class="docstring">
<div class="discussion">
<p>return the preferred type</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>String the preferred media type</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/request/accept_type.rb', line 20</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_preferred identifier id'>preferred</span>
<span class='rubyid_@elements ivar id'>@elements</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:02 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>
</body>
</html>

View File

@ -0,0 +1,579 @@
<!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::Request::Client
&mdash; 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 (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">Client</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::Request::Client
</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::Request::Client</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/client.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents all information about the client of a request.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="KEY_REMOTE_ADDR-constant" class="">KEY_REMOTE_ADDR =
<div class="docstring">
<div class="discussion">
<p>the key for the ip of the client</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'REMOTE_ADDR'</span>
</pre></dd>
<dt id="KEY_REMOTE_HOST-constant" class="">KEY_REMOTE_HOST =
<div class="docstring">
<div class="discussion">
<p>the key for the hostname</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'REMOTE_HOST'</span>
</pre></dd>
<dt id="KEY_USER_AGENT-constant" class="">KEY_USER_AGENT =
<div class="docstring">
<div class="discussion">
<p>the key for the user agent</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'HTTP_USER_AGENT'</span>
</pre></dd>
</dl>
<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="#address-instance_method" title="#address (instance method)">- (String) <strong>address</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>the ip address of the client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hostname-instance_method" title="#hostname (instance method)">- (String) <strong>hostname</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>the hostname of the client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_agent-instance_method" title="#user_agent (instance method)">- (String) <strong>user_agent</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>the user agent of the client.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(environment) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>creates a new client with the data of the request environment.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Request::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(environment)
</h3><div class="docstring">
<div class="discussion">
<p>creates a new client with the data of the request environment</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>environment</span>
<span class='type'></span>
&mdash;
<div class='inline'>
<p>a hash representation of the request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 14</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_environment identifier id'>environment</span><span class='rparen token'>)</span>
<span class='rubyid_@address ivar id'>@address</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_ADDR constant id'>KEY_REMOTE_ADDR</span><span class='rbrack token'>]</span>
<span class='rubyid_@hostname ivar id'>@hostname</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_REMOTE_HOST constant id'>KEY_REMOTE_HOST</span><span class='rbrack token'>]</span>
<span class='rubyid_@user_agent ivar id'>@user_agent</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_USER_AGENT constant id'>KEY_USER_AGENT</span><span class='rbrack token'>]</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="address-instance_method">
- (<tt>String</tt>) <strong>address</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>the ip address of the client</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 address of the client</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 22</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_address identifier id'>address</span>
<span class='rubyid_@address ivar id'>@address</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="hostname-instance_method">
- (<tt>String</tt>) <strong>hostname</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>the hostname of the client</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 hostname of the client</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 25</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_hostname identifier id'>hostname</span>
<span class='rubyid_@hostname ivar id'>@hostname</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="user_agent-instance_method">
- (<tt>String</tt>) <strong>user_agent</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>the user agent of the client</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 user agent of the client</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/client.rb', line 28</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_user_agent identifier id'>user_agent</span>
<span class='rubyid_@user_agent ivar id'>@user_agent</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

View File

@ -0,0 +1,489 @@
<!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::Request::Parameter
&mdash; 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 (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">Parameter</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::Request::Parameter
</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::Request::Parameter</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/parameter.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>represents all parameter set in a session</p>
<p>This class holds all parameters available in the rack environment, split on
query and payload parameters.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="ENV_KEY_QUERY-constant" class="">ENV_KEY_QUERY =
<div class="docstring">
<div class="discussion">
<p>they key for the query string</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'QUERY_STRING'</span>
</pre></dd>
<dt id="ENV_KEY_PAYLOAD-constant" class="">ENV_KEY_PAYLOAD =
<div class="docstring">
<div class="discussion">
<p>the key for the payload</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'rack.input'</span>
</pre></dd>
<dt id="ENV_KEY_CONTENT_TYPE-constant" class="">ENV_KEY_CONTENT_TYPE =
<div class="docstring">
<div class="discussion">
<p>the key for the content type</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'CONTENT_TYPE'</span>
</pre></dd>
<dt id="PAYLOAD_CONTENT_TYPES-constant" class="">PAYLOAD_CONTENT_TYPES =
<div class="docstring">
<div class="discussion">
<p>all content types which used for using the body as a parameter input</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrack token'>[</span>
<span class='string val'>'application/x-www-form-urlencoded'</span><span class='comma token'>,</span>
<span class='string val'>'multipart/form-data'</span>
<span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_set identifier id'>to_set</span>
</pre></dd>
</dl>
<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="#payload-instance_method" title="#payload (instance method)">- (Object) <strong>payload</strong> </a>
(also: #post)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the payload or form data parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#query-instance_method" title="#query (instance method)">- (Object) <strong>query</strong> </a>
(also: #get)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the query parameters.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Parameter) <strong>initialize</strong>(environment) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>creates a new parameter instance.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Request::Parameter (class)">Parameter</a></span></tt>) <strong>initialize</strong>(environment)
</h3><div class="docstring">
<div class="discussion">
<p>creates a new parameter instance</p>
<p>This should never be called directly, as it will be generated for you. This
instance gives you the options to get query parameters (mostly called GET
parameters) and payload parameters (or POST parameters).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>environment</span>
<span class='type'>(<tt>Hash</tt>)</span>
&mdash;
<div class='inline'>
<p>the rack environment</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 37</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_environment identifier id'>environment</span><span class='rparen token'>)</span>
<span class='rubyid_@query ivar id'>@query</span> <span class='assign token'>=</span> <span class='rubyid_extract_query_params identifier id'>extract_query_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span>
<span class='rubyid_@payload ivar id'>@payload</span> <span class='assign token'>=</span> <span class='rubyid_extract_payload_params identifier id'>extract_payload_params</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</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="payload-instance_method">
- (<tt>Object</tt>) <strong>payload</strong> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='post-instance_method'>post</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the payload or form data parameters</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 28</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_payload identifier id'>payload</span>
<span class='rubyid_@payload ivar id'>@payload</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="query-instance_method">
- (<tt>Object</tt>) <strong>query</strong> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='get-instance_method'>get</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the query parameters</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/parameter.rb', line 24</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_query identifier id'>query</span>
<span class='rubyid_@query ivar id'>@query</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

View File

@ -0,0 +1,687 @@
<!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::Request::Server
&mdash; 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 (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
&raquo;
<span class="title">Server</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::Request::Server
</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::Request::Server</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/request/server.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents all server related information of a request.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="KEY_SERVER_NAME-constant" class="">KEY_SERVER_NAME =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>the key for the server name</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'SERVER_NAME'</span>
</pre></dd>
<dt id="KEY_SERVER_PORT-constant" class="">KEY_SERVER_PORT =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>the key for the server port</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'SERVER_PORT'</span>
</pre></dd>
<dt id="KEY_SERVER_PROTOCOL-constant" class="">KEY_SERVER_PROTOCOL =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>the key for the server protocol</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'SERVER_PROTOCOL'</span>
</pre></dd>
<dt id="KEY_SERVER_SOFTWARE-constant" class="">KEY_SERVER_SOFTWARE =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>the key for the server software</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'SERVER_SOFTWARE'</span>
</pre></dd>
</dl>
<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="#hostname-instance_method" title="#hostname (instance method)">- (String) <strong>hostname</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the hostname of the server.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#port-instance_method" title="#port (instance method)">- (Numeric) <strong>port</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the port.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#protocol-instance_method" title="#protocol (instance method)">- (String) <strong>protocol</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the protocol of the server (normally it should be HTTP/1.1).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#software-instance_method" title="#software (instance method)">- (String) <strong>software</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>get the server software.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Server) <strong>initialize</strong>(environment) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>This creates a new server instance extracting all server related.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Request::Server (class)">Server</a></span></tt>) <strong>initialize</strong>(environment)
</h3><div class="docstring">
<div class="discussion">
<p>This creates a new server instance extracting all server related</p>
<pre class="code ruby18"><code>information from the environment.</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 20</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_environment identifier id'>environment</span><span class='rparen token'>)</span>
<span class='rubyid_@hostname ivar id'>@hostname</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_NAME constant id'>KEY_SERVER_NAME</span><span class='rbrack token'>]</span>
<span class='rubyid_@port ivar id'>@port</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_PORT constant id'>KEY_SERVER_PORT</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
<span class='rubyid_@protocol ivar id'>@protocol</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_PROTOCOL constant id'>KEY_SERVER_PROTOCOL</span><span class='rbrack token'>]</span>
<span class='rubyid_@software ivar id'>@software</span> <span class='assign token'>=</span> <span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_SERVER_SOFTWARE constant id'>KEY_SERVER_SOFTWARE</span><span class='rbrack token'>]</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="hostname-instance_method">
- (<tt>String</tt>) <strong>hostname</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the hostname of the server</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 hostname</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 32</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_hostname identifier id'>hostname</span>
<span class='rubyid_@hostname ivar id'>@hostname</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="port-instance_method">
- (<tt>Numeric</tt>) <strong>port</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the port</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Numeric</tt>)</span>
&mdash;
<div class='inline'>
<p>the port</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 29</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_port identifier id'>port</span>
<span class='rubyid_@port ivar id'>@port</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="protocol-instance_method">
- (<tt>String</tt>) <strong>protocol</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the protocol of the server (normally it should be HTTP/1.1)</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 protocol</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 35</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_protocol identifier id'>protocol</span>
<span class='rubyid_@protocol ivar id'>@protocol</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="software-instance_method">
- (<tt>String</tt>) <strong>software</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>get the server software</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 server software name</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/request/server.rb', line 38</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_software identifier id'>software</span>
<span class='rubyid_@software ivar id'>@software</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

723
doc/Zero/Response.html Normal file
View File

@ -0,0 +1,723 @@
<!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::Response
&mdash; 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> &raquo;
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
&raquo;
<span class="title">Response</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::Response
</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::Response</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/response.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is the representation of a response</p>
</div>
</div>
<div class="tags">
</div>
<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="#body-instance_method" title="#body (instance method)">- (Object) <strong>body</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#header-instance_method" title="#header (instance method)">- (Object) <strong>header</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute header.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute status.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#content_length-instance_method" title="#content_length (instance method)">- (Object) <strong>content_length</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the content length header to the current length of the body Also
creates one, if it does not exists.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_type%3D-instance_method" title="#content_type= (instance method)">- (Object) <strong>content_type=</strong>(value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the content type header to the given value Also creates it, if it does
not exists.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong> </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Constructor Sets default status code to 200.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_a-instance_method" title="#to_a (instance method)">- (Array) <strong>to_a</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the data of the response as an array:</p>
<dl class="rdoc-list label-list"><dt>status, header, body
<dd>
<p>to be usable by any webserver.</p>
</dd></dl>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Response (class)">Response</a></span></tt>) <strong>initialize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Constructor Sets default status code to 200.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 12</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span>
<span class='rubyid_@status ivar id'>@status</span> <span class='assign token'>=</span> <span class='integer val'>200</span>
<span class='rubyid_@header ivar id'>@header</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
<span class='rubyid_@body ivar id'>@body</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</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="body=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="body-instance_method">
- (<tt>Object</tt>) <strong>body</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute body</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 7</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_body identifier id'>body</span>
<span class='rubyid_@body ivar id'>@body</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id="header=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="header-instance_method">
- (<tt>Object</tt>) <strong>header</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute header</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 7</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_header identifier id'>header</span>
<span class='rubyid_@header ivar id'>@header</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<span id="status=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
- (<tt>Object</tt>) <strong>status</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute status</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 6</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_status identifier id'>status</span>
<span class='rubyid_@status ivar id'>@status</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="content_length-instance_method">
- (<tt>Object</tt>) <strong>content_length</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Sets the content length header to the current length of the body Also
creates one, if it does not exists</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 57</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_content_length identifier id'>content_length</span>
<span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_header identifier id'>header</span><span class='lbrack token'>[</span><span class='string val'>'Content-Length'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_body identifier id'>body</span><span class='dot token'>.</span><span class='rubyid_join identifier id'>join</span><span class='dot token'>.</span><span class='rubyid_bytesize identifier id'>bytesize</span><span class='dot token'>.</span><span class='rubyid_to_s identifier id'>to_s</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content_type=-instance_method">
- (<tt>Object</tt>) <strong>content_type=</strong>(value)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the content type header to the given value Also creates it, if it does
not exists</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Content-Type tp set</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 66</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_content_type= identifier id'>content_type=</span><span class='lparen token'>(</span><span class='rubyid_value identifier id'>value</span><span class='rparen token'>)</span>
<span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_header identifier id'>header</span><span class='lbrack token'>[</span><span class='string val'>'Content-Type'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_value identifier id'>value</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_a-instance_method">
- (<tt>Array</tt>) <strong>to_a</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the data of the response as an array:</p>
<dl class="rdoc-list label-list"><dt>status, header, body
<dd>
<p>to be usable by any webserver.</p>
<p>Sets the Content-Type to 'text/html', if it's not already set. Sets the
Content-Length, if it's not already set. (Won't fix wrong lengths!) Removes
Content-Type, Content-Length and body on status code 204 and 304.</p>
</dd></dl>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
&mdash;
<div class='inline'>
<p>Usable by webservers</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/response.rb', line 38</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_to_a identifier id'>to_a</span>
<span class='comment val'># Remove content length and body, on status 204 and 304</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_status identifier id'>status</span> <span class='eq op'>==</span> <span class='integer val'>204</span> <span class='rubyid_or or kw'>or</span> <span class='rubyid_status identifier id'>status</span> <span class='eq op'>==</span> <span class='integer val'>304</span>
<span class='rubyid_header identifier id'>header</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'Content-Length'</span><span class='rparen token'>)</span>
<span class='rubyid_header identifier id'>header</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'Content-Type'</span><span class='rparen token'>)</span>
<span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_body identifier id'>body</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='rubyid_else else kw'>else</span>
<span class='comment val'># Set content length, if not already set</span>
<span class='rubyid_content_length identifier id'>content_length</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_header identifier id'>header</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span> <span class='string val'>'Content-Length'</span>
<span class='comment val'># Set content type, if not already set</span>
<span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_content_type identifier id'>content_type</span> <span class='assign token'>=</span> <span class='string val'>'text/html'</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_header identifier id'>header</span><span class='dot token'>.</span><span class='rubyid_has_key? fid id'>has_key?</span> <span class='string val'>'Content-Type'</span>
<span class='rubyid_end end kw'>end</span>
<span class='lbrack token'>[</span><span class='rubyid_status identifier id'>status</span><span class='comma token'>,</span> <span class='rubyid_header identifier id'>header</span><span class='comma token'>,</span> <span class='rubyid_body identifier id'>body</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:01 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>
</body>
</html>

333
doc/Zero/Router.html Normal file
View File

@ -0,0 +1,333 @@
<!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::Router
&mdash; 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> &raquo;
<span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span>
&raquo;
<span class="title">Router</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::Router
</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::Router</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zero/router.rb</dd>
</dl>
<div class="clear"></div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="VARIABLE_MATCH-constant" class="">VARIABLE_MATCH =
<div class="docstring">
<div class="discussion">
<p>match for variables in routes</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='regexp val'>%r{:(\w+)[^/]?}</span>
</pre></dd>
<dt id="VARIABLE_REGEX-constant" class="">VARIABLE_REGEX =
<div class="docstring">
<div class="discussion">
<p>the replacement string to make it an regex</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>'(?&lt;\1&gt;.+?)'</span>
</pre></dd>
</dl>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong>(env) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Router) <strong>initialize</strong>(routes) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Router.</p>
</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">
- (<tt><span class='object_link'><a href="" title="Zero::Router (class)">Router</a></span></tt>) <strong>initialize</strong>(routes)
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of Router</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/router.rb', line 8</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_routes identifier id'>routes</span><span class='rparen token'>)</span>
<span class='rubyid_@routes ivar id'>@routes</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
<span class='rubyid_routes identifier id'>routes</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_route identifier id'>route</span><span class='comma token'>,</span> <span class='rubyid_target identifier id'>target</span><span class='bitor op'>|</span>
<span class='rubyid_@routes ivar id'>@routes</span><span class='lbrack token'>[</span>
<span class='rubyid_Regexp constant id'>Regexp</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span>
<span class='rubyid_route identifier id'>route</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_VARIABLE_MATCH constant id'>VARIABLE_MATCH</span><span class='comma token'>,</span> <span class='rubyid_VARIABLE_REGEX constant id'>VARIABLE_REGEX</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='string val'>'$'</span><span class='rparen token'>)</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_target identifier id'>target</span>
<span class='rubyid_end end kw'>end</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="call-instance_method">
- (<tt>Object</tt>) <strong>call</strong>(env)
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zero/router.rb', line 17</span>
<span class='rubyid_def def kw'>def</span> <span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
<span class='rubyid_request identifier id'>request</span> <span class='assign token'>=</span> <span class='rubyid_Zero constant id'>Zero</span><span class='colon2 op'>::</span><span class='rubyid_Request constant id'>Request</span><span class='dot token'>.</span><span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
<span class='rubyid_@routes ivar id'>@routes</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_route identifier id'>route</span><span class='comma token'>,</span> <span class='rubyid_target identifier id'>target</span><span class='bitor op'>|</span>
<span class='rubyid_match identifier id'>match</span> <span class='assign token'>=</span> <span class='rubyid_route identifier id'>route</span><span class='dot token'>.</span><span class='rubyid_match identifier id'>match</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
<span class='rubyid_if if kw'>if</span> <span class='rubyid_match identifier id'>match</span>
<span class='rubyid_match identifier id'>match</span><span class='dot token'>.</span><span class='rubyid_names identifier id'>names</span><span class='dot token'>.</span><span class='rubyid_each_index identifier id'>each_index</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_i identifier id'>i</span><span class='bitor op'>|</span>
<span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_update_param identifier id'>update_param</span><span class='lparen token'>(</span><span class='rubyid_match identifier id'>match</span><span class='dot token'>.</span><span class='rubyid_names identifier id'>names</span><span class='lbrack token'>[</span><span class='rubyid_i identifier id'>i</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='rubyid_match identifier id'>match</span><span class='dot token'>.</span><span class='rubyid_captures identifier id'>captures</span><span class='lbrack token'>[</span><span class='rubyid_i identifier id'>i</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_return return kw'>return</span> <span class='rubyid_target identifier id'>target</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
<span class='rubyid_end end kw'>end</span>
<span class='lbrack token'>[</span><span class='integer val'>404</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='string val'>'Content-Type'</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='string val'>'text/html'</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='string val'>'Not found!'</span><span class='rbrack token'>]</span><span class='rbrack token'>]</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

235
doc/_index.html Normal file
View File

@ -0,0 +1,235 @@
<!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>
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">
<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="noborder title">Documentation by YARD 0.8.3</h1>
<div id="listing">
<h1 class="alphaindex">Alphabetic Index</h1>
<h2>File Listing</h2>
<ul id="files" class="index_inline_list">
<li class="r1"><a href="index.html" title="README">README</a></li>
</ul>
<div class="clear"></div>
<h2>Namespace Listing A-Z</h2>
<table>
<tr>
<td valign='top' width="33%">
<ul id="alpha_A" class="alpha">
<li class="letter">A</li>
<ul>
<li>
<span class='object_link'><a href="Zero/Request/Accept.html" title="Zero::Request::Accept (class)">Accept</a></span>
<small>(Zero::Request)</small>
</li>
<li>
<span class='object_link'><a href="Zero/Request/AcceptType.html" title="Zero::Request::AcceptType (class)">AcceptType</a></span>
<small>(Zero::Request)</small>
</li>
</ul>
</ul>
<ul id="alpha_C" class="alpha">
<li class="letter">C</li>
<ul>
<li>
<span class='object_link'><a href="Zero/Request/Client.html" title="Zero::Request::Client (class)">Client</a></span>
<small>(Zero::Request)</small>
</li>
<li>
<span class='object_link'><a href="Zero/Controller.html" title="Zero::Controller (class)">Controller</a></span>
<small>(Zero)</small>
</li>
</ul>
</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>
<li>
<span class='object_link'><a href="Zero/Request/Parameter.html" title="Zero::Request::Parameter (class)">Parameter</a></span>
<small>(Zero::Request)</small>
</li>
</ul>
</ul>
<ul id="alpha_R" class="alpha">
<li class="letter">R</li>
<ul>
<li>
<span class='object_link'><a href="Zero/Renderer.html" title="Zero::Renderer (class)">Renderer</a></span>
<small>(Zero)</small>
</li>
<li>
<span class='object_link'><a href="Zero/Request.html" title="Zero::Request (class)">Request</a></span>
<small>(Zero)</small>
</li>
<li>
<span class='object_link'><a href="Zero/Response.html" title="Zero::Response (class)">Response</a></span>
<small>(Zero)</small>
</li>
<li>
<span class='object_link'><a href="Zero/Router.html" title="Zero::Router (class)">Router</a></span>
<small>(Zero)</small>
</li>
</ul>
</ul>
<ul id="alpha_S" class="alpha">
<li class="letter">S</li>
<ul>
<li>
<span class='object_link'><a href="Zero/Request/Server.html" title="Zero::Request::Server (class)">Server</a></span>
<small>(Zero::Request)</small>
</li>
</ul>
</ul>
<ul id="alpha_Z" class="alpha">
<li class="letter">Z</li>
<ul>
<li>
<span class='object_link'><a href="Zero.html" title="Zero (module)">Zero</a></span>
</li>
</ul>
</ul>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

53
doc/class_list.html Normal file
View File

@ -0,0 +1,53 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<base id="base_target" target="_parent" />
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) {
document.getElementById('base_target').target = 'main';
document.body.className = 'frames';
}
</script>
<div id="content">
<h1 id="full_list_header">Class List</h1>
<div id="nav">
<span><a target="_self" href="class_list.html">
Classes
</a></span>
<span><a target="_self" href="method_list.html">
Methods
</a></span>
<span><a target="_self" href="file_list.html">
Files
</a></span>
</div>
<div id="search">Search: <input type="text" /></div>
<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>
</ul>
</div>
</body>
</html>

1
doc/css/common.css Normal file
View File

@ -0,0 +1 @@
/* Override this file with custom rules */

57
doc/css/full_list.css Normal file
View File

@ -0,0 +1,57 @@
body {
margin: 0;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-size: 13px;
height: 101%;
overflow-x: hidden;
}
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
.clear { clear: both; }
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
#full_list { padding: 0; list-style: none; margin-left: 0; }
#full_list ul { padding: 0; }
#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
#noresults { padding: 7px 12px; }
#content.insearch #noresults { margin-left: 7px; }
ul.collapsed ul, ul.collapsed li { display: none; }
ul.collapsed.search_uncollapsed { display: block; }
ul.collapsed.search_uncollapsed li { display: list-item; }
li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
li { color: #888; cursor: pointer; }
li.deprecated { text-decoration: line-through; font-style: italic; }
li.r1 { background: #f0f0f0; }
li.r2 { background: #fafafa; }
li:hover { background: #ddd; }
li small:before { content: "("; }
li small:after { content: ")"; }
li small.search_info { display: none; }
a:link, a:visited { text-decoration: none; color: #05a; }
li.clicked { background: #05a; color: #ccc; }
li.clicked a:link, li.clicked a:visited { color: #eee; }
li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
li.collapsed.clicked a.toggle { background-position: top right; }
#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
#nav a:link, #nav a:visited { color: #358; }
#nav a:hover { background: transparent; color: #5af; }
.frames #nav span:after { content: ' | '; }
.frames #nav span:last-child:after { content: ''; }
.frames #content h1 { margin-top: 0; }
.frames li { white-space: nowrap; cursor: normal; }
.frames li small { display: block; font-size: 0.8em; }
.frames li small:before { content: ""; }
.frames li small:after { content: ""; }
.frames li small.search_info { display: none; }
.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
.frames #content.insearch #search { background-position: center right; }
.frames #search input { width: 110px; }
.frames #nav { display: block; }
#full_list.insearch li { display: none; }
#full_list.insearch li.found { display: list-item; padding-left: 10px; }
#full_list.insearch li a.toggle { display: none; }
#full_list.insearch li small.search_info { display: block; }

328
doc/css/style.css Normal file
View File

@ -0,0 +1,328 @@
body {
padding: 0 20px;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-size: 13px;
}
body.frames { padding: 0 5px; }
h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
h1.title { margin-bottom: 10px; }
h1.alphaindex { margin-top: 0; font-size: 22px; }
h2 {
padding: 0;
padding-bottom: 3px;
border-bottom: 1px #aaa solid;
font-size: 1.4em;
margin: 1.8em 0 0.5em;
}
h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
.clear { clear: both; }
.inline { display: inline; }
.inline p:first-child { display: inline; }
.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
.docstring h1 { font-size: 1.2em; }
.docstring h2 { font-size: 1.1em; }
.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
.summary_desc .object_link, .docstring .object_link { font-family: monospace; }
.rdoc-term { padding-right: 25px; font-weight: bold; }
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
/* style for <ul> */
#filecontents li > p, .docstring li > p { margin: 0px; }
#filecontents ul, .docstring ul { padding-left: 20px; }
/* style for <dl> */
#filecontents dl, .docstring dl { border: 1px solid #ccc; }
#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
#filecontents dd > p, .docstring dd > p { margin: 0px; }
.note {
color: #222;
-moz-border-radius: 3px; -webkit-border-radius: 3px;
background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
display: block;
}
.note.todo { background: #ffffc5; border-color: #ececaa; }
.note.returns_void { background: #efefef; }
.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
.note.private { background: #ffffc5; border-color: #ececaa; }
.note.title { padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
.summary_signature + .note.title { margin-left: 7px; }
h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
.note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
.discussion .note { margin-top: 6px; }
.discussion .note:first-child { margin-top: 0; }
h3.inherited {
font-style: italic;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-weight: normal;
padding: 0;
margin: 0;
margin-top: 12px;
margin-bottom: 3px;
font-size: 13px;
}
p.inherited {
padding: 0;
margin: 0;
margin-left: 25px;
}
#filecontents dl.box, dl.box {
border: 0;
width: 520px;
font-size: 1em;
}
#filecontents dl.box dt, dl.box dt {
float: left;
display: block;
width: 100px;
margin: 0;
text-align: right;
font-weight: bold;
background: transparent;
border: 1px solid #aaa;
border-width: 1px 0px 0px 1px;
padding: 6px 0;
padding-right: 10px;
}
#filecontents dl.box dd, dl.box dd {
float: left;
display: block;
width: 380px;
margin: 0;
padding: 6px 0;
padding-right: 20px;
border: 1px solid #aaa;
border-width: 1px 1px 0 0;
}
#filecontents dl.box .last, dl.box .last {
border-bottom: 1px solid #aaa;
}
#filecontents dl.box .r1, dl.box .r1 { background: #eee; }
ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
.index_inline_list { padding-left: 0; font-size: 1.1em; }
.index_inline_list li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
dl.constants { margin-left: 40px; }
dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
.summary_desc tt { font-size: 0.9em; }
dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
dl.constants .discussion *:first-child { margin-top: 0; }
dl.constants .discussion *:last-child { margin-bottom: 0; }
.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
.method_details.first { border: 0; }
p.signature, h3.signature {
font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
padding: 6px 10px; margin-top: 18px;
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
}
p.signature tt,
h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
p.signature .overload,
h3.signature .overload { display: block; }
p.signature .extras,
h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
p.signature .not_defined_here,
h3.signature .not_defined_here,
p.signature .aliases,
h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
p.signature .aliases .names,
h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
.tags .tag_title { font-size: 1em; margin-bottom: 0; font-weight: bold; }
.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
.tags ul li { margin-bottom: 3px; }
.tags ul .name { font-family: monospace; font-weight: bold; }
.tags ul .note { padding: 3px 6px; }
.tags { margin-bottom: 12px; }
.tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
.tags .examples .inline p { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
.tags .overload .overload_item .signature {
padding: 2px 8px;
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
}
.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
.tags .overload .docstring { margin-top: 15px; }
.defines { display: none; }
#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
.showSource { font-size: 0.9em; }
.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
#content a:link, #content a:visited { text-decoration: none; color: #05a; }
#content a:hover { background: #ffffa5; }
div.docstring, p.docstring { margin-right: 6em; }
ul.summary {
list-style: none;
font-family: monospace;
font-size: 1em;
line-height: 1.5em;
}
ul.summary a:link, ul.summary a:visited {
text-decoration: none; font-size: 1.1em;
}
ul.summary li { margin-bottom: 5px; }
.summary .summary_signature {
padding: 1px 10px;
background: #eaeaff; border: 1px solid #dfdfe5;
-moz-border-radius: 3px; -webkit-border-radius: 3px;
}
.summary_signature:hover { background: #eeeeff; cursor: pointer; }
ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
#content .summary_signature:hover a:link,
#content .summary_signature:hover a:visited {
background: transparent;
color: #48f;
}
p.inherited a { font-family: monospace; font-size: 0.9em; }
p.inherited { word-spacing: 5px; font-size: 1.2em; }
p.children { font-size: 1.2em; }
p.children a { font-size: 0.9em; }
p.children strong { font-size: 0.8em; }
p.children strong.modules { padding-left: 5px; }
ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
ul.fullTree li:first-child { padding-top: 0; background: transparent; }
ul.fullTree li:last-child { padding-bottom: 0; }
.showAll ul.fullTree { display: block; }
.showAll .inheritName { display: none; }
#search { position: absolute; right: 14px; top: 0px; }
#search a:link, #search a:visited {
display: block; float: left; margin-right: 4px;
padding: 8px 10px; text-decoration: none; color: #05a;
border: 1px solid #d8d8e5;
-moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
-webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
background: #eaf0ff;
-webkit-box-shadow: -1px 1px 3px #ddd;
}
#search a:hover { background: #f5faff; color: #06b; }
#search a.active {
background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
-moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
-webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
}
#search a.inactive { color: #999; }
.frames #search { display: none; }
.inheritanceTree, .toggleDefines { float: right; }
#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
#menu .title, #menu a { font-size: 0.7em; }
#menu .title a { font-size: 1em; }
#menu .title { color: #555; }
#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
#menu a:hover { color: #05a; }
#menu .noframes { display: inline; }
.frames #menu .noframes { display: inline; float: right; }
#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
#footer a:hover { color: #05a; }
#listing ul.alpha { font-size: 1.1em; }
#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
#listing ul.alpha ul { margin: 0; padding-left: 15px; }
#listing ul small { color: #666; font-size: 0.7em; }
li.r1 { background: #f0f0f0; }
li.r2 { background: #fafafa; }
#search_frame {
z-index: 9999;
background: #fff;
display: none;
position: absolute;
top: 36px;
right: 18px;
width: 500px;
height: 80%;
overflow-y: scroll;
border: 1px solid #999;
border-collapse: collapse;
-webkit-box-shadow: -7px 5px 25px #aaa;
-moz-box-shadow: -7px 5px 25px #aaa;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
}
#content ul.summary li.deprecated .summary_signature a:link,
#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
#toc {
padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
max-width: 300px;
-webkit-box-shadow: -2px 2px 6px #bbb;
-moz-box-shadow: -2px 2px 6px #bbb;
z-index: 5000;
position: relative;
}
#toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
#toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
#toc .title { margin: 0; }
#toc ol { padding-left: 1.8em; }
#toc li { font-size: 1.1em; line-height: 1.7em; }
#toc > ol > li { font-size: 1.1em; font-weight: bold; }
#toc ol > ol { font-size: 0.9em; }
#toc ol ol > ol { padding-left: 2.3em; }
#toc ol + li { margin-top: 0.3em; }
#toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
#filecontents h1 + #toc.nofloat { margin-top: 0; }
/* syntax highlighting */
.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
#filecontents pre.code, .docstring pre.code { display: block; }
.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
#filecontents pre.code, .docstring pre.code,
.tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
pre.code { color: #000; }
pre.code .info.file { color: #555; }
pre.code .val { color: #036A07; }
pre.code .tstring_content,
pre.code .heredoc_beg, pre.code .heredoc_end,
pre.code .qwords_beg, pre.code .qwords_end,
pre.code .tstring, pre.code .dstring { color: #036A07; }
pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
pre.code .dot + pre.code .id,
pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
pre.code .comment { color: #0066FF; }
pre.code .const, pre.code .constant { color: #585CF6; }
pre.code .symbol { color: #C5060B; }
pre.code .kw,
pre.code .label,
pre.code .rubyid_require,
pre.code .rubyid_extend,
pre.code .rubyid_include { color: #0000FF; }
pre.code .ivar { color: #318495; }
pre.code .gvar,
pre.code .rubyid_backref,
pre.code .rubyid_nth_ref { color: #6D79DE; }
pre.code .regexp, .dregexp { color: #036A07; }
pre.code a { border-bottom: 1px dotted #bbf; }

76
doc/file.README.html Normal file
View File

@ -0,0 +1,76 @@
<!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=US-ASCII" />
<title>
File: README
&mdash; 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</a> &raquo;
<span class="title">File: README</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"><div id='filecontents'><h2>zero - a web helper</h2>
<p>This is a small collection of helpers to create small and easy to use
web applications.</p></div></div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

55
doc/file_list.html Normal file
View File

@ -0,0 +1,55 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<base id="base_target" target="_parent" />
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) {
document.getElementById('base_target').target = 'main';
document.body.className = 'frames';
}
</script>
<div id="content">
<h1 id="full_list_header">File List</h1>
<div id="nav">
<span><a target="_self" href="class_list.html">
Classes
</a></span>
<span><a target="_self" href="method_list.html">
Methods
</a></span>
<span><a target="_self" href="file_list.html">
Files
</a></span>
</div>
<div id="search">Search: <input type="text" /></div>
<ul id="full_list" class="file">
<li class="r1"><a href="index.html" title="README">README</a></li>
</ul>
</div>
</body>
</html>

28
doc/frames.html Normal file
View File

@ -0,0 +1,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.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>Documentation by YARD 0.8.3</title>
</head>
<script type="text/javascript" charset="utf-8">
window.onload = function() {
var match = window.location.hash.match(/^#!(.+)/);
var name = 'index.html';
if (match) {
name = unescape(match[1]);
}
document.writeln('<frameset cols="20%,*">' +
'<frame name="list" src="class_list.html" />' +
'<frame name="main" src="' + name + '" />' +
'</frameset>');
}
</script>
<noscript>
<frameset cols="20%,*">
<frame name="list" src="class_list.html" />
<frame name="main" src="index.html" />
</frameset>
</noscript>
</html>

76
doc/index.html Normal file
View File

@ -0,0 +1,76 @@
<!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=US-ASCII" />
<title>
File: README
&mdash; 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</a> &raquo;
<span class="title">File: README</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"><div id='filecontents'><h2>zero - a web helper</h2>
<p>This is a small collection of helpers to create small and easy to use
web applications.</p></div></div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>

214
doc/js/app.js Normal file
View File

@ -0,0 +1,214 @@
function createSourceLinks() {
$('.method_details_list .source_code').
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
$('.toggleSource').toggle(function() {
$(this).parent().nextAll('.source_code').slideDown(100);
$(this).text("Hide source");
},
function() {
$(this).parent().nextAll('.source_code').slideUp(100);
$(this).text("View source");
});
}
function createDefineLinks() {
var tHeight = 0;
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
$('.toggleDefines').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).prev().show();
$(this).parent().prev().height($(this).parent().height());
$(this).text("(less)");
},
function() {
$(this).prev().hide();
$(this).parent().prev().height(tHeight);
$(this).text("more...");
});
}
function createFullTreeLinks() {
var tHeight = 0;
$('.inheritanceTree').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).parent().toggleClass('showAll');
$(this).text("(hide)");
$(this).parent().prev().height($(this).parent().height());
},
function() {
$(this).parent().toggleClass('showAll');
$(this).parent().prev().height(tHeight);
$(this).text("show all");
});
}
function fixBoxInfoHeights() {
$('dl.box dd.r1, dl.box dd.r2').each(function() {
$(this).prev().height($(this).height());
});
}
function searchFrameLinks() {
$('.full_list_link').click(function() {
toggleSearchFrame(this, $(this).attr('href'));
return false;
});
}
function toggleSearchFrame(id, link) {
var frame = $('#search_frame');
$('#search a').removeClass('active').addClass('inactive');
if (frame.attr('src') == link && frame.css('display') != "none") {
frame.slideUp(100);
$('#search a').removeClass('active inactive');
}
else {
$(id).addClass('active').removeClass('inactive');
frame.attr('src', link).slideDown(100);
}
}
function linkSummaries() {
$('.summary_signature').click(function() {
document.location = $(this).find('a').attr('href');
});
}
function framesInit() {
if (hasFrames) {
document.body.className = 'frames';
$('#menu .noframes a').attr('href', document.location);
window.top.document.title = $('html head title').text();
}
else {
$('#menu .noframes a').text('frames').attr('href', framesUrl);
}
}
function keyboardShortcuts() {
if (window.top.frames.main) return;
$(document).keypress(function(evt) {
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
if (typeof evt.target !== "undefined" &&
(evt.target.nodeName == "INPUT" ||
evt.target.nodeName == "TEXTAREA")) return;
switch (evt.charCode) {
case 67: case 99: $('#class_list_link').click(); break; // 'c'
case 77: case 109: $('#method_list_link').click(); break; // 'm'
case 70: case 102: $('#file_list_link').click(); break; // 'f'
default: break;
}
});
}
function summaryToggle() {
$('.summary_toggle').click(function() {
if (localStorage) {
localStorage.summaryCollapsed = $(this).text();
}
$('.summary_toggle').each(function() {
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
var next = $(this).parent().parent().nextAll('ul.summary').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('ul.summary').first().toggle();
}
else if (next.hasClass('summary')) {
var list = $('<ul class="summary compact" />');
list.html(next.html());
list.find('.summary_desc, .note').remove();
list.find('a').each(function() {
$(this).html($(this).find('strong').html());
$(this).parent().html($(this)[0].outerHTML);
});
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage) {
if (localStorage.summaryCollapsed == "collapse") {
$('.summary_toggle').first().click();
}
else localStorage.summaryCollapsed = "expand";
}
}
function fixOutsideWorldLinks() {
$('a').each(function() {
if (window.location.host != this.host) this.target = '_parent';
});
}
function generateTOC() {
if ($('#filecontents').length === 0) return;
var _toc = $('<ol class="top"></ol>');
var show = false;
var toc = _toc;
var counter = 0;
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
var i;
if ($('#filecontents h1').length > 1) tags.unshift('h1');
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
var lastTag = parseInt(tags[0][1], 10);
$(tags.join(', ')).each(function() {
if ($(this).parents('.method_details .docstring').length != 0) return;
if (this.id == "filecontents") return;
show = true;
var thisTag = parseInt(this.tagName[1], 10);
if (this.id.length === 0) {
var proposedId = $(this).attr('toc-id');
if (typeof(proposedId) != "undefined") this.id = proposedId;
else {
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
this.id = proposedId;
}
}
if (thisTag > lastTag) {
for (i = 0; i < thisTag - lastTag; i++) {
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
}
}
if (thisTag < lastTag) {
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
}
var title = $(this).attr('toc-title');
if (typeof(title) == "undefined") title = $(this).text();
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
lastTag = thisTag;
});
if (!show) return;
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
$('#content').prepend(html);
$('#toc').append(_toc);
$('#toc .hide_toc').toggle(function() {
$('#toc .top').slideUp('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
}, function() {
$('#toc .top').slideDown('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
});
$('#toc .float_toc').toggle(function() {
$(this).text('float');
$('#toc').toggleClass('nofloat');
}, function() {
$(this).text('left');
$('#toc').toggleClass('nofloat');
});
}
$(framesInit);
$(createSourceLinks);
$(createDefineLinks);
$(createFullTreeLinks);
$(fixBoxInfoHeights);
$(searchFrameLinks);
$(linkSummaries);
$(keyboardShortcuts);
$(summaryToggle);
$(fixOutsideWorldLinks);
$(generateTOC);

173
doc/js/full_list.js Normal file
View File

@ -0,0 +1,173 @@
var inSearch = null;
var searchIndex = 0;
var searchCache = [];
var searchString = '';
var regexSearchString = '';
var caseSensitiveMatch = false;
var ignoreKeyCodeMin = 8;
var ignoreKeyCodeMax = 46;
var commandKey = 91;
RegExp.escape = function(text) {
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
}
function fullListSearch() {
// generate cache
searchCache = [];
$('#full_list li').each(function() {
var link = $(this).find('.object_link a');
var fullName = link.attr('title').split(' ')[0];
searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
});
$('#search input').keyup(function(event) {
if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
|| event.keyCode == commandKey)
return;
searchString = this.value;
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
regexSearchString = RegExp.escape(searchString);
if (caseSensitiveMatch) {
regexSearchString += "|" +
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
join('.+?');
}
if (searchString === "") {
clearTimeout(inSearch);
inSearch = null;
$('ul .search_uncollapsed').removeClass('search_uncollapsed');
$('#full_list, #content').removeClass('insearch');
$('#full_list li').removeClass('found').each(function() {
var link = $(this).find('.object_link a');
link.text(link.text());
});
if (clicked) {
clicked.parents('ul').each(function() {
$(this).removeClass('collapsed').prev().removeClass('collapsed');
});
}
highlight();
}
else {
if (inSearch) clearTimeout(inSearch);
searchIndex = 0;
lastRowClass = '';
$('#full_list, #content').addClass('insearch');
$('#noresults').text('');
searchItem();
}
});
$('#search input').focus();
$('#full_list').after("<div id='noresults'></div>");
}
var lastRowClass = '';
function searchItem() {
for (var i = 0; i < searchCache.length / 50; i++) {
var item = searchCache[searchIndex];
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
var matchString = regexSearchString;
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
if (searchName.match(matchRegexp) == null) {
item.node.removeClass('found');
}
else {
item.node.css('padding-left', '10px').addClass('found');
item.node.parents().addClass('search_uncollapsed');
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
}
if (searchCache.length === searchIndex + 1) {
searchDone();
return;
}
else {
searchIndex++;
}
}
inSearch = setTimeout('searchItem()', 0);
}
function searchDone() {
highlight(true);
if ($('#full_list li:visible').size() === 0) {
$('#noresults').text('No results were found.').hide().fadeIn();
}
else {
$('#noresults').text('');
}
$('#content').removeClass('insearch');
clearTimeout(inSearch);
inSearch = null;
}
clicked = null;
function linkList() {
$('#full_list li, #full_list li a:last').click(function(evt) {
if ($(this).hasClass('toggle')) return true;
if (this.tagName.toLowerCase() == "li") {
var toggle = $(this).children('a.toggle');
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
toggle.click();
return false;
}
}
if (clicked) clicked.removeClass('clicked');
var win = window.top.frames.main ? window.top.frames.main : window.parent;
if (this.tagName.toLowerCase() == "a") {
clicked = $(this).parent('li').addClass('clicked');
win.location = this.href;
}
else {
clicked = $(this).addClass('clicked');
win.location = $(this).find('a:last').attr('href');
}
return false;
});
}
function collapse() {
if (!$('#full_list').hasClass('class')) return;
$('#full_list.class a.toggle').click(function() {
$(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
highlight();
return false;
});
$('#full_list.class ul').each(function() {
$(this).addClass('collapsed').prev().addClass('collapsed');
});
$('#full_list.class').children().removeClass('collapsed');
highlight();
}
function highlight(no_padding) {
var n = 1;
$('#full_list li:visible').each(function() {
var next = n == 1 ? 2 : 1;
$(this).removeClass("r" + next).addClass("r" + n);
if (!no_padding && $('#full_list').hasClass('class')) {
$(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
}
n = next;
});
}
function escapeShortcut() {
$(document).keydown(function(evt) {
if (evt.which == 27) {
$('#search_frame', window.top.document).slideUp(100);
$('#search a', window.top.document).removeClass('active inactive');
$(window.top).focus();
}
});
}
$(escapeShortcut);
$(fullListSearch);
$(linkList);
$(collapse);

4
doc/js/jquery.js vendored Normal file

File diff suppressed because one or more lines are too long

508
doc/method_list.html Normal file
View File

@ -0,0 +1,508 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<base id="base_target" target="_parent" />
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) {
document.getElementById('base_target').target = 'main';
document.body.className = 'frames';
}
</script>
<div id="content">
<h1 id="full_list_header">Method List</h1>
<div id="nav">
<span><a target="_self" href="class_list.html">
Classes
</a></span>
<span><a target="_self" href="method_list.html">
Methods
</a></span>
<span><a target="_self" href="file_list.html">
Files
</a></span>
</div>
<div id="search">Search: <input type="text" /></div>
<ul id="full_list" class="method">
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#accept-instance_method" title="Zero::Request#accept (method)">#accept</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Client.html#address-instance_method" title="Zero::Request::Client#address (method)">#address</a></span>
<small>Zero::Request::Client</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#body-instance_method" title="Zero::Response#body (method)">#body</a></span>
<small>Zero::Response</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Router.html#call-instance_method" title="Zero::Router#call (method)">#call</a></span>
<small>Zero::Router</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Controller.html#call-class_method" title="Zero::Controller.call (method)">call</a></span>
<small>Zero::Controller</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#client-instance_method" title="Zero::Request#client (method)">#client</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#content_length-instance_method" title="Zero::Response#content_length (method)">#content_length</a></span>
<small>Zero::Response</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#content_type-instance_method" title="Zero::Request#content_type (method)">#content_type</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#content_type%3D-instance_method" title="Zero::Response#content_type= (method)">#content_type=</a></span>
<small>Zero::Response</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#create-class_method" title="Zero::Request.create (method)">create</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#delete%3F-instance_method" title="Zero::Request#delete? (method)">#delete?</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/AcceptType.html#each-instance_method" title="Zero::Request::AcceptType#each (method)">#each</a></span>
<small>Zero::Request::AcceptType</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Accept.html#encoding-instance_method" title="Zero::Request::Accept#encoding (method)">#encoding</a></span>
<small>Zero::Request::Accept</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#env-instance_method" title="Zero::Request#env (method)">#env</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#get%3F-instance_method" title="Zero::Request#get? (method)">#get?</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#head%3F-instance_method" title="Zero::Request#head? (method)">#head?</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#header-instance_method" title="Zero::Response#header (method)">#header</a></span>
<small>Zero::Response</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Server.html#hostname-instance_method" title="Zero::Request::Server#hostname (method)">#hostname</a></span>
<small>Zero::Request::Server</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Client.html#hostname-instance_method" title="Zero::Request::Client#hostname (method)">#hostname</a></span>
<small>Zero::Request::Client</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Router.html#initialize-instance_method" title="Zero::Router#initialize (method)">#initialize</a></span>
<small>Zero::Router</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#initialize-instance_method" title="Zero::Request#initialize (method)">#initialize</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Renderer.html#initialize-instance_method" title="Zero::Renderer#initialize (method)">#initialize</a></span>
<small>Zero::Renderer</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#initialize-instance_method" title="Zero::Response#initialize (method)">#initialize</a></span>
<small>Zero::Response</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Controller.html#initialize-instance_method" title="Zero::Controller#initialize (method)">#initialize</a></span>
<small>Zero::Controller</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Server.html#initialize-instance_method" title="Zero::Request::Server#initialize (method)">#initialize</a></span>
<small>Zero::Request::Server</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Client.html#initialize-instance_method" title="Zero::Request::Client#initialize (method)">#initialize</a></span>
<small>Zero::Request::Client</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Accept.html#initialize-instance_method" title="Zero::Request::Accept#initialize (method)">#initialize</a></span>
<small>Zero::Request::Accept</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Parameter.html#initialize-instance_method" title="Zero::Request::Parameter#initialize (method)">#initialize</a></span>
<small>Zero::Request::Parameter</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/AcceptType.html#initialize-instance_method" title="Zero::Request::AcceptType#initialize (method)">#initialize</a></span>
<small>Zero::Request::AcceptType</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Accept.html#language-instance_method" title="Zero::Request::Accept#language (method)">#language</a></span>
<small>Zero::Request::Accept</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Accept.html#map-class_method" title="Zero::Request::Accept.map (method)">map</a></span>
<small>Zero::Request::Accept</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Accept.html#map%3D-class_method" title="Zero::Request::Accept.map= (method)">map=</a></span>
<small>Zero::Request::Accept</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#method-instance_method" title="Zero::Request#method (method)">#method</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#params-instance_method" title="Zero::Request#params (method)">#params</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#patch%3F-instance_method" title="Zero::Request#patch? (method)">#patch?</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#path-instance_method" title="Zero::Request#path (method)">#path</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Parameter.html#payload-instance_method" title="Zero::Request::Parameter#payload (method)">#payload</a></span>
<small>Zero::Request::Parameter</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/Server.html#port-instance_method" title="Zero::Request::Server#port (method)">#port</a></span>
<small>Zero::Request::Server</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#post%3F-instance_method" title="Zero::Request#post? (method)">#post?</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request/AcceptType.html#preferred-instance_method" title="Zero::Request::AcceptType#preferred (method)">#preferred</a></span>
<small>Zero::Request::AcceptType</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Server.html#protocol-instance_method" title="Zero::Request::Server#protocol (method)">#protocol</a></span>
<small>Zero::Request::Server</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Request.html#put%3F-instance_method" title="Zero::Request#put? (method)">#put?</a></span>
<small>Zero::Request</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request/Parameter.html#query-instance_method" title="Zero::Request::Parameter#query (method)">#query</a></span>
<small>Zero::Request::Parameter</small>
</li>
<li class="r2 ">
<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="r1 ">
<span class='object_link'><a href="Zero/Controller.html#renderer-class_method" title="Zero::Controller.renderer (method)">renderer</a></span>
<small>Zero::Controller</small>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Controller.html#renderer-instance_method" title="Zero::Controller#renderer (method)">#renderer</a></span>
<small>Zero::Controller</small>
</li>
<li class="r1 ">
<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>
</li>
<li class="r2 ">
<span class='object_link'><a href="Zero/Controller.html#response-instance_method" title="Zero::Controller#response (method)">#response</a></span>
<small>Zero::Controller</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Request.html#server-instance_method" title="Zero::Request#server (method)">#server</a></span>
<small>Zero::Request</small>
</li>
<li class="r2 ">
<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>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#status-instance_method" title="Zero::Response#status (method)">#status</a></span>
<small>Zero::Response</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>
<small>Zero::Renderer</small>
</li>
<li class="r1 ">
<span class='object_link'><a href="Zero/Response.html#to_a-instance_method" title="Zero::Response#to_a (method)">#to_a</a></span>
<small>Zero::Response</small>
</li>
<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>
<small>Zero::Renderer</small>
</li>
<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>
</li>
<li class="r1 ">
<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>
</li>
</ul>
</div>
</body>
</html>

View File

@ -0,0 +1,112 @@
<!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>
Top Level Namespace
&mdash; 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</a> &raquo;
<span class="title">Top Level Namespace</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>Top Level Namespace
</h1>
<dl class="box">
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Zero.html" title="Zero (module)">Zero</a></span>
</p>
</div>
<div id="footer">
Generated on Mon Nov 26 21:40:00 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>
</body>
</html>