docs for 0.2.4

ianwhite · Mar 9, 2010 · 4254a77 · 4254a77
1 parent 2a61964
commit 4254a77
Show file tree

Hide file tree

Showing 33 changed files with 645 additions and 611 deletions.
diff --git a/doc/classes/Pickle.html b/doc/classes/Pickle.html
@@ -48,18 +48,18 @@ <h1 class='name'>
           <li class='other'>
             <a href="../files/lib/pickle/parser_rb.html">lib/pickle/parser.rb</a>
           </li>
-          <li class='other'>
-            <a href="../files/lib/pickle/session/parser_rb.html">lib/pickle/session/parser.rb</a>
-          </li>
           <li class='other'>
             <a href="../files/lib/pickle/path_rb.html">lib/pickle/path.rb</a>
           </li>
           <li class='other'>
-            <a href="../files/lib/pickle/session_rb.html">lib/pickle/session.rb</a>
+            <a href="../files/lib/pickle/session/parser_rb.html">lib/pickle/session/parser.rb</a>
           </li>
           <li class='other'>
             <a href="../files/lib/pickle/version_rb.html">lib/pickle/version.rb</a>
           </li>
+          <li class='other'>
+            <a href="../files/lib/pickle/session_rb.html">lib/pickle/session.rb</a>
+          </li>
           <li class='other'>
             <a href="../files/lib/pickle_rb.html">lib/pickle.rb</a>
           </li>

diff --git a/doc/classes/Pickle/Adapter.html b/doc/classes/Pickle/Adapter.html
@@ -49,7 +49,7 @@ <h1 class='name'>
             </p>
             <p>
             The factory adaptor must have a <a
-            href="Adapter.html#M000083">factories</a> class method that returns its
+            href="Adapter.html#M000084">factories</a> class method that returns its
             instances, and each instance must respond to:
             </p>
             <pre>#name : identifies the factory by name (default is attr_reader)&#x000A;#klass : returns the associated model class for this factory (default is attr_reader)&#x000A;#create(attrs = {}) : returns a newly created object</pre>
@@ -58,12 +58,12 @@ <h1 class='name'>
             <h2>Methods</h2>
             <h3>public class</h3>
             <ol>
-              <li><a href="#M000083">factories</a></li>
-              <li><a href="#M000085">model_classes</a></li>
+              <li><a href="#M000084">factories</a></li>
+              <li><a href="#M000086">model_classes</a></li>
             </ol>
             <h3>public instance</h3>
             <ol>
-              <li><a href="#M000084">create</a></li>
+              <li><a href="#M000085">create</a></li>
             </ol>
           </div>
           <div id='section'>
@@ -92,44 +92,44 @@ <h2 class='section-bar'>Attributes</h2>
             </div>
             <div id='methods'>
               <h2>Public class methods</h2>
-              <div class='method public-class' id='method-M000083'>
-                <a name='M000083'></a>
+              <div class='method public-class' id='method-M000084'>
+                <a name='M000084'></a>
                 <div class='synopsis'>
                   <span class='name'>factories</span>
                   <span class='arguments'>()</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000083-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000084-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000083-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 14</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">factories</span>&#x000A;      <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-value str">&quot;return an array of factory adapter objects&quot;</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000084-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 14</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">factories</span>&#x000A;      <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-value str">&quot;return an array of factory adapter objects&quot;</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
-              <div class='method public-class' id='method-M000085'>
-                <a name='M000085'></a>
+              <div class='method public-class' id='method-M000086'>
+                <a name='M000086'></a>
                 <div class='synopsis'>
                   <span class='name'>model_classes</span>
                   <span class='arguments'>()</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000085-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000086-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000085-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 25</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">model_classes</span>&#x000A;      <span class="ruby-comment cmt"># remove abstract, framework, and non-table classes</span>&#x000A;      <span class="ruby-ivar">@@model_classes</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:subclasses</span>).<span class="ruby-identifier">reject</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span>&#x000A;        <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">abstract_class?</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-identifier">klass</span>.<span class="ruby-identifier">table_exists?</span> <span class="ruby-operator">||</span>&#x000A;         (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecordStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecordStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">||</span>&#x000A;         (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>)&#x000A;      <span class="ruby-keyword kw">end</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000086-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 25</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">model_classes</span>&#x000A;      <span class="ruby-comment cmt"># remove abstract, framework, and non-table classes</span>&#x000A;      <span class="ruby-ivar">@@model_classes</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:subclasses</span>).<span class="ruby-identifier">reject</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span>&#x000A;        <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">abstract_class?</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-identifier">klass</span>.<span class="ruby-identifier">table_exists?</span> <span class="ruby-operator">||</span>&#x000A;         (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecordStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecordStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">||</span>&#x000A;         (<span class="ruby-keyword kw">defined?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionStore</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span>)&#x000A;      <span class="ruby-keyword kw">end</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
               <h2>Public instance methods</h2>
-              <div class='method public-instance' id='method-M000084'>
-                <a name='M000084'></a>
+              <div class='method public-instance' id='method-M000085'>
+                <a name='M000085'></a>
                 <div class='synopsis'>
                   <span class='name'>create</span>
                   <span class='arguments'>(attrs = {})</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000084-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000085-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000084-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 18</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">attrs</span> = {})&#x000A;      <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-value str">&quot;create and return an object with the given attributes&quot;</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000085-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 18</span>&#x000A;    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">attrs</span> = {})&#x000A;      <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-value str">&quot;create and return an object with the given attributes&quot;</span>&#x000A;    <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
             </div>

diff --git a/doc/classes/Pickle/Adapter/ActiveRecord.html b/doc/classes/Pickle/Adapter/ActiveRecord.html
@@ -50,55 +50,55 @@ <h1 class='name'>
             <h2>Methods</h2>
             <h3>public class</h3>
             <ol>
-              <li><a href="#M000089">factories</a></li>
-              <li><a href="#M000090">new</a></li>
+              <li><a href="#M000090">factories</a></li>
+              <li><a href="#M000091">new</a></li>
             </ol>
             <h3>public instance</h3>
             <ol>
-              <li><a href="#M000091">create</a></li>
+              <li><a href="#M000092">create</a></li>
             </ol>
           </div>
           <div id='section'>
             <div id='methods'>
               <h2>Public class methods</h2>
-              <div class='method public-class' id='method-M000089'>
-                <a name='M000089'></a>
+              <div class='method public-class' id='method-M000090'>
+                <a name='M000090'></a>
                 <div class='synopsis'>
                   <span class='name'>factories</span>
                   <span class='arguments'>()</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000089-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000090-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000089-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 74</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">factories</span>&#x000A;        <span class="ruby-identifier">model_classes</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new</span>(<span class="ruby-identifier">klass</span>) }&#x000A;      <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000090-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 74</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">factories</span>&#x000A;        <span class="ruby-identifier">model_classes</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">klass</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new</span>(<span class="ruby-identifier">klass</span>) }&#x000A;      <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
-              <div class='method public-class' id='method-M000090'>
-                <a name='M000090'></a>
+              <div class='method public-class' id='method-M000091'>
+                <a name='M000091'></a>
                 <div class='synopsis'>
                   <span class='name'>new</span>
                   <span class='arguments'>(klass)</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000090-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000091-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000090-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 78</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">klass</span>)&#x000A;        <span class="ruby-ivar">@klass</span>, <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">underscore</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'/'</span>,<span class="ruby-value str">'_'</span>)&#x000A;      <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000091-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 78</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">klass</span>)&#x000A;        <span class="ruby-ivar">@klass</span>, <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">klass</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">underscore</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'/'</span>,<span class="ruby-value str">'_'</span>)&#x000A;      <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
               <h2>Public instance methods</h2>
-              <div class='method public-instance' id='method-M000091'>
-                <a name='M000091'></a>
+              <div class='method public-instance' id='method-M000092'>
+                <a name='M000092'></a>
                 <div class='synopsis'>
                   <span class='name'>create</span>
                   <span class='arguments'>(attrs = {})</span>
                 </div>
                 <div class='source'>
-                  <a class='source-toggle' href='#' onclick="toggleCode('M000091-source'); return false">
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000092-source'); return false">
                     [show source]
                   </a>
-                  <pre id='M000091-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 82</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">attrs</span> = {})&#x000A;        <span class="ruby-ivar">@klass</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:create!</span>, <span class="ruby-identifier">attrs</span>)&#x000A;      <span class="ruby-keyword kw">end</span></pre>
+                  <pre id='M000092-source'><span class="ruby-comment cmt"># File lib/pickle/adapter.rb, line 82</span>&#x000A;      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>(<span class="ruby-identifier">attrs</span> = {})&#x000A;        <span class="ruby-ivar">@klass</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:create!</span>, <span class="ruby-identifier">attrs</span>)&#x000A;      <span class="ruby-keyword kw">end</span></pre>
                 </div>
               </div>
             </div>