method_cacher 0.0.3 → 0.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Method Cacher [![Build Status](https://secure.travis-ci.org/yaronw/method_cacher.png)](http://travis-ci.org/yaronw/method_cacher)
+# Method Cacher
 
 Wraps specified methods with a mechanism that caches the return values.
 
@@ -43,8 +43,8 @@ MethodCacher.configure do
 end
 ```
 
-If used with Rails and no cache store is specified, method_cacher automatically uses the cache store configured with rails
-through a call to `Rails.cache`.
+If used with Rails and no cache store is specified, method_cacher automatically uses the cache store configured in Rails
+by calling `Rails.cache`.
 
 ## Usage
 
@@ -69,7 +69,8 @@ __Options:__
 + :singleton - Singleton methods to be cached are specified in an array of symbols passed through this option.
 + :obj\_key - A _proc_ that accepts the cached object as a single parameter.  This _proc_ should return a value identifying this object.
     If this option is not specified, the object key defaults to the value returned by an instance method named _id_, which is convenient for usage
-    with ActiveRecord objects.
+    with ActiveRecord objects.  In cases when obj\_key evaluates to a nil, such as when using an ActiveRecord that hasn't been saved,
+    the cache is not used.
 
 `cache_method` can take any number of instance or singleton methods at once.
 
@@ -103,4 +104,18 @@ The clear cache methods take identical arguments as their respective original an
 clear the cache for the given set of arguments.
 
 So for example, issuing `clear_cache_for_foo('a')`, would clear the cache for a call to `foo('a')`
-but not to `foo('b')`.
+but not to `foo('b')`.
+
+# Examples
+
+## Caching ActiveRecord Methods That Return Relations
+
+Consider the following ActiveRecord class:
+
+```ruby
+class Factory < ActiveRecord::Base
+    has_many :widgets
+end
+```
+
+TODO: Continue here

data/lib/method_cacher/base.rb

@@ -152,6 +152,7 @@ module MethodCacher
       # Creates the key used to cache a method of the object.
       def cached_method_key(method_name, *args)
         obj_key = self.class.obj_key.call(self)
+        return nil unless obj_key # unable to form key and cache if obj_key evaluates to nil
         [self.class.name, obj_key, method_name, *args]
       end
     end

data/lib/method_cacher/version.rb

@@ -1,3 +1,3 @@
 module MethodCacher
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/method_cacher/base_spec.rb

@@ -193,6 +193,11 @@ describe MethodCacher::Base do
         obj2.foo.should_not == obj1.foo
       end
 
+      it "should not cache if :obj_key evaluates to nil" do
+        obj = NinthClass.new
+        lambda { obj.foo }.should_not be_twice_the_same
+      end
+
       it "should raise an exception if neither an :obj_key option is given nor the default fallback :id method is defined" do
         obj = SixthClass.new
         lambda { obj.foo }.should raise_error(NoMethodError)

data/spec/method_cacher/base_test_helper.rb

@@ -261,4 +261,15 @@ class EighthClass
   end
 
   caches_method :foo2, :foo4
+end
+
+
+class NinthClass
+  include MethodCacher::Base
+
+  caches_method :foo, obj_key: proc { |obj| nil }
+
+  def foo
+    Dummy.function
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_cacher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000Z
+date: 2012-01-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152739300 !ruby/object:Gem::Requirement
+  requirement: &2165582100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152739300
+  version_requirements: *2165582100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152738880 !ruby/object:Gem::Requirement
+  requirement: &2165581680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152738880
+  version_requirements: *2165581680
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &2152738460 !ruby/object:Gem::Requirement
+  requirement: &2165581260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152738460
+  version_requirements: *2165581260
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152738040 !ruby/object:Gem::Requirement
+  requirement: &2165580840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152738040
+  version_requirements: *2165580840
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2152737620 !ruby/object:Gem::Requirement
+  requirement: &2165580420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152737620
+  version_requirements: *2165580420
 description: Easily cache instance and singleton (i.e. class) methods of ActiveRecord
   or any object.
 email: