cachetastic 2.1.4 → 3.0.0

data/doc/files/README.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Fri Jun 05 17:11:09 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -69,76 +69,110 @@
   <div id="contextContent">
 
     <div id="description">
-      <h1>Configuration:</h1>
+      <h1>What is Cachetastic?</h1>
+<p>
+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><a
+href="../classes/Cachetastic/Cache.html">Cachetastic::Cache</a></tt>,
+configure them each individually, and much more.
+</p>
+<p>
+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!
+</p>
+<p>
+Adapters are easy to write, so if the built in adapters don&#8216;t float
+your boat, you can easily knock one off in short order.
+</p>
+<h2>Configuration:</h2>
+<p>
+Configuration of Cachetastic is done using the Configatron gem. I would
+recommend reading the documentation on it first, <a
+href="http://configatron.mackframework.com">configatron.mackframework.com</a>,
+before continuing.
+</p>
+<p>
+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:
+</p>
+<pre>
+  # 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(&quot;log/cachetastic.log&quot;)
+  log_2.level = Logger::ERROR
+  configatron.cachetastic.defaults.logger = [log_1, log_2]
+</pre>
+<p>
+Overriding settings per cache is very simple. Let&#8216;s take the
+following two caches:
+</p>
 <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]
+  class UserCache &lt; Cachetastic::Cache
+  end
+
+  class Admin::UserCache &lt; Cachetastic::Cache
+  end
 </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.
+If we wanted to set the <tt>UserCache</tt> to use the <tt><a
+href="../classes/Cachetastic/Adapters/File.html">Cachetastic::Adapters::File</a></tt>
+adapter and we wanted to set the adapter for the <tt>Admin::UserCache</tt>
+to use <tt><a
+href="../classes/Cachetastic/Adapters/Memcached.html">Cachetastic::Adapters::Memcached</a></tt>,
+we would configure them like such:
 </p>
 <pre>
-  $ 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
 </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;
+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.
 </p>
-<h1>Examples:</h1>
+<h2>Examples:</h2>
 <pre>
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
+  class MyAwesomeCache &lt; Cachetastic::Cache
   end
 
   MyAwesomeCache.set(1, [1,2,3])
   MyAwesomeCache.get(1) # =&gt; [1,2,3]
 
-  class MyAwesomeCache &lt; Cachetastic::Caches::Base
+  class MyAwesomeCache &lt; Cachetastic::Cache
     class &lt;&lt; self
       def get(key, x, y)
         super(key) do

data/doc/files/lib/cachetastic/adapters/base_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Jan 16 17:59:52 -0500 2009</td>
+      <td>Fri Jun 05 15:42:44 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -68,44 +68,6 @@
 
   <div id="contextContent">
 
-    <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.
-</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>stats - returns statistics for the store.
-
-</li>
-<li>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 <a
-href="../../../../classes/Cachetastic/Connection.html">Cachetastic::Connection</a>
-
-</li>
-</ul>
-
-    </div>
 
 
    </div>

data/doc/files/lib/cachetastic/adapters/file_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Fri Jun 05 15:54:26 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -68,26 +68,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-This adapter uses the file system as it&#8216;s backing. The configuration
-for this should look something like this:
-</p>
-<pre>
- my_awesome_cache_options:
-   debug: false
-   adapter: file
-   marshall_method: none
-   default_expiry: &lt;%= 24.hours %&gt;
-   store_options:
-     dir: /usr/local/caches/
-   logging:
-     logger_1:
-       type: file
-       file: log/file_store_cache.log
-</pre>
-
-    </div>
 
 
    </div>

data/doc/files/lib/cachetastic/adapters/local_memory_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Fri Jun 05 15:49:34 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -68,14 +68,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-An adapter/store that keeps objects in local memory. This is great for
-development/testing, but probably shouldn&#8216;t be put into production.
-It&#8216;s also a very good example of how to write a adapter.
-</p>
-
-    </div>
 
 
    </div>

data/doc/files/lib/cachetastic/{ruby_extensions/kernel_rb.html → adapters/memcached_rb.html}

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>File: kernel.rb</title>
+  <title>File: memcached.rb</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" />
@@ -47,16 +47,16 @@
 
 
   <div id="fileHeader">
-    <h1>kernel.rb</h1>
+    <h1>memcached.rb</h1>
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/cachetastic/ruby_extensions/kernel.rb
+      <td>lib/cachetastic/adapters/memcached.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Jan 16 18:02:14 -0500 2009</td>
+      <td>Fri Jun 05 16:01:57 -0400 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic/{ruby_extensions/string_rb.html → cache_rb.html}

@@ -5,10 +5,10 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>File: string.rb</title>
+  <title>File: cache.rb</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" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -47,16 +47,16 @@
 
 
   <div id="fileHeader">
-    <h1>string.rb</h1>
+    <h1>cache.rb</h1>
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/cachetastic/ruby_extensions/string.rb
+      <td>lib/cachetastic/cache.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Feb 27 10:56:04 -0500 2009</td>
+      <td>Fri Jun 05 16:10:19 -0400 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic/cacheable_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Jan 19 16:37:58 -0500 2009</td>
+      <td>Fri Jun 05 16:11:50 -0400 2009</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic/{caches/base_rb.html → extensions/string_rb.html}

@@ -5,7 +5,7 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>File: base.rb</title>
+  <title>File: string.rb</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" />
@@ -47,16 +47,16 @@
 
 
   <div id="fileHeader">
-    <h1>base.rb</h1>
+    <h1>string.rb</h1>
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/cachetastic/caches/base.rb
+      <td>lib/cachetastic/extensions/string.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Wed May 20 14:38:03 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -73,7 +73,7 @@
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
-      singleton&nbsp;&nbsp;
+      digest&nbsp;&nbsp;
       </div>
     </div>
 

data/doc/files/lib/cachetastic/logger_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Fri Jun 05 16:16:49 -0400 2009</td>
     </tr>
     </table>
   </div>
@@ -68,12 +68,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-This class handles logging for the caches and their adapters.
-</p>
-
-    </div>
 
 
    </div>

data/doc/files/lib/cachetastic/{adapters/store_object_rb.html → store_object_rb.html}

@@ -8,7 +8,7 @@
   <title>File: store_object.rb</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" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
 
@@ -51,12 +51,12 @@
     <table class="header-table">
     <tr class="top-aligned-row">
       <td><strong>Path:</strong></td>
-      <td>lib/cachetastic/adapters/store_object.rb
+      <td>lib/cachetastic/store_object.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 01 11:33:36 -0500 2009</td>
+      <td>Fri Jun 05 15:12:26 -0400 2009</td>
     </tr>
     </table>
   </div>