webmachine 0.4.1 → 0.4.2

data/doc/Webmachine/Application.html

@@ -6,7 +6,7 @@
 <title>
   Class: Webmachine::Application
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -98,13 +98,22 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    How to get your Webmachine app running:<br/>  MyApp = Webmachine::Application.new do |app|
+    <p>How to get your Webmachine app running:</p>
+
+<p>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
+      add [&#39;*&#39;], AssetResource
+    end</p>
+
+<pre class="code ruby"><code><span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='int'>8888</span>
+<span class='kw'>end</span>
+</code></pre>
+
+<p>end</p>
+
+<p>MyApp.run</p>
+
 
   </div>
 </div>
@@ -113,7 +122,8 @@
 
 </div>
 
-  
+
+
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     
@@ -136,7 +146,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>The current configuration.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The current configuration.</p>
+</div></span>
   
 </li>
 
@@ -160,7 +171,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>The current dispatcher.</div></span>
+    <span class="summary_desc"><div class='inline'><p>The current dispatcher.</p>
+</div></span>
   
 </li>
 
@@ -169,7 +181,6 @@
 
 
 
-  
 
   
     <h2>
@@ -195,7 +206,30 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>An instance of the configured web-server adapter.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#adapter_class-instance_method" title="#adapter_class (instance method)">- (Object) <strong>adapter_class</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>An instance of the configured web-server adapter.</p>
+</div></span>
   
 </li>
 
@@ -216,7 +250,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>Configure the web server adapter via the passed block.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Configure the web server adapter via the passed block.</p>
+</div></span>
   
 </li>
 
@@ -239,7 +274,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>Create an Application instance.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Create an Application instance.</p>
+</div></span>
   
 </li>
 
@@ -260,8 +296,9 @@
   
 
   
-    <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>
+    <span class="summary_desc"><div class='inline'><p>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.</p>
+</div></span>
   
 </li>
 
@@ -282,7 +319,8 @@ for use in adding a number of routes at once.</div></span>
   
 
   
-    <span class="summary_desc"><div class='inline'>Starts this Application serving requests.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Starts this Application serving requests.</p>
+</div></span>
   
 </li>
 
@@ -303,8 +341,11 @@ for use in adding a number of routes at once.</div></span>
   
 </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.
+    <p>Create an Application instance</p>
+
+<p>An instance of application contains Adapter configuration and
+a Dispatcher instance which can be configured with Routes.</p>
+
 
   </div>
 </div>
@@ -324,7 +365,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>a Webmachine::Configuration</div>
+        <div class='inline'><p>a Webmachine::Configuration</p>
+</div>
       
     </li>
   
@@ -341,7 +383,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>a block in which to configure this Application</div>
+        <div class='inline'><p>a block in which to configure this Application</p>
+</div>
       
     </li>
   
@@ -359,7 +402,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>Application instance being initialized</div>
+        <div class='inline'><p>Application instance being initialized</p>
+</div>
       
     </li>
   
@@ -381,11 +425,11 @@ a Dispatcher instance which can be configured with Routes.
     <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'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span> <span class='op'>=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='rparen'>)</span>
+  <span class='ivar'>@configuration</span> <span class='op'>=</span> <span class='id identifier rubyid_configuration'>configuration</span>
+  <span class='ivar'>@dispatcher</span>    <span class='op'>=</span> <span class='const'>Dispatcher</span><span class='period'>.</span><span class='id identifier rubyid_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'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -409,7 +453,8 @@ a Dispatcher instance which can be configured with Routes.
   
 </p><div class="docstring">
   <div class="discussion">
-    The current configuration
+    <p>The current configuration</p>
+
 
   </div>
 </div>
@@ -426,7 +471,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>the current configuration</div>
+        <div class='inline'><p>the current configuration</p>
+</div>
       
     </li>
   
@@ -445,8 +491,8 @@ a Dispatcher instance which can be configured with Routes.
     <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'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
+  <span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -465,7 +511,8 @@ a Dispatcher instance which can be configured with Routes.
   
 </p><div class="docstring">
   <div class="discussion">
-    The current dispatcher
+    <p>The current dispatcher</p>
+
 
   </div>
 </div>
@@ -482,7 +529,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>the current dispatcher</div>
+        <div class='inline'><p>the current dispatcher</p>
+</div>
       
     </li>
   
@@ -501,7 +549,7 @@ a Dispatcher instance which can be configured with Routes.
     <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='kw'>def</span> <span class='id identifier rubyid_dispatcher'>dispatcher</span>
   <span class='ivar'>@dispatcher</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -523,21 +571,117 @@ a Dispatcher instance which can be configured with Routes.
   
 
   
-</p><table class="source_code">
+</p><div class="docstring">
+  <div class="discussion">
+    <p>An instance of the configured web-server adapter</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'><p>an instance of the configured web-server adapter</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <h3>See Also:</h3>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Adapters.html" title="Webmachine::Adapters (module)">Webmachine::Adapters</a></span></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/webmachine/application.rb', line 57</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_adapter'>adapter</span>
+  <span class='ivar'>@adapter</span> <span class='op'>||=</span> <span class='id identifier rubyid_adapter_class'>adapter_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='comma'>,</span> <span class='id identifier rubyid_dispatcher'>dispatcher</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="adapter_class-instance_method">
+  
+    - (<tt>Object</tt>) <strong>adapter_class</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>An instance of the configured web-server adapter</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'></span>
+      
+      
+      
+        
+        <div class='inline'><p>an instance of the configured web-server adapter</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <h3>See Also:</h3>
+  <ul class="see">
+    
+      <li><span class='object_link'><a href="Adapters.html" title="Webmachine::Adapters (module)">Webmachine::Adapters</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-55
-56
-57</pre>
+63
+64
+65</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 63</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'>def</span> <span class='id identifier rubyid_adapter_class'>adapter_class</span>
+  <span class='const'>Adapters</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -553,7 +697,10 @@ a Dispatcher instance which can be configured with Routes.
   
 </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
+    <p>Configure the web server adapter via the passed block</p>
+
+<p>Returns the receiver so you can chain it with Application#run</p>
+
 
   </div>
 </div>
@@ -570,7 +717,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>a block in which to set configuration values</div>
+        <div class='inline'><p>a block in which to set configuration values</p>
+</div>
       
     </li>
   
@@ -588,7 +736,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>the Configuration instance</div>
+        <div class='inline'><p>the Configuration instance</p>
+</div>
       
     </li>
   
@@ -604,7 +753,8 @@ a Dispatcher instance which can be configured with Routes.
       
       
         &mdash;
-        <div class='inline'>self</div>
+        <div class='inline'><p>self</p>
+</div>
       
     </li>
   
@@ -616,16 +766,16 @@ a Dispatcher instance which can be configured with Routes.
       <pre class="lines">
 
 
-85
-86
-87
-88</pre>
+93
+94
+95
+96</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 85</span>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 93</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'>def</span> <span class='id identifier rubyid_configure'>configure</span>
+  <span class='kw'>yield</span> <span class='id identifier rubyid_configuration'>configuration</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -642,8 +792,9 @@ a Dispatcher instance which can be configured with Routes.
   
 </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.
+    <p>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.</p>
+
 
   </div>
 </div>
@@ -660,7 +811,8 @@ for use in adding a number of routes at once.
       
       
         &mdash;
-        <div class='inline'>self if configuring, or an Array of Routes otherwise</div>
+        <div class='inline'><p>self if configuring, or an Array of Routes otherwise</p>
+</div>
       
     </li>
   
@@ -679,24 +831,24 @@ for use in adding a number of routes at once.
       <pre class="lines">
 
 
-66
-67
-68
-69
-70
-71
-72
-73</pre>
+74
+75
+76
+77
+78
+79
+80
+81</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 66</span>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/application.rb', line 74</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'>def</span> <span class='id identifier rubyid_routes'>routes</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
+    <span class='id identifier rubyid_dispatcher'>dispatcher</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_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='id identifier rubyid_dispatcher'>dispatcher</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -713,7 +865,8 @@ for use in adding a number of routes at once.
   
 </p><div class="docstring">
   <div class="discussion">
-    Starts this Application serving requests
+    <p>Starts this Application serving requests</p>
+
 
   </div>
 </div>
@@ -733,8 +886,8 @@ for use in adding a number of routes at once.
     <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'>def</span> <span class='id identifier rubyid_run'>run</span>
+  <span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -746,9 +899,9 @@ for use in adding a number of routes at once.
 </div>
     
     <div id="footer">
-  Generated on Wed Jan  4 08:47:40 2012 by 
+  Generated on Thu Mar 22 10:24:45 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
+  0.7.5 (ruby-1.9.3).
 </div>
 
   </body>