RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/pkg/webmachine-0.3.0/doc/Webmachine/Dispatcher.html DELETED Viewed

@@ -1,530 +0,0 @@
-<!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: Webmachine::Dispatcher
-    &mdash; Documentation by YARD 0.7.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">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</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>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (D)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span>
-     &raquo;
-    <span class="title">Dispatcher</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 id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Webmachine::Dispatcher
-</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">Webmachine::Dispatcher</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/webmachine/dispatcher.rb<span class="defines">,<br />
-  lib/webmachine/dispatcher/route.rb</span>
-</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    Handles dispatching incoming requests to the proper registered
-resources and initializing the decision logic.
-  </div>
-</div>
-<div class="tags">
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Dispatcher/Route.html" title="Webmachine::Dispatcher::Route (class)">Route</a></span>
-</p>
-  <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="#routes-instance_method" title="#routes (instance method)">- (Object) <strong>routes</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>Returns the value of attribute routes.</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="#add_route-instance_method" title="#add_route (instance method)">- (Object) <strong>add_route</strong>(*args) </a>
-      (also: #add)
-  </span>
-    <span class="summary_desc"><div class='inline'>Adds a route to the dispatch list.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#dispatch-instance_method" title="#dispatch (instance method)">- (Object) <strong>dispatch</strong>(request, response) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Dispatches a request to the appropriate <span class='object_link'><a href="Resource.html" title="Webmachine::Resource (class)">Resource</a></span> in the
-dispatch list.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Dispatcher) <strong>initialize</strong> </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>Initialize a Dispatcher instance.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#reset-instance_method" title="#reset (instance method)">- (Object) <strong>reset</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Resets, removing all routes.</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <p class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Webmachine::Dispatcher (class)">Dispatcher</a></span></tt>) <strong>initialize</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Initialize a Dispatcher instance
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-13
-14
-15</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher.rb', line 13</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span>
-  <span class='ivar'>@routes</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-<span class='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>
-      <span id="routes-instance_method"></span>
-      <div class="method_details first">
-  <p class="signature first" id="routes-instance_method">
-    - (<tt>Object</tt>) <strong>routes</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    Returns the value of attribute routes
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-10
-11
-12</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher.rb', line 10</span>
-<span class='kw'>def</span> <span class='id routes'>routes</span>
-  <span class='ivar'>@routes</span>
-<span class='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">
-  <p class="signature first" id="add_route-instance_method">
-    - (<tt>Object</tt>) <strong>add_route</strong>(*args)
-    <span class="aliases">Also known as:
-    <span class="names"><span id='add-instance_method'>add</span></span>
-    </span>
-</p><div class="docstring">
-  <div class="discussion">
-    Adds a route to the dispatch list. Routes will be matched in the
-order they are added.
-  </div>
-</div>
-<div class="tags">
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li>Route#new</li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-20
-21
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher.rb', line 20</span>
-<span class='kw'>def</span> <span class='id add_route'>add_route</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span>
-  <span class='id route'>route</span> <span class='op'>=</span> <span class='const'>Route</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span>
-  <span class='ivar'>@routes</span> <span class='op'>&lt;&lt;</span> <span class='id route'>route</span>
-  <span class='id route'>route</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="dispatch-instance_method">
-    - (<tt>Object</tt>) <strong>dispatch</strong>(request, response)
-</p><div class="docstring">
-  <div class="discussion">
-    Dispatches a request to the appropriate <span class='object_link'><a href="Resource.html" title="Webmachine::Resource (class)">Resource</a></span> in the
-dispatch list. If a matching resource is not found, a &quot;404 Not
-Found&quot; will be rendered.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>request</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Webmachine::Request (class)">Request</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>the request object</div>
-    </li>
-    <li>
-        <span class='name'>response</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Response.html" title="Webmachine::Response (class)">Response</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>the response object</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher.rb', line 32</span>
-<span class='kw'>def</span> <span class='id dispatch'>dispatch</span><span class='lparen'>(</span><span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-  <span class='id route'>route</span> <span class='op'>=</span> <span class='ivar'>@routes</span><span class='period'>.</span><span class='id find'>find</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id r'>r</span><span class='op'>|</span> <span class='id r'>r</span><span class='period'>.</span><span class='id match?'>match?</span><span class='lparen'>(</span><span class='id request'>request</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
-  <span class='kw'>if</span> <span class='id route'>route</span>
-    <span class='id resource'>resource</span> <span class='op'>=</span> <span class='id route'>route</span><span class='period'>.</span><span class='id resource'>resource</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-    <span class='id route'>route</span><span class='period'>.</span><span class='id apply'>apply</span><span class='lparen'>(</span><span class='id request'>request</span><span class='rparen'>)</span>
-    <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Decision</span><span class='op'>::</span><span class='const'>FSM</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id resource'>resource</span><span class='comma'>,</span> <span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id run'>run</span>
-  <span class='kw'>else</span>
-    <span class='const'>Webmachine</span><span class='period'>.</span><span class='id render_error'>render_error</span><span class='lparen'>(</span><span class='int'>404</span><span class='comma'>,</span> <span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="reset-instance_method">
-    - (<tt>Object</tt>) <strong>reset</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Resets, removing all routes. Useful for testing or reloading the
-application.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-45
-46
-47</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher.rb', line 45</span>
-<span class='kw'>def</span> <span class='id reset'>reset</span>
-  <span class='ivar'>@routes</span><span class='period'>.</span><span class='id clear'>clear</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:40 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
-</div>
-  </body>
-</html>