cache_method 0.2.1 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.2.2 / 2012-03-02
+
+* Enhancements
+
+  * Class name is now force-prepended to the result of #as_cache_key. This prevents objects of different classes that have the same #as_cache_key from being confused with each other. In any case, this sort of duck typing (?) doesn't seem appropriate for cache keys.
+
 0.2.1 / 2012-03-01
 
 * Enhancements

data/README.markdown

@@ -44,6 +44,27 @@ And clear them too
 
 (which doesn't delete the rest of your cache)
 
+## ActiveRecord
+
+If you're caching methods ActiveRecord objects (aka instances of `ActiveRecord::Base`), then you should probably define something like:
+
+    class ActiveRecord::Base
+      def as_cache_key
+        attributes
+      end
+    end
+
+Otherwise the full object will be marshal dumped **just to get a cache key**.
+
+## Debug
+
+CacheMethod can warn you if your obj or args cache keys are suspiciously long.
+
+    require 'cache_method'
+    require 'cache_method/debug'
+
+Then watch your logs.
+
 ## Configuration (and supported cache clients)
 
 You need to set where the cache will be stored:

data/lib/cache_method/cached_result.rb

@@ -16,7 +16,7 @@ module CacheMethod
             memo
           end
         else
-          obj.respond_to?(:as_cache_key) ? obj.as_cache_key : obj
+          obj.respond_to?(:as_cache_key) ? [obj.class.name, obj.as_cache_key] : obj
         end
       end
     end
@@ -46,6 +46,10 @@ module CacheMethod
         v
       end
     end
+
+    def exist?
+      Config.instance.storage.exist?(cache_key)
+    end
     
     def ttl
       @ttl ||= Config.instance.default_ttl

data/lib/cache_method/debug.rb

@@ -0,0 +1,17 @@
+module CacheMethod
+  class CachedResult #:nodoc: all
+    def obj_digest
+      if (l = ::Marshal.dump(CachedResult.resolve_cache_key(obj)).length) > 500
+        $stderr.puts "Warn: #{l} long obj digest. #{obj.class} -> #{CachedResult.resolve_cache_key(obj).inspect}"
+      end
+      @obj_digest ||= ::Digest::SHA1.hexdigest(::Marshal.dump(CachedResult.resolve_cache_key(obj)))
+    end
+  
+    def args_digest
+      if (l = ::Marshal.dump(CachedResult.resolve_cache_key(args)).length) > 500
+        $stderr.puts "Warn: #{l} long args digest. #{method_signature}(#{CachedResult.resolve_cache_key(args).inspect})"
+      end
+      @args_digest ||= args.empty? ? 'empty' : ::Digest::SHA1.hexdigest(::Marshal.dump(CachedResult.resolve_cache_key(args)))
+    end
+  end
+end

data/lib/cache_method/version.rb

@@ -1,3 +1,3 @@
 module CacheMethod
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/cache_method.rb

@@ -35,6 +35,10 @@ module CacheMethod
         raise ::RuntimeError, "[cache_method] cache_method_clear called, but you have disabled generational caching. Check your setting for CacheMethod.config.generational"
       end
     end
+
+    def cache_method_cached?(method_id, *args)
+      ::CacheMethod::CachedResult.new(self, method_id, nil, nil, args).exist?
+    end
   end
 
   # All Classes (but not instances), get the <tt>.cache_method</tt> method.

data/test/helper.rb

@@ -182,3 +182,15 @@ class DontMarshalMe < Struct.new(:message)
     message
   end
 end
+
+class DrJekyll
+  def as_cache_key
+    'just a guy'
+  end
+end
+
+class MrHyde
+  def as_cache_key
+    'just a guy'
+  end
+end

data/test/test_cache_method.rb

@@ -436,4 +436,40 @@ class TestCacheMethod < Test::Unit::TestCase
       end
     end
   end
+
+  def test_cached_query
+    a = CopyCat1.new 'mimo'
+    assert !a.cache_method_cached?(:echo, 'hi')
+    assert !a.cache_method_cached?(:echo, 'there')
+    a.echo('hi')
+    assert a.cache_method_cached?(:echo, 'hi')
+    assert !a.cache_method_cached?(:echo, 'there')
+
+    assert !BlogM.cache_method_cached?(:get_latest_entries)
+    assert !BlogM.cache_method_cached?(:get_latest_entries, 'there')
+    BlogM.get_latest_entries
+    assert BlogM.cache_method_cached?(:get_latest_entries)
+    assert !BlogM.cache_method_cached?(:get_latest_entries, 'there')
+  end
+
+  def test_class_name_automatically_appended_to_cache_key
+    jek = DrJekyll.new
+    hyde = MrHyde.new
+
+    assert_equal jek.as_cache_key, hyde.as_cache_key
+
+    a = CopyCat1.new 'mimo'
+
+    a.ack(jek)
+    assert_equal 1, a.ack_count
+
+    a.ack(hyde)
+    assert_equal 2, a.ack_count
+
+    a.ack(jek)
+    assert_equal 2, a.ack_count
+
+    a.ack(hyde)
+    assert_equal 2, a.ack_count
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_method
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000 Z
+date: 2012-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cache
-  requirement: &2153251040 !ruby/object:Gem::Requirement
+  requirement: &2152318920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2153251040
+  version_requirements: *2152318920
 description: Like alias_method, but it's cache_method!
 email:
 - seamus@abshere.net
@@ -38,6 +38,7 @@ files:
 - lib/cache_method.rb
 - lib/cache_method/cached_result.rb
 - lib/cache_method/config.rb
+- lib/cache_method/debug.rb
 - lib/cache_method/generation.rb
 - lib/cache_method/version.rb
 - test/helper.rb