RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,16 @@
+Copyright 2011-2012 Sean Cribbs and contributors
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+All of the files in this project are under the project-wide license
+unless they are otherwise marked.

data/README.md CHANGED Viewed

@@ -120,8 +120,32 @@ Webmachine.application.run
   object. You should be able to turn this off and on, and visualize
   the decisions on the sequence diagram.
+## LICENSE
+webmachine-ruby is licensed under the
+[Apache v2.0 license](http://www.apache.org/licenses/LICENSE-2.0). See
+LICENSE for details.
 ## Changelog
+### 0.4.2 March 22, 2012
+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!
+* I always intended for Webmachine-Ruby to be Apache licensed, but now
+  that is explicit.
+* When the `#process_post` callback returns an invalid value, that
+  will now be `inspect`ed in the raised exception's message.
+* Route bindings are now applied to the `Request` object before the
+  `Resource` class is instantiated. This means you can inspect them
+  inside the `#initialize` method of your resource.
+* Some `NameError` exceptions and scope problems in the Mongrel
+  adapter were resolved.
+* URL-encoded `=` characters in the query string decoded in the proper
+  order.
 ### 0.4.1 February 8, 2012
 0.4.1 is a bugfix release that corrects a few minor issues. Added Sam

data/doc/Webmachine/Adapter.html ADDED Viewed

@@ -0,0 +1,580 @@
+<!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::Adapter
+    &mdash; Documentation by YARD 0.7.5
+</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">Adapter</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::Adapter
+  <span class="abstract note title">Abstract</span>
+</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::Adapter</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/webmachine/adapter.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This class is abstract.</strong>
+  <div class='inline'><p>Subclass and override <span class='object_link'><a href="#run-instance_method" title="Webmachine::Adapter#run (method)">#run</a></span> to implement a custom adapter.</p>
+</div>
+</div>
+<p>The abstract class for definining a Webmachine adapter.</p>
+  </div>
+</div>
+<div class="tags">
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Adapters/Mongrel.html" title="Webmachine::Adapters::Mongrel (class)">Webmachine::Adapters::Mongrel</a></span>, <span class='object_link'><a href="Adapters/Rack.html" title="Webmachine::Adapters::Rack (class)">Webmachine::Adapters::Rack</a></span>, <span class='object_link'><a href="Adapters/WEBrick.html" title="Webmachine::Adapters::WEBrick (class)">Webmachine::Adapters::WEBrick</a></span></p>
+</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)">- (Webmachine::Configuration) <strong>configuration</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>The application&#39;s configuration.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#dispatcher-instance_method" title="#dispatcher (instance method)">- (Webmachine::Dispatcher) <strong>dispatcher</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'><p>The application&#39;s dispatcher.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#run-class_method" title="run (class method)">+ (Object) <strong>run</strong>(configuration, dispatcher) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Create a new adapter and run it.</p>
+</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="#initialize-instance_method" title="#initialize (instance method)">- (Adapter) <strong>initialize</strong>(configuration, dispatcher) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'><p>configuration.</p>
+</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="abstract note title">Abstract</span>
+    <span class="summary_desc"><div class='inline'><p>Start the adapter.</p>
+</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::Adapter (class)">Adapter</a></span></tt>) <strong>initialize</strong>(configuration, dispatcher)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>configuration.</p>
+  </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>
+        &mdash;
+        <div class='inline'><p>the application&#39;s</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>dispatcher</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Dispatcher.html" title="Webmachine::Dispatcher (class)">Webmachine::Dispatcher</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>the application&#39;s dispatcher.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+17
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/adapter.rb', line 17</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='comma'>,</span> <span class='id identifier rubyid_dispatcher'>dispatcher</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='id identifier rubyid_dispatcher'>dispatcher</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="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)">Webmachine::Configuration</a></span></tt>) <strong>configuration</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>The application&#39;s configuration.</p>
+  </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)">Webmachine::Configuration</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>the application&#39;s configuration.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/adapter.rb', line 9</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_configuration'>configuration</span>
+  <span class='ivar'>@configuration</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)">Webmachine::Dispatcher</a></span></tt>) <strong>dispatcher</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>The application&#39;s dispatcher.</p>
+  </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)">Webmachine::Dispatcher</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'><p>the application&#39;s dispatcher.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/adapter.rb', line 12</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>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="run-class_method">
+    + (<tt>Object</tt>) <strong>run</strong>(configuration, dispatcher)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Create a new adapter and run it.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/adapter.rb', line 23</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</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='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='period'>.</span><span class='id identifier rubyid_run'>run</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="run-instance_method">
+    - (<tt>Object</tt>) <strong>run</strong>
+</p><div class="docstring">
+  <div class="discussion">
+    <div class="note abstract">
+  <strong>This method is abstract.</strong>
+  <div class='inline'><p>Subclass and override <span class='object_link'><a href="#run-instance_method" title="Webmachine::Adapter#run (method)">#run</a></span> to implement a custom adapter.</p>
+</div>
+</div>
+<p>Start the adapter.</p>
+  </div>
+</div>
+<div class="tags">
+<h3>Raises:</h3>
+<ul class="raise">
+    <li>
+        <span class='type'>(<tt>NotImplementedError</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/webmachine/adapter.rb', line 31</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  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.5 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/doc/Webmachine/Adapters.html CHANGED Viewed

@@ -6,7 +6,7 @@
 <title>
   Module: Webmachine::Adapters
-    &mdash; Documentation by YARD 0.7.3
+    &mdash; Documentation by YARD 0.7.5
 </title>
@@ -73,7 +73,7 @@
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/webmachine/adapters.rb<span class="defines">,<br />
-  lib/webmachine/adapters/rack.rb,<br /> lib/webmachine/adapters/mongrel.rb,<br /> lib/webmachine/adapters/webrick.rb</span>
+  lib/webmachine/adapters/rack.rb,<br /> lib/webmachine/adapters/webrick.rb,<br /> lib/webmachine/adapters/mongrel.rb</span>
 </dd>
 </dl>
@@ -81,8 +81,9 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    Contains classes and modules that connect Webmachine to Ruby
-application servers.
+    <p>Contains classes and modules that connect Webmachine to Ruby
+application servers.</p>
   </div>
 </div>
@@ -93,11 +94,9 @@ application servers.
 <p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Adapters/Mongrel.html" title="Webmachine::Adapters::Mongrel (module)">Mongrel</a></span>, <span class='object_link'><a href="Adapters/WEBrick.html" title="Webmachine::Adapters::WEBrick (module)">WEBrick</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Adapters/Rack.html" title="Webmachine::Adapters::Rack (class)">Rack</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Adapters/Mongrel.html" title="Webmachine::Adapters::Mongrel (class)">Mongrel</a></span>, <span class='object_link'><a href="Adapters/Rack.html" title="Webmachine::Adapters::Rack (class)">Rack</a></span>, <span class='object_link'><a href="Adapters/WEBrick.html" title="Webmachine::Adapters::WEBrick (class)">WEBrick</a></span>
 </p>
@@ -108,12 +107,14 @@ application servers.
 </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>