cache_method 0.1.5 → 0.1.6

data/README.rdoc

@@ -2,6 +2,12 @@
 
 It's like <tt>alias_method</tt>, but it's <tt>cache_method</tt>!
 
+Lets you cache the results of calling methods given their arguments. Like memoization, but stored in Memcached, Redis, etc. so that the cached results can be shared between processes and hosts.
+
+== Real-world usage
+
+In production use at {impact.brighterplanet.com}[http://impact.brighterplanet.com] and {data.brighterplanet.com}[http://data.brighterplanet.com].
+
 == Example
 
     require 'cache_method'
@@ -14,17 +20,16 @@ It's like <tt>alias_method</tt>, but it's <tt>cache_method</tt>!
         @url = url
       end
 
-      # The method we're going to cache
       def get_latest_entries
-        sleep 5
+        # ...
       end
-      
-      # What you get with this gem
       cache_method :get_latest_entries
 
-      # Per Ruby convention, a "hash code" representing the internal state of an instance.
-      # It's recommended that you construct a String or a Hash and then call #hash on it.
-      def hash
+      # cache_method defaults to using the #hash method
+      # It's a "hash code" (integer! always integer!) representing the internal state of an instance.
+      # If you need to customize it, you can define #method_cache_hash.
+      # In that case, it's recommended that you construct a String or a Hash and then call #hash on it (because you should return an integer)
+      def method_cache_hash
         { :name => name, :url => url }.hash
       end
     end
@@ -40,10 +45,6 @@ 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:
@@ -70,7 +71,7 @@ get_latest_entries doesn't take any arguments, so it must depend on my_blog.url
 
     class Blog
       # [...]
-      def hash
+      def method_cache_hash
         { :name => name, :url => url }.hash
       end
       # [...]
@@ -86,6 +87,33 @@ Note: this is NOT the same thing as <tt>#to_hash</tt>! That returns a <b><tt>Has
 
 If you don't want to modify #hash, use #method_cache_hash instead.
 
+== Module methods
+
+You can put <tt>#cache_method</tt> right into your module declarations:
+
+    module MyModule
+      def my_module_method(args)
+        # [...]
+      end
+      cache_method :my_module_method
+    end
+
+    class Tiger
+      extend MyModule
+    end
+    
+    class Lion
+      extend MyModule
+    end
+    
+Rest assured that <tt>Tiger.my_module_method</tt> and <tt>Lion.my_module_method</tt> will be cached correctly and separately. This, on the other hand, won't work:
+
+    class Tiger
+      extend MyModule
+      # wrong - will raise NameError Exception: undefined method `my_module_method' for class `Tiger'
+      # cache_method :my_module_method
+    end
+
 == Rationale
 
 * 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])

data/cache_method.gemspec

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

data/lib/cache_method/cached_result.rb

@@ -1,17 +1,12 @@
 require 'digest/md5'
 module CacheMethod
   class CachedResult #:nodoc: all
-    class << self
-      def fetch(options = {})
-        cached_result = new options
-        cached_result.fetch
-      end
-    end
-    
-    def initialize(options = {})
-      options.each do |k, v|
-        instance_variable_set "@#{k}", v
-      end
+    def initialize(obj, method_id, original_method_id, ttl, args)
+      @obj = obj
+      @method_id = method_id
+      @original_method_id = original_method_id
+      @ttl = ttl
+      @args = args
     end
 
     attr_reader :obj
@@ -35,10 +30,10 @@ module CacheMethod
     end
     
     def cache_key
-      if obj.is_a? ::Class or obj.is_a? ::Module
-        [ 'CacheMethod', 'CachedResult', method_signature, current_epoch, args_digest ].join ','
+      if obj.is_a?(::Class) or obj.is_a?(::Module)
+        [ 'CacheMethod', 'CachedResult', method_signature, current_generation, args_digest ].compact.join ','
       else
-        [ 'CacheMethod', 'CachedResult', method_signature, obj_hash, current_epoch, args_digest ].join ','
+        [ 'CacheMethod', 'CachedResult', method_signature, obj_hash, current_generation, args_digest ].compact.join ','
       end
     end
     
@@ -54,8 +49,10 @@ module CacheMethod
       @args_digest ||= args.empty? ? 'empty' : ::Digest::MD5.hexdigest(args.join)
     end
         
-    def current_epoch
-      @current_epoch ||= Epoch.current(:obj => obj, :method_id => method_id)
+    def current_generation
+      if Config.instance.generational?
+        @current_generation ||= Generation.new(obj, method_id).current
+      end
     end
   end
 end

data/lib/cache_method/config.rb

@@ -11,6 +11,20 @@ module CacheMethod
   class Config
     include ::Singleton
     
+    # Whether to use "generational" caching. Default is true.
+    #
+    # Pro: enables clearing/flushing/expiring specific methods
+    # Con: requires an extra trip to memcached to get the current "generation"
+    #
+    # Set to false if you just flush everything and don't need to selectively flush particular methods
+    def generational=(boolean)
+      @generational = boolean
+    end
+    
+    def generational? #:nodoc:
+      @generational == true or @generational.nil?
+    end
+    
     # Storage for the cache.
     #
     # Supported memcached clients:

data/lib/cache_method/{epoch.rb → generation.rb}

@@ -1,25 +1,14 @@
 module CacheMethod
-  class Epoch #:nodoc: all
+  class Generation #:nodoc: all
     class << self
-      def current(options = {})
-        epoch = new options
-        epoch.current
-      end
-      
-      def mark_passing(options = {})
-        epoch = new options
-        epoch.mark_passing
-      end
-      
       def random_name
-        rand(1_000_000).to_s
+        rand(100_000_000).to_s
       end
     end
 
-    def initialize(options = {})
-      options.each do |k, v|
-        instance_variable_set "@#{k}", v
-      end
+    def initialize(obj, method_id)
+      @obj = obj
+      @method_id = method_id
     end
     
     attr_reader :obj
@@ -35,9 +24,9 @@ module CacheMethod
     
     def cache_key
       if obj.is_a? ::Class or obj.is_a? ::Module
-        [ 'CacheMethod', 'Epoch', method_signature ].join ','
+        [ 'CacheMethod', 'Generation', method_signature ].join ','
       else
-        [ 'CacheMethod', 'Epoch', method_signature, obj_hash ].join ','
+        [ 'CacheMethod', 'Generation', method_signature, obj_hash ].join ','
       end
     end
     
@@ -45,7 +34,7 @@ module CacheMethod
       if cached_v = Config.instance.storage.get(cache_key)
         cached_v
       else
-        v = Epoch.random_name
+        v = Generation.random_name
         # never expire!
         Config.instance.storage.set cache_key, v, 0
         v

data/lib/cache_method/version.rb

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

data/lib/cache_method.rb

@@ -3,7 +3,7 @@ require 'cache_method/version'
 module CacheMethod
   autoload :Config, 'cache_method/config'
   autoload :CachedResult, 'cache_method/cached_result'
-  autoload :Epoch, 'cache_method/epoch'
+  autoload :Generation, 'cache_method/generation'
 
   def self.config #:nodoc:
     Config.instance
@@ -30,7 +30,11 @@ module CacheMethod
     # Example:
     #     my_blog.clear_method_cache :get_latest_entries
     def clear_method_cache(method_id)
-      ::CacheMethod::Epoch.mark_passing :obj => self, :method_id => method_id
+      if ::CacheMethod.config.generational?
+        ::CacheMethod::Generation.new(self, method_id).mark_passing
+      else
+        raise ::RuntimeError, "[cache_method] clear_method_cache called, but you have disabled generational caching. Check your setting for CacheMethod.config.generational"
+      end
     end
   end
 
@@ -44,20 +48,16 @@ module CacheMethod
     #
     # Example:
     #     class Blog
-    #       # [...]
     #       def get_latest_entries
-    #         sleep 5
+    #         # [...]
     #       end
-    #       # [...]
     #       cache_method :get_latest_entries
-    #       # if you wanted a different ttl...
-    #       # cache_method :get_latest_entries, 800 #seconds
     #     end
     def cache_method(method_id, ttl = nil)
       original_method_id = "_uncached_#{method_id}"
       alias_method original_method_id, method_id
       define_method method_id do |*args|
-        ::CacheMethod::CachedResult.fetch :obj => self, :method_id => method_id, :original_method_id => original_method_id, :ttl => ttl, :args => args
+        ::CacheMethod::CachedResult.new(self, method_id, original_method_id, ttl, args).fetch
       end
     end
   end

data/test/helper.rb

@@ -52,6 +52,22 @@ class CopyCat1a < CopyCat1
   end
 end
 
+module Say
+  def say_count
+    @say_count ||= 0
+  end
+  
+  def say_count=(x)
+    @say_count = x
+  end
+  
+  def say(msg)
+    self.say_count += 1
+    msg
+  end
+  cache_method :say
+end
+
 class CopyCat2
   class << self
     attr_writer :echo_count
@@ -122,11 +138,7 @@ class Blog2
   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
@@ -141,3 +153,8 @@ module BlogM
     cache_method :get_latest_entries
   end
 end
+
+CopyCat1.extend Say
+CopyCat2.extend Say
+
+CopyCat1.send :include, Say

data/test/test_cache_method.rb

@@ -6,9 +6,12 @@ class TestCacheMethod < Test::Unit::TestCase
   def setup
     Blog2.request_count = 0
     CopyCat2.echo_count = 0
-    my_cache = Memcached.new '127.0.0.1:11211', :binary => false
+    CopyCat1.say_count = 0
+    CopyCat2.say_count = 0
+    my_cache = Memcached.new '127.0.0.1:11211', :binary => true
     my_cache.flush
     CacheMethod.config.storage = my_cache
+    CacheMethod.config.generational = true
   end
   
   def test_cache_instance_method_with_args
@@ -233,4 +236,63 @@ class TestCacheMethod < Test::Unit::TestCase
       a.echo 'hi'
     end
   end
+  
+  def test_method_added_by_extension
+    assert_equal 'hi', CopyCat2.say('hi')
+    assert_equal 1, CopyCat2.say_count
+
+    assert_equal 'hi', CopyCat2.say('hi')
+    assert_equal 1, CopyCat2.say_count
+  end
+  
+  def test_method_added_by_inclusion
+    a = CopyCat1.new 'sayer'
+
+    assert_equal 'hi', a.say('hi')
+    assert_equal 1, a.say_count
+    
+    assert_equal 'hi', a.say('hi')
+    assert_equal 1, a.say_count
+  end
+  
+  def test_not_confused_by_module
+    assert_equal 'hi', CopyCat2.say('hi')
+    assert_equal 1, CopyCat2.say_count
+
+    assert_equal 'hi', CopyCat2.say('hi')
+    assert_equal 1, CopyCat2.say_count
+
+    assert_equal 'hi', CopyCat1.say('hi')
+    assert_equal 1, CopyCat1.say_count
+
+    assert_equal 'hi', CopyCat1.say('hi')
+    assert_equal 1, CopyCat1.say_count
+  end
+  
+  def test_disable_generational_caching
+    CacheMethod.config.generational = false
+    
+    a = CopyCat1.new 'mimo'
+    
+    assert_equal 'hi', a.echo('hi')
+    assert_equal 1, a.echo_count
+    
+    assert_equal 'hi', a.echo('hi')
+    assert_equal 1, a.echo_count
+  end
+  
+  def test_cant_clear_method_cache_without_generational_caching
+    CacheMethod.config.generational = false
+
+    a = new_instance_of_my_blog
+    assert_equal ["hello from #{a.name}"], a.get_latest_entries
+    assert_equal 1, a.request_count
+    
+    assert_raises(::RuntimeError) do
+      a.clear_method_cache :get_latest_entries
+    end
+    
+    assert_equal ["hello from #{a.name}"], a.get_latest_entries
+    assert_equal 1, a.request_count
+  end
 end

metadata

@@ -1,77 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cache_method
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
 platform: ruby
-authors: 
+authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-12 23:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: cache
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2155074680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 0
-        - 2
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: memcached
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155074680
+- !ruby/object:Gem::Dependency
+  name: memcached
+  requirement: &2155073740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2155073740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2155072900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2155072900
 description: Like alias_method, but it's cache_method!
-email: 
+email:
 - seamus@abshere.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.rdoc
@@ -80,44 +59,35 @@ files:
 - lib/cache_method.rb
 - lib/cache_method/cached_result.rb
 - lib/cache_method/config.rb
-- lib/cache_method/epoch.rb
+- lib/cache_method/generation.rb
 - lib/cache_method/version.rb
 - test/helper.rb
 - test/test_cache_method.rb
-has_rdoc: true
 homepage: https://github.com/seamusabshere/cache_method
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: cache_method
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Lets you cache methods (to memcached, redis, etc.) sort of like you can memoize them
-test_files: 
+summary: Lets you cache methods (to memcached, redis, etc.) sort of like you can memoize
+  them
+test_files:
 - test/helper.rb
 - test/test_cache_method.rb