arid_cache 0.2.2 → 0.2.3

data/README.rdoc

@@ -105,7 +105,7 @@ You can pass a hash of options to <tt>instance_caches</tt> and <tt>class_caches<
       highlight_tracks(:include => [:album, :artist]) do
         cached_tracks(:limit => 10, :include => [:album, :artist])
       end
-      highlight_artists do
+      highlight_artists(:order => nil) do   # override the global :order option 
         cached_artists(:limit => 10)
       end
       highlight_albums(:include => :artist) do
@@ -259,11 +259,34 @@ For example, assume we have a <tt>named_scope :active</tt> on <tt>User</tt> whic
 * If you only request a count AridCache will only select the count.  See <i>Cached Counts</i>.
 * If a collection has already been loaded, you get the count for free.  See <i>Cached Counts</i>.
 
+== Compatibility
+
+Tested on Ruby 1.8.6 and 1.8.7.  Should be compatible with 1.9.
+
+For Ruby < 1.8.7 you probably want to include the following to extend the Array class with a <tt>count</tt> method.  Otherwise your <tt>cached_<key>_count</tt> calls probably won't work:
+  
+  Array.class_eval { alias count size }
+
+The version of Rails shouldn't matter much, but it's working on 2.3.4.
+
+== Resources & Metrics
+
+
+* {RDoc}[http://rdoc.info/projects/kjvarga/arid_cache]
+* {GetCaliper Metrics}[http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fkjvarga%2Farid_cache.git]
+
 == Known Issues
 
-1. Caches that contains duplicate records (for example from the result of a join), will only return unique records on subsequent calls.  This is because of the way <tt>find</tt> works when selecting multiple ids.  For example, if your query returns <tt>[#<User id: 1>, #<User id: 1>, #<User id: 1>]</tt>, the IDs are cached as <tt>[1,1,1]</tt>.  On the next call to the cache we load the IDs using <tt>user.find([1,1,1])</tt> which returns <tt>[#<User id: 1>]</tt>, not <tt>[#<User id: 1>, #<User id: 1>, #<User id: 1>]</tt> as you might have expected.
+1. Caches that contains duplicate records (for example from the result of a join), will only return unique records on subsequent calls.  This is because of the way <tt>find</tt> works when selecting multiple ids.  For example, if your query returns <tt>[#<User id: 1>, #<User id: 1>, #<User id: 1>]</tt>, the IDs are cached as <tt>[1,1,1]</tt>.  On the next call to the cache we load the IDs using <tt>User.find([1,1,1])</tt> which returns <tt>[#<User id: 1>]</tt>, not <tt>[#<User id: 1>, #<User id: 1>, #<User id: 1>]</tt> as you might have expected.
+
+== Wish List / Coming Soon
+
+* Some kind of memoize option.
+* Priming caches.  Warm up the cache for all models based on the information in the instance and class cache configurations.  Would need to know when you want to prime counts as well.
+* The ability to <tt>include AridCache</tt> on any class or module.
+* An option to bypass ID caching when you want to store records in the cache.
 
-== Contributions
+== Contributors
 
 Contributions are welcome!  Please,
 
@@ -273,6 +296,11 @@ Contributions are welcome!  Please,
 * Commit (don't mess with the Rakefile, version, or history).
 * Send me a pull request.
 
+
+==== Thank-you to these contributors to AridCache:
+
+* {Sutto}[http://github.com/Sutto]
+
 == Copyright
 
 Copyright (c) 2009 Karl Varga. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/arid_cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{arid_cache}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karl Varga"]
-  s.date = %q{2010-01-15}
+  s.date = %q{2010-01-19}
   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.
 }

data/lib/arid_cache/helpers.rb

@@ -64,22 +64,16 @@ module AridCache
     private
 
     def method_for_cached(object, key, fetch_method=:fetch, method_name=nil)
-      method_name = "cached_" + (method_name || key)
-      if object.is_a?(Class)
-        (class << object; self; end).instance_eval do
-          define_method(method_name) do |*args, &block|
-            opts = args.empty? ? {} : args.first
-            AridCache.cache.send(fetch_method, self, key, opts, &block)
-          end
+      method_name = ("cached_" + (method_name || key)).gsub(/[^\w\!\?]/, '_')
+      method_body = <<-END
+        def #{method_name}(*args, &block)
+          opts = args.empty? ? {} : args.first
+          AridCache.cache.send(#{fetch_method.inspect}, self, #{key.inspect}, opts, &block)
         end
-      else
-        object.class_eval do
-          define_method(method_name) do |*args, &block|
-            opts = args.empty? ? {} : args.first
-            AridCache.cache.send(fetch_method, self, key, opts, &block)
-          end
-        end
-      end
+      END
+      # Get the correct object
+      object = (class << object; self; end) if object.is_a?(Class)
+      object.class_eval(method_body, __FILE__, __LINE__)
     end
   end  
 end

data/test/test_helper.rb

@@ -54,4 +54,4 @@ require 'db/prepare'
 
 ActiveRecord::Base.logger.info("#{"="*25} RUNNING UNIT TESTS #{"="*25}\n\t\t\t#{Time.now.to_s}\n#{"="*70}")
 
-
+Array.class_eval { alias count size } if RUBY_VERSION < '1.8.7'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arid_cache
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Karl Varga
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 +08:00
+date: 2010-01-19 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency