RubyGems - cachetastic - Versions diffs - 1.5.0 → 1.6.0 - Mend

cachetastic 1.5.0 → 1.6.0

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 (56) hide show

data/doc/classes/ActiveRecord/Base.html +188 -0
data/doc/classes/CGI/Session/CachetasticStore.html +124 -0
data/doc/classes/Cachetastic/Adapters/Base.html +331 -0
data/doc/classes/Cachetastic/Adapters/Drb.html +332 -0
data/doc/classes/Cachetastic/Adapters/File.html +248 -0
data/doc/classes/Cachetastic/Adapters/FileBase.html +309 -0
data/doc/classes/Cachetastic/Adapters/HtmlFile.html +224 -0
data/doc/classes/Cachetastic/Adapters/LocalMemory.html +346 -0
data/doc/classes/Cachetastic/Adapters/Memcache.html +498 -0
data/doc/classes/Cachetastic/Cacheable.html +264 -0
data/doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html +287 -0
data/doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html +200 -0
data/doc/classes/Cachetastic/Caches/Base.html +672 -0
data/doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html +179 -0
data/doc/classes/Cachetastic/Caches/MackSessionCache.html +119 -0
data/doc/classes/Cachetastic/Caches/PageCache.html +121 -0
data/doc/classes/Cachetastic/Caches/RailsSessionCache.html +154 -0
data/doc/classes/Cachetastic/Connection.html +212 -0
data/doc/classes/Cachetastic/Errors/UnsupportedAdapter.html +146 -0
data/doc/classes/Cachetastic/Logger.html +189 -0
data/doc/classes/Object.html +152 -0
data/doc/created.rid +1 -0
data/doc/files/README.html +207 -0
data/doc/files/lib/adapters/cachetastic_adapters_base_rb.html +139 -0
data/doc/files/lib/adapters/cachetastic_adapters_drb_rb.html +115 -0
data/doc/files/lib/adapters/cachetastic_adapters_file_base_rb.html +109 -0
data/doc/files/lib/adapters/cachetastic_adapters_file_rb.html +121 -0
data/doc/files/lib/adapters/cachetastic_adapters_html_file_rb.html +137 -0
data/doc/files/lib/adapters/cachetastic_adapters_local_memory_rb.html +109 -0
data/doc/files/lib/adapters/cachetastic_adapters_memcache_rb.html +127 -0
data/doc/files/lib/adapters/cachetastic_adapters_store_object_rb.html +101 -0
data/doc/files/lib/caches/cachetastic_caches_base_rb.html +108 -0
data/doc/files/lib/caches/cachetastic_caches_mack_session_cache_rb.html +107 -0
data/doc/files/lib/caches/cachetastic_caches_page_cache_rb.html +109 -0
data/doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html +107 -0
data/doc/files/lib/cachetastic_cacheable_rb.html +101 -0
data/doc/files/lib/cachetastic_connection_rb.html +107 -0
data/doc/files/lib/cachetastic_logger_rb.html +107 -0
data/doc/files/lib/cachetastic_rb.html +222 -0
data/doc/files/lib/errors/cachetastic_errors_unsupported_adapter_rb.html +101 -0
data/doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html +101 -0
data/doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html +109 -0
data/doc/files/lib/ruby_extensions/object_rb.html +101 -0
data/doc/fr_class_index.html +47 -0
data/doc/fr_file_index.html +47 -0
data/doc/fr_method_index.html +100 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/lib/cachetastic.rb +21 -23
data/lib/cachetastic_cacheable.rb +202 -0
data/lib/rails_extensions/cachetastic_active_record_base.rb +12 -39
data/lib/ruby_extensions/object.rb +8 -0
data/test/active_record_test.rb +8 -8
data/test/cacheable_test.rb +72 -0
metadata +52 -2
data/lib/helpers/cachetastic_helpers_active_record.rb +0 -46

data/doc/classes/Object.html ADDED Viewed

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Object</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Object</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/ruby_extensions/object_rb.html">
+                lib/ruby_extensions/object.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Object.html">
+                Object
+               </a>
+            </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">cachetastic_key</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance 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">cachetastic_key</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Override this method in your object if you use the <a
+href="Cachetastic/Cacheable.html">Cachetastic::Cacheable</a> module.
+</p>
+          <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/ruby_extensions/object.rb, line 4</span>
+4:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cachetastic_key</span>
+5:     <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'cachetastic_key'</span>)
+6:   <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/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Tue, 03 Jun 2008 17:30:28 -0400

data/doc/files/README.html ADDED Viewed

@@ -0,0 +1,207 @@
+<?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>File: README</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="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Jun 03 13:14:49 -0400 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <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 adapters can be developed and plugged in as desired
+    adapter: local_memory # local_memory | memcache | file | drb | html_file (default: local_memory)
+    # this will marshall objects into and out of the store.
+    marshall_method: none # none | yaml | ruby (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.
+    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.
+    store_options: # listed below are the options for drb
+      host: &quot;druby://127.0.0.1:61676&quot;
+    # 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>
+# 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>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>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/lib/adapters/cachetastic_adapters_base_rb.html ADDED Viewed

@@ -0,0 +1,139 @@
+<?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>File: cachetastic_adapters_base.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" />
+  <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="fileHeader">
+    <h1>cachetastic_adapters_base.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/adapters/cachetastic_adapters_base.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Tue Jun 03 13:14:49 -0400 2008</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <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>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>