RubyGems - cachetastic - Versions diffs - 1.2.3 → 1.2.7.1 - Mend

cachetastic 1.2.3 → 1.2.7.1

Files changed (105) hide show

data/doc/classes/Cachetastic/Adapters/Memcache.src/M000013.html DELETED Viewed

@@ -1,24 +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>
-<head>
-  <title>valid? (Cachetastic::Adapters::Memcache)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 47</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
-    <span class="ruby-keyword kw">begin</span>
-      <span class="ruby-keyword kw">return</span> (<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">conn</span>.<span class="ruby-identifier">active?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_version</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>))
-    <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
-      <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
-      <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
-      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
-    <span class="ruby-keyword kw">end</span>
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/Cachetastic/Adapters/Memcache.src/M000014.html DELETED Viewed

@@ -1,19 +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>
-<head>
-  <title>namespace (Cachetastic::Adapters::Memcache)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 61</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">namespace</span>
-    <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_version</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>)
-    <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;#{name}.#{v}&quot;</span>
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/Cachetastic/Adapters/Memcache.src/M000015.html DELETED Viewed

@@ -1,20 +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>
-<head>
-  <title>ns_versions (Cachetastic::Adapters::Memcache)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 66</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ns_versions</span>
-    <span class="ruby-identifier">ivar_cache</span> <span class="ruby-keyword kw">do</span>
-      <span class="ruby-identifier">ns_conn</span> = <span class="ruby-constant">MemCache</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">servers</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">store_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-identifier">:namespace</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:namespace_versions</span>}))
-    <span class="ruby-keyword kw">end</span>
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/Cachetastic/Adapters/Memcache.src/M000016.html DELETED Viewed

@@ -1,20 +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>
-<head>
-  <title>increment_version (Cachetastic::Adapters::Memcache)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 72</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">increment_version</span>(<span class="ruby-identifier">name</span>)
-    <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
-    <span class="ruby-identifier">v</span> = <span class="ruby-identifier">get_version</span>(<span class="ruby-identifier">name</span>)
-    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">v</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/Cachetastic/Adapters/Memcache.src/M000017.html DELETED Viewed

@@ -1,24 +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>
-<head>
-  <title>get_version (Cachetastic::Adapters::Memcache)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/adapters/cachetastic_adapters_memcache.rb, line 78</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_version</span>(<span class="ruby-identifier">name</span>)
-    <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
-    <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>)
-    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
-      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-value">1</span>)
-      <span class="ruby-identifier">v</span> = <span class="ruby-value">1</span>
-    <span class="ruby-keyword kw">end</span>
-    <span class="ruby-identifier">v</span>
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

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

@@ -1,441 +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>Class: Cachetastic::Caches::Base</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>Class</strong></td>
-          <td class="class-name-in-header">Cachetastic::Caches::Base</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/caches/cachetastic_caches_base_rb.html">
-                lib/caches/cachetastic_caches_base.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <p>
-When creating a new &#8216;Cache&#8217; this class should be extended. Once
-extended you&#8216;ll only need to override just the methods that are
-different for your cache.
-</p>
-<pre>
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
-  end
-  MyAwesomeCache.set(1, &quot;One&quot;)
-  MyAwesomeCache.get(1) # =&gt; &quot;One&quot;
-  MyAwesomeCache.update(1, &quot;One!!&quot;)
-  MyAwesomeCache.get(1) # =&gt; &quot;One!!&quot;
-  MyAwesomeCache.delete(1)
-  MyAwesomeCache.get(1) # =&gt; nil
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
-    class &lt;&lt; self
-      def get(key)
-        super(key) do
-          set(key, key * 10)
-        end
-      end
-    end
-  end
-  MyAwesomeCache.set(1, &quot;One&quot;)
-  MyAwesomeCache.get(1) # =&gt; &quot;One&quot;
-  MyAwesomeCache.delete(1)
-  MyAwesomeCache.get(1) # =&gt; 10
-</pre>
-    </div>
-   </div>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000048">adapter</a>&nbsp;&nbsp;
-      <a href="#M000051">adapter_supported?</a>&nbsp;&nbsp;
-      <a href="#M000040">all_registered_caches</a>&nbsp;&nbsp;
-      <a href="#M000047">cache_name</a>&nbsp;&nbsp;
-      <a href="#M000052">calculate_expiry_time</a>&nbsp;&nbsp;
-      <a href="#M000043">delete</a>&nbsp;&nbsp;
-      <a href="#M000044">expire_all</a>&nbsp;&nbsp;
-      <a href="#M000041">get</a>&nbsp;&nbsp;
-      <a href="#M000049">logger</a>&nbsp;&nbsp;
-      <a href="#M000045">populate_all</a>&nbsp;&nbsp;
-      <a href="#M000042">set</a>&nbsp;&nbsp;
-      <a href="#M000046">stats</a>&nbsp;&nbsp;
-      <a href="#M000050">unsupported_adapters</a>&nbsp;&nbsp;
-      </div>
-    </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-      Class <a href="Base/RegisteredCaches.html" class="link">Cachetastic::Caches::Base::RegisteredCaches</a><br />
-    </div>
-    <div id="aliases-list">
-      <h3 class="section-bar">External Aliases</h3>
-      <div class="name-list">
-                        <table summary="aliases">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">set</td>
-          <td>-&gt;</td>
-          <td class="context-item-value">put</td>
-        </tr>
-                        </table>
-      </div>
-    </div>
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000048" class="method-detail">
-        <a name="M000048"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000048.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000048.html');return false;">
-          <span class="method-name">adapter</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns the underlying <a
-href="../Adapters/Base.html">Cachetastic::Adapters::Base</a> for this
-cache.
-</p>
-        </div>
-      </div>
-      <div id="method-M000051" class="method-detail">
-        <a name="M000051"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000051.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000051.html');return false;">
-          <span class="method-name">adapter_supported?</span><span class="method-args">(a = cache_conn_instance.get(cache_name).class)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns true/false on whether the <a href="Base.html#M000048">adapter</a>
-you want to use is supported for the cache.
-</p>
-        </div>
-      </div>
-      <div id="method-M000040" class="method-detail">
-        <a name="M000040"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000040.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000040.html');return false;">
-          <span class="method-name">all_registered_caches</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns a list of all registered caches in the system.
-</p>
-        </div>
-      </div>
-      <div id="method-M000047" class="method-detail">
-        <a name="M000047"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000047.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000047.html');return false;">
-          <span class="method-name">cache_name</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns a &#8216;methodize&#8217; version of the cache&#8216;s class name.
-This gets used in logging, namespacing, and as the key in the <a
-href="../Connection.html">Cachetastic::Connection</a> class.
-</p>
-<pre>
-  MyAwesomeCache.cache # =&gt; &quot;my_awesome_cache&quot;
-  Cachetastic::Caches::Base # =&gt; &quot;cachetastic_caches_base&quot;
-</pre>
-        </div>
-      </div>
-      <div id="method-M000043" class="method-detail">
-        <a name="M000043"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000043.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000043.html');return false;">
-          <span class="method-name">delete</span><span class="method-args">(key, delay = 0)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Deletes an object from the cache. The optional delay parameter sets an
-offset, in seconds, for when the object should <a
-href="Base.html#M000041">get</a> deleted. The default of 0 means the object
-gets deleted right away.
-</p>
-        </div>
-      </div>
-      <div id="method-M000044" class="method-detail">
-        <a name="M000044"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000044.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000044.html');return false;">
-          <span class="method-name">expire_all</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Expires all objects for this cache.
-</p>
-        </div>
-      </div>
-      <div id="method-M000041" class="method-detail">
-        <a name="M000041"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000041.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000041.html');return false;">
-          <span class="method-name">get</span><span class="method-args">(key) {|key if block_given?| ...}</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns an object from the cache for a given key. If the object comes back
-as nil and a block is given that block will be run and the results of the
-block will be run. This can be used to JIT caches, just make sure in the
-block to call the <a href="Base.html#M000042">set</a> method because the
-results of the block are not automatically cached.
-</p>
-        </div>
-      </div>
-      <div id="method-M000049" class="method-detail">
-        <a name="M000049"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000049.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000049.html');return false;">
-          <span class="method-name">logger</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns the <a href="../Logger.html">Cachetastic::Logger</a> for the
-underlying <a href="../Adapters/Base.html">Cachetastic::Adapters::Base</a>.
-</p>
-        </div>
-      </div>
-      <div id="method-M000045" class="method-detail">
-        <a name="M000045"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000045.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000045.html');return false;">
-          <span class="method-name">populate_all</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Raises a MethodNotImplemented exception. This method should be overridden
-in the child class to enable a populating the cache with all things that
-should be in there.
-</p>
-        </div>
-      </div>
-      <div id="method-M000042" class="method-detail">
-        <a name="M000042"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000042.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000042.html');return false;">
-          <span class="method-name">set</span><span class="method-args">(key, value, expiry = (adapter.all_options[&quot;default_expiry&quot;] || 0))</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Set a particular object info the cache for the given key. An optional third
-parameter sets the expiry time for the object in the cache. The default for
-this expiry is <a href="Base.html#M000042">set</a> as either 0, meaning it
-never expires, or if there&#8216;s a default_expiry time <a
-href="Base.html#M000042">set</a> in the config file, that file will be
-used. If there is an expiry_swing <a href="Base.html#M000042">set</a> in
-the config file it will be +/- to the expiry time. See also: <a
-href="Base.html#M000052">calculate_expiry_time</a>
-</p>
-        </div>
-      </div>
-      <div id="method-M000046" class="method-detail">
-        <a name="M000046"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000046.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000046.html');return false;">
-          <span class="method-name">stats</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-A convenience method that returns statistics for the underlying <a
-href="../Adapters/Base.html">Cachetastic::Adapters::Base</a> for the cache.
-</p>
-        </div>
-      </div>
-      <div id="method-M000050" class="method-detail">
-        <a name="M000050"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000050.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000050.html');return false;">
-          <span class="method-name">unsupported_adapters</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Returns an array of unsupported adapters for this cache. Defaults to an
-empty array which will let any <a href="Base.html#M000048">adapter</a> be
-used by the cache. Override in your specific cache to prevent certain
-adapters.
-</p>
-        </div>
-      </div>
-      <h3 class="section-bar">Private Class methods</h3>
-      <div id="method-M000052" class="method-detail">
-        <a name="M000052"></a>
-        <div class="method-heading">
-          <a href="Base.src/M000052.html" target="Code" class="method-signature"
-            onclick="popupCode('Base.src/M000052.html');return false;">
-          <span class="method-name">calculate_expiry_time</span><span class="method-args">(expiry)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-If the expiry time is <a href="Base.html#M000042">set</a> to 60 minutes and
-the expiry_swing time is <a href="Base.html#M000042">set</a> to 15 minutes,
-this method will return a number between 45 minutes and 75 minutes.
-</p>
-        </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>