diff options
| author | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
|---|---|---|
| committer | Gibheer <gibheer@gmail.com> | 2012-11-26 21:40:21 +0100 |
| commit | 37a4a28deec224f7cd9a5a124e22258e868913e4 (patch) | |
| tree | 23f8ce9b940ff1a357336344388cbcd46aa57ee7 /doc/Zero/Router.html | |
| parent | 77a2cbe6d4e8752a9450e945724522d10cfb5f09 (diff) | |
added the first set of documentation
Diffstat (limited to 'doc/Zero/Router.html')
| -rw-r--r-- | doc/Zero/Router.html | 333 |
1 files changed, 333 insertions, 0 deletions
diff --git a/doc/Zero/Router.html b/doc/Zero/Router.html new file mode 100644 index 0000000..8f95463 --- /dev/null +++ b/doc/Zero/Router.html @@ -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 + + — Documentation by YARD 0.8.3 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = '../'; + framesUrl = "../frames.html#!" + escape(window.location.href); +</script> + + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (R)</a> » + <span class='title'><span class='object_link'><a href="../Zero.html" title="Zero (module)">Zero</a></span></span> + » + <span class="title">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'>'(?<\1>.+?)'</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'>></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>
\ No newline at end of file |