cache_method 0.1.4 → 0.1.5

data/README.rdoc

@@ -40,6 +40,10 @@ And clear them too
 
 (which doesn't delete the rest of your cache)
 
+== Real-world usage
+
+In production use at {carbon.brighterplanet.com}[http://carbon.brighterplanet.com], the Brighter Planet emission estimate web service.
+
 == Configuration (and supported cache clients)
 
 You need to set where the cache will be stored:
@@ -78,14 +82,13 @@ Ideally, you should try to make a <tt>String</tt> or a <tt>Hash</tt> and call th
 
 Note: this is NOT the same thing as <tt>#to_hash</tt>! That returns a <b><tt>Hash</tt></b>. What we want is an integer "hash code."
 
+== Using #method_cache_hash instead of #hash
+
+If you don't want to modify #hash, use #method_cache_hash instead.
+
 == Rationale
 
-* It should be easy to cache a method using memcached.
-* The main clients should be supported
-  * memcache-client (for people who use the Rails default)
-  * dalli (for people on heroku)
-  * memcached (for people using Evan Weaver's ultra-fast gem)
-  * redis (for people who like that sort of thing, but you won't get expiration)
+* It should be easy to cache a method using memcached, dalli (if you're on heroku), redis, etc. (that's why I made the {cache gem}[https://rubygems.org/gems/cache])
 * It should be easy to uncache a method without clearing the whole cache
 * It should be easy to cache instance methods
 * It should be easy to cache methods that depend on object state

data/cache_method.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   
   s.add_dependency 'cache', '>=0.2.1'
   s.add_development_dependency 'memcached'
+  s.add_development_dependency 'activesupport'
   # if RUBY_VERSION >= '1.9'
   #   s.add_development_dependency 'ruby-debug19'
   # else

data/lib/cache_method/cached_result.rb

@@ -35,7 +35,7 @@ module CacheMethod
     end
     
     def cache_key
-      if obj.is_a? ::Class
+      if obj.is_a? ::Class or obj.is_a? ::Module
         [ 'CacheMethod', 'CachedResult', method_signature, current_epoch, args_digest ].join ','
       else
         [ 'CacheMethod', 'CachedResult', method_signature, obj_hash, current_epoch, args_digest ].join ','
@@ -47,7 +47,7 @@ module CacheMethod
     end
             
     def obj_hash
-      @obj_hash ||= obj.hash
+      @obj_hash ||= obj.respond_to?(:method_cache_hash) ? obj.method_cache_hash : obj.hash
     end
   
     def args_digest

data/lib/cache_method/epoch.rb

@@ -30,11 +30,11 @@ module CacheMethod
     end
     
     def obj_hash
-      @obj_hash ||= obj.hash
+      @obj_hash ||= obj.respond_to?(:method_cache_hash) ? obj.method_cache_hash : obj.hash
     end
     
     def cache_key
-      if obj.is_a? ::Class
+      if obj.is_a? ::Class or obj.is_a? ::Module
         [ 'CacheMethod', 'Epoch', method_signature ].join ','
       else
         [ 'CacheMethod', 'Epoch', method_signature, obj_hash ].join ','

data/lib/cache_method/version.rb

@@ -1,3 +1,3 @@
 module CacheMethod
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/cache_method.rb

@@ -10,11 +10,11 @@ module CacheMethod
   end
   
   def self.klass_name(obj) #:nodoc:
-    obj.is_a?(::Class) ? obj.to_s : obj.class.to_s
+    (obj.is_a?(::Class) or obj.is_a?(::Module)) ? obj.to_s : obj.class.to_s
   end
   
   def self.method_delimiter(obj) #:nodoc:
-    obj.is_a?(::Class) ? '.' : '#'
+    (obj.is_a?(::Class) or obj.is_a?(::Module)) ? '.' : '#'
   end
   
   def self.method_signature(obj, method_id) #:nodoc:
@@ -66,4 +66,5 @@ end
 unless ::Object.method_defined? :cache_method
   ::Object.send :include, ::CacheMethod::InstanceMethods
   ::Class.send :include, ::CacheMethod::ClassMethods
+  ::Module.send :include, ::CacheMethod::ClassMethods
 end

data/test/helper.rb

@@ -38,11 +38,20 @@ class CopyCat1
     end
   end
   def hash
+    raise "Used hash"
+  end
+  def method_cache_hash
     name.hash
   end
   cache_method :echo
 end
 
+class CopyCat1a < CopyCat1
+  def method_cache_hash
+    raise "Used method_cache_hash"
+  end
+end
+
 class CopyCat2
   class << self
     attr_writer :echo_count
@@ -112,3 +121,23 @@ class Blog2
     cache_method :get_latest_entries
   end
 end
+
+require 'active_support'
+require 'active_support/core_ext/module'
+module BlogM
+  # mattr_accessor :request_count
+  # self.request_count = 0
+  def self.request_count
+    @request_count ||= 0
+  end
+  def self.request_count=(x)
+    @request_count = x
+  end
+  def self.get_latest_entries
+    self.request_count += 1
+    'danke schoen'
+  end
+  class << self
+    cache_method :get_latest_entries
+  end
+end

data/test/test_cache_method.rb

@@ -20,7 +20,7 @@ class TestCacheMethod < Test::Unit::TestCase
     assert_equal 'hi', a.echo('hi')
     assert_equal 1, a.echo_count
   end
-
+  
   def test_cache_instance_method_with_nil_args
     a = CopyCat1.new 'mimo'
     assert_equal nil, a.echo
@@ -31,11 +31,11 @@ class TestCacheMethod < Test::Unit::TestCase
     
     assert_equal nil, a.echo(nil)
     assert_equal 2, a.echo_count
-
+  
     assert_equal nil, a.echo(nil)
     assert_equal 2, a.echo_count    
   end
-
+  
   def test_cache_instance_method_with_array_args
     a = CopyCat1.new 'mimo'
     
@@ -64,7 +64,7 @@ class TestCacheMethod < Test::Unit::TestCase
     assert_equal [], a.echo([])
     assert_equal 4, a.echo_count
   end
-
+  
   def test_cache_class_method_with_args
     assert_equal 'hi', CopyCat2.echo('hi')
     assert_equal 1, CopyCat2.echo_count
@@ -82,7 +82,7 @@ class TestCacheMethod < Test::Unit::TestCase
     
     assert_equal nil, CopyCat2.echo(nil)
     assert_equal 2, CopyCat2.echo_count
-
+  
     assert_equal nil, CopyCat2.echo(nil)
     assert_equal 2, CopyCat2.echo_count    
   end
@@ -218,4 +218,19 @@ class TestCacheMethod < Test::Unit::TestCase
     assert_equal 'hi', a.echo('hi')
     assert_equal 1, a.echo_count
   end
+  
+  def test_cache_module_method
+    assert_equal 0, BlogM.request_count
+    assert_equal 'danke schoen', BlogM.get_latest_entries
+    assert_equal 1, BlogM.request_count
+    assert_equal 'danke schoen', BlogM.get_latest_entries
+    assert_equal 1, BlogM.request_count
+  end
+  
+  def test_method_cache_hash
+    assert_raises(RuntimeError, /Used method_cache_hash/) do
+      a = CopyCat1a.new 'mimo'
+      a.echo 'hi'
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cache_method
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 17
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -06:00
+date: 2011-03-12 23:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Like alias_method, but it's cache_method!
 email: 
 - seamus@abshere.net
@@ -100,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cache_method
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Lets you cache methods (to memcached, redis, etc.) sort of like you can memoize them