timedcache 0.1.1 → 0.2

data/History.txt

@@ -0,0 +1,13 @@
+=== 0.2 / 2008-02-02
+
+* Updated specs to be compatible with the latest rSpec release.
+
+* Made thread safe by synchronizing all access to the @store instance
+  variable used by a TimedCache instance.
+
+* Altered the API so that strings and symbols are not treated as equivalent keys.
+  This is in order to prevent unintentional memory leaks.
+
+=== 0.1 / 2006-12-07
+
+* Initial release.

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/timed_cache.rb
+lib/timedcache.rb
+misc/thread_test.rb
+spec/timed_cache_spec.rb

data/README.txt

@@ -0,0 +1,57 @@
+= timedcache
+
+* http://timedcache.rubyforge.org
+
+== DESCRIPTION:
+
+TimedCache implements a cache in which you can place objects
+and specify a timeout value.
+
+If you attempt to retrieve the object within the specified timeout
+period, the object will be returned. If the timeout period has elapsed,
+the TimedCache will return nil.
+
+== FEATURES/PROBLEMS:
+
+* Memory or file-based data stores available.
+* Thread safety.
+
+== SYNOPSIS:
+
+  cache = TimedCache.new
+  cache.put :my_object_key, "Expensive data", 10 #=> "Expensive data"
+  
+  cache.get :my_object_key #=> "Expensive data"
+  cache[:my_object_key]    #=> "Expensive data"
+  
+  ... 10 seconds later:
+  cache.get :my_object_key #=> nil
+
+== INSTALL:
+
+  sudo gem timedcache
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nicholas Dainty
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/timedcache.rb'
+
+Hoe.new('timedcache', TimedCache::VERSION) do |p|
+  p.rubyforge_name = 'timedcache'
+  p.author = 'Nicholas Dainty'
+  p.email = 'nick@npad.co.uk'
+  p.summary = 'A very simple time-based object cache.'
+  p.description = p.paragraphs_of('README.txt', 3..4).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # Place RDocs on project home page.
+end

data/lib/timedcache.rb

@@ -1,4 +1,5 @@
 require "pstore"
+require "monitor"
 
 # == TimedCache
 # 
@@ -39,9 +40,13 @@ require "pstore"
 # 
 #   TimedCache.new(:type => :file, :filename => "my_cache.db")
 # 
+# The file-based cache makes it possible to easily share a cache between several ruby 
+# processes. However when using the cache in this way, you will probably want to update the 
+# cache by passing a block to the TimedCache#get method (see below for details).
+# 
 # Note that objects that cannot be marshalled (e.g. a Proc) can't be stored using the file-based cache.
 class TimedCache
-  Version = "0.1.1"
+  VERSION = "0.2"
   
   attr_reader :default_timeout
   
@@ -56,6 +61,7 @@ class TimedCache
     opts[:type] ||= :memory
     @default_timeout = opts[:default_timeout] || 60
     @store = new_store(opts)
+    @store.extend(MonitorMixin)
   end
   
   # Add an object to the cache. e.g.:
@@ -64,13 +70,31 @@ class TimedCache
   # The third parameter is an optional timeout value. If not specified, the 
   # <tt>:default_timeout</tt> for this TimedCache will be used instead.
   def put(key, value, timeout = @default_timeout)
-    @store.put(key, value, timeout)
+    @store.synchronize do
+      @store.put(key, value, timeout) unless value.nil?
+    end
   end
   
   # Retrieve the object which the given +key+. If the object has expired or
   # is not present, +nil+ is returned.
-  def get(key)
-    @store.get(key)
+  # 
+  # Optionally, a block can be given. The result of evaluating the block will
+  # be substituted as the cache value, if the cache has expired. This is particularly
+  # useful when using a file-based cache from multiple ruby processes, as it
+  # will prevent your application from making multiple simultaneous attempts to 
+  # re-populate the cache.
+  # 
+  # e.g.:
+  # 
+  #   cache.get("slow_database_query") do
+  #     MyDatabase.query("SELECT * FROM bigtable...")
+  #   end
+  # 
+  # The block syntax can also be used with the in-memory cache.
+  def get(key, &block)
+    @store.synchronize do
+      @store.get(key, &block)
+    end
   end
   
   # Add to the cache using a hash-like syntax. e.g.:
@@ -91,18 +115,52 @@ class TimedCache
   protected
   
   def new_store(options) #:nodoc:
-    self.class.const_get(options[:type].to_s.capitalize + "Store").new(options)
+    self.class.const_get(options[:type].to_s.capitalize + "Store").new(self, options)
   end
   
   class Store #:nodoc:
-    def initialize(options)
-      @options = options
+    def initialize(timed_cache, options)
+      @timed_cache = timed_cache
+      @options     = options
+    end
+    
+    protected
+    
+    def generic_get(key, timeout, callback, fetch_key = lambda {|k| @cache[key]})
+      if object_store = fetch_key.call(key)
+        if object_store.expired?
+          if callback
+            run_callback_and_add_to_cache(key, object_store, callback, timeout)
+          else
+            # Free up memory:
+            @cache[key] = nil
+          end
+        else
+          object_store.object
+        end
+      elsif callback
+        run_callback_and_add_to_cache(key, object_store, callback, timeout)
+      end
+    end
+    
+    def run_callback_and_add_to_cache(key, object_store, callback, timeout)
+      object_store.no_expiry! if object_store
+      
+      begin
+        result = callback.call
+      rescue
+        object_store.reset_expiry! if object_store
+        raise
+      end
+      
+      @timed_cache.put(key, result, timeout)
+      result
     end
   end
   
   class MemoryStore < Store #:nodoc:
-    def initialize(options)
-      super
+    def initialize(*args)
+      super(*args)
       @cache = Hash.new
     end
     
@@ -113,15 +171,8 @@ class TimedCache
       value
     end
     
-    def get(key)
-      if object_store = @cache[key]
-        if object_store.expired?
-          # Free up memory:
-          @cache[key] = nil
-        else
-          object_store.object
-        end
-      end
+    def get(key, timeout = @timed_cache.default_timeout, &block)
+      generic_get(key, timeout, block)
     end
   end
   
@@ -135,41 +186,46 @@ class TimedCache
       @cache = PStore.new(filename)
     end
     
-    def put(key, value, timeout = nil)
-      @cache.transaction do
-        @cache[key] = ObjectContainer.new(value, timeout)
-      end
+    def put(key, value, timeout)
+      @cache.transaction { @cache[key] = ObjectContainer.new(value, timeout) }
       
       # Return just the given value, so that references to the
       # ObjectStore instance can't be held outside this TimedCache:
       value
     end
     
-    def get(key)
-      @cache.transaction do
-        if object_store = @cache[key]
-          if object_store.expired?
-            # Free up memory:
-            @cache[key] = nil
-          else
-            object_store.object
-          end
-        end
+    def get(key, timeout = @timed_cache.default_timeout, &block)
+      if block
+        generic_get(key, timeout, block, lambda {|k| @cache.transaction { @cache[key] } })
+      else
+        @cache.transaction { generic_get(key, timeout, block) }
       end
     end
   end
   
   class ObjectContainer #:nodoc:
-    attr_reader :object
+    attr_accessor :object
     
     def initialize(object, timeout)
       @created_at = Time.now.utc
       @timeout    = timeout
       @object     = object
+      @frozen     = false
     end
     
     def expired?
-      (Time.now.utc - @timeout) > @created_at
+      if @frozen: false
+      else
+        (Time.now.utc - @timeout) > @created_at
+      end
+    end
+    
+    def no_expiry!
+      @frozen = true
+    end
+    
+    def reset_expiry!
+      @frozen = false
     end
   end
 end

data/misc/thread_test.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "../lib/timedcache")
+
+# This script will almost certainly raise an exception if 
+# thread safety is not implemented.
+
+db = File.join(File.dirname(__FILE__), "thread_test.db")
+
+cache = TimedCache.new(:type => :file, :filename => File.join(db))
+
+threads = []
+
+10.times do
+  threads << Thread.new do
+    100.times {
+      cache.put("thread-safe?", "let's find out")
+      cache.get("thread-safe?")
+    }
+  end
+end
+
+
+threads.each { |t| t.join }
+
+File.delete(db)

data/spec/timed_cache_spec.rb

@@ -0,0 +1,102 @@
+require File.join(File.dirname(__FILE__), "../lib/timedcache")
+
+$filename = File.join(File.dirname(__FILE__), "specs.db")
+
+describe "Adding and retrieving objects from the cache" do
+  setup do
+    @memory_cache = TimedCache.new
+    @file_cache   = TimedCache.new(:type => :file, :filename => $filename)
+    @caches       = [@memory_cache, @file_cache]
+  end
+  
+  teardown do
+    File.delete($filename)
+  end
+  
+  it "Can add an object to the cache, specifying a timeout value" do
+    @caches.each do |cache|
+      cache.put(:myobject, "This needs caching", 10).should == "This needs caching"
+    end
+  end
+    
+  it "Cache should hold seperate values for each key" do
+    @caches.each do |cache|    
+      cache.put(:myobject, "This needs caching", 10).should == "This needs caching"
+      cache.put(:my_other_object, "...and this too", 10).should == "...and this too"
+      cache.get(:myobject).should == "This needs caching"
+      cache.get(:my_other_object).should == "...and this too"
+    end
+  end
+  
+  it "String and symbol keys are not treated as equivalent" do
+    @caches.each do |cache|
+      cache[:symbolkey]  = "Referenced by symbol"
+      cache["stringkey"] = "Referenced by string"
+      
+      cache[:symbolkey].should == "Referenced by symbol"
+      cache["symbolkey"].should == nil
+      
+      cache["stringkey"].should == "Referenced by string"
+      cache[:stringkey].should == nil
+    end
+  end
+  
+  it "After the specified timeout value has elapsed, nil should be returned" do
+    @caches.each do |cache|    
+      cache.put(:myobject, "This needs caching", 0).should == "This needs caching"
+      cache.get(:myobject).should == nil
+    end
+  end
+  
+  it "If no object matching the given key is found, nil should be returned" do
+    @caches.each do |cache|
+      cache.get(:my_nonexistant_object).should == nil
+    end
+  end
+  
+  it "Should be able to use an array as a cache key" do
+    @caches.each do |cache|
+      cache.put([123,234], "Array").should == "Array"
+      cache.get([123,234]).should == "Array"
+    end
+  end
+  
+  it "Passing a block to the TimedCache#get method should substitute the " +
+     "result of the block as the value for the given key" do
+    @caches.each do |cache|
+      cache.put("block_test", 1984, 0)
+      cache.get("block_test") { 2001 }.should == 2001
+      cache.get("block_test").should == 2001
+    end
+  end
+  
+  it "Passing a block to TimedCache#get should add the result of the callback " + 
+     "when there is no existing value for the key given" do
+    @caches.each do |cache|
+      cache.get("new_key_with_block").should == nil
+      cache.get("new_key_with_block") { "Nicholas" }.should == "Nicholas"
+    end
+  end
+end
+
+describe "Specifying a default timeout" do
+  it "Should be able to it a default timeout when creating a TimedCache" do
+    cache = TimedCache.new(:default_timeout => 20)
+    cache.should be_kind_of(TimedCache)
+    cache.default_timeout.should == 20
+  end
+  
+  it "If no default timeout is set, 60 seconds should be used" do
+    cache = TimedCache.new
+    cache.should be_kind_of(TimedCache)
+    cache.default_timeout.should == 60
+  end
+  
+  it "Timeout specified when putting a new object into the cache should override default timeout" do
+    cache = TimedCache.new(:default_timeout => 20)
+    cache.default_timeout.should == 20
+    cache.put("alternative_timeout", "2 minutes", 120)
+    cache.instance_variable_get(:@store).instance_variable_get(
+      :@cache)["alternative_timeout"].instance_variable_get(:@timeout).should == 120
+  end
+end

metadata

@@ -1,60 +1,71 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: timedcache
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-03-26 00:00:00 +01:00
-summary: A very simple time-based object cache.
-require_paths: 
-- lib
-email: nick@npad.co.uk
-homepage: http://timedcache.rubyforge.org
-rubyforge_project: timedcache
-description: TimedCache implements a cache in which you can place objects and specify a timeout value.  If you attempt to retrieve the object within the specified timeout period, the object will be returned. If the timeout period has elapsed, the TimedCache will return nil.
-autorequire: timedcache
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: "0.2"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Nicholas Dainty
-files: 
-- doc/classes
-- doc/created.rid
-- doc/files
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/rdoc-style.css
-- lib/timed_cache.rb
-- lib/timedcache.rb
-- specs/timed_cache_spec.rb
-- MIT_LICENSE
-test_files: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-rdoc_options: 
-- --main
-- TimedCache
-- --line-numbers
-- --inline-source
-extra_rdoc_files: 
-- MIT_LICENSE
+date: 2008-02-03 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: TimedCache implements a cache in which you can place objects and specify a timeout value.  If you attempt to retrieve the object within the specified timeout period, the object will be returned. If the timeout period has elapsed, the TimedCache will return nil.
+email: nick@npad.co.uk
 executables: []
 
 extensions: []
 
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/timed_cache.rb
+- lib/timedcache.rb
+- misc/thread_test.rb
+- spec/timed_cache_spec.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: timedcache
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A very simple time-based object cache.
+test_files: []
 

data/MIT_LICENSE

@@ -1,7 +0,0 @@
-Copyright (c) 2006 Nicholas Dainty
-
-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/doc/created.rid

@@ -1 +0,0 @@
-Mon Mar 26 22:35:48 +0100 2007

data/doc/fr_class_index.html

@@ -1,27 +0,0 @@
-
-<?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">
-
-<!--
-
-    Classes
-
-  -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Classes</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
-  <base target="docwin" />
-</head>
-<body>
-<div id="index">
-  <h1 class="section-bar">Classes</h1>
-  <div id="index-entries">
-    <a href="classes/TimedCache.html">TimedCache</a><br />
-  </div>
-</div>
-</body>
-</html>

data/doc/fr_file_index.html

@@ -1,29 +0,0 @@
-
-<?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">
-
-<!--
-
-    Files
-
-  -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Files</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
-  <base target="docwin" />
-</head>
-<body>
-<div id="index">
-  <h1 class="section-bar">Files</h1>
-  <div id="index-entries">
-    <a href="files/MIT_LICENSE.html">MIT_LICENSE</a><br />
-    <a href="files/lib/timed_cache_rb.html">lib/timed_cache.rb</a><br />
-    <a href="files/lib/timedcache_rb.html">lib/timedcache.rb</a><br />
-  </div>
-</div>
-</body>
-</html>

data/doc/fr_method_index.html

@@ -1,31 +0,0 @@
-
-<?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">
-
-<!--
-
-    Methods
-
-  -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Methods</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="rdoc-style.css" type="text/css" />
-  <base target="docwin" />
-</head>
-<body>
-<div id="index">
-  <h1 class="section-bar">Methods</h1>
-  <div id="index-entries">
-    <a href="classes/TimedCache.html#M000005">[] (TimedCache)</a><br />
-    <a href="classes/TimedCache.html#M000004">[]= (TimedCache)</a><br />
-    <a href="classes/TimedCache.html#M000003">get (TimedCache)</a><br />
-    <a href="classes/TimedCache.html#M000001">new (TimedCache)</a><br />
-    <a href="classes/TimedCache.html#M000002">put (TimedCache)</a><br />
-  </div>
-</div>
-</body>
-</html>

data/doc/index.html

@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-
-<!--
-
-    TimedCache Documentation
-
-  -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>TimedCache Documentation</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-</head>
-<frameset rows="20%, 80%">
-    <frameset cols="25%,35%,45%">
-        <frame src="fr_file_index.html"   title="Files" name="Files" />
-        <frame src="fr_class_index.html"  name="Classes" />
-        <frame src="fr_method_index.html" name="Methods" />
-    </frameset>
-    <frame src="classes/TimedCache.html" name="docwin" />
-</frameset>
-</html>

data/doc/rdoc-style.css

@@ -1,208 +0,0 @@
-
-body {
-    font-family: Verdana,Arial,Helvetica,sans-serif;
-    font-size:   90%;
-    margin: 0;
-    margin-left: 40px;
-    padding: 0;
-    background: white;
-}
-
-h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
-h1 { font-size: 150%; }
-h2,h3,h4 { margin-top: 1em; }
-
-a { background: #eef; color: #039; text-decoration: none; }
-a:hover { background: #039; color: #eef; }
-
-/* Override the base stylesheet's Anchor inside a table cell */
-td > a {
-  background: transparent;
-  color: #039;
-  text-decoration: none;
-}
-
-/* and inside a section title */
-.section-title > a {
-  background: transparent;
-  color: #eee;
-  text-decoration: none;
-}
-
-/* === Structural elements =================================== */
-
-div#index {
-    margin: 0;
-    margin-left: -40px;
-    padding: 0;
-    font-size: 90%;
-}
-
-
-div#index a {
-    margin-left: 0.7em;
-}
-
-div#index .section-bar {
-   margin-left: 0px;
-   padding-left: 0.7em;
-   background: #ccc;
-   font-size: small;
-}
-
-
-div#classHeader, div#fileHeader {
-    width: auto;
-    color: white;
-    padding: 0.5em 1.5em 0.5em 1.5em;
-    margin: 0;
-    margin-left: -40px;
-    border-bottom: 3px solid #006;
-}
-
-div#classHeader a, div#fileHeader a {
-    background: inherit;
-    color: white;
-}
-
-div#classHeader td, div#fileHeader td {
-    background: inherit;
-    color: white;
-}
-
-
-div#fileHeader {
-    background: #057;
-}
-
-div#classHeader {
-    background: #048;
-}
-
-
-.class-name-in-header {
-  font-size:  180%;
-  font-weight: bold;
-}
-
-
-div#bodyContent {
-    padding: 0 1.5em 0 1.5em;
-}
-
-div#description {
-    padding: 0.5em 1.5em;
-    background: #efefef;
-    border: 1px dotted #999;
-}
-
-div#description h1,h2,h3,h4,h5,h6 {
-    color: #125;;
-    background: transparent;
-}
-
-div#validator-badges {
-    text-align: center;
-}
-div#validator-badges img { border: 0; }
-
-div#copyright {
-    color: #333;
-    background: #efefef;
-    font: 0.75em sans-serif;
-    margin-top: 5em;
-    margin-bottom: 0;
-    padding: 0.5em 2em;
-}
-
-
-/* === Classes =================================== */
-
-table.header-table {
-    color: white;
-    font-size: small;
-}
-
-.type-note {
-    font-size: small;
-    color: #DEDEDE;
-}
-
-.xxsection-bar {
-    background: #eee;
-    color: #333;
-    padding: 3px;
-}
-
-.section-bar {
-   color: #333;
-   border-bottom: 1px solid #999;
-    margin-left: -20px;
-}
-
-
-.section-title {
-    background: #79a;
-    color: #eee;
-    padding: 3px;
-    margin-top: 2em;
-    margin-left: -30px;
-    border: 1px solid #999;
-}
-
-.top-aligned-row {  vertical-align: top }
-.bottom-aligned-row { vertical-align: bottom }
-
-/* --- Context section classes ----------------------- */
-
-.context-row { }
-.context-item-name { font-family: monospace; font-weight: bold; color: black; }
-.context-item-value { font-size: small; color: #448; }
-.context-item-desc { color: #333; padding-left: 2em; }
-
-/* --- Method classes -------------------------- */
-.method-detail {
-    background: #efefef;
-    padding: 0;
-    margin-top: 0.5em;
-    margin-bottom: 1em;
-    border: 1px dotted #ccc;
-}
-.method-heading {
-  color: black;
-  background: #ccc;
-  border-bottom: 1px solid #666;
-  padding: 0.2em 0.5em 0 0.5em;
-}
-.method-signature { color: black; background: inherit; }
-.method-name { font-weight: bold; }
-.method-args { font-style: italic; }
-.method-description { padding: 0 0.5em 0 0.5em; }
-
-/* --- Source code sections -------------------- */
-
-a.source-toggle { font-size: 90%; }
-div.method-source-code {
-    background: #262626;
-    color: #ffdead;
-    margin: 1em;
-    padding: 0.5em;
-    border: 1px dashed #999;
-    overflow: hidden;
-}
-
-div.method-source-code pre { color: #ffdead; overflow: hidden; }
-
-/* --- Ruby keyword styles --------------------- */
-
-.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
-
-.ruby-constant  { color: #7fffd4; background: transparent; }
-.ruby-keyword { color: #00ffff; background: transparent; }
-.ruby-ivar    { color: #eedd82; background: transparent; }
-.ruby-operator  { color: #00ffee; background: transparent; }
-.ruby-identifier { color: #ffdead; background: transparent; }
-.ruby-node    { color: #ffa07a; background: transparent; }
-.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
-.ruby-regexp  { color: #ffa07a; background: transparent; }
-.ruby-value   { color: #7fffd4; background: transparent; }

data/specs/timed_cache_spec.rb

@@ -1,80 +0,0 @@
-require File.join(File.dirname(__FILE__), "../lib/timedcache")
-
-$filename = File.join(File.dirname(__FILE__), "specs.db")
-
-context "Adding and retrieving objects from the cache" do
-  setup do
-    @memory_cache = TimedCache.new
-    @file_cache   = TimedCache.new(:type => :file, :filename => $filename)
-    @caches = [@memory_cache, @file_cache]
-  end
-  
-  teardown do
-    File.delete($filename)
-  end
-  
-  specify "Can add an object to the cache, specifying a timeout value" do
-    @caches.each do |cache|
-      cache.put(:myobject, "This needs caching", 10).should_equal "This needs caching"
-    end
-  end
-    
-  specify "Cache should hold seperate values for each key" do
-    @caches.each do |cache|    
-      cache.put(:myobject, "This needs caching", 10).should_equal "This needs caching"
-      cache.put(:my_other_object, "...and this too", 10).should_equal "...and this too"
-      cache.get(:myobject).should_equal "This needs caching"
-      cache.get(:my_other_object).should_equal "...and this too"
-    end
-  end
-  
-  specify "String and symbol keys are not treated as equivalent" do
-    @caches.each do |cache|
-      cache[:symbolkey]  = "Referenced by symbol"
-      cache["stringkey"] = "Referenced by string"
-      
-      cache[:symbolkey].should_equal "Referenced by symbol"
-      cache["symbolkey"].should_equal nil
-      
-      cache["stringkey"].should_equal "Referenced by string"
-      cache[:stringkey].should_equal nil
-    end
-  end
-  
-  specify "After the specified timeout value has elapsed, nil should be returned" do
-    @caches.each do |cache|    
-      cache.put(:myobject, "This needs caching", 0).should_equal "This needs caching"
-      cache.get(:myobject).should_equal nil
-    end
-  end
-  
-  specify "If no object matching the given key is found, nil should be returned" do
-    @caches.each do |cache|
-      cache.get(:my_nonexistant_object).should_equal nil
-    end
-  end
-  
-  specify "Should be able to use an array as a cache key" do
-    @caches.each do |cache|
-      cache.put([123,234], "Array").should_equal "Array"
-      cache.get([123,234]).should_equal "Array"
-    end
-  end
-end
-
-context "Specifying a default timeout" do
-  specify "Should be able to specify a default timeout when creating a TimedCache" do
-    cache = TimedCache.new(:default_timeout => 20)
-    cache.should_be_kind_of TimedCache
-    cache.default_timeout.should_equal 20
-  end
-  
-  specify "If no default timeout is set, 60 seconds should be used" do
-    cache = TimedCache.new
-    cache.should_be_kind_of TimedCache
-    cache.default_timeout.should_equal 60
-  end
-  
-  specify "Timeout specified when putting a new object into the cache should override default timeout" do
-  end
-end