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.4.0/pkg/webmachine-0.3.0/doc/Webmachine/Dispatcher/Route.html DELETED Viewed

@@ -1,657 +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::Route
-    &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 (R)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Dispatcher.html" title="Webmachine::Dispatcher (class)">Dispatcher</a></span></span>
-     &raquo;
-    <span class="title">Route</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::Route
-</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::Route</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/webmachine/dispatcher/route.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    Pairs URIs with <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span> classes in the <span class='object_link'><a href="../Dispatcher.html" title="Webmachine::Dispatcher (class)">Webmachine::Dispatcher</a></span>. To
-create routes, use <span class='object_link'><a href="../Dispatcher.html#add_route-instance_method" title="Webmachine::Dispatcher#add_route (method)">#add_route</a></span>.
-  </div>
-</div>
-<div class="tags">
-</div>
-  <h2>Constant Summary</h2>
-    <dl class="constants">
-        <dt id="MATCH_ALL-constant" class="">MATCH_ALL =
-          <div class="docstring">
-  <div class="discussion">
-    When used in a path specification, will match all remaining
-segments
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id freeze'>freeze</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="#path_spec-instance_method" title="#path_spec (instance method)">- (Array&lt;String|Symbol&gt;) <strong>path_spec</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>The list of path segments
-used to define this route (see #initialize).</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#resource-instance_method" title="#resource (instance method)">- (Class) <strong>resource</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>The resource this route will dispatch to, a
-subclass of <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span>.</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="#apply-instance_method" title="#apply (instance method)">- (Object) <strong>apply</strong>(request) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Decorates the request with information about the dispatch
-route, including path bindings.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Route) <strong>initialize</strong>(path_spec, resource, bindings = {}) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>Creates a new Route that will associate a pattern to a
-<span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span>.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#match%3F-instance_method" title="#match? (instance method)">- (Boolean) <strong>match?</strong>(request) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Determines whether the given request matches this route and
-should be dispatched to the <span class='object_link'><a href="#resource-instance_method" title="Webmachine::Dispatcher::Route#resource (method)">#resource</a></span>.</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::Route (class)">Route</a></span></tt>) <strong>initialize</strong>(path_spec, resource, bindings = {})
-</p><div class="docstring">
-  <div class="discussion">
-    Creates a new Route that will associate a pattern to a
-<span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span>.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>path_spec</span>
-        <span class='type'>(<tt>Array&lt;String|Symbol&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>a list of path
-segments (String) and identifiers (Symbol) to bind.
-Strings will be simply matched for equality. Symbols in
-the path spec will be extracted into <span class='object_link'><a href="../Request.html#path_info-instance_method" title="Webmachine::Request#path_info (method)">Request#path_info</a></span> for use
-inside your <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span>. The special segment <span class='object_link'><a href="#MATCH_ALL-constant" title="Webmachine::Dispatcher::Route::MATCH_ALL (constant)">MATCH_ALL</a></span> will match
-all remaining segments.</div>
-    </li>
-    <li>
-        <span class='name'>resource</span>
-        <span class='type'>(<tt>Class</tt>)</span>
-        &mdash;
-        <div class='inline'>the <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span> to dispatch to</div>
-    </li>
-    <li>
-        <span class='name'>bindings</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>additional information to add to
-<span class='object_link'><a href="../Request.html#path_info-instance_method" title="Webmachine::Request#path_info (method)">Request#path_info</a></span> when this route matches</div>
-    </li>
-</ul>
-<h3>Raises:</h3>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-    </li>
-</ul>
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li><span class='object_link'><a href="../Dispatcher.html#add_route-instance_method" title="Webmachine::Dispatcher#add_route (method)">Webmachine::Dispatcher#add_route</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-33
-34
-35
-36</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher/route.rb', line 33</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id path_spec'>path_spec</span><span class='comma'>,</span> <span class='id resource'>resource</span><span class='comma'>,</span> <span class='id bindings'>bindings</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='ivar'>@path_spec</span><span class='comma'>,</span> <span class='ivar'>@resource</span><span class='comma'>,</span> <span class='ivar'>@bindings</span> <span class='op'>=</span> <span class='id path_spec'>path_spec</span><span class='comma'>,</span> <span class='id resource'>resource</span><span class='comma'>,</span> <span class='id bindings'>bindings</span>
-  <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='id t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>not_resource_class</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='id resource'>resource</span><span class='period'>.</span><span class='id name'>name</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id resource'>resource</span> <span class='op'>&lt;</span> <span class='const'>Resource</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="path_spec-instance_method"></span>
-      <div class="method_details first">
-  <p class="signature first" id="path_spec-instance_method">
-    - (<tt>Array&lt;String|Symbol&gt;</tt>) <strong>path_spec</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    The list of path segments
-used to define this route (see #initialize).
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String|Symbol&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>the list of path segments
-used to define this route (see #initialize).</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-15
-16
-17</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher/route.rb', line 15</span>
-<span class='kw'>def</span> <span class='id path_spec'>path_spec</span>
-  <span class='ivar'>@path_spec</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <span id="resource-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="resource-instance_method">
-    - (<tt>Class</tt>) <strong>resource</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    The resource this route will dispatch to, a
-subclass of <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span>
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Class</tt>)</span>
-        &mdash;
-        <div class='inline'>the resource this route will dispatch to, a
-subclass of <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-11
-12
-13</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher/route.rb', line 11</span>
-<span class='kw'>def</span> <span class='id resource'>resource</span>
-  <span class='ivar'>@resource</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="apply-instance_method">
-    - (<tt>Object</tt>) <strong>apply</strong>(request)
-</p><div class="docstring">
-  <div class="discussion">
-    Decorates the request with information about the dispatch
-route, including path bindings.
-  </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>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-49
-50
-51
-52
-53
-54
-55</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher/route.rb', line 49</span>
-<span class='kw'>def</span> <span class='id apply'>apply</span><span class='lparen'>(</span><span class='id request'>request</span><span class='rparen'>)</span>
-  <span class='id request'>request</span><span class='period'>.</span><span class='id disp_path'>disp_path</span> <span class='op'>=</span> <span class='id request'>request</span><span class='period'>.</span><span class='id uri'>uri</span><span class='period'>.</span><span class='id path'>path</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/(.*)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
-  <span class='id request'>request</span><span class='period'>.</span><span class='id path_info'>path_info</span> <span class='op'>=</span> <span class='ivar'>@bindings</span><span class='period'>.</span><span class='id dup'>dup</span>
-  <span class='id tokens'>tokens</span> <span class='op'>=</span> <span class='id request'>request</span><span class='period'>.</span><span class='id disp_path'>disp_path</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id depth'>depth</span><span class='comma'>,</span> <span class='id trailing'>trailing</span> <span class='op'>=</span> <span class='id bind'>bind</span><span class='lparen'>(</span><span class='id tokens'>tokens</span><span class='comma'>,</span> <span class='id request'>request</span><span class='period'>.</span><span class='id path_info'>path_info</span><span class='rparen'>)</span>
-  <span class='id request'>request</span><span class='period'>.</span><span class='id path_tokens'>path_tokens</span> <span class='op'>=</span> <span class='id trailing'>trailing</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="match?-instance_method">
-    - (<tt>Boolean</tt>) <strong>match?</strong>(request)
-</p><div class="docstring">
-  <div class="discussion">
-    Determines whether the given request matches this route and
-should be dispatched to the <span class='object_link'><a href="#resource-instance_method" title="Webmachine::Dispatcher::Route#resource (method)">#resource</a></span>.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>request</span>
-        <span class='type'>(<tt>Reqeust</tt>)</span>
-        &mdash;
-        <div class='inline'>the request object</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-41
-42
-43
-44</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/dispatcher/route.rb', line 41</span>
-<span class='kw'>def</span> <span class='id match?'>match?</span><span class='lparen'>(</span><span class='id request'>request</span><span class='rparen'>)</span>
-  <span class='id tokens'>tokens</span> <span class='op'>=</span> <span class='id request'>request</span><span class='period'>.</span><span class='id uri'>uri</span><span class='period'>.</span><span class='id path'>path</span><span class='period'>.</span><span class='id match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/(.*)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id bind'>bind</span><span class='lparen'>(</span><span class='id tokens'>tokens</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:41 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>