cachetastic 2.1.4 → 3.0.0

data/doc/files/lib/cachetastic_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Feb 27 10:55:34 -0500 2009</td>
+      <td>Thu Jun 11 12:07:40 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -68,106 +68,15 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <h1>Configuration:</h1>
-<pre>
-    # 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
-
-    # 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)
-
-    # this will marshall objects into and out of the store.
-    configatron.cachetastic_default_options.marshall_method = :none # none | yaml | ruby (default: none)
-
-    # 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)
-
-    # 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)
-
-    # these options get passed on directly to the store.
-    # listed below are options for memcache:
-    configatron.cachetastic_default_options.store_options.c_threshold = &quot;10_000&quot;
-    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 = [&quot;127.0.0.1:11211&quot;] # ip:port used for memcache
-
-    # listed below are the options for file:
-    configatron.cachetastic_default_options.store_options.dir = &quot;/cachetastic/caches&quot;
-
-    # listed below are the options for drb:
-    configatron.cachetastic_default_options.servers = [&quot;druby://127.0.0.1:61676&quot;]
-
-    # 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(&quot;log/cachetastic.log&quot;)
-    log_2.level = Logger::ERROR
-    configatron.cachetastic_default_options.logger = [log_1, log_2]
-</pre>
-<h1>Cachetastic::Drb::Server</h1>
-<p>
-If you want to use Drb and the <a
-href="../../classes/Cachetastic/Adapters/Drb.html">Cachetastic::Adapters::Drb</a>
-adapter, you&#8216;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.
-</p>
-<pre>
-  $ cachetastic_drb_server # that will start the drb server on the host 127.0.0.1 on the port 61676
-</pre>
-<p>
-The server takes to command line parameters: -h &lt;host&gt; -p
-&lt;port&gt; -v &lt;verbose&gt; -rv &lt;really verbose&gt;
-</p>
-<h1>Examples:</h1>
-<pre>
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
-  end
-
-  MyAwesomeCache.set(1, [1,2,3])
-  MyAwesomeCache.get(1) # =&gt; [1,2,3]
-
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
-    class &lt;&lt; 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) # =&gt; 8
-  MyAwesomeCache.get(1, 4, 4) # =&gt; 8
-</pre>
-
-    </div>
 
     <div id="requires-list">
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
-      rubygems&nbsp;&nbsp;
-      singleton&nbsp;&nbsp;
-      logger&nbsp;&nbsp;
-      yaml&nbsp;&nbsp;
-      zlib&nbsp;&nbsp;
-      pp&nbsp;&nbsp;
-      drb&nbsp;&nbsp;
       configatron&nbsp;&nbsp;
+      logger&nbsp;&nbsp;
+      activesupport&nbsp;&nbsp;
+      fileutils&nbsp;&nbsp;
       memcache&nbsp;&nbsp;
       </div>
     </div>

data/doc/fr_class_index.html

@@ -20,28 +20,16 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
-    <a href="classes/ActiveRecord/Base.html">ActiveRecord::Base</a><br />
-    <a href="classes/CGI/Session/CachetasticStore.html">CGI::Session::CachetasticStore</a><br />
+    <a href="classes/Cachetastic/Adapters.html">Cachetastic::Adapters</a><br />
     <a href="classes/Cachetastic/Adapters/Base.html">Cachetastic::Adapters::Base</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html">Cachetastic::Adapters::Drb</a><br />
     <a href="classes/Cachetastic/Adapters/File.html">Cachetastic::Adapters::File</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html">Cachetastic::Adapters::FileBase</a><br />
-    <a href="classes/Cachetastic/Adapters/HtmlFile.html">Cachetastic::Adapters::HtmlFile</a><br />
     <a href="classes/Cachetastic/Adapters/LocalMemory.html">Cachetastic::Adapters::LocalMemory</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html">Cachetastic::Adapters::Memcache</a><br />
+    <a href="classes/Cachetastic/Adapters/Memcached.html">Cachetastic::Adapters::Memcached</a><br />
+    <a href="classes/Cachetastic/Cache.html">Cachetastic::Cache</a><br />
     <a href="classes/Cachetastic/Cacheable.html">Cachetastic::Cacheable</a><br />
     <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html">Cachetastic::Cacheable::ClassAndInstanceMethods</a><br />
     <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html">Cachetastic::Cacheable::ClassOnlyMethods</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html">Cachetastic::Caches::Base</a><br />
-    <a href="classes/Cachetastic/Caches/Base/RegisteredCaches.html">Cachetastic::Caches::Base::RegisteredCaches</a><br />
-    <a href="classes/Cachetastic/Caches/MackSessionCache.html">Cachetastic::Caches::MackSessionCache</a><br />
-    <a href="classes/Cachetastic/Caches/PageCache.html">Cachetastic::Caches::PageCache</a><br />
-    <a href="classes/Cachetastic/Caches/RailsSessionCache.html">Cachetastic::Caches::RailsSessionCache</a><br />
-    <a href="classes/Cachetastic/Connection.html">Cachetastic::Connection</a><br />
-    <a href="classes/Cachetastic/Errors/UnsupportedAdapter.html">Cachetastic::Errors::UnsupportedAdapter</a><br />
     <a href="classes/Cachetastic/Logger.html">Cachetastic::Logger</a><br />
-    <a href="classes/Object.html">Object</a><br />
-    <a href="classes/String.html">String</a><br />
   </div>
 </div>
 </body>

data/doc/fr_file_index.html

@@ -20,29 +20,18 @@
 <div id="index">
   <h1 class="section-bar">Files</h1>
   <div id="index-entries">
+    <a href="files/LICENSE.html">LICENSE</a><br />
     <a href="files/README.html">README</a><br />
     <a href="files/lib/cachetastic_rb.html">lib/cachetastic.rb</a><br />
     <a href="files/lib/cachetastic/adapters/base_rb.html">lib/cachetastic/adapters/base.rb</a><br />
-    <a href="files/lib/cachetastic/adapters/drb_rb.html">lib/cachetastic/adapters/drb.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/file_base_rb.html">lib/cachetastic/adapters/file_base.rb</a><br />
-    <a href="files/lib/cachetastic/adapters/html_file_rb.html">lib/cachetastic/adapters/html_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/memcache_rb.html">lib/cachetastic/adapters/memcache.rb</a><br />
-    <a href="files/lib/cachetastic/adapters/store_object_rb.html">lib/cachetastic/adapters/store_object.rb</a><br />
+    <a href="files/lib/cachetastic/adapters/memcached_rb.html">lib/cachetastic/adapters/memcached.rb</a><br />
+    <a href="files/lib/cachetastic/cache_rb.html">lib/cachetastic/cache.rb</a><br />
     <a href="files/lib/cachetastic/cacheable_rb.html">lib/cachetastic/cacheable.rb</a><br />
-    <a href="files/lib/cachetastic/caches/base_rb.html">lib/cachetastic/caches/base.rb</a><br />
-    <a href="files/lib/cachetastic/caches/mack_session_cache_rb.html">lib/cachetastic/caches/mack_session_cache.rb</a><br />
-    <a href="files/lib/cachetastic/caches/page_cache_rb.html">lib/cachetastic/caches/page_cache.rb</a><br />
-    <a href="files/lib/cachetastic/caches/rails_session_cache_rb.html">lib/cachetastic/caches/rails_session_cache.rb</a><br />
-    <a href="files/lib/cachetastic/connection_rb.html">lib/cachetastic/connection.rb</a><br />
-    <a href="files/lib/cachetastic/errors/unsupported_adapter_rb.html">lib/cachetastic/errors/unsupported_adapter.rb</a><br />
+    <a href="files/lib/cachetastic/extensions/string_rb.html">lib/cachetastic/extensions/string.rb</a><br />
     <a href="files/lib/cachetastic/logger_rb.html">lib/cachetastic/logger.rb</a><br />
-    <a href="files/lib/cachetastic/rails_extensions/active_record_base_rb.html">lib/cachetastic/rails_extensions/active_record_base.rb</a><br />
-    <a href="files/lib/cachetastic/rails_extensions/cgi_session_store_rb.html">lib/cachetastic/rails_extensions/cgi_session_store.rb</a><br />
-    <a href="files/lib/cachetastic/ruby_extensions/kernel_rb.html">lib/cachetastic/ruby_extensions/kernel.rb</a><br />
-    <a href="files/lib/cachetastic/ruby_extensions/object_rb.html">lib/cachetastic/ruby_extensions/object.rb</a><br />
-    <a href="files/lib/cachetastic/ruby_extensions/string_rb.html">lib/cachetastic/ruby_extensions/string.rb</a><br />
+    <a href="files/lib/cachetastic/store_object_rb.html">lib/cachetastic/store_object.rb</a><br />
   </div>
 </div>
 </body>

data/doc/fr_method_index.html

@@ -20,84 +20,32 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Cachetastic/Caches/Base.html#M000058">adapter (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000061">adapter_supported? (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000051">all_registered_caches (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000071">cache_class (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000057">cache_name (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Cacheable.html#M000066">cache_self (Cachetastic::Cacheable)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000072">cacher (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
-    <a href="classes/Object.html#M000001">cachetastic_key (Object)</a><br />
-    <a href="classes/ActiveRecord/Base.html#M000077">cachetastic_key (ActiveRecord::Base)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000064">calculate_expiry_time (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/String.html#M000004">camelcase (String)</a><br />
-    <a href="classes/Cachetastic/Adapters/Base.html#M000039">configuration (Cachetastic::Adapters::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Base.html#M000038">configuration (Cachetastic::Adapters::Base)</a><br />
-    <a href="classes/String.html#M000005">constantize (String)</a><br />
-    <a href="classes/Cachetastic/Adapters/Base.html#M000036">debug? (Cachetastic::Adapters::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000012">delete (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000032">delete (Cachetastic::Adapters::FileBase)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000054">delete (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000045">delete (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000027">delete (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000069">delete_from_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000055">expire_all (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000033">expire_all (Cachetastic::Adapters::FileBase)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000024">expire_all (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000042">expire_all (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000073">expire_all (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000014">expire_all (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/File.html#M000047">get (Cachetastic::Adapters::File)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000052">get (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000043">get (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Adapters/HtmlFile.html#M000007">get (Cachetastic::Adapters::HtmlFile)</a><br />
-    <a href="classes/Cachetastic/Connection.html#M000076">get (Cachetastic::Connection)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000013">get (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000025">get (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000068">get_from_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
-    <a href="classes/ActiveRecord/Base.html#M000078">get_from_cache (ActiveRecord::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000021">get_version (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000020">increment_version (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000015">inspect (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Object.html#M000002">ivar_cache (Object)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000059">logger (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000062">marshall (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000018">namespace (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Object.html#M000003">needs_method (Object)</a><br />
-    <a href="classes/Cachetastic/Logger.html#M000074">new (Cachetastic::Logger)</a><br />
-    <a href="classes/Cachetastic/Caches/Base/RegisteredCaches.html#M000065">new (Cachetastic::Caches::Base::RegisteredCaches)</a><br />
-    <a href="classes/Cachetastic/Connection.html#M000075">new (Cachetastic::Connection)</a><br />
-    <a href="classes/Cachetastic/Adapters/Base.html#M000035">new (Cachetastic::Adapters::Base)</a><br />
-    <a href="classes/Cachetastic/Errors/UnsupportedAdapter.html#M000006">new (Cachetastic::Errors::UnsupportedAdapter)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000019">ns_versions (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000026">set (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000011">set (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000053">set (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/File.html#M000048">set (Cachetastic::Adapters::File)</a><br />
-    <a href="classes/Cachetastic/Adapters/HtmlFile.html#M000008">set (Cachetastic::Adapters::HtmlFile)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000044">set (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000070">set_into_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000023">setup (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000041">setup (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000010">setup (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000029">setup (Cachetastic::Adapters::FileBase)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000046">stats (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Adapters/Base.html#M000037">stats (Cachetastic::Adapters::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000031">stats (Cachetastic::Adapters::FileBase)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000017">stats (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000028">stats (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000056">stats (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/HtmlFile.html#M000009">store_file_name (Cachetastic::Adapters::HtmlFile)</a><br />
-    <a href="classes/Cachetastic/Adapters/File.html#M000049">store_file_name (Cachetastic::Adapters::File)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000034">store_file_name (Cachetastic::Adapters::FileBase)</a><br />
-    <a href="classes/Cachetastic/Cacheable.html#M000067">uncache_self (Cachetastic::Cacheable)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000063">unmarshall (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Caches/RailsSessionCache.html#M000050">unsupported_adapters (Cachetastic::Caches::RailsSessionCache)</a><br />
-    <a href="classes/Cachetastic/Caches/Base.html#M000060">unsupported_adapters (Cachetastic::Caches::Base)</a><br />
-    <a href="classes/Cachetastic/Adapters/Drb.html#M000040">valid? (Cachetastic::Adapters::Drb)</a><br />
-    <a href="classes/Cachetastic/Adapters/LocalMemory.html#M000022">valid? (Cachetastic::Adapters::LocalMemory)</a><br />
-    <a href="classes/Cachetastic/Adapters/Memcache.html#M000016">valid? (Cachetastic::Adapters::Memcache)</a><br />
-    <a href="classes/Cachetastic/Adapters/FileBase.html#M000030">valid? (Cachetastic::Adapters::FileBase)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000022">adapter (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Adapters.html#M000001">build (Cachetastic::Adapters)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000015">cache_class (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
+    <a href="classes/Cachetastic/Cacheable.html#M000010">cache_self (Cachetastic::Cacheable)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000016">cacher (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000025">calculate_expiry_time (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000023">clear_adapter! (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000020">delete (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000006">delete (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000013">delete_from_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000021">expire_all (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000007">expire_all (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html#M000017">expire_all (Cachetastic::Cacheable::ClassAndInstanceMethods)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000004">get (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000018">get (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000012">get_from_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000024">logger (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000003">new (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Logger.html#M000026">new (Cachetastic::Logger)</a><br />
+    <a href="classes/Cachetastic/Cache.html#M000019">set (Cachetastic::Cache)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000005">set (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Cacheable/ClassOnlyMethods.html#M000014">set_into_cache (Cachetastic::Cacheable::ClassOnlyMethods)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000008">transform_key (Cachetastic::Adapters::Base)</a><br />
+    <a href="classes/Cachetastic/Cacheable.html#M000011">uncache_self (Cachetastic::Cacheable)</a><br />
+    <a href="classes/Cachetastic/Adapters/Memcached.html#M000002">valid? (Cachetastic::Adapters::Memcached)</a><br />
+    <a href="classes/Cachetastic/Adapters/Base.html#M000009">valid? (Cachetastic::Adapters::Base)</a><br />
   </div>
 </div>
 </body>

data/lib/cachetastic.rb

@@ -1,74 +1,20 @@
-# :include: README
-require 'rubygems'
-require 'singleton'
-require 'logger'
-require 'yaml'
-require 'zlib'
-require 'pp'
-require 'drb'
 require 'configatron'
-# require 'mack-facets'
-begin
-  require 'memcache'
-rescue Exception => e
-  # if you don't have memcache installed, don't 
-  # blow up, print a message, and you can't use
-  # the memcache adapter.
-  puts "CACHETASTIC: Warning: You don't have the memcache gem installed which means you can't use the Cachetastic::Adapters::Memcache adapter."
-end
-
-class Object
-  # Uses <code>define_method</code> to create an empty for the method parameter defined.
-  # That method will then raise MethodNotImplemented. This is useful for creating interfaces
-  # and you want to stub out methods that others need to implement.
-  def self.needs_method(meth)
-    define_method(meth) do
-      raise NoMethodError.new("The interface you are using requires you define the following method '#{meth}'")
-    end
-  end
-end
+require 'logger'
+require 'activesupport'
+require 'fileutils'
+require 'memcache'
 
-module Cachetastic #:nodoc:#
-  module Caches #:nodoc:#
-  end
-  module Adapters #:nodoc:#
-  end
-  module Errors #:nodoc:#
-  end
-  module Cacheable
-  end
+Dir.glob(File.join(File.dirname(__FILE__), 'cachetastic', '**/*.rb')).each do |f|
+  require File.expand_path(f)
 end
-module ActiveRecord #:nodoc:#
-end
-
-home = File.join(File.dirname(__FILE__), 'cachetastic')
-
-require File.join(home, 'connection')
-require File.join(home, 'logger')
-require File.join(home, 'caches/base')
-require File.join(home, 'caches/page_cache')
-require File.join(home, 'caches/rails_session_cache')
-require File.join(home, 'caches/mack_session_cache')
-require File.join(home, 'errors/unsupported_adapter')
-require File.join(home, 'adapters/base')
-require File.join(home, 'adapters/store_object')
-require File.join(home, 'adapters/memcache')
-require File.join(home, 'adapters/local_memory')
-require File.join(home, 'adapters/file_base')
-require File.join(home, 'adapters/file')
-require File.join(home, 'adapters/html_file')
-require File.join(home, 'adapters/drb')
-require File.join(home, 'cacheable')
-require File.join(home, 'rails_extensions/active_record_base')
-require File.join(home, 'rails_extensions/cgi_session_store')
-require File.join(home, 'ruby_extensions/object')
-require File.join(home, 'ruby_extensions/kernel')
-require File.join(home, 'ruby_extensions/string')
-
-configatron.cachetastic_default_options.set_default(:debug, false)
-configatron.cachetastic_default_options.set_default(:adapter, :local_memory)
-configatron.cachetastic_default_options.set_default(:logger, ::Logger.new(STDOUT))
 
-#--
-# http://rdoc.sourceforge.net/doc/index.html
-#++
+configatron.cachetastic.defaults.set_default(:marshal_method, :none)
+configatron.cachetastic.defaults.set_default(:expiry_swing, 0)
+configatron.cachetastic.defaults.set_default(:default_expiry, 86400)
+configatron.cachetastic.defaults.set_default(:debug, true)
+configatron.cachetastic.defaults.set_default(:adapter, Cachetastic::Adapters::LocalMemory)
+log_path = File.join(FileUtils.pwd, 'log', 'cachetastic.log')
+FileUtils.mkdir_p(File.dirname(log_path))
+logger = ::Logger.new(log_path)
+logger.level = ::Logger::DEBUG
+configatron.cachetastic.defaults.set_default(:logger, logger)

data/lib/cachetastic/adapters/base.rb

@@ -1,76 +1,178 @@
-# 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...
-# 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.
-# 
-# === Methods that need to be implemented:
-# * setup - used to setup the implementation of the adapter.
-# * set(key, object, expiry) - sets an object into the store using the given key and the expiry time.
-# * get(key) - returns an object from the store for a given key.
-# * delete(key, delay) - deletes an object from the store for a given key. If the store supports it, a delay can be used.
-# * expire_all - expires all objects in the store for a given cache.
-# * stats - returns statistics for the store.
-# * valid? - used to test whether or not the store is still valid. If this returns false a new instance of the adapter is created by Cachetastic::Connection
-class Cachetastic::Adapters::Base
-  
-  # attr_reader :all_options
-  # attr_reader :store_options
-  # attr_reader :servers
-  attr_reader :name
-  # attr_reader :logging
-  attr_reader :logger
-  
-  def initialize(name)
-    @name = name
-    @logger = Cachetastic::Logger.new(configuration.retrieve(:logger, ::Logger.new(STDOUT)))
-    setup
-    if self.debug?
-      self.logger.debug(self.name, :self, self.inspect)
-    end
-  end
-  
-  needs_method :setup
-  needs_method :set
-  needs_method :get
-  needs_method :delete
-  needs_method :expire_all
-  needs_method :stats
-  needs_method :valid?
-  
-  # Returns true/or falsed based on whether or not the debug setting is set to true in the
-  # configuration file. If the config setting is set, then false is returned.
-  def debug?
-    configuration.retrieve(:debug, false)
-  end
-  
-  def stats
-    cache_name = self.name.to_s.camelize
-    adapter_type = self.class.to_s.gsub('Cachetastic::Adapters::', '')
-    s = "Cache: #{cache_name}\nStore Type: #{adapter_type}\n"
-    if self.servers
-      servers = self.servers.join(',')
-      s += "Servers: #{servers}"
-    end
-    puts s
-  end
-  
-  def configuration
-    Cachetastic::Adapters::Base.configuration(self.name)
-  end
-  
-  class << self
-    # Returns either the options
-    # Options need to be specified in configatrion as the methodized name of the cache with
-    # _options attached at the end.
-    # Examples:
-    #   Cachetastic::Caches::PageCache # => cachetastic_caches_page_cache_options
-    #   MyAwesomeCache # => my_awesome_cache_options
-    def configuration(name)
-      name = "#{name}_options"
-      conf = configatron.retrieve(name, configatron.cachetastic_default_options)
-      conf
-    end
-  end
-  
-end
+module Cachetastic # :nodoc:
+  module Adapters
+    
+    class << self
+      
+      # This method will return the appropriate 
+      # <tt>Cachetastic::Adapters::Base</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.
+      # 
+      # Examples:
+      #   configatron.cachetastic.defaults.adapter = Cachetastic::Adapters::LocalMemory
+      #   configatron.cachetastic.user.adapter = Cachetastic::Adapters::Memcached
+      #   Cachetastic::Adapters.build(User).class # => Cachetastic::Adapters::Memcached
+      #   Cachetastic::Adapters.build(Comment).class # => Cachetastic::Adapters::LocalMemory
+      def build(klass)
+        adp = klass.to_configatron(:cachetastic).adapter
+        if adp.nil?
+          adp = configatron.cachetastic.defaults.adapter
+        end
+        adp.new(klass)
+      end
+      
+    end # class << self
+    
+    # This class should be extended to create new 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.
+    # 
+    # This base class provides common functionality and an API for all
+    # adapters to be used with Cachetastic.
+    # 
+    # The default settings for all adapters are:
+    # 
+    #   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
+    # 
+    # See the README for more information on what each of those settings mean,
+    # and what are values may be used for each one.
+    class Base
+      
+      # The Class that this adapter is associated with. Note that it is a
+      # <i>class</i> reference and not an instance reference.
+      attr_accessor :klass
+      
+      # Creates a new adapter. It takes a class reference to tie the
+      # instance of the adapter to a particular class. Note that it is a
+      # <i>class</i> reference and not an instance reference.
+      # 
+      # Examples:
+      #   Cachetastic::Adapters::Base.new(User)
+      # 
+      # Adapters are configured using the Configatron gem.
+      # 
+      # Examples:
+      #   configatron.cachetastic.user.adapter = Cachetastic::Adapters::File
+      #   configatron.cachetastic.user.expiry_time = 5.hours
+      #   configatron.cachetastic.defaults.expiry_time = 24.hours
+      # 
+      # Refered to each adapter for its specific configuration settings.
+      def initialize(klass)
+        self.klass = klass
+        configatron.cachetastic.defaults.configatron_keys.each do |key|
+          define_accessor(key)
+          self.send("#{key}=", configatron.cachetastic.defaults.send(key))
+        end
+        klass.to_configatron(:cachetastic).configatron_keys.each do |key|
+          define_accessor(key)
+          self.send("#{key}=", klass.to_configatron(:cachetastic).send(key))
+        end
+      end
+      
+      # <b>This method MUST be implemented by a subclass!</b>
+      # 
+      # The implementation of this method should take a key and return
+      # an associated object, if available, from the underlying persistence
+      # layer. 
+      def get(key)
+        raise NoMethodError.new('get')
+      end # get
+      
+      # <b>This method MUST be implemented by a subclass!</b>
+      # 
+      # 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.
+      def set(key, value, expiry_time = configatron.cachetastic.defaults.default_expiry)
+        raise NoMethodError.new('set')
+      end # set
+      
+      # <b>This method MUST be implemented by a subclass!</b>
+      # 
+      # The implementation of this method should take a key and remove
+      # an object, if it exists, from an underlying persistence store.
+      def delete(key)
+        raise NoMethodError.new('delete')
+      end # delete
+      
+      # <b>This method MUST be implemented by a subclass!</b>
+      # 
+      # The implementation of this method is expected to delete all
+      # objects belonging to the associated cache from the underlying
+      # persistence store. It is <b>NOT</b> meant to delete <b>ALL</b>
+      # objects across <b>ALL</b> caches for the underlying persistence
+      # store. That would be very very bad!!
+      def expire_all
+        raise NoMethodError.new('expire_all')
+      end # expire_all
+      
+      # Allows an adapter to transform the key
+      # to a safe representation for it's backend.
+      # For example, the key: '$*...123()%~q' is not a 
+      # key for the file system, so the 
+      # Cachetastic::Adapters::File class should override
+      # this to make it safe for the file system.
+      def transform_key(key)
+        key
+      end
+      
+      # <b>This method MUST be implemented by a subclass!</b>
+      # 
+      # 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.
+      def valid?
+        true
+      end
+      
+      def debug? # :nodoc:
+        return self.debug if self.respond_to?(:debug)
+        return false
+      end
+      
+      def marshal(value) # :nodoc:
+        return nil if value.nil?
+        case self.marshal_method.to_sym
+        when :yaml
+          return YAML.dump(value)
+        when :ruby
+          return Marshal.dump(value)
+        else
+          return value
+        end
+      end
+      
+      def unmarshal(value) # :nodoc:
+        return nil if value.nil?
+        case self.marshal_method.to_sym
+        when :yaml
+          return YAML.load(value)
+        when :ruby
+          return Marshal.load(value)
+        else
+          return value
+        end
+      end
+      
+      private
+      def define_accessor(key)
+        instance_eval(%{
+          def #{key}
+            @#{key}
+          end
+          def #{key}=(x)
+            @#{key} = x
+          end
+        })        
+      end
+      
+    end # Base
+  end # Adapters
+end # Cachetastic