cachetastic-three 3.0.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Mark Bates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,89 @@
+=What is Cachetastic?
+Cachetastic is an incredibly easy to use and administer caching framework. Just because it is easy to use, does not mean that
+it is light with features. Cachetastic allows you to create classes that extend <tt>Cachetastic::Cache</tt>, configure them
+each individually, and much more.
+
+Unlike other systems each cache in your system can use different backends via the use of adapters that get assigned to each
+cache, and globally. You can define different expiration times, loggers, marshal methods, and more! And again, you can choose to 
+define these settings globally, or for each cache!
+
+Adapters are easy to write, so if the built in adapters don't float your boat, you can easily knock one off in short order.
+
+==Configuration:
+Configuration of Cachetastic is done using the Configatron gem. I would recommend reading the documentation on it first, http://configatron.mackframework.com, before continuing.
+
+All configuration settings hang off of the <tt>cachetastic</tt> namespace on <tt>configatron</tt>. The default settings
+all hang off the <tt>defaults</tt> namespace on the <tt>cachetastic</tt> namespace, as shown below:
+
+  # This will write detailed information to the logger.
+  configatron.cachetastic.defaults.debug = false
+
+  # This is the type of file store to be used for this cache.
+  # More adapters can be developed and plugged in as desired.
+  # The default is Cachetastic::Adapters::LocalMemory
+  configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::LocalMemory
+  configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::File
+  configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::Memcached
+
+  # This will marshall objects into and out of the store.
+  # The default is :none, except for Cachetastic::Adapters::File, which defaults to :yaml
+  configatron.cachetastic.defaults.marshall_method = :none
+  configatron.cachetastic.defaults.marshall_method = :yaml
+  configatron.cachetastic.defaults.marshall_method = :ruby
+
+  # This sets how long objects will live in the cache before they are auto expired.
+  configatron.cachetastic.defaults.default_expiry = 86400 # time in seconds (default: 24 hours)
+
+  # When setting objects into the cache the expiry_swing is +/- to the expiry time.
+  # Example: if the expiry time is 1 minute, and the swing is 15 seconds,
+  # objects will go into the cache with an expiry time sometime between 45 seconds and 75 seconds.
+  # The default is 0 seconds.
+  configatron.cachetastic.defaults.expiry_swing = 15
+
+  # Configure logging for the system.
+  # n number of logs can be configured for a cache.
+  log_1 = Logger.new(STDOUT)
+  log_1.level = Logger::DEBUG
+  log_2 = Logger.new("log/cachetastic.log")
+  log_2.level = Logger::ERROR
+  configatron.cachetastic.defaults.logger = [log_1, log_2]
+    
+Overriding settings per cache is very simple. Let's take the following two caches:
+
+  class UserCache < Cachetastic::Cache
+  end
+
+  class Admin::UserCache < Cachetastic::Cache
+  end
+
+If we wanted to set the <tt>UserCache</tt> to use the <tt>Cachetastic::Adapters::File</tt> adapter and we wanted to set the adapter for 
+the <tt>Admin::UserCache</tt> to use <tt>Cachetastic::Adapters::Memcached</tt>, we would configure them like such:
+
+  configatron.cachetastic.user_cache.adapter = Cachetastic::Adapters::File
+  configatron.cachetastic.admin.user_cache.adapter = Cachetastic::Adapters::Memcached
+  
+In this scenario we have changed the adapters for each of the classes. All of the other default settings will remain intact for
+each of those classes. This makes it incredibly easy to just change the one parameter you need, and not have to reset them all.
+    
+==Examples:
+
+  class MyAwesomeCache < Cachetastic::Cache
+  end
+  
+  MyAwesomeCache.set(1, [1,2,3])
+  MyAwesomeCache.get(1) # => [1,2,3] 
+  
+  class MyAwesomeCache < Cachetastic::Cache
+    class << self
+      def get(key, x, y)
+        super(key) do
+          n = x + y
+          set(key, n)
+          n
+        end
+      end
+    end
+  end
+  
+  MyAwesomeCache.get(1, 2, 4) # => 8
+  MyAwesomeCache.get(1, 4, 4) # => 8

data/doc/classes/Cachetastic/Adapters.html

@@ -0,0 +1,180 @@
+<?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::Adapters</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::Adapters</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/cachetastic/adapters/base_rb.html">
+                lib/cachetastic/adapters/base.rb
+                </a>
+        <br />
+                <a href="../../files/lib/cachetastic/adapters/file_rb.html">
+                lib/cachetastic/adapters/file.rb
+                </a>
+        <br />
+                <a href="../../files/lib/cachetastic/adapters/local_memory_rb.html">
+                lib/cachetastic/adapters/local_memory.rb
+                </a>
+        <br />
+                <a href="../../files/lib/cachetastic/adapters/memcached_rb.html">
+                lib/cachetastic/adapters/memcached.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="#M000001">build</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="Adapters/Base.html" class="link">Cachetastic::Adapters::Base</a><br />
+Class <a href="Adapters/File.html" class="link">Cachetastic::Adapters::File</a><br />
+Class <a href="Adapters/LocalMemory.html" class="link">Cachetastic::Adapters::LocalMemory</a><br />
+Class <a href="Adapters/Memcached.html" class="link">Cachetastic::Adapters::Memcached</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">build</span><span class="method-args">(klass)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This method will return the appropriate <tt><a
+href="Adapters/Base.html">Cachetastic::Adapters::Base</a></tt> class that
+is defined for the Class passed in. If an adapter has not been defined for
+the Class than the default adapter is returned.
+</p>
+<p>
+Examples:
+</p>
+<pre>
+  configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::LocalMemory
+  configatron.cachetastic.user.adapter = Cachetastic::Adapters::Memcached
+  Cachetastic::Adapters.build(User).class # =&gt; Cachetastic::Adapters::Memcached
+  Cachetastic::Adapters.build(Comment).class # =&gt; Cachetastic::Adapters::LocalMemory
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 16</span>
+16:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>(<span class="ruby-identifier">klass</span>)
+17:         <span class="ruby-identifier">adp</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_configatron</span>(<span class="ruby-identifier">:cachetastic</span>).<span class="ruby-identifier">adapter</span>
+18:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">adp</span>.<span class="ruby-identifier">nil?</span>
+19:           <span class="ruby-identifier">adp</span> = <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">cachetastic</span>.<span class="ruby-identifier">defaults</span>.<span class="ruby-identifier">adapter</span>
+20:         <span class="ruby-keyword kw">end</span>
+21:         <span class="ruby-identifier">adp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">klass</span>)
+22:       <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/Adapters/Base.html

@@ -0,0 +1,419 @@
+<?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::Adapters::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::Adapters::Base</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/cachetastic/adapters/base_rb.html">
+                lib/cachetastic/adapters/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>
+This class should be extended to create <a href="Base.html#M000003">new</a>
+adapters for various backends. It is important that all subclasses call the
+<tt>initialize</tt> method in this base, otherwise things just will not
+work right.
+</p>
+<p>
+This base class provides common functionality and an API for all adapters
+to be used with Cachetastic.
+</p>
+<p>
+The default settings for all adapters are:
+</p>
+<pre>
+  configatron.cachetastic.defaults.marshal_method = :none
+  configatron.cachetastic.defaults.expiry_swing = 0
+  configatron.cachetastic.defaults.default_expiry = 86400
+  configatron.cachetastic.defaults.debug = true
+  configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::LocalMemory
+  logger = ::Logger.new(File.join(FileUtils.pwd, 'log', 'cachetastic.log'))
+  logger.level = ::Logger::DEBUG
+  configatron.cachetastic.defaults.logger = logger
+</pre>
+<p>
+See the README for more information on what each of those settings mean,
+and what are values may be used for each one.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000006">delete</a>&nbsp;&nbsp;
+      <a href="#M000007">expire_all</a>&nbsp;&nbsp;
+      <a href="#M000004">get</a>&nbsp;&nbsp;
+      <a href="#M000003">new</a>&nbsp;&nbsp;
+      <a href="#M000005">set</a>&nbsp;&nbsp;
+      <a href="#M000008">transform_key</a>&nbsp;&nbsp;
+      <a href="#M000009">valid?</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">klass</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+The Class that this adapter is associated with. Note that it is a
+<em>class</em> reference and not an instance reference.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(klass)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a <a href="Base.html#M000003">new</a> adapter. It takes a class
+reference to tie the instance of the adapter to a particular class. Note
+that it is a <em>class</em> reference and not an instance reference.
+</p>
+<p>
+Examples:
+</p>
+<pre>
+  Cachetastic::Adapters::Base.new(User)
+</pre>
+<p>
+<a href="../Adapters.html">Adapters</a> are configured using the
+Configatron gem.
+</p>
+<p>
+Examples:
+</p>
+<pre>
+  configatron.cachetastic.user.adapter = Cachetastic::Adapters::File
+  configatron.cachetastic.user.expiry_time = 5.hours
+  configatron.cachetastic.defaults.expiry_time = 24.hours
+</pre>
+<p>
+Refered to each adapter for its specific configuration settings.
+</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/cachetastic/adapters/base.rb, line 67</span>
+67:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">klass</span>)
+68:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">klass</span> = <span class="ruby-identifier">klass</span>
+69:         <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">cachetastic</span>.<span class="ruby-identifier">defaults</span>.<span class="ruby-identifier">configatron_keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
+70:           <span class="ruby-identifier">define_accessor</span>(<span class="ruby-identifier">key</span>)
+71:           <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{key}=&quot;</span>, <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">cachetastic</span>.<span class="ruby-identifier">defaults</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">key</span>))
+72:         <span class="ruby-keyword kw">end</span>
+73:         <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_configatron</span>(<span class="ruby-identifier">:cachetastic</span>).<span class="ruby-identifier">configatron_keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
+74:           <span class="ruby-identifier">define_accessor</span>(<span class="ruby-identifier">key</span>)
+75:           <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{key}=&quot;</span>, <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_configatron</span>(<span class="ruby-identifier">:cachetastic</span>).<span class="ruby-identifier">send</span>(<span class="ruby-identifier">key</span>))
+76:         <span class="ruby-keyword kw">end</span>
+77:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">delete</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<b>This method MUST be implemented by a subclass!</b>
+</p>
+<p>
+The implementation of this method should take a key and remove an object,
+if it exists, from an underlying persistence store.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 101</span>
+101:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+102:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'delete'</span>)
+103:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">expire_all</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<b>This method MUST be implemented by a subclass!</b>
+</p>
+<p>
+The implementation of this method is expected to <a
+href="Base.html#M000006">delete</a> all objects belonging to the associated
+cache from the underlying persistence store. It is <b>NOT</b> meant to <a
+href="Base.html#M000006">delete</a> <b>ALL</b> objects across <b>ALL</b>
+caches for the underlying persistence store. That would be very very bad!!
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 112</span>
+112:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expire_all</span>
+113:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'expire_all'</span>)
+114:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">get</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<b>This method MUST be implemented by a subclass!</b>
+</p>
+<p>
+The implementation of this method should take a key and return an
+associated object, if available, from the underlying persistence layer.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 84</span>
+84:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
+85:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'get'</span>)
+86:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">set</span><span class="method-args">(key, value, expiry_time = configatron.cachetastic.defaults.default_expiry)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<b>This method MUST be implemented by a subclass!</b>
+</p>
+<p>
+The implementation of this method should take a key, a value, and an expiry
+time and save it to the persistence store, where it should live until it is
+either deleted by the user of the expiry time has passed.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 93</span>
+93:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">expiry_time</span> = <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">cachetastic</span>.<span class="ruby-identifier">defaults</span>.<span class="ruby-identifier">default_expiry</span>)
+94:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'set'</span>)
+95:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">transform_key</span><span class="method-args">(key)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Allows an adapter to transform the key to a safe representation for
+it&#8216;s backend. For example, the key: &#8217;$*&#8230;123()%~q&#8217;
+is not a key for the file system, so the <a
+href="File.html">Cachetastic::Adapters::File</a> class should override this
+to make it safe for the file system.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 122</span>
+122:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transform_key</span>(<span class="ruby-identifier">key</span>)
+123:         <span class="ruby-identifier">key</span>
+124:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">valid?</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+<b>This method MUST be implemented by a subclass!</b>
+</p>
+<p>
+The implementation of this method should return <tt>true</tt> if the
+adapter is in a valid state, and <tt>false</tt> if it is not.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/cachetastic/adapters/base.rb, line 131</span>
+131:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
+132:         <span class="ruby-keyword kw">true</span>
+133:       <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>