cachetastic 1.6.0 → 1.7.0

data/doc/classes/ActiveRecord/Base.html

@@ -128,21 +128,27 @@
         </div>
       
         <div class="method-description">
+          <p>
+Returns an object from the cache for a given key. If the object returned is
+nil and the self_populate parameter is true then the key will be used to
+try and find the object in the database, set the object into the cache, and
+then return the object.
+</p>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/rails_extensions/cachetastic_active_record_base.rb, line 9</span>
- 9:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_from_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">self_populate</span> = <span class="ruby-keyword kw">false</span>)
-10:     <span class="ruby-identifier">res</span> = <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
-11:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">self_populate</span>
-12:       <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">key</span>)
-13:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span>
-14:         <span class="ruby-identifier">res</span>.<span class="ruby-identifier">cache_self</span>
-15:       <span class="ruby-keyword kw">end</span>
-16:     <span class="ruby-keyword kw">end</span>
-17:     <span class="ruby-identifier">res</span>
-18:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/rails_extensions/cachetastic_active_record_base.rb, line 13</span>
+13:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_from_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">self_populate</span> = <span class="ruby-keyword kw">false</span>)
+14:     <span class="ruby-identifier">res</span> = <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
+15:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">self_populate</span>
+16:       <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">key</span>)
+17:       <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span>
+18:         <span class="ruby-identifier">res</span>.<span class="ruby-identifier">cache_self</span>
+19:       <span class="ruby-keyword kw">end</span>
+20:     <span class="ruby-keyword kw">end</span>
+21:     <span class="ruby-identifier">res</span>
+22:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Cachetastic/Cacheable.html

@@ -79,12 +79,7 @@
     <div id="description">
       <p>
 Include this module into an <a href="../Object.html">Object</a> to achieve
-simplistic <a href="../Object.html">Object</a> level caching. When
-including this module you <b>MUST</b> create an instance level method
-called cachetastic_key and have it return a valid key! If you return nil
-from the cachetastic_key method you will not be able to use the <a
-href="Cacheable.html#M000047">cache_self</a> and <a
-href="Cacheable.html#M000048">uncache_self</a> methods.
+simplistic <a href="../Object.html">Object</a> level caching.
 </p>
 <p>
 Example:
@@ -162,7 +157,7 @@ Unless the object&#8216;s cachetastic_key method returns nil this method
 will store the object in the cache using the object&#8216;s cachetastic_key
 as the key. You <b>MUST</b> create an instance level method called
 cachetastic_key and have it return a valid key! If you return nil from the
-cachetastic_key method you will not be able to use the <a
+cachetastic_key method or you will not be able to use the <a
 href="Cacheable.html#M000047">cache_self</a> and <a
 href="Cacheable.html#M000048">uncache_self</a> methods.
 </p>
@@ -188,10 +183,10 @@ Example:
             onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000047-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 143</span>
-143:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cache_self</span>
-144:       <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>, <span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>.<span class="ruby-identifier">nil?</span>
-145:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 140</span>
+140:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cache_self</span>
+141:       <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>, <span class="ruby-keyword kw">self</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>.<span class="ruby-identifier">nil?</span>
+142:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -212,7 +207,7 @@ Unless the object&#8216;s cachetastic_key method returns nil this method
 will delete the object in the cache using the object&#8216;s
 cachetastic_key as the key. You <b>MUST</b> create an instance level method
 called cachetastic_key and have it return a valid key! If you return nil
-from the cachetastic_key method you will not be able to use the <a
+from the cachetastic_key method or you will not be able to use the <a
 href="Cacheable.html#M000047">cache_self</a> and <a
 href="Cacheable.html#M000048">uncache_self</a> methods.
 </p>
@@ -240,10 +235,10 @@ Example:
             onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000048-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 169</span>
-169:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">uncache_self</span>
-170:       <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>.<span class="ruby-identifier">nil?</span>
-171:     <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 166</span>
+166:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">uncache_self</span>
+167:       <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">cachetastic_key</span>.<span class="ruby-identifier">nil?</span>
+168:     <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html

@@ -139,21 +139,21 @@ Example:
             onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000049-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 42</span>
-42:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cache_class</span>
-43:         <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>
-44:         <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;Class&quot;</span>
-45:         <span class="ruby-comment cmt"># puts &quot;n: #{n}&quot;</span>
-46:         <span class="ruby-identifier">c_name</span> = <span class="ruby-node">&quot;Cachetastic::Cacheable::#{n}Cache&quot;</span>
-47:         <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Cacheable</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-node">&quot;#{n}Cache&quot;</span>)
-48:           <span class="ruby-comment cmt"># puts &quot;we need to create a cache for: #{c_name}&quot;</span>
-49:           <span class="ruby-identifier">eval</span> <span class="ruby-node">%{
-50:             class #{c_name} &lt; Cachetastic::Caches::Base
-51:             end
-52:           }</span>
-53:         <span class="ruby-keyword kw">end</span>
-54:         <span class="ruby-identifier">c_name</span>.<span class="ruby-identifier">constantize</span>
-55:       <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 39</span>
+39:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cache_class</span>
+40:         <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>
+41:         <span class="ruby-identifier">n</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;Class&quot;</span>
+42:         <span class="ruby-comment cmt"># puts &quot;n: #{n}&quot;</span>
+43:         <span class="ruby-identifier">c_name</span> = <span class="ruby-node">&quot;Cachetastic::Cacheable::#{n}Cache&quot;</span>
+44:         <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Cacheable</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-node">&quot;#{n}Cache&quot;</span>)
+45:           <span class="ruby-comment cmt"># puts &quot;we need to create a cache for: #{c_name}&quot;</span>
+46:           <span class="ruby-identifier">eval</span> <span class="ruby-node">%{
+47:             class #{c_name} &lt; Cachetastic::Caches::Base
+48:             end
+49:           }</span>
+50:         <span class="ruby-keyword kw">end</span>
+51:         <span class="ruby-identifier">c_name</span>.<span class="ruby-identifier">constantize</span>
+52:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -192,34 +192,31 @@ Example:
       end
     end
   end
+
+  Person.new.always_the_same(1,2) # =&gt; 3
+  Person.new.always_the_same(2,2) # =&gt; 3
+  Person.new.always_the_same(3,3) # =&gt; 3
+  Person.cacher(&quot;always_the_same&quot;) # =&gt; 3
+  Person.get_from_cache(&quot;always_the_same&quot;) # =&gt; 3
+  Cachetastic::Cacheable::PersonCache.get(&quot;always_the_same&quot;) # =&gt; 3
+
+  Person.cacher(&quot;say_hi&quot;) {&quot;Hi There&quot;} # =&gt; &quot;Hi There&quot;
+  Person.get_from_cache(&quot;say_hi&quot;) # =&gt; &quot;Hi There&quot;
+  Cachetastic::Cacheable::PersonCache.get(&quot;say_hi&quot;) # =&gt; &quot;Hi There&quot;
 </pre>
-<p>
-Person.new.always_the_same(1,2) # =&gt; 3 Person.new.always_the_same(2,2) #
-=&gt; 3 Person.new.always_the_same(3,3) # =&gt; 3
-Person.cacher(&quot;always_the_same&quot;) # =&gt; 3
-Person.get_from_cache(&quot;always_the_same&quot;) # =&gt; 3
-Cachetastic::Cacheable::PersonCache.get(&quot;always_the_same&quot;) #
-=&gt; 3
-</p>
-<p>
-Person.cacher(&quot;say_hi&quot;) {&quot;Hi There&quot;} # =&gt; &quot;Hi
-There&quot; Person.get_from_cache(&quot;say_hi&quot;) # =&gt; &quot;Hi
-There&quot; Cachetastic::Cacheable::PersonCache.get(&quot;say_hi&quot;) #
-=&gt; &quot;Hi There&quot;
-</p>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000050-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 87</span>
-87:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cacher</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
-88:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword kw">do</span>
-89:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-90:             <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">yield</span>
-91:             <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">res</span>, <span class="ruby-identifier">expiry</span>)
-92:           <span class="ruby-keyword kw">end</span>
-93:         <span class="ruby-keyword kw">end</span>
-94:       <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 84</span>
+84:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cacher</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
+85:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword kw">do</span>
+86:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+87:             <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">yield</span>
+88:             <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">res</span>, <span class="ruby-identifier">expiry</span>)
+89:           <span class="ruby-keyword kw">end</span>
+90:         <span class="ruby-keyword kw">end</span>
+91:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -263,10 +260,10 @@ Example:
             onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000051-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 115</span>
-115:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
-116:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">expire_all</span>
-117:       <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 112</span>
+112:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
+113:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">expire_all</span>
+114:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html

@@ -121,10 +121,10 @@ Deletes an object from the cache for a given key.
             onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000053-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 191</span>
-191:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_from_cache</span>(<span class="ruby-identifier">key</span>)
-192:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
-193:       <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 185</span>
+185:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_from_cache</span>(<span class="ruby-identifier">key</span>)
+186:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+187:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -141,19 +141,16 @@ Deletes an object from the cache for a given key.
       
         <div class="method-description">
           <p>
-Returns an object from the cache for a given key. If the object returned is
-nil and the self_populate parameter is true then the key will be used to
-try and find the object in the database, set the object into the cache, and
-then return the object.
+Returns an object from the cache for a given key.
 </p>
           <p><a class="source-toggle" href="#"
             onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000052-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 186</span>
-186:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_from_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-187:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-188:       <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 180</span>
+180:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_from_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+181:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+182:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -176,10 +173,10 @@ Sets an object into the cache for a given key.
             onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000054-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 196</span>
-196:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_into_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
-197:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>)
-198:       <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/cachetastic_cacheable.rb, line 190</span>
+190:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_into_cache</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span> = <span class="ruby-value">0</span>)
+191:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry</span>)
+192:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/Cachetastic/Caches/Base.html

@@ -373,7 +373,7 @@ results of the block are not automatically cached.
           <div class="method-source-code" id="M000057-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/caches/cachetastic_caches_base.rb, line 58</span>
-58:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
+58:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 59:       <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">nil</span>
 60:       <span class="ruby-identifier">do_with_logging</span>(<span class="ruby-identifier">:get</span>, <span class="ruby-identifier">key</span>) <span class="ruby-keyword kw">do</span>
 61:         <span class="ruby-identifier">retryable</span>(<span class="ruby-identifier">:on</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">ArgumentError</span>) <span class="ruby-keyword kw">do</span>

data/doc/created.rid

@@ -1 +1 @@
-Tue, 03 Jun 2008 17:30:28 -0400
+Wed, 04 Jun 2008 10:11:52 -0400

data/doc/files/lib/caches/cachetastic_caches_base_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jun 03 13:14:49 -0400 2008</td>
+      <td>Wed Jun 04 10:11:36 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic_cacheable_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jun 03 17:28:04 -0400 2008</td>
+      <td>Wed Jun 04 10:11:36 -0400 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jun 03 16:59:08 -0400 2008</td>
+      <td>Wed Jun 04 10:11:36 -0400 2008</td>
     </tr>
     </table>
   </div>
@@ -186,6 +186,7 @@ The server takes to command line parameters: -h &lt;host&gt; -p
       zlib&nbsp;&nbsp;
       pp&nbsp;&nbsp;
       drb&nbsp;&nbsp;
+      mack_ruby_core_extensions&nbsp;&nbsp;
       application_configuration&nbsp;&nbsp;
       memcache&nbsp;&nbsp;
       </div>

data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jun 03 17:25:57 -0400 2008</td>
+      <td>Wed Jun 04 10:11:36 -0400 2008</td>
     </tr>
     </table>
   </div>

data/lib/caches/cachetastic_caches_base.rb

@@ -55,7 +55,7 @@ class Cachetastic::Caches::Base
     # will be run. This can be used to JIT caches, just make
     # sure in the block to call the set method because the
     # results of the block are not automatically cached.
-    def get(key)
+    def get(key, &block)
       res = nil
       do_with_logging(:get, key) do
         retryable(:on => ArgumentError) do

data/lib/cachetastic.rb

@@ -6,6 +6,7 @@ require 'yaml'
 require 'zlib'
 require 'pp'
 require 'drb'
+require 'mack_ruby_core_extensions'
 require 'application_configuration'
 begin
   require 'memcache'
@@ -13,7 +14,7 @@ rescue Exception => e
   # if you don't have memcache installed, don't 
   # blow up, print a message, and you can't use
   # the memcache adapter.
-  puts e.message
+  puts "Warning: You don't have the memcache gem installed which means you can't use the Cachetastic::Adapters::Memcache adapter."
 end
 
 

data/lib/cachetastic_cacheable.rb

@@ -1,8 +1,5 @@
 module Cachetastic
   # Include this module into an Object to achieve simplistic Object level caching.
-  # When including this module you *MUST* create an instance level method called cachetastic_key and 
-  # have it return a valid key! If you return nil from the cachetastic_key method you will not be
-  # able to use the cache_self and uncache_self methods.
   # 
   # Example:
   #   class Person
@@ -74,16 +71,16 @@ module Cachetastic
       #     end
       #   end
       # 
-      # Person.new.always_the_same(1,2) # => 3
-      # Person.new.always_the_same(2,2) # => 3
-      # Person.new.always_the_same(3,3) # => 3
-      # Person.cacher("always_the_same") # => 3
-      # Person.get_from_cache("always_the_same") # => 3
-      # Cachetastic::Cacheable::PersonCache.get("always_the_same") # => 3
-      # 
-      # Person.cacher("say_hi") {"Hi There"} # => "Hi There"
-      # Person.get_from_cache("say_hi") # => "Hi There"
-      # Cachetastic::Cacheable::PersonCache.get("say_hi") # => "Hi There"
+      #   Person.new.always_the_same(1,2) # => 3
+      #   Person.new.always_the_same(2,2) # => 3
+      #   Person.new.always_the_same(3,3) # => 3
+      #   Person.cacher("always_the_same") # => 3
+      #   Person.get_from_cache("always_the_same") # => 3
+      #   Cachetastic::Cacheable::PersonCache.get("always_the_same") # => 3
+      #   
+      #   Person.cacher("say_hi") {"Hi There"} # => "Hi There"
+      #   Person.get_from_cache("say_hi") # => "Hi There"
+      #   Cachetastic::Cacheable::PersonCache.get("say_hi") # => "Hi There"
       def cacher(key, expiry = 0)
         cache_class.get(key) do
           if block_given?
@@ -123,7 +120,7 @@ module Cachetastic
     # Unless the object's cachetastic_key method returns nil this method will store
     # the object in the cache using the object's cachetastic_key as the key.
     # You *MUST* create an instance level method called cachetastic_key and 
-    # have it return a valid key! If you return nil from the cachetastic_key method you will not be
+    # have it return a valid key! If you return nil from the cachetastic_key method or you will not be
     # able to use the cache_self and uncache_self methods.
     # 
     # Example:
@@ -147,7 +144,7 @@ module Cachetastic
     # Unless the object's cachetastic_key method returns nil this method will delete
     # the object in the cache using the object's cachetastic_key as the key.
     # You *MUST* create an instance level method called cachetastic_key and 
-    # have it return a valid key! If you return nil from the cachetastic_key method you will not be
+    # have it return a valid key! If you return nil from the cachetastic_key method or you will not be
     # able to use the cache_self and uncache_self methods.
     # 
     # Example:
@@ -180,9 +177,6 @@ module Cachetastic
     
     module ClassOnlyMethods
       # Returns an object from the cache for a given key.
-      # If the object returned is nil and the self_populate parameter is true
-      # then the key will be used to try and find the object in the database,
-      # set the object into the cache, and then return the object.
       def get_from_cache(key, &block)
         cache_class.get(key, &block)
       end

data/lib/rails_extensions/cachetastic_active_record_base.rb

@@ -6,6 +6,10 @@ class ActiveRecord::Base
     self.id
   end
   
+  # Returns an object from the cache for a given key.
+  # If the object returned is nil and the self_populate parameter is true
+  # then the key will be used to try and find the object in the database,
+  # set the object into the cache, and then return the object.
   def self.get_from_cache(key, self_populate = false)
     res = cache_class.get(key)
     if res.nil? && self_populate

data/test/cacheable_test.rb

@@ -67,6 +67,10 @@ class CacheableTest < Test::Unit::TestCase
   def test_get_from_cache
     assert_nil Person.get_from_cache("i should be nil")
     assert_equal 86, Person.get_from_cache("maxwell smart") {86}
+    x = Person.get_from_cache("my name") do |key|
+      "Mark Bates"
+    end
+    assert_equal "Mark Bates", x
   end
   
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: cachetastic
 version: !ruby/object:Gem::Version 
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors: 
 - markbates
-autorequire: cachetastic
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-03 00:00:00 -04:00
+date: 2008-06-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,8 +36,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - lib/adapters/cachetastic_adapters_base.rb
 - lib/adapters/cachetastic_adapters_drb.rb
@@ -108,7 +108,7 @@ files:
 - doc/fr_method_index.html
 - doc/index.html
 - doc/rdoc-style.css
-has_rdoc: false
+has_rdoc: true
 homepage: http://www.mackframework.com
 post_install_message: 
 rdoc_options: []
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: magrathea
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2