RubyGems - cachetastic - Versions diffs - 3.0.0 → 3.0.1 - Mend

cachetastic 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/lib/cachetastic.rb +1 -1
metadata +2 -30
data/doc/classes/Cachetastic/Adapters.html +0 -180
data/doc/classes/Cachetastic/Adapters/Base.html +0 -419
data/doc/classes/Cachetastic/Adapters/File.html +0 -135
data/doc/classes/Cachetastic/Adapters/LocalMemory.html +0 -125
data/doc/classes/Cachetastic/Adapters/Memcached.html +0 -193
data/doc/classes/Cachetastic/Cache.html +0 -425
data/doc/classes/Cachetastic/Cacheable.html +0 -255
data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html +0 -290
data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html +0 -197
data/doc/classes/Cachetastic/Logger.html +0 -186
data/doc/created.rid +0 -1
data/doc/files/LICENSE.html +0 -132
data/doc/files/README.html +0 -222
data/doc/files/lib/cachetastic/adapters/base_rb.html +0 -101
data/doc/files/lib/cachetastic/adapters/file_rb.html +0 -101
data/doc/files/lib/cachetastic/adapters/local_memory_rb.html +0 -101
data/doc/files/lib/cachetastic/adapters/memcached_rb.html +0 -101
data/doc/files/lib/cachetastic/cache_rb.html +0 -101
data/doc/files/lib/cachetastic/cacheable_rb.html +0 -101
data/doc/files/lib/cachetastic/extensions/string_rb.html +0 -108
data/doc/files/lib/cachetastic/logger_rb.html +0 -101
data/doc/files/lib/cachetastic/store_object_rb.html +0 -101
data/doc/files/lib/cachetastic_rb.html +0 -112
data/doc/fr_class_index.html +0 -36
data/doc/fr_file_index.html +0 -38
data/doc/fr_method_index.html +0 -52
data/doc/index.html +0 -24
data/doc/rdoc-style.css +0 -208

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

@@ -1,290 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Module: Cachetastic::Cacheable::ClassAndInstanceMethods</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Cachetastic::Cacheable::ClassAndInstanceMethods</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/cachetastic/cacheable_rb.html">
-                lib/cachetastic/cacheable.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000015">cache_class</a>&nbsp;&nbsp;
-      <a href="#M000016">cacher</a>&nbsp;&nbsp;
-      <a href="#M000017">expire_all</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000015" class="method-detail">
-        <a name="M000015"></a>
-        <div class="method-heading">
-          <a href="#M000015" class="method-signature">
-          <span class="method-name">cache_class</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns the <a href="../Cache.html">Cachetastic::Cache</a> object
-associated with the object. If a cache hasn&#8216;t been defined the one
-will be created on the fly. The cache for the object is expected to be
-defined as: <a
-href="../Cacheable.html">Cachetastic::Cacheable</a>::{CLASS_NAME_HERE}<a
-href="../Cache.html">Cache</a>
-</p>
-<p>
-Examples:
-</p>
-<pre>
-  class Person
-    include Cachetastic::Cacheable
-  end
- Person.cache_class # =&gt; Cachetastic::Cacheable::PersonCache
-  class Admin::Person
-    include Cachetastic::Cacheable
-  end
- Admin::Person.cache_class # =&gt; Cachetastic::Cacheable::Admin_PersonCache
-</pre>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000015-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic/cacheable.rb, line 41</span>
-41:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cache_class</span>
-42:         <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>
-43:         <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>
-44:         <span class="ruby-identifier">c_name</span> = <span class="ruby-node">&quot;Cachetastic::Cacheable::#{n.gsub('::', '_')}Cache&quot;</span>
-45:         <span class="ruby-keyword kw">begin</span>
-46:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">c_name</span>.<span class="ruby-identifier">constantize</span>
-47:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
-48:           <span class="ruby-identifier">eval</span> <span class="ruby-node">%{
-49:             class #{c_name} &lt; Cachetastic::Cache
-50:
-51:               def self.cache_klass
-52:                 #{n}
-53:               end
-54:
-55:             end
-56:           }</span>
-57:           <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">c_name</span>.<span class="ruby-identifier">constantize</span>
-58:         <span class="ruby-keyword kw">end</span>
-59:
-60:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000016" class="method-detail">
-        <a name="M000016"></a>
-        <div class="method-heading">
-          <a href="#M000016" class="method-signature">
-          <span class="method-name">cacher</span><span class="method-args">(key, expiry = nil) {|| ...}</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-How much did I want to call this method cache?? It originally was that, but
-in Rails 2.0 they decided to use that name, so I had to rename this method.
-This method will attempt to get an object from the cache for a given key.
-If the object is nil and a block is given the block will be run, and the
-results of the block will be automatically cached.
-</p>
-<p>
-Example:
-</p>
-<pre>
-  class Person
-    include Cachetastic::Cacheable
-    def always_the_same(x,y)
-      cacher(&quot;always_the_same&quot;) do
-        x + y
-      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><a class="source-toggle" href="#"
-            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000016-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cachetastic/cacheable.rb, line 89</span>
-89:       <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-keyword kw">nil</span>)
-90:         <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>
-91:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-92:             <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">yield</span>
-93:             <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>)
-94:           <span class="ruby-keyword kw">end</span>
-95:         <span class="ruby-keyword kw">end</span>
-96:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000017" class="method-detail">
-        <a name="M000017"></a>
-        <div class="method-heading">
-          <a href="#M000017" class="method-signature">
-          <span class="method-name">expire_all</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Expires the entire cache associated with this objects&#8216;s cache.
-</p>
-<p>
-Example:
-</p>
-<pre>
-  class Person
-    include Cachetastic::Cacheable
-    attr_accessor :name
-    def cachetastic_key
-      self.name
-    end
-  end
-  Person.set_into_cache(1, &quot;one&quot;)
-  Person.get_from_cache(1) # =&gt; &quot;one&quot;
-  Person.expire_all
-  Person.get_from_cache(1) # =&gt; nil
-  Person.set_into_cache(1, &quot;one&quot;)
-  Person.get_from_cache(1) # =&gt; &quot;one&quot;
-  Cachetastic::Cacheable::PersonCache.expire_all
-  Person.get_from_cache(1) # =&gt; nil
-</pre>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000017-source">
-<pre>
-     <span class="ruby-comment cmt"># File lib/cachetastic/cacheable.rb, line 117</span>
-117:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
-118:         <span class="ruby-identifier">cache_class</span>.<span class="ruby-identifier">expire_all</span>
-119:       <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>

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

@@ -1,197 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Module: Cachetastic::Cacheable::ClassOnlyMethods</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Cachetastic::Cacheable::ClassOnlyMethods</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/cachetastic/cacheable_rb.html">
-                lib/cachetastic/cacheable.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000013">delete_from_cache</a>&nbsp;&nbsp;
-      <a href="#M000012">get_from_cache</a>&nbsp;&nbsp;
-      <a href="#M000014">set_into_cache</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
-        <div class="method-heading">
-          <a href="#M000013" class="method-signature">
-          <span class="method-name">delete_from_cache</span><span class="method-args">(key)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Deletes an object from the cache for a given key.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000013-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>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-        <div class="method-heading">
-          <a href="#M000012" class="method-signature">
-          <span class="method-name">get_from_cache</span><span class="method-args">(key, &amp;block)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns an object from the cache for a given key.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000012-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>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000014" class="method-detail">
-        <a name="M000014"></a>
-        <div class="method-heading">
-          <a href="#M000014" class="method-signature">
-          <span class="method-name">set_into_cache</span><span class="method-args">(key, value, expiry = 0)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Sets an object into the cache for a given key.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000014-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>
-</pre>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-</body>
-</html>