ninjudd-method_cache 0.6.2

data/README.rdoc

@@ -0,0 +1,42 @@
+= MethodCache
+
+MethodCache lets you easily cache the results of any instance method or class method in
+Ruby.
+
+== Usage:
+
+  class Foo
+    extend MethodCache
+
+    cache_method :bar
+    def bar
+      # do expensive calculation
+    end
+    
+    cache_class_method :baz, :clone => true, :expiry => 1.day
+    def self.baz
+      # do some expensive calculation that will be invalid tomorrow
+    end
+  end
+
+  foo = Foo.new
+  foo.bar # does calculation
+  foo.bar # cached
+  
+  Foo.baz # does calculation
+  Foo.baz # cached
+  
+  Foo.invalidate_cached_method(:baz)
+
+  Foo.baz # does calculation
+  Foo.baz # cached
+
+== Install:
+
+  sudo gem install ninjudd-memcache -s http://gems.github.com
+  sudo gem install ninjudd-cache_version -s http://gems.github.com
+  sudo gem install ninjudd-method_cache -s http://gems.github.com
+
+== License:
+
+Copyright (c) 2009 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/VERSION.yml

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

data/lib/method_cache/proxy.rb

@@ -0,0 +1,172 @@
+module MethodCache
+  class Proxy
+    attr_reader :method_name, :opts, :args, :target
+
+    def initialize(method_name, opts)
+      @method_name = method_name
+      @opts        = opts
+    end
+
+    def bind(target, args)
+      self.clone.bind!(target, args)
+    end
+    
+    def bind!(target, args)
+      @target = target
+      @args   = args
+      @key    = nil
+      self
+    end
+
+    def invalidate
+      if block_given?
+        # Only invalidate if the block returns true.
+        value = cache[key]
+        return if value and not yield(value)
+      end
+      cache.delete(key)
+    end
+
+    def context
+      opts[:context]
+    end
+
+    def version
+      dynamic_opt(:version)
+    end
+
+    def cached?
+      not cache[key].nil?
+    end
+    
+    def update
+      value = block_given? ? yield(cache[key]) : target.send(method_name_without_caching, *args)
+      write_to_cache(key, value)
+      value
+    end
+
+    def value
+      value = cache[key]
+      value = nil unless valid?(:load, value)
+
+      if value.nil?
+        value = target.send(method_name_without_caching, *args)
+        write_to_cache(key, value) if valid?(:save, value)
+      end
+          
+      value = nil if value == NULL
+      if clone? and value
+        value.clone
+      else
+        value
+      end
+    end
+
+    NULL = 'NULL'
+    def method_with_caching
+      proxy = self # Need access to the proxy in the closure.
+
+      lambda do |*args|
+        proxy.bind(self, args).value
+      end
+    end
+
+    def method_name_without_caching
+      @method_name_without_caching ||= begin
+        base_name, punctuation = method_name.to_s.sub(/([?!=])$/, ''), $1
+        "#{base_name}_without_caching#{punctuation}"
+      end
+    end
+
+    def cache
+      if @cache.nil?
+        @cache = opts[:cache] || MethodCache.default_cache
+        @cache = MemCache.pool[@cache] if @cache.kind_of?(Symbol)
+      end
+      @cache
+    end
+
+    def local?
+      cache.kind_of?(Hash)
+    end
+
+    def clone?
+      !!opts[:clone]
+    end
+
+    def key
+      if @key.nil?
+        arg_string = ([method_name, target] + args).collect do |arg|
+          object_key(arg)
+        end.join('|')
+        @key = ['m', version, arg_string].compact.join('|')
+      end
+      @key
+    end
+
+  private
+
+    def expiry(value)
+      dynamic_opt(:expiry, value).to_i
+    end
+
+    def valid?(type, value)
+      name = "#{type}_validation".to_sym
+      return true unless opts[name]
+      return unless value
+      
+      dynamic_opt(name, value)
+    end
+
+    def dynamic_opt(name, value = nil)
+      if opts[name].kind_of?(Proc)
+        proc = opts[name].bind(target)       
+        case proc.arity
+        when 0: proc.call()
+        when 1: proc.call(value)
+        else
+          proc.call(value, *args)
+        end
+      else
+        opts[name]
+      end
+    end
+
+    def write_to_cache(key, value)
+      if cache.kind_of?(Hash)
+        raise 'expiry not permitted when cache is a Hash' if opts[:expiry]
+        cache[key] = value
+      else
+        value  = value.nil? ? NULL : value
+        cache.set(key, value, expiry(value))
+      end
+    end
+
+    def object_key(arg)      
+      return "#{class_key(arg.class)}-#{arg.string_hash}" if arg.respond_to?(:string_hash)
+
+      case arg
+      when NilClass      : 'nil'
+      when TrueClass     : 'true'
+      when FalseClass    : 'false'
+      when Numeric       : arg.to_s
+      when Symbol        : ":#{arg}"
+      when String        : "'#{arg}'"
+      when Class, Module : class_key(arg)
+      when Hash
+        '{' + arg.collect {|key, value| "#{object_key(key)}=#{object_key(value)}"}.sort.join(',') + '}'
+      when Array
+        '[' + arg.collect {|item| object_key(item)}.join(',') + ']'
+      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}"
+      end
+    end 
+
+    def class_key(klass)
+      klass.respond_to?(:version) ? "#{klass.name}_#{klass.version(context)}" : klass.name
+    end
+  end
+end

data/lib/method_cache.rb

@@ -0,0 +1,162 @@
+require 'memcache'
+
+$:.unshift(File.dirname(__FILE__))
+require 'method_cache/proxy'
+
+module MethodCache
+  def cache_method(method_name, opts = {})
+    method_name = method_name.to_sym
+    proxy = opts.kind_of?(Proxy) ? opts : Proxy.new(method_name, opts)
+    
+    if self.class == Class
+      return if instance_methods.include?(proxy.method_name_without_caching)
+
+      if cached_instance_methods.empty?
+        include(InvalidationMethods)
+        extend(MethodAdded)
+      end
+      
+      cached_instance_methods[method_name] = nil
+      begin
+        # Replace instance method.
+        alias_method proxy.method_name_without_caching, method_name
+        define_method method_name, proxy.method_with_caching
+      rescue NameError => e
+        # The method has not been defined yet. We will alias it in method_added.
+        # pp e, e.backtrace
+      end
+      cached_instance_methods[method_name] = proxy
+
+    elsif self.class == Module
+      # We will alias all methods when the module is mixed-in.
+      extend(ModuleAdded) if cached_module_methods.empty?
+      cached_module_methods[method_name.to_sym] = proxy
+    end
+  end
+
+  def cache_class_method(method_name, opts = {})
+    method_name = method_name.to_sym
+    proxy = opts.kind_of?(Proxy) ? opts : Proxy.new(method_name, opts)
+
+    return if methods.include?(proxy.method_name_without_caching)
+
+    if cached_class_methods.empty?
+      extend(InvalidationMethods)
+      extend(SingletonMethodAdded)
+    end
+
+    method_name = method_name.to_sym
+    cached_class_methods[method_name] = nil
+    begin
+      # Replace class method.
+      (class << self; self; end).module_eval do
+        alias_method proxy.method_name_without_caching, method_name
+        define_method method_name, proxy.method_with_caching
+      end
+    rescue NameError => e
+      # The method has not been defined yet. We will alias it in singleton_method_added.
+      # pp e, e.backtrace
+    end
+    cached_class_methods[method_name] = proxy
+  end
+
+  def self.default_cache
+    @default_cache ||= {}
+  end
+
+  def cached_instance_methods(method_name = nil)
+    if method_name
+      method_name = method_name.to_sym
+      ancestors.each do |klass|
+        next unless klass.kind_of?(MethodCache)
+        proxy = klass.cached_instance_methods[method_name]
+        return proxy if proxy
+      end
+      nil
+    else
+      @cached_instance_methods ||= {}
+    end
+  end
+
+  def cached_class_methods(method_name = nil)
+    if method_name
+      method_name = method_name.to_sym
+      ancestors.each do |klass|
+        next unless klass.kind_of?(MethodCache)
+        proxy = klass.cached_class_methods[method_name]
+        return proxy if proxy
+      end
+      nil
+    else
+      @cached_class_methods ||= {}
+    end
+  end
+
+  def cached_module_methods(method_name = nil)
+    if method_name
+      cached_module_methods[method_name.to_sym]
+    else
+      @cached_module_methods ||= {}
+    end
+  end
+
+  module InvalidationMethods
+   def invalidate_cached_method(method_name, *args, &block)
+      cached_method(method_name, args).invalidate(&block)
+    end
+
+    def method_value_cached?(method_name, *args)
+      cached_method(method_name, args).cached?
+    end
+    
+    def update_cached_method(method_name, *args, &block)
+      cached_method(method_name, args).update(&block)
+    end
+
+  private
+
+    def cached_method(method_name, args)
+      if self.kind_of?(Class) or self.kind_of?(Module)
+        proxy = cached_class_methods(method_name)
+      else
+        proxy = self.class.send(:cached_instance_methods, method_name)
+      end
+      raise "method '#{method_name}' not cached" unless proxy
+      proxy.bind(self, args)
+    end
+  end
+
+  module MethodAdded
+    def method_added(method_name)
+      if proxy = cached_instance_methods(method_name)
+        cache_method(method_name, proxy)
+      end
+      super
+    end
+  end
+
+  module SingletonMethodAdded
+    def singleton_method_added(method_name)
+      if proxy = cached_class_methods(method_name)
+        cache_class_method(method_name, proxy)
+      end
+      super
+    end
+  end
+
+  module ModuleAdded
+    def extended(mod)
+      mod.extend(MethodCache)
+      cached_module_methods.each do |method_name, proxy|
+        mod.cache_class_method(method_name, proxy)
+      end
+    end
+
+    def included(mod)
+      mod.extend(MethodCache)
+      cached_module_methods.each do |method_name, proxy|
+        mod.cache_method(method_name, proxy)
+      end
+    end
+  end
+end

data/test/method_cache_test.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Foo
+  extend MethodCache
+ 
+  def foo(i)
+    @i ||= 0
+    @i  += i
+  end
+  cache_method :foo
+
+  cache_method :bar
+  def bar
+    @i ||= 0
+    @i  += 1
+  end
+
+  @@i = 0
+  def baz(i)
+    @@i += i
+  end
+  cache_method :baz, :cache => :remote
+end
+
+module Bar
+  extend MethodCache
+  
+  cache_method :foo
+  def foo(i)
+    @i ||= 0
+    @i  += i
+  end
+end
+
+class Baz
+  include Bar
+end
+
+class TestMethodCache < Test::Unit::TestCase
+  should 'cache methods locally' do
+    a = Foo.new
+    f1 = a.foo(1)
+    f2 = a.foo(2)
+    
+    assert_equal 1, f1
+    assert_equal 3, f2
+    
+    assert f1 == a.foo(1)
+    assert f1 != f2
+    assert f2 == a.foo(2)
+    
+    b = a.bar
+    assert b == a.bar
+    assert b == a.bar
+  end
+
+  should 'cache methods remotely' do
+    a = Foo.new
+    b1 = a.baz(1)
+    b2 = a.baz(2)
+    
+    assert_equal 1, b1
+    assert_equal 3, b2
+    
+    assert b1 == a.baz(1)
+    assert b1 != b2
+    assert b2 == a.baz(2)
+  end  
+
+  should 'cache methods for mixins' do
+    a = Baz.new
+    
+    assert_equal 1, a.foo(1)
+    assert_equal 1, a.foo(1)
+    assert_equal 3, a.foo(2)
+    assert_equal 3, a.foo(2)
+  end
+  
+  should 'invalidate cached method' do
+    a = Foo.new
+    
+    assert_equal 1, a.foo(1)
+    assert_equal 3, a.foo(2)
+    
+    a.invalidate_cached_method(:foo, 1)
+
+    assert_equal 4, a.foo(1)
+    assert_equal 3, a.foo(2)
+  end
+
+  should 'use consistent local keys' do
+    a = Foo.new
+    o = Object.new
+    a_hash = a.hash
+    o_hash = o.hash
+
+    5.times do
+      key = a.send(:cached_method, :bar, [{'a' => 3, 'b' => [5,6], 'c' => o}, [1,nil,{:o => o}]]).key
+      assert_equal "m|:bar|Foo-#{a_hash}|{'a'=3,'b'=[5,6],'c'=Object-#{o_hash}}|[1,nil,{:o=Object-#{o_hash}}]", key
+    end
+  end
+
+  should 'use consistent remote keys' do
+    a = Foo.new
+    o = Object.new
+    a_hash = Marshal.dump(a).hash
+    o_hash = Marshal.dump(o).hash
+
+    5.times do
+      key = a.send(:cached_method, :baz, [{:a => 3, :b => [5,6], :c => o}, [false,true,{:o => o}]]).key
+      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
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'pp'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../memcache/lib"
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../cache_version/lib"
+require 'method_cache'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: ninjudd-method_cache
+version: !ruby/object:Gem::Version 
+  version: 0.6.2
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple memcache-based memoization library for Ruby
+email: code@justinbalthrop.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/method_cache
+- lib/method_cache/proxy.rb
+- lib/method_cache.rb
+- test/method_cache_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ninjudd/method_cache
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Simple memcache-based memoization library for Ruby
+test_files: []
+