cache_helper 0.1.0 → 0.2.0

data/lib/cache_helper.rb

@@ -4,7 +4,7 @@ module CacheHelper
     base.extend(ClassMethods)
   end
 
-  # Overrides ActiveRecord::Base#cache_key to return unique keys for new
+  # Overrides ActiveRecord::Base#cache_key to return unique cache keys for new
   # records.
   def cache_key_with_new_record_id
     key = cache_key_without_new_record_id
@@ -28,13 +28,56 @@ module CacheHelper
     key
   end
 
+  # Returns a cache key associated with the record for the specified method,
+  # associations, and options.
+  def method_cache_key_using_associations(method, *remaining_args)
+    options = remaining_args.extract_options!
+    associations = remaining_args
+    associations.each do |association|
+      options["#{association.to_s}_updated_time".to_sym] = association_updated_time(association)
+    end
+    method_cache_key(method, options)
+  end
+
+  # Returns the latest updated time of the record or records in the specified
+  # association.  This can be used as a method_cache_key option if the method's
+  # return value depends on the associated records.
+  def association_updated_time(association)
+    self.class.reflect_on_all_associations.each do |assoc_reflection|
+      if (assoc_reflection.name == association)
+        case assoc_reflection.macro
+        when :has_one, :belongs_to
+          return self.__send__(association).updated_at
+        when :has_many, :has_and_belongs_to_many
+          return self.__send__(association).maximum(:updated_at)
+        end
+      end
+    end
+    raise ArgumentError.new("association #{association.inspect} not found in #{self.class.name}")
+  end
+
   module ClassMethods
   private
-    # Wraps an instance method with basic caching functionality.
+    # Adds basic caching functionality to an instance method.
     def cache_method(method)
+      cache_method_using_cache_key_method(method, :method_cache_key, method)
+    end
+
+    # Adds basic caching functionality to an instance method whose return value
+    # depends on associated records.
+    def cache_method_using_associations(method, *associations)
+      associations.each do |association|
+        raise ArgumentError.new("association #{association.inspect} not found in #{self.name}") unless self.reflect_on_all_associations.any? { |assoc_reflection| assoc_reflection.name == association }
+      end
+      cache_method_using_cache_key_method(method, :method_cache_key_using_associations, method, *associations)
+    end
+
+    # Adds basic caching functionality to an instance method using the
+    # specified cache key method and arguments.
+    def cache_method_using_cache_key_method(method, cache_key_method, *cache_key_method_args)
       method_with_caching, method_without_caching = method_chain_aliases(method, :caching)
       define_method(method_with_caching.to_sym) {
-        Rails.cache.fetch(method_cache_key(method)) do
+        Rails.cache.fetch(self.__send__(cache_key_method, *cache_key_method_args)) do
           self.__send__(method_without_caching.to_sym)
         end
       }

data/lib/cache_helper/version.rb

@@ -1,3 +1,3 @@
 module CacheHelper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cache_helper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Clyde Law
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 Z
+date: 2011-04-20 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -64,6 +65,7 @@ files:
 - cache_helper.gemspec
 - lib/cache_helper.rb
 - lib/cache_helper/version.rb
+has_rdoc: true
 homepage: http://github.com/FutureAdvisor/cache_helper
 licenses: 
 - MIT
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cache_helper
-rubygems_version: 1.7.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Adds methods to more easily work with Rails caching.