cache_method 0.2.5 → 0.2.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjczZDg5NDE3MTY2MGMxMTMwNGI3OWFhOTZhMGM1NzE5YTQzZDkzYQ==
+  data.tar.gz: !binary |-
+    OGZhNzRiM2JhMTQ3NjA3MzllOTc0NDEyOGZlZGI5OTg4MWNkYTM4MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmQ1MTIxOTJkZTZjZjFjODRlMDM5MjNmOGU0N2YwN2M0NzIwYWEwYzAyMTAw
+    YTM2MDAwMGI0OWZhZmVlOWE5ODY2ZjhhZjlkNGE5MTliYmFjNTU1YzA2MjA3
+    YWM3YWFhODY1MTBiMGFmNWI5YmIxOTc3MWQ2MmM2YmRlNjYxOTI=
+  data.tar.gz: !binary |-
+    NTQ5ZDBkYjViNGIxYjk0MDE4MTY0ZGRmNTFlNTI0NTcwMDFiN2NmZmZmNThk
+    ODdlYWVkNDcyZjlmODVjNTNjYzI1OGUzNjJiNDg2YjhjZDIxODc2ODhlYzg5
+    YzUzZDMzNmIzNmNkNWQyNGEyMTA5OWFjNzU4MGU4ZjhhODViOTE=

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.2.6 / 2013-05-13
+
+* Enhancements
+
+  * cache_method_clear_on - for when a cache should be cleared whenever another method is called - thanks @rubemz ! https://github.com/seamusabshere/cache_method/pull/4
+  * hypothetically more useful output when you require 'cache_method/debug'
+
 0.2.5 / 2012-04-24
 
 * Enhancements

data/Gemfile

@@ -1,11 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cache_method.gemspec
 gemspec
-
-# development dependencies
-gem 'rake'
-gem 'dalli'
-gem 'yard'
-gem 'minitest'
-gem 'minitest-reporters'

data/README.markdown

@@ -24,17 +24,29 @@ We use `cache_method` for [data science at Brighter Planet](http://brighterplane
 
     require 'cache_method'
     class Blog
+
       attr_reader :name, :url
+
       def initialize(name, url)
         @name = name
         @url = url
       end
-      # The slow method that you want to speed up
+
       def entries(date)
         # ...
       end
+
+      # cache that slow method!
       cache_method :entries
-      # Not always required
+
+      def update(stuff)
+        # ...
+      end
+
+      # automatically clear cache for #entries when #update is called...
+      cache_method_clear_on :update, :entries
+
+      # custom cache key - not always required!
       def as_cache_key
         { :name => name, :url => url }
       end
@@ -221,6 +233,11 @@ Rest assured that `Tiger.my_module_method` and `Lion.my_module_method` will be c
       # cache_method :my_module_method
     end
 
+## Contributors
+
+* [Seamus Abshere](https://github.com/seamusabshere)
+* [Rubem Nakamura](https://github.com/rubemz)
+
 ## Copyright
 
 Copyright 2012 Seamus Abshere

data/cache_method.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "cache_method/version"
+require File.expand_path("../lib/cache_method/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "cache_method"
@@ -17,5 +16,13 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
   
-  s.add_dependency 'cache', '>=0.2.1'
+  s.add_runtime_dependency 'cache', '>=0.2.1'
+
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'dalli'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'minitest'
+  if RUBY_VERSION >= '1.9'
+    s.add_development_dependency 'minitest-reporters'
+  end
 end

data/lib/cache_method.rb

@@ -14,15 +14,15 @@ module CacheMethod
       @config ||= Config.new
     end
   end
-  
+
   def CacheMethod.klass_name(obj) #:nodoc:
     (obj.is_a?(::Class) or obj.is_a?(::Module)) ? obj.to_s : obj.class.to_s
   end
-  
+
   def CacheMethod.method_delimiter(obj) #:nodoc:
     (obj.is_a?(::Class) or obj.is_a?(::Module)) ? '.' : '#'
   end
-  
+
   def CacheMethod.method_signature(obj, method_id) #:nodoc:
     [ klass_name(obj), method_id ].join method_delimiter(obj)
   end
@@ -55,7 +55,7 @@ module CacheMethod
   def CacheMethod.digest(obj)
     ::Digest::SHA1.hexdigest ::Marshal.dump(resolve_cache_key(obj))
   end
-    
+
   # All Objects, including instances and Classes, get the <tt>#cache_method_clear</tt> method.
   module InstanceMethods
     # Clear the cache for a particular method.
@@ -99,6 +99,30 @@ module CacheMethod
         ::CacheMethod::CachedResult.new(self, method_id, original_method_id, ttl, args, &blk).fetch
       end
     end
+
+    # Clear a cache method once another method is called. Useful in situations where
+    # you want to clear a cache whenever another method is callled, commonly
+    # an update.
+    #
+    # Example:
+    #     class Blog
+    #       def get_latest_entries
+    #         # [...]
+    #       end
+    #       def update_entries
+    #         # update happens
+    #       end
+    #       cache_method_clear_on :update_entries, :get_latest_entries
+    #     end
+    def cache_method_clear_on(method_id, cache_method_clear_id)
+      original_method_id = "_original_#{method_id}"
+      alias_method original_method_id, method_id
+
+      define_method method_id do |*args, &blk|
+        cache_method_clear cache_method_clear_id
+        send(original_method_id, *args, &blk)
+      end
+    end
   end
 end
 

data/lib/cache_method/debug.rb

@@ -1,18 +1,25 @@
 module CacheMethod
   def CacheMethod.digest(obj)
-    if (l = ::Marshal.dump(resolve_cache_key(obj)).length) > 500
-      $stderr.puts "[cache_method] DIGEST (long?): #{resolve_cache_key(obj).inspect}"
+    cache_key = resolve_cache_key obj
+    m = Marshal.dump cache_key
+    if m.length > 1000
+      $stderr.puts
+      $stderr.puts "[cache_method] DIGEST (#{'X' * (m.length / 1024)}): #{cache_key.inspect}"
     end
-    ::Digest::SHA1.hexdigest ::Marshal.dump(resolve_cache_key(obj))
+    ::Digest::SHA1.hexdigest m
   end
 
   class CachedResult
     def debug_get_wrapped
       retval = original_get_wrapped
       if retval
+        # $stderr.puts
         # $stderr.puts "[cache_method] GET: #{method_signature}(#{args.inspect})"
       else
-        $stderr.puts "[cache_method] GET (miss!): #{method_signature}(#{args.inspect})"
+        cache_key = CacheMethod.resolve_cache_key obj
+        m = Marshal.dump cache_key
+        $stderr.puts
+        $stderr.puts "[cache_method] GET (miss!): #{method_signature}(#{args.inspect}) - #{::Digest::SHA1.hexdigest(m)} - #{cache_key.inspect}"
       end
       retval
     end
@@ -21,9 +28,12 @@ module CacheMethod
 
     def debug_set_wrapped
       retval = original_set_wrapped
-      if (l = ::Marshal.dump(retval).length > 1000)
-        $stderr.puts "[cache_method] SET (long?): #{method_signature}(#{args.inspect}) -> #{retval.inspect}"
+      m = Marshal.dump retval
+      if m.length > 1000
+        $stderr.puts
+        $stderr.puts "[cache_method] SET (#{'X' * (m.length / 1024)}): #{method_signature}(#{args.inspect}) -> #{retval.inspect}"
       else
+        # $stderr.puts
         # $stderr.puts "[cache_method] SET: #{method_signature}(#{args.inspect})"
       end
       retval

data/lib/cache_method/version.rb

@@ -1,3 +1,3 @@
 module CacheMethod
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/test/helper.rb

@@ -2,12 +2,9 @@ require 'rubygems'
 require 'bundler/setup'
 require 'minitest/spec'
 require 'minitest/autorun'
-require 'minitest/reporters'
-MiniTest::Unit.runner = MiniTest::SuiteRunner.new
-MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
-
-if ::Bundler.definition.specs['ruby-debug19'].first or ::Bundler.definition.specs['ruby-debug'].first
-  require 'ruby-debug'
+if RUBY_VERSION >= '1.9'
+  require 'minitest/reporters'
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
 end
 
 require 'cache_method'
@@ -66,11 +63,11 @@ 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
@@ -123,6 +120,14 @@ class Blog1
     ["voo vaa #{name}"]
   end
   cache_method :get_latest_entries2, 1 # second
+  def update_entries param
+    if block_given?
+      yield param
+    else
+      param
+    end
+  end
+  cache_method_clear_on :update_entries, :get_latest_entries
   def as_cache_key
     { :name => name, :url => url }
   end

data/test/test_cache_method.rb

@@ -197,11 +197,25 @@ describe CacheMethod do
     a = new_instance_of_my_blog
     a.get_latest_entries.must_equal ["hello from #{a.name}"]
     a.request_count.must_equal 1
+    a.get_latest_entries.must_equal ["hello from #{a.name}"]
+    a.request_count.must_equal 1
     a.cache_method_clear :get_latest_entries
     a.get_latest_entries.must_equal ["hello from #{a.name}"]
     a.request_count.must_equal 2
   end
 
+  it %{cache_method_clear_on} do
+    a = new_instance_of_my_blog
+    a.get_latest_entries.must_equal ["hello from #{a.name}"]
+    a.request_count.must_equal 1
+    a.update_entries("param").must_equal("param")
+    a.update_entries(1) {|param| param + 1}.must_equal(2)
+    a.get_latest_entries.must_equal ["hello from #{a.name}"]
+    a.request_count.must_equal 2
+    a.get_latest_entries.must_equal ["hello from #{a.name}"]
+    a.request_count.must_equal 2
+  end
+
   it %{clear_correct_instance_method} do
     a = new_instance_of_my_blog
     a.get_latest_entries.must_equal ["hello from #{a.name}"]

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: cache_method
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.2.6
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cache
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,11 +20,80 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Like alias_method, but it's cache_method!
 email:
 - seamus@abshere.net
@@ -50,27 +117,26 @@ files:
 - test/test_cache_method.rb
 homepage: https://github.com/seamusabshere/cache_method
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: cache_method
-rubygems_version: 1.8.21
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lets you cache methods (to memcached, redis, etc.) sort of like you can memoize
   them
 test_files: