webmachine 0.4.1 → 0.4.2

data/doc/Webmachine/CallableEncoder.html

@@ -6,7 +6,7 @@
 <title>
   Class: Webmachine::CallableEncoder
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -102,8 +102,9 @@
   <strong>This class is part of a private API.</strong> 
   You should avoid using this class if possible, as it may be removed or be changed in the future.
 </p>
-Implements a streaming encoder for callable bodies, such as
-Proc. (essentially futures)
+<p>Implements a streaming encoder for callable bodies, such as
+Proc. (essentially futures)</p>
+
 
   </div>
 </div>
@@ -112,22 +113,15 @@ Proc. (essentially futures)
 
 </div>
 
-  
-  
-  
-  
-  
 
 
-  
-  
-  
+
+
   <h2>Instance Attribute Summary</h2>
   
   <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="StreamingEncoder.html" title="Webmachine::StreamingEncoder (class)">StreamingEncoder</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="StreamingEncoder.html#body-instance_method" title="Webmachine::StreamingEncoder#body (method)">body</a></span>, <span class='object_link'><a href="StreamingEncoder.html#charsetter-instance_method" title="Webmachine::StreamingEncoder#charsetter (method)">charsetter</a></span>, <span class='object_link'><a href="StreamingEncoder.html#encoder-instance_method" title="Webmachine::StreamingEncoder#encoder (method)">encoder</a></span>, <span class='object_link'><a href="StreamingEncoder.html#resource-instance_method" title="Webmachine::StreamingEncoder#resource (method)">resource</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="StreamingEncoder.html#body-instance_method" title="Webmachine::StreamingEncoder#body (method)">#body</a></span>, <span class='object_link'><a href="StreamingEncoder.html#charsetter-instance_method" title="Webmachine::StreamingEncoder#charsetter (method)">#charsetter</a></span>, <span class='object_link'><a href="StreamingEncoder.html#encoder-instance_method" title="Webmachine::StreamingEncoder#encoder (method)">#encoder</a></span>, <span class='object_link'><a href="StreamingEncoder.html#resource-instance_method" title="Webmachine::StreamingEncoder#resource (method)">#resource</a></span></p>
 
-  
 
   
     <h2>
@@ -153,7 +147,8 @@ Proc. (essentially futures)
   <span class="private note title">Private</span>
 
   
-    <span class="summary_desc"><div class='inline'>Encodes the output of the body Proc.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Encodes the output of the body Proc.</p>
+</div></span>
   
 </li>
 
@@ -174,7 +169,8 @@ Proc. (essentially futures)
   <span class="private note title">Private</span>
 
   
-    <span class="summary_desc"><div class='inline'>Converts this encoder into a Proc.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Converts this encoder into a Proc.</p>
+</div></span>
   
 </li>
 
@@ -207,7 +203,8 @@ Proc. (essentially futures)
   <strong>This method is part of a private API.</strong> 
   You should avoid using this method if possible, as it may be removed or be changed in the future.
 </p>
-Encodes the output of the body Proc.
+<p>Encodes the output of the body Proc.</p>
+
 
   </div>
 </div>
@@ -240,8 +237,8 @@ Encodes the output of the body Proc.
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/streaming.rb', line 37</span>
 
-<span class='kw'>def</span> <span class='id call'>call</span>
-  <span class='id resource'>resource</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id encoder'>encoder</span><span class='comma'>,</span> <span class='id resource'>resource</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id charsetter'>charsetter</span><span class='comma'>,</span> <span class='id body'>body</span><span class='period'>.</span><span class='id call'>call</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rparen'>)</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
+  <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_encoder'>encoder</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_charsetter'>charsetter</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -261,7 +258,8 @@ Encodes the output of the body Proc.
   <strong>This method is part of a private API.</strong> 
   You should avoid using this method if possible, as it may be removed or be changed in the future.
 </p>
-Converts this encoder into a Proc.
+<p>Converts this encoder into a Proc.</p>
+
 
   </div>
 </div>
@@ -278,7 +276,8 @@ Converts this encoder into a Proc.
       
       
         &mdash;
-        <div class='inline'>a closure that wraps the <span class='object_link'><a href="#call-instance_method" title="Webmachine::CallableEncoder#call (method)">#call</a></span> method</div>
+        <div class='inline'><p>a closure that wraps the <span class='object_link'><a href="#call-instance_method" title="Webmachine::CallableEncoder#call (method)">#call</a></span> method</p>
+</div>
       
     </li>
   
@@ -304,8 +303,8 @@ Converts this encoder into a Proc.
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/streaming.rb', line 44</span>
 
-<span class='kw'>def</span> <span class='id to_proc'>to_proc</span>
-  <span class='id method'>method</span><span class='lparen'>(</span><span class='symbol'>:call</span><span class='rparen'>)</span><span class='period'>.</span><span class='id to_proc'>to_proc</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_to_proc'>to_proc</span>
+  <span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:call</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_proc'>to_proc</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -317,9 +316,9 @@ Converts this encoder into a Proc.
 </div>
     
     <div id="footer">
-  Generated on Wed Jan  4 08:47:40 2012 by 
+  Generated on Thu Mar 22 10:24:44 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>

data/doc/Webmachine/ChunkedBody.html

@@ -6,7 +6,7 @@
 <title>
   Class: Webmachine::ChunkedBody
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -94,15 +94,21 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">ChunkedBody</a></span> is used to wrap an Enumerable object (like an enumerable
-<span class='object_link'><a href="Response.html#body-instance_method" title="Webmachine::Response#body (method)">Response#body</a></span>) so it yields proper chunks for chunked transfer encoding.<br/>    case response.body
-    when String
-      socket.write(response.body)
-    when Enumerable
-      Webmachine::ChunkedBody.new(response.body).each do |chunk|
-        socket.write(chunk)
-      end
-    end<br/>This is needed for Ruby webservers which don't do the chunking themselves.
+    <p><span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">ChunkedBody</a></span> is used to wrap an Enumerable object (like an enumerable
+<span class='object_link'><a href="Response.html#body-instance_method" title="Webmachine::Response#body (method)">Response#body</a></span>) so it yields proper chunks for chunked transfer encoding.</p>
+
+<pre class="code ruby"><code><span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
+<span class='kw'>when</span> <span class='const'>String</span>
+  <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
+<span class='kw'>when</span> <span class='const'>Enumerable</span>
+  <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>ChunkedBody</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_chunk'>chunk</span><span class='op'>|</span>
+    <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+</code></pre>
+
+<p>This is needed for Ruby webservers which don&#39;t do the chunking themselves.</p>
+
 
   </div>
 </div>
@@ -117,7 +123,8 @@
         <dt id="CRLF-constant" class="">CRLF =
           <div class="docstring">
   <div class="discussion">
-    Delimiter for chunked encoding
+    <p>Delimiter for chunked encoding</p>
+
 
   </div>
 </div>
@@ -131,7 +138,8 @@
         <dt id="FINAL_CHUNK-constant" class="">FINAL_CHUNK =
           <div class="docstring">
   <div class="discussion">
-    Final chunk in any chunked-encoding response
+    <p>Final chunk in any chunked-encoding response</p>
+
 
   </div>
 </div>
@@ -149,6 +157,8 @@
 
 
 
+
+
   
     <h2>
       Instance Method Summary
@@ -173,8 +183,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>Calls the given block once for each chunk, passing that chunk as a
-parameter.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Calls the given block once for each chunk, passing that chunk as a
+parameter.</p>
+</div></span>
   
 </li>
 
@@ -197,7 +208,8 @@ parameter.</div></span>
   
 
   
-    <span class="summary_desc"><div class='inline'>Creates a new <span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">ChunkedBody</a></span> from the given Enumerable.</div></span>
+    <span class="summary_desc"><div class='inline'><p>Creates a new <span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">ChunkedBody</a></span> from the given Enumerable.</p>
+</div></span>
   
 </li>
 
@@ -217,7 +229,8 @@ parameter.</div></span>
   
 </p><div class="docstring">
   <div class="discussion">
-    Creates a new <span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">Webmachine::ChunkedBody</a></span> from the given Enumerable.
+    <p>Creates a new <span class='object_link'><a href="" title="Webmachine::ChunkedBody (class)">Webmachine::ChunkedBody</a></span> from the given Enumerable.</p>
+
 
   </div>
 </div>
@@ -235,7 +248,8 @@ parameter.</div></span>
       
       
         &mdash;
-        <div class='inline'>the enumerable response body</div>
+        <div class='inline'><p>the enumerable response body</p>
+</div>
       
     </li>
   
@@ -255,8 +269,8 @@ parameter.</div></span>
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/chunked_body.rb', line 25</span>
 
-<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id body'>body</span><span class='rparen'>)</span>
-  <span class='ivar'>@body</span> <span class='op'>=</span> <span class='id body'>body</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
+  <span class='ivar'>@body</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -279,9 +293,10 @@ parameter.</div></span>
   
 </p><div class="docstring">
   <div class="discussion">
-    Calls the given block once for each chunk, passing that chunk as a
+    <p>Calls the given block once for each chunk, passing that chunk as a
 parameter.
-Returns an Enumerator if no block is given.
+Returns an Enumerator if no block is given.</p>
+
 
   </div>
 </div>
@@ -321,13 +336,13 @@ Returns an Enumerator if no block is given.
     <td>
       <pre class="code"><span class="info file"># File 'lib/webmachine/chunked_body.rb', line 32</span>
 
-<span class='kw'>def</span> <span class='id each'>each</span>
-  <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id to_enum'>to_enum</span> <span class='kw'>unless</span> <span class='id block_given?'>block_given?</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
+  <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_enum'>to_enum</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
 
-  <span class='ivar'>@body</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chunk'>chunk</span><span class='op'>|</span>
-    <span class='id size'>size</span> <span class='op'>=</span> <span class='id chunk'>chunk</span><span class='period'>.</span><span class='id bytesize'>bytesize</span>
-    <span class='kw'>next</span> <span class='kw'>if</span> <span class='id size'>size</span> <span class='op'>==</span> <span class='int'>0</span>
-    <span class='kw'>yield</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id size'>size</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>CRLF</span><span class='comma'>,</span> <span class='id chunk'>chunk</span><span class='comma'>,</span> <span class='const'>CRLF</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id join'>join</span><span class='rparen'>)</span>
+  <span class='ivar'>@body</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_chunk'>chunk</span><span class='op'>|</span>
+    <span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
+    <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>==</span> <span class='int'>0</span>
+    <span class='kw'>yield</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>CRLF</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='comma'>,</span> <span class='const'>CRLF</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
   <span class='kw'>yield</span><span class='lparen'>(</span><span class='const'>FINAL_CHUNK</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
@@ -341,9 +356,9 @@ Returns an Enumerator if no block is given.
 </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>

data/doc/Webmachine/Decision.html

@@ -6,7 +6,7 @@
 <title>
   Module: Webmachine::Decision
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -81,9 +81,10 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    This module encapsulates the logic related to delivering the
+    <p>This module encapsulates the logic related to delivering the
 proper HTTP response, given the constraints of the <span class='object_link'><a href="Request.html" title="Webmachine::Request (class)">Request</a></span> and
-the <span class='object_link'><a href="Resource.html" title="Webmachine::Resource (class)">Resource</a></span> which is being processed.
+the <span class='object_link'><a href="Resource.html" title="Webmachine::Resource (class)">Resource</a></span> which is being processed.</p>
+
 
   </div>
 </div>
@@ -109,12 +110,14 @@ the <span class='object_link'><a href="Resource.html" title="Webmachine::Resourc
 
 
 
+
+
 </div>
     
     <div id="footer">
-  Generated on Wed Jan  4 08:47:39 2012 by 
+  Generated on Thu Mar 22 10:24:44 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>