webmachine 0.4.1 → 0.4.2

data/doc/index.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -54,8 +54,7 @@
     
     <iframe id="search_frame"></iframe>
     
-    <div id="content"><div id='filecontents'><h1>webmachine for Ruby <a href="http://travis-ci.org/seancribbs/webmachine-ruby"><img src="https://secure.travis-ci.org/seancribbs/webmachine-ruby.png" alt="travis">
-</a></h1>
+    <div id="content"><div id='filecontents'><h1>webmachine for Ruby <a href="http://travis-ci.org/seancribbs/webmachine-ruby"><img src="https://secure.travis-ci.org/seancribbs/webmachine-ruby.png" alt="travis"></a></h1>
 
 <p>webmachine-ruby is a port of
 <a href="https://github.com/basho/webmachine">Webmachine</a>, which is written in
@@ -79,72 +78,79 @@ when given a clear stack.</p>
 
 <h2>Getting Started</h2>
 
-<p>Webmachine is very young, but it's still easy to construct an
+<p>Webmachine is very young, but it&#39;s still easy to construct an
 application for it!</p>
 
-<pre class="code ruby"><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>webmachine</span><span class='tstring_end'>'</span></span>
+<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>webmachine</span><span class='tstring_end'>'</span></span>
 <span class='comment'># Require any of the files that contain your resources here
-</span><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_resource</span><span class='tstring_end'>'</span></span> 
+</span><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_resource</span><span class='tstring_end'>'</span></span> 
 
-<span class='comment'># Point all URIs at the MyResource class
-</span><span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Dispatcher</span><span class='period'>.</span><span class='id add_route'>add_route</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>MyResource</span><span class='rparen'>)</span>
+<span class='comment'># Create an application which encompasses routes and configruation
+</span><span class='const'>MyApp</span> <span class='op'>=</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Application</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_app'>app</span><span class='op'>|</span>
+  <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='kw'>do</span>
+    <span class='comment'># Point all URIs at the MyResource class
+</span>    <span class='id identifier rubyid_add'>add</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>MyResource</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
 
 <span class='comment'># Start the server, binds to port 8080 using WEBrick
-</span><span class='const'>Webmachine</span><span class='period'>.</span><span class='id run'>run</span> 
-</pre>
+</span><span class='const'>MyApp</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
+</code></pre>
 
 <p>Your resource will look something like this:</p>
 
-<pre class="code ruby"><span class='kw'>class</span> <span class='const'>MyResource</span> <span class='op'>&lt;</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Resource</span>
-  <span class='kw'>def</span> <span class='id to_html'>to_html</span>
+<pre class="code ruby"><code><span class='kw'>class</span> <span class='const'>MyResource</span> <span class='op'>&lt;</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Resource</span>
+  <span class='kw'>def</span> <span class='id identifier rubyid_to_html'>to_html</span>
     <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;html&gt;&lt;body&gt;Hello, world!&lt;/body&gt;&lt;/html&gt;</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
 <span class='kw'>end</span>
-</pre>
+</code></pre>
 
-<p>Run the first file and your application is up. That's all there is to
+<p>Run the first file and your application is up. That&#39;s all there is to
 it! If you want to customize your resource more, look at the available
 callbacks in lib/webmachine/resource/callbacks.rb. For example, you
 might want to enable &quot;gzip&quot; compression on your resource, for which
 you can simply add an <code>encodings_provided</code> callback method:</p>
 
-<pre class="code ruby"><span class='kw'>class</span> <span class='const'>MyResource</span> <span class='op'>&lt;</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Resource</span>
-  <span class='kw'>def</span> <span class='id encodings_provided'>encodings_provided</span>
+<pre class="code ruby"><code><span class='kw'>class</span> <span class='const'>MyResource</span> <span class='op'>&lt;</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Resource</span>
+  <span class='kw'>def</span> <span class='id identifier rubyid_encodings_provided'>encodings_provided</span>
     <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>gzip</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:encode_gzip</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>identity</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:encode_identity</span><span class='rbrace'>}</span>
   <span class='kw'>end</span>
 
-  <span class='kw'>def</span> <span class='id to_html'>to_html</span>
+  <span class='kw'>def</span> <span class='id identifier rubyid_to_html'>to_html</span>
     <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;html&gt;&lt;body&gt;Hello, world!&lt;/body&gt;&lt;/html&gt;</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
 <span class='kw'>end</span>
-</pre>
+</code></pre>
 
 <p>There are many other HTTP features exposed to your resource through
 <span class='object_link'><a href="Webmachine/Resource/Callbacks.html" title="Webmachine::Resource::Callbacks (module)">Webmachine::Resource::Callbacks</a></span>. Give them a try!</p>
 
-<h3>Configurator</h3>
+<h3>Application/Configurator</h3>
 
-<p>There's a configurator that allows you to set the ip address and port
+<p>There&#39;s a configurator that allows you to set the ip address and port
 bindings as well as a different webserver adapter.  You can also add
-your routes in a block. Both of these call return the <code>Webmachine</code>
-module, so you could chain them if you like.</p>
+your routes in a block (as shown above). Both of these call return the
+<code>Webmachine::Application</code> instance, so you could chain them if you
+like. If you don&#39;t want to create your own separate application
+object, <code>Webmachine.application</code> will return a global one.</p>
 
-<pre class="code ruby"><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>webmachine</span><span class='tstring_end'>'</span></span>
-<span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_resource</span><span class='tstring_end'>'</span></span>
+<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>webmachine</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>my_resource</span><span class='tstring_end'>'</span></span>
 
-<span class='const'>Webmachine</span><span class='period'>.</span><span class='id routes'>routes</span> <span class='kw'>do</span>
-  <span class='id add'>add</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>MyResource</span>
+<span class='const'>Webmachine</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_routes'>routes</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_add'>add</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>*</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>MyResource</span>
 <span class='kw'>end</span>
 
-<span class='const'>Webmachine</span><span class='period'>.</span><span class='id configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id config'>config</span><span class='op'>|</span>
-  <span class='id config'>config</span><span class='period'>.</span><span class='id ip'>ip</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>'</span></span>
-  <span class='id config'>config</span><span class='period'>.</span><span class='id port'>port</span> <span class='op'>=</span> <span class='int'>3000</span>
-  <span class='id config'>config</span><span class='period'>.</span><span class='id adapter'>adapter</span> <span class='op'>=</span> <span class='symbol'>:Mongrel</span>
+<span class='const'>Webmachine</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</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_ip'>ip</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>'</span></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'>3000</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='symbol'>:Mongrel</span>
 <span class='kw'>end</span>
 
 <span class='comment'># Start the server.
-</span><span class='const'>Webmachine</span><span class='period'>.</span><span class='id run'>run</span>
-</pre>
+</span><span class='const'>Webmachine</span><span class='period'>.</span><span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
+</code></pre>
 
 <h2>Features</h2>
 
@@ -170,8 +176,78 @@ object. You should be able to turn this off and on, and visualize
 the decisions on the sequence diagram.</li>
 </ul>
 
+<h2>LICENSE</h2>
+
+<p>webmachine-ruby is licensed under the
+<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache v2.0 license</a>. See
+LICENSE for details.</p>
+
 <h2>Changelog</h2>
 
+<h3>0.4.2 March 22, 2012</h3>
+
+<p>0.4.2 is a bugfix release that corrects a few minor issues. Added Lars
+Gierth and Rob Gleeson as contributors. Thank you for your
+contributions!</p>
+
+<ul>
+<li>I always intended for Webmachine-Ruby to be Apache licensed, but now
+that is explicit.</li>
+<li>When the <code>#process_post</code> callback returns an invalid value, that
+will now be <code>inspect</code>ed in the raised exception&#39;s message.</li>
+<li>Route bindings are now applied to the <code>Request</code> object before the
+<code>Resource</code> class is instantiated. This means you can inspect them
+inside the <code>#initialize</code> method of your resource.</li>
+<li>Some <code>NameError</code> exceptions and scope problems in the Mongrel
+adapter were resolved.</li>
+<li>URL-encoded <code>=</code> characters in the query string decoded in the proper
+order.</li>
+</ul>
+
+<h3>0.4.1 February 8, 2012</h3>
+
+<p>0.4.1 is a bugfix release that corrects a few minor issues. Added Sam
+Goldman as a contributor. Thank you for your contributions!</p>
+
+<ul>
+<li>Updated README with <code>Webmachine::Application</code> examples.</li>
+<li>The CGI env vars <code>CONTENT_LENGTH</code> and <code>CONTENT_TYPE</code> are now being
+correctly converted into their Webmachine equivalents.</li>
+<li>The request body given via the Rack and Mongrel adapters now
+responds to <code>#to_s</code> and <code>#each</code> so it can be treated like a <code>String</code>
+or <code>Enumerable</code> that yields chunks.</li>
+</ul>
+
+<h3>0.4.0 February 5, 2012</h3>
+
+<p>0.4.0 includes some important refactorings, isolating the idea of
+global state into an Application object with its own Dispatcher and
+configuration, and making Adapters into real classes with a consistent
+interface. It also adds some query methods on the Request object for
+the HTTP method and scheme and Route guards (matching predicates).
+Added Michael Maltese, Emmanuel Gomez, and Bernerd Schaefer as
+committers. Thank you for your contributions!</p>
+
+<ul>
+<li>Fixed <code>Request#query</code> to handle nil values for the URI query accessor.</li>
+<li><code>Webmachine::Dispatcher</code> is a real class rather than a module with
+state.</li>
+<li><code>Webmachine::Application</code> is a class that includes its own
+dispatcher and configuration. The default instance is accessible via
+<code>Webmachine.application</code>.</li>
+<li><code>Webmachine::Adapter</code> is now the superclass of all implemented
+adapters so that they have a uniform interface.</li>
+<li>The Mongrel spec is skipped on JRuby since version 1.2 (pre-release)
+doesn&#39;t work. Direct Mongrel support may be removed in a later
+release.</li>
+<li><code>Webmachine::Dispatcher::Route</code> now accepts guards, which may be
+expressed as lambdas/procs or any object responding to <code>call</code>
+preceding the <code>Resource</code> class in the route definition, or as a
+trailing block. All guards will be passed the <code>Request</code> object when
+matching the route and should return a truthy or falsey value
+(without side-effects).</li>
+</ul>
+
 <h3>0.3.0 November 9, 2011</h3>
 
 <p>0.3.0 introduces some new features, refactorings, and now has 100%
@@ -182,13 +258,13 @@ contributions!</p>
 
 <ul>
 <li>Chunked bodies are now wrapped in a way that works on webservers
-that don't automatically produce them.</li>
+that don&#39;t automatically produce them.</li>
 <li>HTTP Basic Authentication is easy to add to resources, just include
 <code>Webmachine::Resource::Authentication</code>.</li>
 <li>Routes are a little less painful to add, you can now specify them
 with <code>Webmachine.routes</code> which will be evaled into the <code>Dispatcher</code>.</li>
 <li>The new default port is 8080.</li>
-<li>Rack is minimally supported as a host server. <em>Don't put middleware
+<li>Rack is minimally supported as a host server. <em>Don&#39;t put middleware
 above Webmachine!</em></li>
 <li>Fibers can be used as streamed response bodies.</li>
 <li><code>Dispatcher#add_route</code> will now return the added <code>Route</code> instance.</li>
@@ -196,7 +272,7 @@ above Webmachine!</em></li>
 into <code>Webmachine::Headers</code>.</li>
 <li><code>Route#path_spec</code> is now public so that applications can inspect
 existing routes, perhaps for URL generation.</li>
-<li><code>Request#query</code> now uses <code>CGI.unescape</code> so '+' characters are
+<li><code>Request#query</code> now uses <code>CGI.unescape</code> so &#39;+&#39; characters are
 correctly parsed.</li>
 <li>YARD documentation has 100% coverage.</li>
 </ul>
@@ -231,9 +307,9 @@ top-level class.</li>
 </div></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>

data/doc/js/app.js

@@ -2,11 +2,11 @@ function createSourceLinks() {
     $('.method_details_list .source_code').
         before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
     $('.toggleSource').toggle(function() {
-       $(this).parent().next().slideDown(100);
+       $(this).parent().nextAll('.source_code').slideDown(100);
        $(this).text("Hide source");
     },
     function() {
-        $(this).parent().next().slideUp(100);
+        $(this).parent().nextAll('.source_code').slideUp(100);
         $(this).text("View source");
     });
 }
@@ -109,10 +109,10 @@ function summaryToggle() {
   $('.summary_toggle').click(function() {
     localStorage.summaryCollapsed = $(this).text();
     $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
-    var next = $(this).parent().parent().next();
+    var next = $(this).parent().parent().nextAll('ul.summary').first();
     if (next.hasClass('compact')) {
       next.toggle();
-      next.next().toggle();
+      next.nextAll('ul.summary').first().toggle();
     } 
     else if (next.hasClass('summary')) {
       var list = $('<ul class="summary compact" />');

data/doc/js/full_list.js

@@ -4,6 +4,9 @@ var searchCache = [];
 var searchString = '';
 var regexSearchString = '';
 var caseSensitiveMatch = false;
+var ignoreKeyCodeMin = 8;
+var ignoreKeyCodeMax = 46;
+var commandKey = 91;
 
 RegExp.escape = function(text) {
     return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
@@ -19,6 +22,9 @@ function fullListSearch() {
   });
   
   $('#search input').keyup(function() {
+    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) 
+         || event.keyCode == commandKey)
+      return;
     searchString = this.value;
     caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
     regexSearchString = RegExp.escape(searchString);