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/doc/Webmachine/Application.html DELETED Viewed

@@ -1,755 +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::Application
-    &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 (A)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span>
-     &raquo;
-    <span class="title">Application</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::Application
-</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::Application</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Extended by:</dt>
-      <dd class="r2">Forwardable</dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/webmachine/application.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    How to get your Webmachine app running:<br/>  MyApp = Webmachine::Application.new do |app|
-    app.routes do
-      add ['*'], AssetResource
-    end<br/>    app.configure do |config|
-      config.port = 8888
-    end
-  end<br/>  MyApp.run
-  </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="#configuration-instance_method" title="#configuration (instance method)">- (Configuration) <strong>configuration</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The current configuration.</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#dispatcher-instance_method" title="#dispatcher (instance method)">- (Dispatcher) <strong>dispatcher</strong> </a>
-  </span>
-    <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>The current dispatcher.</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="#adapter-instance_method" title="#adapter (instance method)">- (Object) <strong>adapter</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#configure-instance_method" title="#configure (instance method)">- (Application) <strong>configure</strong> {|config| ... }</a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Configure the web server adapter via the passed block.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Application) <strong>initialize</strong>(configuration = Configuration.default) {|app| ... }</a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>Create an Application instance.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#routes-instance_method" title="#routes (instance method)">- (Application, Array&lt;Route&gt;) <strong>routes</strong>(&amp;block) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Evaluates the passed block in the context of <span class='object_link'><a href="Dispatcher.html" title="Webmachine::Dispatcher (class)">Dispatcher</a></span>
-for use in adding a number of routes at once.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#run-instance_method" title="#run (instance method)">- (Object) <strong>run</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Starts this Application serving requests.</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::Application (class)">Application</a></span></tt>) <strong>initialize</strong>(configuration = Configuration.default) {|app| ... }
-</p><div class="docstring">
-  <div class="discussion">
-    Create an Application instance<br/>An instance of application contains Adapter configuration and
-a Dispatcher instance which can be configured with Routes.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>configuration</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Configuration.html" title="Webmachine::Configuration (class)">Webmachine::Configuration</a></span></tt>)</span>
-        <em class="default">(defaults to: <tt>Configuration.default</tt>)</em>
-        &mdash;
-        <div class='inline'>a Webmachine::Configuration</div>
-    </li>
-</ul>
-<h3>Yields:</h3>
-<ul class="yield">
-    <li>
-        <span class='type'>(<tt>app</tt>)</span>
-        &mdash;
-        <div class='inline'>a block in which to configure this Application</div>
-    </li>
-</ul>
-<h3>Yield Parameters:</h3>
-<ul class="yieldparam">
-    <li>
-        <span class='name'>the</span>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Webmachine::Application (class)">Application</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>Application instance being initialized</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-43
-44
-45
-46
-47
-48</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 43</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id configuration'>configuration</span> <span class='op'>=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id default'>default</span><span class='rparen'>)</span>
-  <span class='ivar'>@configuration</span> <span class='op'>=</span> <span class='id configuration'>configuration</span>
-  <span class='ivar'>@dispatcher</span>    <span class='op'>=</span> <span class='const'>Dispatcher</span><span class='period'>.</span><span class='id new'>new</span>
-  <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</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="configuration=-instance_method"></span>
-      <span id="configuration-instance_method"></span>
-      <div class="method_details first">
-  <p class="signature first" id="configuration-instance_method">
-    - (<tt><span class='object_link'><a href="Configuration.html" title="Webmachine::Configuration (class)">Configuration</a></span></tt>) <strong>configuration</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    The current configuration
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Configuration.html" title="Webmachine::Configuration (class)">Configuration</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>the current configuration</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-26
-27
-28</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 26</span>
-<span class='kw'>def</span> <span class='id configuration'>configuration</span>
-  <span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id default'>default</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <span id="dispatcher-instance_method"></span>
-      <div class="method_details ">
-  <p class="signature " id="dispatcher-instance_method">
-    - (<tt><span class='object_link'><a href="Dispatcher.html" title="Webmachine::Dispatcher (class)">Dispatcher</a></span></tt>) <strong>dispatcher</strong>  <span class="extras">(readonly)</span>
-</p><div class="docstring">
-  <div class="discussion">
-    The current dispatcher
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Dispatcher.html" title="Webmachine::Dispatcher (class)">Dispatcher</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>the current dispatcher</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/webmachine/application.rb', line 29</span>
-<span class='kw'>def</span> <span class='id dispatcher'>dispatcher</span>
-  <span class='ivar'>@dispatcher</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="adapter-instance_method">
-    - (<tt>Object</tt>) <strong>adapter</strong>
-</p><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-55
-56
-57</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 55</span>
-<span class='kw'>def</span> <span class='id adapter'>adapter</span>
-  <span class='const'>Adapters</span><span class='period'>.</span><span class='id const_get'>const_get</span><span class='lparen'>(</span><span class='id configuration'>configuration</span><span class='period'>.</span><span class='id adapter'>adapter</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="configure-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Webmachine::Application (class)">Application</a></span></tt>) <strong>configure</strong> {|config| ... }
-</p><div class="docstring">
-  <div class="discussion">
-    Configure the web server adapter via the passed block<br/>Returns the receiver so you can chain it with Application#run
-  </div>
-</div>
-<div class="tags">
-<h3>Yields:</h3>
-<ul class="yield">
-    <li>
-        <span class='type'>(<tt>config</tt>)</span>
-        &mdash;
-        <div class='inline'>a block in which to set configuration values</div>
-    </li>
-</ul>
-<h3>Yield Parameters:</h3>
-<ul class="yieldparam">
-    <li>
-        <span class='name'>config</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Configuration.html" title="Webmachine::Configuration (class)">Configuration</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>the Configuration instance</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Webmachine::Application (class)">Application</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>self</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-85
-86
-87
-88</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 85</span>
-<span class='kw'>def</span> <span class='id configure'>configure</span>
-  <span class='kw'>yield</span> <span class='id configuration'>configuration</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
-  <span class='kw'>self</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="routes-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Webmachine::Application (class)">Application</a></span></tt>, <tt>Array&lt;Route&gt;</tt>) <strong>routes</strong>(&amp;block)
-</p><div class="docstring">
-  <div class="discussion">
-    Evaluates the passed block in the context of <span class='object_link'><a href="Dispatcher.html" title="Webmachine::Dispatcher (class)">Dispatcher</a></span>
-for use in adding a number of routes at once.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Webmachine::Application (class)">Application</a></span></tt>, <tt>Array&lt;Route&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>self if configuring, or an Array of Routes otherwise</div>
-    </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)">Dispatcher#add_route</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-66
-67
-68
-69
-70
-71
-72
-73</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 66</span>
-<span class='kw'>def</span> <span class='id routes'>routes</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id block'>block</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
-    <span class='id dispatcher'>dispatcher</span><span class='period'>.</span><span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id block'>block</span><span class='rparen'>)</span>
-    <span class='kw'>self</span>
-  <span class='kw'>else</span>
-    <span class='id dispatcher'>dispatcher</span><span class='period'>.</span><span class='id routes'>routes</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="run-instance_method">
-    - (<tt>Object</tt>) <strong>run</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Starts this Application serving requests
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-51
-52
-53</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 51</span>
-<span class='kw'>def</span> <span class='id run'>run</span>
-  <span class='id adapter'>adapter</span><span class='period'>.</span><span class='id run'>run</span><span class='lparen'>(</span><span class='id configuration'>configuration</span><span class='comma'>,</span> <span class='id dispatcher'>dispatcher</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: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>