arid_cache 1.3.3 → 1.3.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    arid_cache (1.3.2)
+    arid_cache (1.3.3)
       will_paginate
 
 GEM

data/README.rdoc

@@ -8,6 +8,7 @@ AridCache simplifies caching by supporting auto-expiring cache keys - as well as
 
 == Changes
 
+* v1.3.4: Inherited caches: Caches, cache options and cache blocks are inherited by all subclasses
 * v1.3.2: <tt>AridCache.raw_with_options</tt> configuration for better <tt>:raw</tt> handling on cached ActiveRecord collections
 * v1.3.1: Proxy support which allow you to control how your objects get serialized and unserialized
 * v1.3.0: Support limits, ordering and pagination on cached Enumerables
@@ -40,7 +41,8 @@ Then
 
 * Include the AridCache module in any Class
 * <b>Rails 2 & 3 compatible</b> with automatic ActiveRecord::Base integration
-* Supports <b>auto-expiring cache keys</b>
+* Auto-generated namespaced cache keys
+* <b>auto-expiring cache keys</b> - your cache expires when the updated_at timestamp changes
 * Supports *limits*, *ordering* & *pagination* of cached Enumerables and ActiveRecord collections
 * Define caches and their options on your class using +instance_caches+ and +class_caches+
 * <b>Counts for free</b> - if you have already cached the result, you get the count for free
@@ -50,6 +52,7 @@ Then
 * <b>Preserves ordering</b> of your cached ActiveRecord collections
 * <b>Optimized</b> to make as few cache and database accesses as absolutely neccessary
 * Define your own <b>cache proxy</b> to serialize your objects as they go to and from the cache
+* <b>Inherited caches</b> - subclasses inherit all caches, cache options and blocks from superclasses.
 
 == Introduction
 

data/VERSION

@@ -1 +1 @@
-1.3.3
+1.3.4

data/arid_cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{arid_cache}
-  s.version = "1.3.3"
+  s.version = "1.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karl Varga"]
-  s.date = %q{2011-04-08}
+  s.date = %q{2011-04-11}
   s.description = %q{AridCache makes caching easy and effective.  AridCache supports caching on all your model named scopes, class methods and instance methods right out of the box.  AridCache prevents caching logic from cluttering your models and clarifies your logic by making explicit calls to cached result sets.
 AridCache is designed for handling large, expensive ActiveRecord collections but is equally useful for caching anything else as well.
 }
@@ -47,6 +47,8 @@ AridCache is designed for handling large, expensive ActiveRecord collections but
      "spec/arid_cache/cache_proxy/result_processor_spec.rb",
      "spec/arid_cache/cache_proxy/utilities_spec.rb",
      "spec/arid_cache/cache_proxy_spec.rb",
+     "spec/arid_cache/helpers_spec.rb",
+     "spec/arid_cache/store_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/support/ar_query.rb",
@@ -78,6 +80,8 @@ AridCache is designed for handling large, expensive ActiveRecord collections but
      "spec/arid_cache/cache_proxy/result_processor_spec.rb",
      "spec/arid_cache/cache_proxy/utilities_spec.rb",
      "spec/arid_cache/cache_proxy_spec.rb",
+     "spec/arid_cache/helpers_spec.rb",
+     "spec/arid_cache/store_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/ar_query.rb",
      "spec/support/custom_methods.rb",

data/lib/arid_cache/helpers.rb

@@ -40,7 +40,7 @@ module AridCache
     #
     # @return an AridCache::Store::Blueprint.
     def define(object, key, opts, fetch_method=:fetch, method_name=nil, &block)
-      
+
       # FIXME: Pass default options to store.add
       # Pass nil in for now until we get the cache_ calls working.
       # This means that the first time you define a dynamic cache
@@ -61,6 +61,12 @@ module AridCache
       blueprint
     end
 
+    def subclasses_of(parent)
+      result = []
+      ObjectSpace.each_object(Class) { |klass| result << klass if klass < parent }
+      result
+    end
+
     private
 
     # Dynamically define a method on the object's class to return cached results
@@ -82,5 +88,5 @@ module AridCache
       object = (class << object; self; end) if object.is_a?(Class)
       object.class_eval(method_body, __FILE__, __LINE__)
     end
-  end  
+  end
 end

data/lib/arid_cache/store.rb

@@ -69,7 +69,15 @@ module AridCache
     class ClassCacheConfiguration    < Configuration; end #:nodoc:
 
     def has?(object, key)
-      self.include?(object_store_key(object, key))
+      return true if self.include?(object_store_key(object, key))
+
+      store_key = object.is_a?(Class) ? :class_store_key : :instance_store_key
+      klass = object.is_a?(Class) ? object : object.class
+      while klass.superclass
+        return true if self.include?(send(store_key, klass.superclass, key))
+        klass = klass.superclass
+      end
+      false
     end
 
     # Empty the proc store
@@ -82,7 +90,7 @@ module AridCache
     end
 
     def find(object, key)
-      self[object_store_key(object, key)]
+      inherited_find(object, key)
     end
 
     def add_instance_cache_configuration(klass, key, opts, proc)
@@ -97,19 +105,10 @@ module AridCache
       add_generic_cache_configuration(object_store_key(object, key), object, key, opts, proc)
     end
 
-    def find_or_create(object, key)
-      store_key = object_store_key(object, key)
-      if self.include?(store_key)
-        self[store_key]
-      else
-        self[store_key] = AridCache::Store::Blueprint.new(object, key)
-      end
-    end
-
     protected
 
-    def add_generic_cache_configuration(store_key, *args)
-      self[store_key] = AridCache::Store::Blueprint.new(*args)
+    def add_generic_cache_configuration(store_key, object, key, opts, proc)
+      self[store_key] = AridCache::Store::Blueprint.new(object, key, opts, proc)
     end
 
     def initialize
@@ -120,5 +119,27 @@ module AridCache
     def object_store_key(object, key)
       case object; when Class; class_store_key(object, key); else; instance_store_key(object.class, key); end
     end
+
+    def inherited_find(object, key)
+      blueprint = self[object_store_key(object, key)] || AridCache::Store::Blueprint.new(object, key)
+      inherit_options(blueprint, object, key)
+      if blueprint.opts.empty? && blueprint['proc'].nil?
+        nil
+      else
+        blueprint
+      end
+    end
+
+    def inherit_options(blueprint, object, key)
+      klass = object.is_a?(Class) ? object : object.class
+      store_key = object.is_a?(Class) ? :class_store_key : :instance_store_key
+      while klass.superclass
+        if super_blueprint = self[send(store_key, klass.superclass, key)]
+          blueprint.opts = super_blueprint.opts.merge(blueprint.opts)
+          blueprint['proc'] ||= super_blueprint['proc']
+        end
+        klass = klass.superclass
+      end
+    end
   end
-end
+end

data/spec/arid_cache/cache_proxy_spec.rb

@@ -241,4 +241,85 @@ describe AridCache::CacheProxy do
       @user.cached_get_result(:raw => true).should == @user.get_result
     end
   end
+
+  describe "inheritance" do
+    before :each do
+      class Abc
+        include AridCache
+        instance_caches do
+          name(:limit => 2, :expires_in => 1) { 'abc' }
+        end
+
+        def inherited_method
+          'inherited'
+        end
+      end
+
+      class Def < Abc
+        instance_caches do
+          name(:limit => 1, :expires_in => 2) { 'def' }
+          call_name { name }
+        end
+      end
+
+      class Xyz < Def
+        instance_caches do
+          name(:limit => 3) # should use the block from the superclass
+        end
+
+        def name
+          'xyz'
+        end
+      end
+      @abc = Abc.new
+      @def = Def.new
+      @xyz = Xyz.new
+    end
+
+    it "should inherit procs and options from subclasses" do
+      @abc.cached_name.should == 'ab'
+      @def.cached_name.should == 'd'
+      @xyz.cached_name.should == 'def'
+    end
+
+    it "should inherit options" do
+      AridCache.store.find(@xyz, 'name').opts[:expires_in].should == 2
+    end
+
+    it "should inherit caches" do
+      @xyz.should respond_to(:cached_call_name)
+    end
+
+    it "should evaluate inherited caches in the right instance" do
+      @xyz.cached_call_name.should == 'xyz'
+      lambda {
+        @def.cached_call_name
+      }.should raise_error(NameError)
+    end
+
+    it "should inherit methods" do
+      @abc.cached_inherited_method.should == 'inherited'
+      @def.cached_inherited_method.should == 'inherited'
+      @xyz.cached_inherited_method.should == 'inherited'
+    end
+  end
+
+  # describe "reserved names" do
+  #   before :each do
+  #     @obj = Class.new do
+  #       include AridCache
+  #       instance_caches do
+  #         debugger
+  #         test(:expires_in => 1)
+  #       end
+  #       def test
+  #         true
+  #       end
+  #     end.new
+  #   end
+  #
+  #   it "should support a cache named test" do
+  #     @obj.cached_test
+  #   end
+  # end
 end

data/spec/arid_cache/helpers_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe AridCache::Helpers do
+  describe "subclasses_of" do
+    before :each do
+      class Aa; end
+      class Bb < Aa; end
+      class Cc < Bb; end
+    end
+    
+    it "should description" do
+      AridCache.subclasses_of(Aa).should == [Cc, Bb]
+      AridCache.subclasses_of(Bb).should == [Cc]
+    end
+  end
+end

data/spec/arid_cache/store_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe AridCache::Store do
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arid_cache
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 3
-  - 3
-  version: 1.3.3
+  - 4
+  version: 1.3.4
 platform: ruby
 authors: 
 - Karl Varga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -07:00
+date: 2011-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -115,6 +115,8 @@ files:
 - spec/arid_cache/cache_proxy/result_processor_spec.rb
 - spec/arid_cache/cache_proxy/utilities_spec.rb
 - spec/arid_cache/cache_proxy_spec.rb
+- spec/arid_cache/helpers_spec.rb
+- spec/arid_cache/store_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/ar_query.rb
@@ -174,6 +176,8 @@ test_files:
 - spec/arid_cache/cache_proxy/result_processor_spec.rb
 - spec/arid_cache/cache_proxy/utilities_spec.rb
 - spec/arid_cache/cache_proxy_spec.rb
+- spec/arid_cache/helpers_spec.rb
+- spec/arid_cache/store_spec.rb
 - spec/spec_helper.rb
 - spec/support/ar_query.rb
 - spec/support/custom_methods.rb