RubyGems - cachetastic - Versions diffs - 1.1.3 → 1.1.8 - Mend

cachetastic 1.1.3 → 1.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (110) hide show

data/doc/classes/Cachetastic/Stores/Memcache.src/M000016.html CHANGED Viewed

@@ -5,20 +5,20 @@
 <html>
 <head>
-  <title>valid? (Cachetastic::Stores::Memcache)</title>
+  <title>get_version (Cachetastic::Stores::Memcache)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/stores/cachetastic_stores_memcache.rb, line 33</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
-    <span class="ruby-keyword kw">begin</span>
-      <span class="ruby-keyword kw">return</span> (<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">conn</span>.<span class="ruby-identifier">active?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_version</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>))
-    <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
-      <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
-      <span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
-      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
+  <pre><span class="ruby-comment cmt"># File lib/stores/cachetastic_stores_memcache.rb, line 78</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_version</span>(<span class="ruby-identifier">name</span>)
+    <span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>
+    <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>)
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ns_versions</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">name</span>, <span class="ruby-value">1</span>)
+      <span class="ruby-identifier">v</span> = <span class="ruby-value">1</span>
     <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">v</span>
   <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/created.rid CHANGED Viewed

	@@ -1 +1 @@
1	- ~~Thu~~, 10 Jan 2008 16:34:40 -0500
1	+ Wed, 16 Jan 2008 12:55:57 -0500

data/doc/files/init_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jan 08 13:17:00 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,116 @@
   <div id="contextContent">
+    <div id="description">
+      <h1>Gem Requirements:</h1>
+<ul>
+<li>Application Configuration
+</li>
+<li>Ruby Extensions
+</li>
+<li>Rails Extensions
+</li>
+</ul>
+<h1>Configuration:</h1>
+<pre>
+  cachetastic_default_options:
+    # this will dump into the log, configuration info for each cache, as well as the .inspect
+    # for each object returned from the cache
+    debug: true # true | false (default: false)
+    # this is the type of file store to be used for this cache.
+    # more stores can be developed and plugged in as desired
+    store: local_memory # local_memory | memcache | file (default: local_memory)
+    # this will marshall objects into and out of the store.
+    # so far yaml is the only supported marshall format.
+    marshall_method: none # none | yaml (default: none)
+    # this sets how long objects will live in the cache before they are auto expired.
+    default_expiry: &lt;%= 24.hours %&gt; # 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.
+    expiry_swing: &lt;%= 15.minutes %&gt; # time in seconds (default: 0)
+    # these options get passed on directly to the store.
+    # only the memcache store uses these options currently.
+    store_options: # listed below are options for memcache
+      c_threshold: 10_000
+      compression: true
+      debug: false
+      readonly: false
+      urlencode: false
+    store_options: # listed below are the options for file
+      dir: /cachetastic/caches/ # absolute path to the directory where caches should be stored.
+    # configure logging for this cache:
+    logging:
+      # n number of logs can be configured for a cache
+      # their names can be anything you want, it's doesn't matter
+      logger_1:
+        # this sets the type of log you want to write to.
+        # right now the only two options are file and console
+        type: file # console | file (default: none)
+        # if the type is file, you need to configure where the log file is to be written.
+        file: log/memcached.log # relative | absolute path to log file
+        # this sets the level of logging for this cache
+        level: info # debug | info | warn | error | fatal (default: info)
+      logger_2:
+        # this sets the type of log you want to write to.
+        # right now the only two options are file and console
+        type: console # console | file (default: none)
+        # this sets the level of logging for this cache
+        level: error # debug | info | warn | error | fatal (default: info)
+    # set the servers to be used for memcache
+    servers:
+      - 127.0.0.1:11211 # ip:port used for memcache
+</pre>
+<p>
+# if using the mongrel_page_cache_handler gem, you can configure it to use
+cachetastic.
+</p>
+<pre>
+  page_cache_storage: cachetastic # disk | cachetastic (default: cachetastic)
+</pre>
+<p>
+# example of how to override options for page cacheing:
+</p>
+<pre>
+  cachetastic_caches_page_cache_options:
+    default_expiry: &lt;%= 1.hour %&gt;
+    expiry_swing: &lt;%= 15.minutes %&gt;
+</pre>
+<p>
+# example of how to override options for rails session cacheing:
+</p>
+<pre>
+  cachetastic_caches_rails_session_cache_options:
+    default_expiry: &lt;%= 30.minutes %&gt;
+</pre>
+<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>

data/doc/files/lib/caches/cachetastic_caches_base_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 10 16:34:23 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/caches/cachetastic_caches_page_cache_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jan 08 13:17:00 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,14 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+Used by the Mongrel Page Cache Handler gem for page caching. Future
+functionality may be added to this class to allow for things such as
+deleting a certain page/set of pages based on regex, etc&#8230;
+</p>
+    </div>
    </div>

data/doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jan 08 13:17:00 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,12 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+Used for storing Rails sessions.
+</p>
+    </div>
    </div>

data/doc/files/lib/cachetastic_connection_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Jan 02 21:36:27 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/cachetastic_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Jan 02 21:36:27 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -89,7 +89,7 @@
     debug: true # true | false (default: false)
     # this is the type of file store to be used for this cache.
     # more stores can be developed and plugged in as desired
-    store: local_memory # local_memory | memcache (default: local_memory)
+    store: local_memory # local_memory | memcache | file (default: local_memory)
     # this will marshall objects into and out of the store.
     # so far yaml is the only supported marshall format.
     marshall_method: none # none | yaml (default: none)
@@ -107,6 +107,8 @@
       debug: false
       readonly: false
       urlencode: false
+    store_options: # listed below are the options for file
+      dir: /cachetastic/caches/ # absolute path to the directory where caches should be stored.
     # configure logging for this cache:
     logging:
       # n number of logs can be configured for a cache
@@ -194,8 +196,10 @@ cachetastic.
       caches/cachetastic_caches_page_cache&nbsp;&nbsp;
       caches/cachetastic_caches_rails_session_cache&nbsp;&nbsp;
       stores/cachetastic_stores_base&nbsp;&nbsp;
+      stores/cachetastic_stores_store_object&nbsp;&nbsp;
       stores/cachetastic_stores_memcache&nbsp;&nbsp;
       stores/cachetastic_stores_local_memory&nbsp;&nbsp;
+      stores/cachetastic_stores_file&nbsp;&nbsp;
       helpers/cachetastic_helpers_active_record&nbsp;&nbsp;
       rails_extensions/cachetastic_active_record_base&nbsp;&nbsp;
       rails_extensions/cgi_session_cachetastic_store&nbsp;&nbsp;

data/doc/files/lib/helpers/cachetastic_helpers_active_record_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Dec 27 14:48:41 -0500 2007</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Dec 27 14:49:05 -0500 2007</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Dec 26 14:31:53 -0500 2007</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/stores/cachetastic_stores_base_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jan 10 14:13:08 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,44 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+This class is the interface used to develop stores for caches. 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 store.
+</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 store is created by <a
+href="../../../classes/Cachetastic/Connection.html">Cachetastic::Connection</a>
+</li>
+</ul>
+    </div>
    </div>

data/doc/{classes/ActiveRecord.html → files/lib/stores/cachetastic_stores_file_rb.html} RENAMED Viewed

@@ -5,10 +5,10 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Module: ActiveRecord</title>
+  <title>File: cachetastic_stores_file.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[
@@ -46,20 +46,20 @@
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">ActiveRecord</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-            </td>
-        </tr>
-        </table>
-    </div>
+  <div id="fileHeader">
+    <h1>cachetastic_stores_file.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/stores/cachetastic_stores_file.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
+    </tr>
+    </table>
+  </div>
   <!-- banner header -->
   <div id="bodyContent">
@@ -68,6 +68,26 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+This store 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
+   store: 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>
@@ -80,12 +100,6 @@
     <div id="section">
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-      Class <a href="ActiveRecord/Base.html" class="link">ActiveRecord::Base</a><br />
-    </div>

data/doc/files/lib/stores/cachetastic_stores_local_memory_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Dec 28 14:03:29 -0500 2007</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,14 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+A 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 store.
+</p>
+    </div>
    </div>

data/doc/files/lib/stores/cachetastic_stores_memcache_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Jan 02 21:36:26 -0500 2008</td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
     </tr>
     </table>
   </div>
@@ -68,6 +68,32 @@
   <div id="contextContent">
+    <div id="description">
+      <p>
+This store uses Memcache as it&#8216;s backing. The configuration for this
+should look something like this:
+</p>
+<pre>
+ my_awesome_cache_options:
+   debug: false
+   store: memcache
+   marshall_method: none
+   default_expiry: &lt;%= 24.hours %&gt;
+   store_options:
+     c_threshold: 10_000
+     compression: true
+     debug: false
+     readonly: false
+     urlencode: false
+   logging:
+     logger_1:
+       type: file
+       file: log/memcached.log
+   servers:
+     - 127.0.0.1:11211
+</pre>
+    </div>
    </div>

data/doc/{classes/Cachetastic/Caches/ActiveRecord.html → files/lib/stores/cachetastic_stores_store_object_rb.html} RENAMED Viewed

@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-  <title>Module: Cachetastic::Caches::ActiveRecord</title>
+  <title>File: cachetastic_stores_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" />
@@ -46,24 +46,20 @@
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Cachetastic::Caches::ActiveRecord</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../files/lib/cachetastic_rb.html">
-                lib/cachetastic.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        </table>
-    </div>
+  <div id="fileHeader">
+    <h1>cachetastic_stores_store_object.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/stores/cachetastic_stores_store_object.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Jan 16 12:54:51 -0500 2008</td>
+    </tr>
+    </table>
+  </div>
   <!-- banner header -->
   <div id="bodyContent">

data/doc/fr_class_index.html CHANGED Viewed

@@ -20,23 +20,17 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
-    <a href="classes/ActiveRecord.html">ActiveRecord</a><br />
     <a href="classes/ActiveRecord/Base.html">ActiveRecord::Base</a><br />
-    <a href="classes/Cachetastic.html">Cachetastic</a><br />
-    <a href="classes/Cachetastic/Caches.html">Cachetastic::Caches</a><br />
-    <a href="classes/Cachetastic/Caches/ActiveRecord.html">Cachetastic::Caches::ActiveRecord</a><br />
+    <a href="classes/CGI/Session/CachetasticStore.html">CGI::Session::CachetasticStore</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/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/Helpers.html">Cachetastic::Helpers</a><br />
-    <a href="classes/Cachetastic/Helpers/ActiveRecord.html">Cachetastic::Helpers::ActiveRecord</a><br />
     <a href="classes/Cachetastic/Logger.html">Cachetastic::Logger</a><br />
-    <a href="classes/Cachetastic/Stores.html">Cachetastic::Stores</a><br />
     <a href="classes/Cachetastic/Stores/Base.html">Cachetastic::Stores::Base</a><br />
+    <a href="classes/Cachetastic/Stores/File.html">Cachetastic::Stores::File</a><br />
     <a href="classes/Cachetastic/Stores/LocalMemory.html">Cachetastic::Stores::LocalMemory</a><br />
-    <a href="classes/Cachetastic/Stores/LocalMemory/StoreObject.html">Cachetastic::Stores::LocalMemory::StoreObject</a><br />
     <a href="classes/Cachetastic/Stores/Memcache.html">Cachetastic::Stores::Memcache</a><br />
   </div>
 </div>

data/doc/fr_file_index.html CHANGED Viewed

@@ -31,8 +31,10 @@
     <a href="files/lib/rails_extensions/cachetastic_active_record_base_rb.html">lib/rails_extensions/cachetastic_active_record_base.rb</a><br />
     <a href="files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html">lib/rails_extensions/cgi_session_cachetastic_store.rb</a><br />
     <a href="files/lib/stores/cachetastic_stores_base_rb.html">lib/stores/cachetastic_stores_base.rb</a><br />
+    <a href="files/lib/stores/cachetastic_stores_file_rb.html">lib/stores/cachetastic_stores_file.rb</a><br />
     <a href="files/lib/stores/cachetastic_stores_local_memory_rb.html">lib/stores/cachetastic_stores_local_memory.rb</a><br />
     <a href="files/lib/stores/cachetastic_stores_memcache_rb.html">lib/stores/cachetastic_stores_memcache.rb</a><br />
+    <a href="files/lib/stores/cachetastic_stores_store_object_rb.html">lib/stores/cachetastic_stores_store_object.rb</a><br />
   </div>
 </div>
 </body>