caching 0.0.2 → 0.0.3

data/README.md

@@ -25,23 +25,36 @@ Or install it yourself as:
 ## Usage
 
     class Model
-      extend Caching
-      
-      cache :slow_method, :other_slow_method
-
       def slow_method
         ...
       end
+      cache_method :slow_method
 
-      def other_slow_method
+      def slow_method_with_args(*args)
         ...
       end
+      cache_method :slow_method_with_args
 
       def fast_method
         ...
       end
     end
 
+    model = Model.new
+    
+    model.slow_method # => Execute method
+    model.slow_method # => Return cached value
+
+    model.slow_method_with_args 'some value' # => Execute method
+    model.slow_method_with_args 'some value' # => Return cached value for argument 'some value'
+
+    model.slow_method_with_args 1234 # => Execute method
+    model.slow_method_with_args 1234 # => Return cached value for argument 1234
+
+    model.clear_cache :slow_method # => Remove cache only for method slow_method
+
+    model.clear_cache # => Remove cache for all cached methods
+
 ## Contributing
 
 1. Fork it

data/lib/caching/version.rb

@@ -1,3 +1,3 @@
 module Caching
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/caching.rb

@@ -2,23 +2,41 @@ Dir["#{File.dirname(__FILE__)}/caching/*.rb"].each { |file| require file }
 
 module Caching
 
-  def self.extended(klass)
-    constructor = klass.method :new
+  module ClassMethods
 
-    klass.define_singleton_method :new do |*args, &block|
-      instance = constructor.call(*args, &block)
-      proxy = Proxy.new instance, *@cached_methods
+    def cache_method(method)
+      alias_method "#{method}_without_cache", method
 
-      instance.send :define_singleton_method, :clear_cache do
-        proxy.clear_cache
+      define_method method do |*args, &block|
+        method_key = "#{method}_#{Marshal.dump(args)}"
+        cached_methods_keys[method] << method_key
+        cache_storage.fetch(method_key) { send "#{method}_without_cache", *args, &block }
       end
-
-      proxy
     end
+
   end
 
-  def cache(*methods)
-    @cached_methods = (@cached_methods ||= []) | methods.map(&:to_sym).uniq
+  module InstanceMethods
+
+    def cache_storage
+      @cache_storage ||= Storage.new
+    end
+
+    def cached_methods_keys
+      @cached_methods_keys ||= Hash.new {|h,k| h[k] = []}
+    end
+
+    def clear_cache(*methods)
+      method_keys = cached_methods_keys.
+        select{ |m,_| methods.include? m }.
+        flat_map{ |_,keys| keys }
+
+      cache_storage.clear *method_keys
+    end
+
   end
 
-end
+end
+
+Object.send :extend, Caching::ClassMethods
+Object.send :include, Caching::InstanceMethods

data/spec/caching_spec.rb

@@ -3,37 +3,36 @@ require 'minitest_helper'
 describe Caching do
   
   class Cachable
-    extend Caching
-    cache :slow_method, :other_slow_method
 
     def initialize
       @slow_method = 0
-      @other_slow_method = 0
+      @slow_method_with_args = 0
       @fast_method = 0
     end
 
     def slow_method
       @slow_method += 1
     end
+    cache_method :slow_method
 
-    def other_slow_method
-      @other_slow_method += 1
+    def slow_method_with_args(arg)
+      @slow_method_with_args += 1
     end
+    cache_method :slow_method_with_args
 
     def fast_method
       @fast_method += 1
     end
 
-    def reset
-      clear_cache
-    end
   end
 
+
   it 'Cache methods' do
     object = Cachable.new
 
     3.times { object.slow_method.must_equal 1 }
-    3.times { object.other_slow_method.must_equal 1 }
+    3.times { object.slow_method_with_args([1]).must_equal 1 }
+    3.times { object.slow_method_with_args('text').must_equal 2 }
     object.fast_method.must_equal 1
     object.fast_method.must_equal 2
   end
@@ -42,36 +41,41 @@ describe Caching do
     object = Cachable.new
 
     3.times { object.slow_method.must_equal 1 }
-    3.times { object.other_slow_method.must_equal 1 }
+    3.times { object.slow_method_with_args([1]).must_equal 1 }
+    3.times { object.slow_method_with_args('text').must_equal 2 }
 
     object.clear_cache
 
     object.slow_method.must_equal 2
-    object.other_slow_method.must_equal 2
+    object.slow_method_with_args(3).must_equal 3
   end
 
   it 'Clear cache for specific method' do
     object = Cachable.new
 
     3.times { object.slow_method.must_equal 1 }
-    3.times { object.other_slow_method.must_equal 1 }
+    3.times { object.slow_method_with_args([1]).must_equal 1 }
+    3.times { object.slow_method_with_args('text').must_equal 2 }
 
     object.clear_cache :slow_method
 
     object.slow_method.must_equal 2
-    object.other_slow_method.must_equal 1
+    object.slow_method_with_args([1]).must_equal 1
+    object.slow_method_with_args('text').must_equal 2
   end
 
-  it 'Clear cache inside object' do
+  it 'Clear cache for specific method with arguments' do
     object = Cachable.new
 
     3.times { object.slow_method.must_equal 1 }
-    3.times { object.other_slow_method.must_equal 1 }
+    3.times { object.slow_method_with_args([1]).must_equal 1 }
+    3.times { object.slow_method_with_args('text').must_equal 2 }
 
-    object.reset
+    object.clear_cache :slow_method_with_args
 
-    object.slow_method.must_equal 2
-    object.other_slow_method.must_equal 2
+    object.slow_method.must_equal 1
+    object.slow_method_with_args([1]).must_equal 3
+    object.slow_method_with_args('text').must_equal 4
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caching
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,13 +107,11 @@ files:
 - Rakefile
 - caching.gemspec
 - lib/caching.rb
-- lib/caching/proxy.rb
 - lib/caching/storage.rb
 - lib/caching/version.rb
 - spec/caching_spec.rb
 - spec/coverage_helper.rb
 - spec/minitest_helper.rb
-- spec/proxy_spec.rb
 - spec/storage_spec.rb
 homepage: https://github.com/gabynaiman/caching
 licenses:
@@ -144,6 +142,5 @@ test_files:
 - spec/caching_spec.rb
 - spec/coverage_helper.rb
 - spec/minitest_helper.rb
-- spec/proxy_spec.rb
 - spec/storage_spec.rb
 has_rdoc: 

data/lib/caching/proxy.rb

@@ -1,25 +0,0 @@
-module Caching
-  class Proxy
-  
-    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
-
-    def initialize(target, *methods)
-      @target = target
-      @methods = methods.map(&:to_sym)
-      @storage = Storage.new
-    end
-
-    def method_missing(method, *args, &block)
-      if @methods.include? method.to_sym
-        @storage.fetch(method) { @target.send(method, *args, &block) }
-      else
-        @target.send(method, *args, &block)
-      end
-    end
-
-    def clear_cache(*methods)
-      @storage.clear *methods
-    end
-
-  end
-end

data/spec/proxy_spec.rb

@@ -1,59 +0,0 @@
-require 'minitest_helper'
-
-describe Caching::Proxy do
-  
-  class Fake
-    attr_reader :x, :y
-
-    def initialize
-      @x = 0
-      @y = 0
-    end
-
-    def next_x
-      @x += 1
-    end
-
-    def next_y
-      @y += 1
-    end
-  end
-
-  it 'Cache specific method' do
-    object = Fake.new
-    proxy = Caching::Proxy.new object, :next_x
-
-    proxy.next_x.must_equal 1
-    proxy.next_x.must_equal 1
-
-    proxy.next_y.must_equal 1
-    proxy.next_y.must_equal 2
-  end
-
-  it 'Clear cache for all methods' do
-    object = Fake.new
-    proxy = Caching::Proxy.new object, :next_x, :next_y
-
-    3.times{ proxy.next_x.must_equal 1 }
-    3.times{ proxy.next_y.must_equal 1 }
-    
-    proxy.clear_cache
-
-    proxy.next_x.must_equal 2
-    proxy.next_y.must_equal 2
-  end
-
-  it 'Clear cache for specific method' do
-    object = Fake.new
-    proxy = Caching::Proxy.new object, :next_x, :next_y
-
-    3.times{ proxy.next_x.must_equal 1 }
-    3.times{ proxy.next_y.must_equal 1 }
-    
-    proxy.clear_cache :next_x
-
-    proxy.next_x.must_equal 2
-    proxy.next_y.must_equal 1
-  end
-
-end