Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ianwhite
ianwhite committed Feb 25, 2010
1 parent c3d01a5 commit 9bd0f3a
Show file tree
Hide file tree
Showing 34 changed files with 851 additions and 610 deletions.
20 changes: 10 additions & 10 deletions doc/classes/Pickle.html
View file
Expand Up @@ -40,10 +40,10 @@ <h1 class='name'>
<a href="../files/lib/pickle/email/parser_rb.html">lib/pickle/email/parser.rb</a>
</li>
<li class='other'>
<a href="../files/lib/pickle/email_rb.html">lib/pickle/email.rb</a>
<a href="../files/lib/pickle/parser/matchers_rb.html">lib/pickle/parser/matchers.rb</a>
</li>
<li class='other'>
<a href="../files/lib/pickle/parser/matchers_rb.html">lib/pickle/parser/matchers.rb</a>
<a href="../files/lib/pickle/email_rb.html">lib/pickle/email.rb</a>
</li>
<li class='other'>
<a href="../files/lib/pickle/parser_rb.html">lib/pickle/parser.rb</a>
Expand All @@ -55,10 +55,10 @@ <h1 class='name'>
<a href="../files/lib/pickle/session/parser_rb.html">lib/pickle/session/parser.rb</a>
</li>
<li class='other'>
<a href="../files/lib/pickle/session_rb.html">lib/pickle/session.rb</a>
<a href="../files/lib/pickle/version_rb.html">lib/pickle/version.rb</a>
</li>
<li class='other'>
<a href="../files/lib/pickle/version_rb.html">lib/pickle/version.rb</a>
<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>
Expand Down Expand Up @@ -92,8 +92,8 @@ <h2>Classes and Modules</h2>
</div>
<div id='methods'>
<h2>Public class methods</h2>
<div class='public-class method' id='method-M000001'>
<a name='M000001'> </a>
<div class='method public-class' id='method-M000001'>
<a name='M000001'></a>
<div class='synopsis'>
<span class='name'>config</span>
<span class='arguments'>()</span>
Expand All @@ -105,8 +105,8 @@ <h2>Public class methods</h2>
<pre id='M000001-source'><span class="ruby-comment cmt"># File lib/pickle.rb, line 14</span>&#x000A; <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config</span>&#x000A; <span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>&#x000A; <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='public-class method' id='method-M000002'>
<a name='M000002'> </a>
<div class='method public-class' id='method-M000002'>
<a name='M000002'></a>
<div class='synopsis'>
<span class='name'>configure</span>
<span class='arguments'>(&amp;block)</span>
Expand All @@ -118,8 +118,8 @@ <h2>Public class methods</h2>
<pre id='M000002-source'><span class="ruby-comment cmt"># File lib/pickle.rb, line 18</span>&#x000A; <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A; <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configure</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A; <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='public-class method' id='method-M000003'>
<a name='M000003'> </a>
<div class='method public-class' id='method-M000003'>
<a name='M000003'></a>
<div class='synopsis'>
<span class='name'>parser</span>
<span class='arguments'>(options = {})</span>
Expand Down
32 changes: 16 additions & 16 deletions doc/classes/Pickle/Adapter.html
View file
Expand Up @@ -49,7 +49,7 @@ <h1 class='name'>
</p>
<p>
The factory adaptor must have a <a
href="Adapter.html#M000074">factories</a> class method that returns its
href="Adapter.html#M000082">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>
Expand All @@ -58,12 +58,12 @@ <h1 class='name'>
<h2>Methods</h2>
<h3>public class</h3>
<ol>
<li><a href="#M000074">factories</a></li>
<li><a href="#M000076">model_classes</a></li>
<li><a href="#M000082">factories</a></li>
<li><a href="#M000084">model_classes</a></li>
</ol>
<h3>public instance</h3>
<ol>
<li><a href="#M000075">create</a></li>
<li><a href="#M000083">create</a></li>
</ol>
</div>
<div id='section'>
Expand Down Expand Up @@ -92,44 +92,44 @@ <h2 class='section-bar'>Attributes</h2>
</div>
<div id='methods'>
<h2>Public class methods</h2>
<div class='public-class method' id='method-M000074'>
<a name='M000074'> </a>
<div class='method public-class' id='method-M000082'>
<a name='M000082'></a>
<div class='synopsis'>
<span class='name'>factories</span>
<span class='arguments'>()</span>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('M000074-source'); return false">
<a class='source-toggle' href='#' onclick="toggleCode('M000082-source'); return false">
[show source]
</a>
<pre id='M000074-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='M000082-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='public-class method' id='method-M000076'>
<a name='M000076'> </a>
<div class='method public-class' id='method-M000084'>
<a name='M000084'></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('M000076-source'); return false">
<a class='source-toggle' href='#' onclick="toggleCode('M000084-source'); return false">
[show source]
</a>
<pre id='M000076-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='M000084-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='public-instance method' id='method-M000075'>
<a name='M000075'> </a>
<div class='method public-instance' id='method-M000083'>
<a name='M000083'></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('M000075-source'); return false">
<a class='source-toggle' href='#' onclick="toggleCode('M000083-source'); return false">
[show source]
</a>
<pre id='M000075-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='M000083-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>
Expand Down

0 comments on commit 9bd0f3a

Please sign in to comment.