cache_method 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,8 +1,15 @@
+0.2.3 / 2012-04-06
+
+* Enhancements
+
+  * Make it possible to work with proxies by defining #to_cache_key which---unlike #as_cache_key---does not cause #class to be run
+
 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.
+  * Enable "debug mode" by requiring "cache_method/debug"... it helps you find cache keys that are suspiciously long (and therefore slow to digest).
 
 0.2.1 / 2012-03-01
 

data/README.markdown

@@ -54,8 +54,6 @@ If you're caching methods ActiveRecord objects (aka instances of `ActiveRecord::
       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.
@@ -81,7 +79,7 @@ or this might even work...
 
 See `Config` for the full list of supported caches.
 
-== Defining a #as_cache_key method
+## Defining a #as_cache_key method
 
 Since we're not pure functional programmers, sometimes cache hits depend on object state in addition to method arguments. To illustrate:
 
@@ -99,6 +97,25 @@ get_latest_entries doesn't take any arguments, so it must depend on my_blog.url
 
 If you don't define `#as_cache_key`, then `cache_method` will `Marshal.dump` an instance.
 
+## Danger: #to_cache_key
+
+Let's say you want need cache keys from classes that undefine the `#class` method (how annoying). You can define `#to_cache_key`, but **make sure it identifies the class too!** (in addition to the instance.)
+
+For example, if you find yourself passing association proxies as arguments to cached methods, this might be helpful:
+
+    user = User.first
+    Foo.bar(user.groups) # you're passing an association as an argument
+
+    class ActiveRecord::Associations::AssociationCollection
+      # danger! this is a special case... try to use #as_cache_key instead
+      # also note that this example is based on ActiveRecord 3.0.10 ... YMMV
+      def to_cache_key
+        [ proxy_owner.class.name, proxy_owner.id, proxy_reflection.name, conditions ].join('/')
+      end
+    end
+
+Otherwise, `cache_method` will try to run `user.groups.class` which causes the proxy to be loaded. You probably don't want to load 1000 AR objects just to generate a cache key.
+
 ## Module methods
 
 You can put `#cache_method` right into your module declarations:

data/lib/cache_method/cached_result.rb

@@ -16,7 +16,14 @@ module CacheMethod
             memo
           end
         else
-          obj.respond_to?(:as_cache_key) ? [obj.class.name, obj.as_cache_key] : obj
+          if obj.respond_to?(:to_cache_key)
+            # this is meant to be used sparingly, usually when a proxy class is involved
+            obj.to_cache_key
+          elsif obj.respond_to?(:as_cache_key)
+            [obj.class.name, obj.as_cache_key]
+          else
+            obj
+          end
         end
       end
     end

data/lib/cache_method/version.rb

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

data/test/helper.rb

@@ -55,6 +55,15 @@ class CopyCat1a < CopyCat1
   end
 end
 
+class CopyCat1b < CopyCat1
+  def as_cache_key
+    raise "Used as_cache_key"
+  end
+  def to_cache_key
+    raise "Used to_cache_key"
+  end
+end
+
 module Say
   def say_count
     @say_count ||= 0

data/test/test_cache_method.rb

@@ -317,6 +317,13 @@ class TestCacheMethod < Test::Unit::TestCase
     end
   end
 
+  def test_to_cache_key
+    assert_raises(RuntimeError, /Used to_cache_key/) do
+      a = CopyCat1b.new 'mimo'
+      a.echo 'hi'
+    end
+  end
+
   def test_method_added_by_extension
     assert_equal 'hi', CopyCat2.say('hi')
     assert_equal 1, CopyCat2.say_count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_method
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cache
-  requirement: &2152318920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152318920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: Like alias_method, but it's cache_method!
 email:
 - seamus@abshere.net
@@ -63,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cache_method
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Lets you cache methods (to memcached, redis, etc.) sort of like you can memoize