method_cache 0.6.4 → 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+*~
+*.swp
+Gemfile.lock

data/.rbenv-gemsets

@@ -0,0 +1 @@
+method_cache

data/.rbenv-version

@@ -0,0 +1 @@
+ree-1.8.7-2012.02

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+
+gemspec

data/Rakefile

@@ -1,45 +1,10 @@
-require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "method_cache"
-    s.summary = %Q{Simple memcache-based memoization library for Ruby}
-    s.email = "code@justinbalthrop.com"
-    s.homepage = "http://github.com/ninjudd/method_cache"
-    s.description = "Simple memcache-based memoization library for Ruby"
-    s.authors = ["Justin Balthrop"]
-    s.add_dependency('memcache', '>= 1.0.0')
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib'
+  t.libs = ['lib', 'test']
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'method_cache'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |t|
-    t.libs << 'test'
-    t.test_files = FileList['test/**/*_test.rb']
-    t.verbose = true
-  end
-rescue LoadError
-end
-
 task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/method_cache/local_cache.rb

@@ -0,0 +1,67 @@
+module MethodCache
+  class LocalCache
+    def initialize
+      clear
+    end
+
+    def clear
+      @data       = {}
+      @cached_at  = {}
+      @expires_at = {}
+    end
+
+    def get(key)
+      if expires = expires_at(key)
+        delete(key) if expires <= Time.now
+      end
+      @data[key]
+    end
+    alias [] get
+
+    def count(key)
+      get(key).to_i
+    end
+
+    def set(key, value, expiry)
+      @cached_at[key]  = Time.now
+      @expires_at[key] = expiry_to_time(expiry)
+      @data[key]       = value
+    end
+    alias []= set
+    alias write set
+
+    def delete(key)
+      @cached_at.delete(key)
+      @expires_at.delete(key)
+      @data.delete(key)
+    end
+
+    def incr(key, amount)
+      @data[key] = count(key) + amount
+    end
+
+    def decr(key, amount)
+      incr(key, -amount)
+    end
+
+    def expires_at(key)
+      @expires_at[key]
+    end
+
+    def cached_at(key)
+      @cached_at[key]
+    end
+
+  private
+
+    def expiry_to_time(expiry)
+      expiry = Time.at(expiry) if expiry > 60*60*24*30
+      if expiry.kind_of?(Time)
+        expiry
+      else
+        expiry = expiry.to_i
+        expiry == 0 ? nil : Time.now + expiry
+      end
+    end
+  end
+end

data/lib/method_cache/proxy.rb

@@ -1,5 +1,9 @@
 require 'digest/sha1'
 
+class Object
+  def metaclass; class << self; self; end; end
+end
+
 module MethodCache
   class Proxy
     attr_reader :method_name, :opts, :args, :target
@@ -44,13 +48,22 @@ module MethodCache
     end
 
     def update
-      value = block_given? ? yield(cache[key]) : target.send(method_name_without_caching, *args)
-      write_to_cache(key, value)
-      value
+      if block_given?
+        old_value = read_from_cache(key)
+        return if old_value.nil?
+
+        old_value = nil if old_value == NULL
+        new_value = yield(old_value)
+        return if old_value == new_value
+      else
+        new_value = target.send(method_name_without_caching, *args)
+      end
+      write_to_cache(key, new_value)
+      new_value
     end
 
     def value
-      value = opts[:counter] ? cache.count(key) : cache[key] unless MethodCache.disabled?
+      value = read_from_cache(key)
       value = nil unless valid?(:load, value)
 
       if value.nil?
@@ -59,6 +72,11 @@ module MethodCache
         write_to_cache(key, value) if valid?(:save, value)
       end
 
+      if opts[:counter]
+        value = [value, opts[:max]].min if opts[:max]
+        value = [value, opts[:min]].max if opts[:min]
+      end
+
       value = nil if value == NULL
       if clone? and value
         value.clone
@@ -98,12 +116,19 @@ module MethodCache
       if @cache.nil?
         @cache = opts[:cache] || MethodCache.default_cache
         @cache = Memcache.pool[@cache] if @cache.kind_of?(Symbol)
+        if not @cache.respond_to?(:[]) and @cache.respond_to?(:get)
+          @cache.metaclass.module_eval do
+            define_method :[] do |key|
+              get(key)
+            end
+          end
+        end
       end
       @cache
     end
 
     def local?
-      cache.kind_of?(Hash)
+      cache.kind_of?(LocalCache) or cache.kind_of?(Hash)
     end
 
     def clone?
@@ -121,10 +146,23 @@ module MethodCache
       @key
     end
 
+    def cached_at
+      cache.cached_at(key) if cache.respond_to?(:cached_at)
+    end
+
+    def expires_at
+      cache.expires_at(key) if cache.respond_to?(:expires_at)
+    end
+
   private
 
     def expiry(value)
-      dynamic_opt(:expiry, value).to_i
+      value = dynamic_opt(:expiry, value).to_i
+      if defined?(Memcache) and cache.kind_of?(Memcache)
+        {:expiry => value}
+      else
+        value
+      end
     end
 
     def valid?(type, value)
@@ -137,12 +175,17 @@ module MethodCache
 
     def dynamic_opt(name, value = nil)
       if opts[name].kind_of?(Proc)
-        proc = opts[name].bind(target)
+        proc = opts[name]
         case proc.arity
-        when 0 then proc.call()
-        when 1 then proc.call(value)
+        when 0 then target.instance_exec(&proc)
+        when 1 then target.instance_exec(value, &proc)
         else
-          proc.call(value, *args)
+          meta = {
+            :args       => args,
+            :cached_at  => cached_at,
+            :expires_at => expires_at,
+          }
+          target.instance_exec(value, meta, &proc)
         end
       else
         opts[name]
@@ -150,18 +193,25 @@ module MethodCache
     end
 
     def write_to_cache(key, value)
+      unless opts[:counter]
+        value = value.nil? ? NULL : value
+      end
       if cache.kind_of?(Hash)
         raise 'expiry not permitted when cache is a Hash'        if opts[:expiry]
         raise 'counter cache not permitted when cache is a Hash' if opts[:counter]
         cache[key] = value
       elsif opts[:counter]
-        cache.write(key, value.to_s, :expiry => expiry(value))
+        cache.write(key, value.to_s, expiry(value))
       else
-        value = value.nil? ? NULL : value
-        cache.set(key, value, :expiry => expiry(value))
+        cache.set(key, value, expiry(value))
       end
     end
 
+    def read_from_cache(key)
+      return if MethodCache.disabled?
+      opts[:counter] ? cache.count(key) : cache[key]
+    end
+
     def increment(amount)
       raise "cannot increment non-counter method" unless opts[:counter]
       cache.incr(key, amount)
@@ -190,8 +240,12 @@ module MethodCache
       when defined?(ActiveRecord::Base) && ActiveRecord::Base
         "#{class_key(arg.class)}-#{arg.id}"
       else
-        hash = local? ? arg.hash : Marshal.dump(arg).hash
-        "#{class_key(arg.class)}-#{hash}"
+        if arg.respond_to?(:method_cache_key)
+          arg.method_cache_key
+        else
+          hash = local? ? arg.hash : Marshal.dump(arg).hash
+          "#{class_key(arg.class)}-#{hash}"
+        end
       end
     end
 

data/lib/method_cache.rb

@@ -1,6 +1,5 @@
-require 'memcache'
-
 $:.unshift(File.dirname(__FILE__))
+require 'method_cache/local_cache'
 require 'method_cache/proxy'
 
 module MethodCache
@@ -12,7 +11,7 @@ module MethodCache
       return if instance_methods.include?(proxy.method_name_without_caching)
 
       if cached_instance_methods.empty?
-        include(InvalidationMethods)
+        include(HelperMethods)
         extend(MethodAdded)
       end
 
@@ -43,7 +42,7 @@ module MethodCache
     return if methods.include?(proxy.method_name_without_caching)
 
     if cached_class_methods.empty?
-      extend(InvalidationMethods)
+      extend(HelperMethods)
       extend(SingletonMethodAdded)
     end
 
@@ -72,7 +71,7 @@ module MethodCache
   end
 
   def self.default_cache
-    @default_cache ||= {}
+    @default_cache ||= LocalCache.new
   end
 
   def cached_instance_methods(method_name = nil)
@@ -111,7 +110,7 @@ module MethodCache
     end
   end
 
-  def self.disable(&block)
+  def self.disable(value = true, &block)
     @disabled, old = true, @disabled
     yield
   ensure
@@ -122,7 +121,7 @@ module MethodCache
     @disabled
   end
 
-  module InvalidationMethods
+  module HelperMethods
     def invalidate_cached_method(method_name, *args, &block)
       cached_method(method_name, args).invalidate(&block)
     end
@@ -135,6 +134,14 @@ module MethodCache
       cached_method(method_name, args).update(&block)
     end
 
+    def method_cached_at(method_name, *args)
+      cached_method(method_name, args).cached_at
+    end
+
+    def method_expires_at(method_name, *args)
+      cached_method(method_name, args).expires_at
+    end
+
     def without_method_cache(&block)
       MethodCache.disable(&block)
     end

data/method_cache.gemspec

@@ -1,47 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-Gem::Specification.new do |s|
-  s.name = %q{method_cache}
-  s.version = "0.6.4"
+Gem::Specification.new do |gem|
+  gem.name          = "method_cache"
+  gem.version       = IO.read('VERSION')
+  gem.authors       = ["Justin Balthrop"]
+  gem.email         = ["git@justinbalthrop.com"]
+  gem.description   = %q{Simple memcache-based memoization library for Ruby}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/ninjudd/method_cache"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Justin Balthrop"]
-  s.date = %q{2011-08-23}
-  s.description = %q{Simple memcache-based memoization library for Ruby}
-  s.email = %q{code@justinbalthrop.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION.yml",
-    "lib/method_cache.rb",
-    "lib/method_cache/proxy.rb",
-    "method_cache.gemspec",
-    "test/method_cache_test.rb",
-    "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/ninjudd/method_cache}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Simple memcache-based memoization library for Ruby}
+  gem.add_development_dependency 'shoulda'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'dalli'
+  gem.add_development_dependency 'activesupport', '~> 2.3.9'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<memcache>, [">= 1.0.0"])
-    else
-      s.add_dependency(%q<memcache>, [">= 1.0.0"])
-    end
-  else
-    s.add_dependency(%q<memcache>, [">= 1.0.0"])
-  end
-end
+  gem.add_dependency 'memcache', '>= 1.0.0'
 
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/method_cache_remote_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'dalli'
+
+PORT    = 19112
+$client = Dalli::Client.new("localhost:#{PORT}")
+
+class FooBar
+  extend MethodCache
+
+  cache_method :foo, :cache => $client 
+  def foo
+    'bar'
+  end
+end
+
+class MethodCacheRemoteTest < Test::Unit::TestCase
+
+  should 'work with dalli client' do
+    start_memcache(PORT)
+    $client.flush
+
+    f = FooBar.new
+    assert_equal 'bar', f.foo
+  end
+end

data/test/method_cache_test.rb

@@ -1,4 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper'
+require 'memcache'
+
+TEST_EXPIRY = 1
 
 class Foo
   extend MethodCache
@@ -26,11 +29,39 @@ class Foo
     @i ||= 0
     @i  += i
   end
-  
+
   cache_class_method :zap, :counter => true
   def self.zap
     0
   end
+
+  attr_accessor :z
+  def zang
+    self.z ||= 1
+    self.z  += 1
+    nil
+  end
+  cache_method :zang
+
+  cache_method :pow, :expiry => TEST_EXPIRY
+  def pow(ignored)
+    Time.now
+  end
+
+  attr_accessor :bam_updated_at
+
+  cache_method :bam, :load_validation => lambda {|val, meta|
+    if bam_updated_at
+      meta[:cached_at] > bam_updated_at
+    else
+      true
+    end
+  }
+
+  def bam
+    @i ||= 0
+    @i  += 1
+  end
 end
 
 module Bar
@@ -62,13 +93,51 @@ class TestMethodCache < Test::Unit::TestCase
     assert_equal 1, f1
     assert_equal 3, f2
 
-    assert f1 == a.foo(1)
-    assert f1 != f2
-    assert f2 == a.foo(2)
+    assert_equal     f1, a.foo(1)
+    assert_not_equal f1, f2
+    assert_equal     f2, a.foo(2)
 
     b = a.bar
-    assert b == a.bar
-    assert b == a.bar
+    assert_equal b, a.bar
+    assert_equal b, a.bar
+  end
+
+  should 'store cached_at when cached locally' do
+    a = Foo.new
+    a.foo(1)
+
+    assert     a.method_cached_at(:foo, 1) <= Time.now
+    assert_nil a.method_cached_at(:foo, 2)
+  end
+
+  should 'expire and store expires_at when cached locally' do
+    a = Foo.new
+    t = a.pow(1)
+
+    assert     a.method_expires_at(:pow, 1) >= Time.now
+    assert_nil a.method_expires_at(:pow, 2)
+
+    # expire and recalculate
+    sleep TEST_EXPIRY
+    assert_not_equal t, a.pow(1)
+  end
+
+  should 'pass cached_at to load_validation' do
+    a = Foo.new
+    i = a.bam
+
+    assert a.method_cached_at(:bam) <= Time.now
+
+    # should be cached
+    assert_equal i, a.bam
+
+    # should still be cached
+    a.bam_updated_at = Time.now - 100
+    assert_equal i, a.bam
+
+    # should now be invalidated
+    a.bam_updated_at = Time.now + 100
+    assert_not_equal i, a.bam
   end
 
   should 'disable method_cache' do
@@ -182,4 +251,11 @@ class TestMethodCache < Test::Unit::TestCase
       assert_equal "m|:baz|Foo-#{a_hash}|{:a=3,:b=[5,6],:c=Object-#{o_hash}}|[false,true,{:o=Object-#{o_hash}}]", key
     end
   end
+
+  should 'cache nil locally' do
+    a = Foo.new
+    a.zang
+    a.zang
+    assert_equal 2, a.z
+  end
 end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'mocha'
+require 'mocha/setup'
 require 'pp'
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
@@ -10,4 +10,9 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + "/../../cache_version/lib"
 require 'method_cache'
 
 class Test::Unit::TestCase
+  def start_memcache(port)
+    system("memcached -p #{port} -U 0 -d -P /tmp/memcached_#{port}.pid")
+    sleep 1
+    File.read("/tmp/memcached_#{port}.pid")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: method_cache
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Justin Balthrop
@@ -15,13 +15,85 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-23 00:00:00 -07:00
+date: 2013-07-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: memcache
+  name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  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
+- !ruby/object:Gem::Dependency 
+  name: dalli
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 3
+        - 9
+        version: 2.3.9
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: memcache
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,28 +105,34 @@ dependencies:
         - 0
         version: 1.0.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id006
 description: Simple memcache-based memoization library for Ruby
-email: code@justinbalthrop.com
+email: 
+- git@justinbalthrop.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- .rbenv-gemsets
+- .rbenv-version
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- VERSION
 - lib/method_cache.rb
+- lib/method_cache/local_cache.rb
 - lib/method_cache/proxy.rb
 - method_cache.gemspec
+- test/method_cache_remote_test.rb
 - test/method_cache_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/ninjudd/method_cache
+homepage: https://github.com/ninjudd/method_cache
 licenses: []
 
 post_install_message: 
@@ -87,5 +165,7 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Simple memcache-based memoization library for Ruby
-test_files: []
-
+test_files: 
+- test/method_cache_remote_test.rb
+- test/method_cache_test.rb
+- test/test_helper.rb

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-:build: 
-:minor: 6
-:patch: 4
-:major: 0