simple_cache_rs 0.9.3 → 0.10.0

data/VERSION

@@ -1 +1 @@
-0.9.3
+0.10.0

data/lib/simple_cache/marshal.rb

@@ -5,8 +5,11 @@ module SimpleCache::Marshal
   extend self
   
   def uid(key)
-    md5 = Digest::MD5.hexdigest(key)
-    md5.unpack("LL").inject { |a,b| (a << 31) + b }
+    md5(key).unpack("LL").inject { |a,b| (a << 31) + b }
+  end
+
+  def md5(key)
+    Digest::MD5.hexdigest(key)
   end
 
   def unmarshal(marshalled)

data/lib/simple_cache.rb

@@ -19,7 +19,7 @@ module SimpleCache
     else                raise uri.scheme.inspect
     end
     
-    cache.extend SimpleCache
+    cache.extend SimpleCache::Interface
   end
 
   singleton_class.class_eval do
@@ -33,15 +33,103 @@ module SimpleCache
       Thread.current["simple_cache_store"] ||= new(url)
     end
 
-    extend Forwardable
-    delegate [:fetch, :store, :clear, :cached] => :cache_store
+    def fetch(key, &block)
+      key = SimpleCache.cache_key(key)
+      cache_store.fetch(key, &block)
+    end
+    
+    def store(key, value)
+      key = SimpleCache.cache_key(key)
+      cache_store.store key, value
+    end
+    
+    def clear(key)
+      key = SimpleCache.cache_key(key)
+      cache_store.clear key
+    end
+    
+    def cached(key, ttl = nil, &block)
+      key = SimpleCache.cache_key(key)
+      cache_store.cached key, ttl, &block
+    end
   end
 
-  def cached(key, ttl = nil, &block)
-    fetch(key) do
-      value = yield
-      store(key, value, ttl) unless ttl == 0 || ttl == false
-      value
+  module Interface
+    @@requests = @@misses = 0
+
+    def cached(key, ttl = nil, &block)
+      @@requests += 1
+      
+      fetch(key) do
+        @@misses += 1
+
+        value = yield
+        store(key, value, ttl) unless ttl == 0 || ttl == false
+        value
+      end
+    end
+
+    def self.stats
+      return {} if @@requests == 0
+      
+      {
+        :hits => @@requests - @@misses,
+        :misses => @@misses
+      }
     end
   end
+
+  def self.cache_key(obj)
+    return SimpleCache::Marshal.md5(obj.cache_key) if obj.respond_to?(:cache_key)
+
+    case obj
+    when String
+      SimpleCache::Marshal.md5 obj
+    when Hash
+      parts = []
+      obj.each { |k,v| parts << cache_key(k) << cache_key(v) }
+      SimpleCache::Marshal.md5 parts.join("/")
+    when Array
+      parts = obj.map { |part| cache_key(part) }
+      SimpleCache::Marshal.md5 parts.join(":")
+    else
+      SimpleCache::Marshal.md5 self.inspect
+    end
+  end
+  
+  # The SimplyCached module contains a method to easily implement
+  # memoized-like caching on top of SimpleCache
+  module SimplyCached
+    def simply_cached(method, options = {})
+      ttl = options[:ttl]
+
+      uncached_method = "#{method}__uncached".to_sym
+
+      alias_method uncached_method, method
+
+      define_method(method) do |*args|
+        cache_key = args.empty? ? self : [ self ] + args
+        current_ttl = if ttl.respond_to?(:call)
+          ttl.send(:call, *args)
+        else
+          ttl
+        end
+
+        SimpleCache.cached(cache_key, current_ttl) do
+          self.send uncached_method, *args
+        end 
+      end
+    end
+  end
+end
+
+class Module
+  include SimpleCache::SimplyCached
+end
+
+at_exit do
+  stats = SimpleCache::Interface.stats
+  next if stats.empty?
+  
+  STDERR.puts "SimpleCache stats: #{stats[:hits]} hits, #{stats[:misses]} misses"
 end

data/simple_cache_rs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_cache_rs"
-  s.version = "0.9.3"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["radiospiel"]
-  s.date = "2012-05-03"
+  s.date = "2012-05-23"
   s.description = "A sensibly fast, yet simplistic file based cache."
   s.email = "eno@open-lab.org"
   s.extra_rdoc_files = [
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/simple_cache/sqlite_store.rb",
     "simple_cache.gemspec",
     "simple_cache_rs.gemspec",
+    "test/memoize_test.rb",
     "test/redis_store_test.rb",
     "test/simple_cache_test.rb",
     "test/sqlite_store_test.rb",

data/test/memoize_test.rb

@@ -0,0 +1,42 @@
+require_relative 'test_helper'
+
+class SimpleCache::MemoizeTest < Test::Unit::TestCase
+  class X
+    attr :cache_key
+    
+    def initialize(value)
+      @value = value
+      @cache_key = { :value => @value[0,2] }.inspect
+    end
+
+    def do_something
+      @value.length
+    end
+    
+    simply_cached :do_something
+  end
+
+  def setup
+    SimpleCache.url = "#{File.dirname(__FILE__)}/memoize_test"
+  end
+
+  def test_simply_cached
+    foo = X.new "11"
+    assert_equal(2, foo.do_something)
+    assert_equal(2, foo.do_something)
+
+    # The following constructs an object with the same cache_key. If the
+    # do_something method is properly cached, it must return the identical
+    # value; if it was not cached then do_something would return a different
+    # value (i.e. 4)
+    bar = X.new "1111"
+    assert_equal(2, bar.do_something)
+    assert_equal(2, bar.do_something)
+
+    # The following constructs an object with a different cache_key. 
+    # The do_something method must return a different value.
+    baz = X.new "222"
+    assert_equal(3, baz.do_something)
+    assert_equal(3, baz.do_something)
+  end
+end

data/test/sqlite_store_test.rb

@@ -4,7 +4,7 @@ class SimpleCache::SqliteStoreTest < Test::Unit::TestCase
   include SimpleCache::TestCase
 
   def simple_cache
-    @simple_cache ||= SimpleCache.new("simple_cache_test").tap(&:clear)
+    @simple_cache ||= SimpleCache.new("#{ROOT}/test/simple_cache_test").tap(&:clear)
   end
   
   def teardown

data/test/test_helper.rb

@@ -16,15 +16,13 @@ SimpleCov.start do
   add_filter "test/*.rb"
 end
 
+ROOT = File.join(File.dirname(__FILE__), '..')
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'simple_cache'
 
 module SimpleCache::TestCase
-  def test_simple_cache_kindof
-    assert simple_cache.kind_of?(SimpleCache)
-  end
-  
   def test_simple_cache
     assert_equal(nil, simple_cache.fetch("bar"))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_cache_rs
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70161923648460 !ruby/object:Gem::Requirement
+  requirement: &70171064055940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70161923648460
+  version_requirements: *70171064055940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70161923647820 !ruby/object:Gem::Requirement
+  requirement: &70171064054980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923647820
+  version_requirements: *70171064054980
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70161923640800 !ruby/object:Gem::Requirement
+  requirement: &70171064052800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923640800
+  version_requirements: *70171064052800
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70161923639800 !ruby/object:Gem::Requirement
+  requirement: &70171064051480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923639800
+  version_requirements: *70171064051480
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70161923638540 !ruby/object:Gem::Requirement
+  requirement: &70171064050440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923638540
+  version_requirements: *70171064050440
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70161923634620 !ruby/object:Gem::Requirement
+  requirement: &70171064035160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923634620
+  version_requirements: *70171064035160
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70161923633860 !ruby/object:Gem::Requirement
+  requirement: &70171064032640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70161923633860
+  version_requirements: *70171064032640
 description: A sensibly fast, yet simplistic file based cache.
 email: eno@open-lab.org
 executables: []
@@ -109,6 +109,7 @@ files:
 - lib/simple_cache/sqlite_store.rb
 - simple_cache.gemspec
 - simple_cache_rs.gemspec
+- test/memoize_test.rb
 - test/redis_store_test.rb
 - test/simple_cache_test.rb
 - test/sqlite_store_test.rb
@@ -128,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4386423963111190464
+      hash: -1481443802176194731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: