cachetastic 2.1.4 → 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

@@ -1,65 +1,79 @@
-=Configuration:
+=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.
 
-    # this will dump into the log, configuration info for each cache, as well as the .inspect
-    # for each object returned from the cache
-    configatron.cachetastic_default_options.debug = false
+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!
 
-    # this is the type of file store to be used for this cache.
-    # more adapters can be developed and plugged in as desired
-    configatron.cachetastic_default_options.adapter = :local_memory # local_memory | memcache | file | drb | html_file (default: local_memory)
+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.
 
-    # this will marshall objects into and out of the store.
-    configatron.cachetastic_default_options.marshall_method = :none # none | yaml | ruby (default: none)
+==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.
 
-    # this sets how long objects will live in the cache before they are auto expired.
-    configatron.cachetastic_default_options.default_expiry = 86400 # time in seconds (default: 24 hours)
+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:
 
-    # when setting objects into the cache the expiry_swing is +/- to the expiry time.
-    # example: if the expiry time is 1 hour, and the swing is 15 minutes,
-    # objects will go into the cache with an expiry time sometime between 45 mins and 75 mins.
-    configatron.cachetastic_default_options.expiry_swing = 60 * 15 # time in seconds (default: 0)
+  # This will write detailed information to the logger.
+  configatron.cachetastic.defaults.debug = false
 
-    # these options get passed on directly to the store.
-    # listed below are options for memcache:
-    configatron.cachetastic_default_options.store_options.c_threshold = "10_000"
-    configatron.cachetastic_default_options.store_options.compression = true
-    configatron.cachetastic_default_options.store_options.debug = false
-    configatron.cachetastic_default_options.store_options.readonly = false
-    configatron.cachetastic_default_options.store_options.urlencode = false
-    
-    # set the servers to be used for memcache
-    configatron.cachetastic_default_options.servers = ["127.0.0.1:11211"] # ip:port used for memcache
+  # 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
 
-    # listed below are the options for file:
-    configatron.cachetastic_default_options.store_options.dir = "/cachetastic/caches"
+  # 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)
 
-    # listed below are the options for drb:
-    configatron.cachetastic_default_options.servers = ["druby://127.0.0.1:61676"]
+  # 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:
 
-    # configure logging for this cache
-    # 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_default_options.logger = [log_1, log_2]
+  class UserCache < Cachetastic::Cache
+  end
+
+  class Admin::UserCache < Cachetastic::Cache
+  end
 
-=Cachetastic::Drb::Server
-If you want to use Drb and the Cachetastic::Adapters::Drb adapter, you'll have to use the Cachetastic::Drb::Server that comes with Cachetastic. Using this server is simple. It gets installed as a binary when you install the Cachetastic gem.
+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:
 
-  $ cachetastic_drb_server # that will start the drb server on the host 127.0.0.1 on the port 61676
+  configatron.cachetastic.user_cache.adapter = Cachetastic::Adapters::File
+  configatron.cachetastic.admin.user_cache.adapter = Cachetastic::Adapters::Memcached
   
-The server takes to command line parameters: -h <host> -p <port> -v <verbose> -rv <really verbose>
+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:
+==Examples:
 
-  class MyAwesomeCache < Cachetastic::Caches::Base
+  class MyAwesomeCache < Cachetastic::Cache
   end
   
   MyAwesomeCache.set(1, [1,2,3])
   MyAwesomeCache.get(1) # => [1,2,3] 
   
-  class MyAwesomeCache < Cachetastic::Caches::Base
+  class MyAwesomeCache < Cachetastic::Cache
     class << self
       def get(key, x, y)
         super(key) do

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

@@ -65,9 +65,7 @@
         <tr class="top-aligned-row">
             <td><strong>Parent:</strong></td>
             <td>
-                <a href="../../Object.html">
                 Object
-               </a>
             </td>
         </tr>
         </table>
@@ -82,40 +80,32 @@
 
     <div id="description">
       <p>
-This class is the interface used to develop adapters for stores. Stores are
-where the data is actually held. These could be local memory, memcached, a
-database, the file system, etc&#8230; If you implement this API, then you
-should be able to plug in different stores for your caches without having
-to change any of your code.
+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>
-<h3>Methods that need to be implemented:</h3>
-<ul>
-<li>setup - used to setup the implementation of the adapter.
-
-</li>
-<li>set(key, object, expiry) - sets an object into the store using the given
-key and the expiry time.
-
-</li>
-<li>get(key) - returns an object from the store for a given key.
-
-</li>
-<li>delete(key, delay) - deletes an object from the store for a given key. If
-the store supports it, a delay can be used.
-
-</li>
-<li>expire_all - expires all objects in the store for a given cache.
-
-</li>
-<li><a href="Base.html#M000037">stats</a> - returns statistics for the store.
-
-</li>
-<li>valid? - used to test whether or not the store is still valid. If this
-returns false a <a href="Base.html#M000035">new</a> instance of the adapter
-is created by <a href="../Connection.html">Cachetastic::Connection</a>
-
-</li>
-</ul>
 
     </div>
 
@@ -126,11 +116,13 @@ is created by <a href="../Connection.html">Cachetastic::Connection</a>
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000039">configuration</a>&nbsp;&nbsp;
-      <a href="#M000038">configuration</a>&nbsp;&nbsp;
-      <a href="#M000036">debug?</a>&nbsp;&nbsp;
-      <a href="#M000035">new</a>&nbsp;&nbsp;
-      <a href="#M000037">stats</a>&nbsp;&nbsp;
+      <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>
 
@@ -151,18 +143,11 @@ is created by <a href="../Connection.html">Cachetastic::Connection</a>
       <div class="name-list">
         <table>
         <tr class="top-aligned-row context-row">
-          <td class="context-item-name">logger</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc">
-attr_reader :logging
-
-</td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">name</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-name">klass</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
           <td class="context-item-desc">
-attr_reader :all_options attr_reader :store_options attr_reader :servers
+The Class that this adapter is associated with. Note that it is a
+<em>class</em> reference and not an instance reference.
 
 </td>
         </tr>
@@ -176,146 +161,244 @@ attr_reader :all_options attr_reader :store_options attr_reader :servers
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000039" class="method-detail">
-        <a name="M000039"></a>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
 
         <div class="method-heading">
-          <a href="#M000039" class="method-signature">
-          <span class="method-name">configuration</span><span class="method-args">(name)</span>
+          <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>
-Returns either the options Options need to be specified in configatrion as
-the methodized name of the cache with _options attached at the end.
+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::Caches::PageCache # =&gt; cachetastic_caches_page_cache_options
-  MyAwesomeCache # =&gt; my_awesome_cache_options
+  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('M000039-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000039-source">
+            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 69</span>
-69:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configuration</span>(<span class="ruby-identifier">name</span>)
-70:       <span class="ruby-identifier">name</span> = <span class="ruby-node">&quot;#{name}_options&quot;</span>
-71:       <span class="ruby-identifier">conf</span> = <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">retrieve</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">cachetastic_default_options</span>)
-72:       <span class="ruby-identifier">conf</span>
-73:     <span class="ruby-keyword kw">end</span>
+    <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>
 
-      <div id="method-M000035" class="method-detail">
-        <a name="M000035"></a>
+      <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="#M000035" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(name)</span>
+          <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('M000035-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000035-source">
+            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 24</span>
-24:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
-25:     <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
-26:     <span class="ruby-ivar">@logger</span> = <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">retrieve</span>(<span class="ruby-identifier">:logger</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">STDOUT</span>)))
-27:     <span class="ruby-identifier">setup</span>
-28:     <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">debug?</span>
-29:       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">:self</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">inspect</span>)
-30:     <span class="ruby-keyword kw">end</span>
-31:   <span class="ruby-keyword kw">end</span>
+     <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>
 
-      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
-      <div id="method-M000038" class="method-detail">
-        <a name="M000038"></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="#M000038" class="method-signature">
-          <span class="method-name">configuration</span><span class="method-args">()</span>
+          <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('M000038-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000038-source">
+            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 58</span>
-58:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configuration</span>
-59:     <span class="ruby-constant">Cachetastic</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapters</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">configuration</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>)
-60:   <span class="ruby-keyword kw">end</span>
+    <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-M000036" class="method-detail">
-        <a name="M000036"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="#M000036" class="method-signature">
-          <span class="method-name">debug?</span><span class="method-args">()</span>
+          <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>
-Returns true/or falsed based on whether or not the debug setting is set to
-true in the <a href="Base.html#M000038">configuration</a> file. If the
-config setting is set, then false is returned.
+<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('M000036-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000036-source">
+            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 43</span>
-43:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug?</span>
-44:     <span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">retrieve</span>(<span class="ruby-identifier">:debug</span>, <span class="ruby-keyword kw">false</span>)
-45:   <span class="ruby-keyword kw">end</span>
+    <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-M000037" class="method-detail">
-        <a name="M000037"></a>
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
 
         <div class="method-heading">
-          <a href="#M000037" class="method-signature">
-          <span class="method-name">stats</span><span class="method-args">()</span>
+          <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('M000037-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000037-source">
+            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 47</span>
-47:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span>
-48:     <span class="ruby-identifier">cache_name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">camelize</span>
-49:     <span class="ruby-identifier">adapter_type</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'Cachetastic::Adapters::'</span>, <span class="ruby-value str">''</span>)
-50:     <span class="ruby-identifier">s</span> = <span class="ruby-node">&quot;Cache: #{cache_name}\nStore Type: #{adapter_type}\n&quot;</span>
-51:     <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">servers</span>
-52:       <span class="ruby-identifier">servers</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">servers</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">','</span>)
-53:       <span class="ruby-identifier">s</span> <span class="ruby-operator">+=</span> <span class="ruby-node">&quot;Servers: #{servers}&quot;</span>
-54:     <span class="ruby-keyword kw">end</span>
-55:     <span class="ruby-identifier">puts</span> <span class="ruby-identifier">s</span>
-56:   <span class="ruby-keyword kw">end</span>
+     <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>