arid_cache 1.3.6 → 1.4.0

data/Gemfile

@@ -1,18 +1,25 @@
 # A sample Gemfile
 source "http://rubygems.org"
 
-gem 'activerecord', '=2.3.11'
-gem 'activesupport', '=2.3.11'
+gem 'activerecord', '=3.0.6', :require => 'active_record'
+gem 'activesupport', '=3.0.6', :require => 'active_support'
 gem 'sqlite3-ruby', '=1.3.1'
-
-gem 'will_paginate', '=2.3.15'
+gem "will_paginate", "~> 3.0.pre2"
 gem 'jeweler', '=1.4.0'
 
 gem 'ruby-debug', '=0.10.3'
 gem 'ruby-debug-base', '=0.10.3'
 gem 'machinist', '=1.0.6'
-gem 'faker', '=0.3.1'
-gem 'rspec', '~>1.3.1', :require => 'spec'
+gem "rspec", "~> 2"
 gem 'test-unit', '=1.2.3'
-gem 'arid_cache', :path => "./"
 gem 'rr', '~>1.0.2'
+
+gem 'i18n', :require => 'I18n' # required by Faker
+gem 'faker', '=0.9.5'
+
+
+# Required by the ActiveSupport::Cache::FileStore.
+# Get a "no such file to load -- rack/utils" otherwise.
+gem 'rack'
+
+gem 'arid_cache', :path => "./"

data/Gemfile.lock

@@ -1,32 +1,51 @@
 PATH
-  remote: .
+  remote: ./
   specs:
-    arid_cache (1.3.5)
+    arid_cache (1.3.6)
       will_paginate
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activerecord (2.3.11)
-      activesupport (= 2.3.11)
-    activesupport (2.3.11)
-    columnize (0.3.1)
-    faker (0.3.1)
-    gemcutter (0.6.1)
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.6)
+    arel (2.0.9)
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    faker (0.9.5)
+      i18n (~> 0.4)
+    gemcutter (0.7.0)
     git (1.2.5)
-    hoe (2.6.2)
+    hoe (2.9.4)
       rake (>= 0.8.7)
-      rubyforge (>= 2.0.4)
+    i18n (0.5.0)
     jeweler (1.4.0)
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
+    json_pure (1.5.1)
     linecache (0.43)
     machinist (1.0.6)
+    rack (1.2.2)
     rake (0.8.7)
     rr (1.0.2)
-    rspec (1.3.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
     ruby-debug (0.10.3)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.3.0)
@@ -37,22 +56,25 @@ GEM
     sqlite3-ruby (1.3.1)
     test-unit (1.2.3)
       hoe (>= 1.5.1)
-    will_paginate (2.3.15)
+    tzinfo (0.3.26)
+    will_paginate (3.0.pre2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 2.3.11)
-  activesupport (= 2.3.11)
+  activerecord (= 3.0.6)
+  activesupport (= 3.0.6)
   arid_cache!
-  faker (= 0.3.1)
+  faker (= 0.9.5)
+  i18n
   jeweler (= 1.4.0)
   machinist (= 1.0.6)
+  rack
   rr (~> 1.0.2)
-  rspec (~> 1.3.1)
+  rspec (~> 2)
   ruby-debug (= 0.10.3)
   ruby-debug-base (= 0.10.3)
   sqlite3-ruby (= 1.3.1)
   test-unit (= 1.2.3)
-  will_paginate (= 2.3.15)
+  will_paginate (~> 3.0.pre2)

data/Gemfile.rails2

@@ -0,0 +1,25 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem 'activerecord', '2.3.11'
+gem 'activesupport', '2.3.11', :require => 'active_support'
+gem 'sqlite3-ruby', '1.3.1'
+gem "will_paginate", "2.3.15"
+gem 'jeweler', '1.4.0'
+
+gem 'ruby-debug', '0.10.3'
+gem 'ruby-debug-base', '0.10.3'
+gem 'machinist', '1.0.6'
+gem "rspec", "~> 2"
+gem 'test-unit', '1.2.3'
+gem 'rr', '~>1.0.2'
+
+gem 'i18n', :require => 'I18n' # required by Faker
+gem 'faker', '0.9.5'
+
+
+# Required by the ActiveSupport::Cache::FileStore.
+# Get a "no such file to load -- rack/utils" otherwise.
+gem 'rack'
+
+gem 'arid_cache', :path => "./"

data/Gemfile.rails2.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: ./
+  specs:
+    arid_cache (1.3.6)
+      will_paginate
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.11)
+      activesupport (= 2.3.11)
+    activesupport (2.3.11)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    faker (0.9.5)
+      i18n (~> 0.4)
+    gemcutter (0.7.0)
+    git (1.2.5)
+    hoe (2.9.4)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.5.1)
+    linecache (0.43)
+    machinist (1.0.6)
+    rack (1.2.2)
+    rake (0.8.7)
+    rr (1.0.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.1)
+    test-unit (1.2.3)
+      hoe (>= 1.5.1)
+    will_paginate (2.3.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.11)
+  activesupport (= 2.3.11)
+  arid_cache!
+  faker (= 0.9.5)
+  i18n
+  jeweler (= 1.4.0)
+  machinist (= 1.0.6)
+  rack
+  rr (~> 1.0.2)
+  rspec (~> 2)
+  ruby-debug (= 0.10.3)
+  ruby-debug-base (= 0.10.3)
+  sqlite3-ruby (= 1.3.1)
+  test-unit (= 1.2.3)
+  will_paginate (= 2.3.15)

data/Gemfile.rails3

@@ -0,0 +1,25 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem 'activerecord', '=3.0.6', :require => 'active_record'
+gem 'activesupport', '=3.0.6', :require => 'active_support'
+gem 'sqlite3-ruby', '=1.3.1'
+gem "will_paginate", "~> 3.0.pre2"
+gem 'jeweler', '=1.4.0'
+
+gem 'ruby-debug', '=0.10.3'
+gem 'ruby-debug-base', '=0.10.3'
+gem 'machinist', '=1.0.6'
+gem "rspec", "~> 2"
+gem 'test-unit', '=1.2.3'
+gem 'rr', '~>1.0.2'
+
+gem 'i18n', :require => 'I18n' # required by Faker
+gem 'faker', '=0.9.5'
+
+
+# Required by the ActiveSupport::Cache::FileStore.
+# Get a "no such file to load -- rack/utils" otherwise.
+gem 'rack'
+
+gem 'arid_cache', :path => "./"

data/Gemfile.rails3.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: ./
+  specs:
+    arid_cache (1.3.6)
+      will_paginate
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.6)
+    arel (2.0.9)
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    faker (0.9.5)
+      i18n (~> 0.4)
+    gemcutter (0.7.0)
+    git (1.2.5)
+    hoe (2.9.4)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.5.1)
+    linecache (0.43)
+    machinist (1.0.6)
+    rack (1.2.2)
+    rake (0.8.7)
+    rr (1.0.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.1)
+    test-unit (1.2.3)
+      hoe (>= 1.5.1)
+    tzinfo (0.3.26)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.6)
+  activesupport (= 3.0.6)
+  arid_cache!
+  faker (= 0.9.5)
+  i18n
+  jeweler (= 1.4.0)
+  machinist (= 1.0.6)
+  rack
+  rr (~> 1.0.2)
+  rspec (~> 2)
+  ruby-debug (= 0.10.3)
+  ruby-debug-base (= 0.10.3)
+  sqlite3-ruby (= 1.3.1)
+  test-unit (= 1.2.3)
+  will_paginate (~> 3.0.pre2)

data/README.rdoc

@@ -1,14 +1,17 @@
 = AridCache
 
-AridCache makes caching easy and effective.  AridCache supports caching on all ActiveRecord class and instance methods right out of the box.  AridCache keeps caching logic out of your model methods and clarifies your code by making calls to cached result sets explicit.
+AridCache now supports Rails 3!
+
+AridCache is a caching framework written in Ruby which makes caching easy and effective.  AridCache supports Rails 2 and 3 and provides caching on any ActiveRecord class or instance method right out of the box.  AridCache keeps caching logic in your cache configuration rather than dispersed throughout your code, and makes your code easy to manage by making cached calls explicit.
 
 AridCache supports caching large, expensive ActiveRecord collections by caching only the model IDs, provides efficient in-memory pagination of your cached collections, and gives you collection counts for free.  Non-ActiveRecord collection data is cached unchanged allowing you to cache the results of anything simply by prepending your method call with <tt>cached_</tt>.
 
-AridCache simplifies caching by supporting auto-expiring cache keys - as well as common options like <tt>:expires_in</tt> - and provides methods to help you manage your caches.
+AridCache simplifies caching by supporting auto-expiring cache keys - as well as common options like <tt>:expires_in</tt> - and provides methods to help you manage your caches.  AridCache now supports counts, limits, pagination and in-memory sorting of any cached Enumerable, as well as Proxies, a powerful new feature which gives you total control over your cached data.
 
 == Changes
 
-* v1.3.5: Backwards-compatibility fix for caching an empty array with <tt>:raw => true</tt>
+* v1.4.0: Rails 3 fully supported!
+* v1.3.5: Backwards-compatibility fixes
 * v1.3.4: Inherited cache configurations: Cache options and cache blocks are inherited from superclasses
 * 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
@@ -41,8 +44,9 @@ Then
 == Features
 
 * Include the AridCache module in any Class
-* <b>Rails 2 & 3 compatible</b> with automatic ActiveRecord::Base integration
-* Auto-generated namespaced cache keys
+* <b>Rails 2 & 3 supported</b> with automatic ActiveRecord::Base integration.
+* When using ActiveRecord 3, returns lazy-loaded result sets.
+* 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+
@@ -508,8 +512,9 @@ Here +cached_actual_name+ is using its own <tt>:limit => 1</tt> but since no anc
 
 == Compatibility
 
-Tested on Ruby 1.8.6, 1.8.7, REE 1.8.7 and 1.9.1.
-Tested in Rails 2.3.8, 2.3.11, Rails 3.0.0, Rails 3.0.5
+Ruby: 1.8.6, 1.8.7, REE 1.8.7 and 1.9.1.
+Rails: 2.3.8, 2.3.11, 3.0.0, Rails 3.0.5, 3.0.6
+WillPaginate: 2.3.15 (Rails 2), 3.0.pre2 (Rails 3)
 
 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:
 
@@ -525,6 +530,7 @@ For Ruby < 1.8.7 you probably want to include the following to extend the Array
 2. <b>You can't cache polymorphic arrays</b> e.g. [#<User id: 1>, #<Pet id: 5>] because it expects all ActiveRecords to be of the same class.  If you need polymorphism consider using a proxy and do the record-loading yourself.
 3. Rails ActiveRecord (or SQL) has a quirk where if you pass an +offset+ without a +limit+ the +offset+ is ignored.  AridCache fixes this unexpected behaviour by including a +limit+ on its queries.
 4. When you use the <tt>:order</tt> option with a cached ActiveRecord collection we have to go to the database to order.  So we also do pagination and limiting there because we want to retrieve as few records as possible.  So we use WillPaginate's ActiveRecord::Base#paginate method.  Unfortunately if you pass <tt>:limit</tt> or <tt>:offset</tt> in addition to your pagination options, the limit and offset are ignored.  This is not the behaviour when interacting with other cached types.  In that case we apply the order, then the limits and finally the pagination, which is what you would expect.
+5. There is a {bug in ActiveRecord 3's AREL}[http://breakthebit.org/post/3487560245/rails-3-arel-count-size-length-weirdness] where calling +count+ or +size+ on an AREL query will cause a </tt>COUNT(*)<tt> to be executed but without applying a +LIMIT+.  Calling +length+ works as expected, and returns the number of records that matched the query.  So we alias +count+ and +size+ to the +length+ on the AREL object that is returned.
 
 == Contributors
 

data/Rakefile

@@ -27,16 +27,10 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--backtrace']
 end
 
 require 'rake/testtask'
@@ -71,4 +65,4 @@ namespace :release do
     Rake::Task['git:release'].invoke
     Rake::Task['gemcutter:release'].invoke
   end
-end
+end

data/VERSION

@@ -1 +1 @@
-1.3.6
+1.4.0

data/arid_cache.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{arid_cache}
-  s.version = "1.3.6"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karl Varga"]
-  s.date = %q{2011-04-14}
+  s.date = %q{2011-04-18}
   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.
 }
@@ -22,6 +22,10 @@ AridCache is designed for handling large, expensive ActiveRecord collections but
     ".gitignore",
      "Gemfile",
      "Gemfile.lock",
+     "Gemfile.rails2",
+     "Gemfile.rails2.lock",
+     "Gemfile.rails3",
+     "Gemfile.rails3.lock",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -34,6 +38,7 @@ AridCache is designed for handling large, expensive ActiveRecord collections but
      "lib/arid_cache/cache_proxy/options.rb",
      "lib/arid_cache/cache_proxy/result_processor.rb",
      "lib/arid_cache/cache_proxy/utilities.rb",
+     "lib/arid_cache/framework.rb",
      "lib/arid_cache/helpers.rb",
      "lib/arid_cache/inflector.rb",
      "lib/arid_cache/inflector/inflections.rb",

data/init.rb

@@ -3,4 +3,4 @@ begin
 rescue LoadError
   require 'arid_cache' # From gem
 end
-AridCache.init_rails if defined?(Rails)
+AridCache.framework.init

data/lib/arid_cache.rb

@@ -7,11 +7,16 @@ require 'arid_cache/active_record'
 require 'arid_cache/cache_proxy'
 require 'arid_cache/railtie' if defined?(Rails)
 require 'arid_cache/inflector'
+require 'arid_cache/framework'
 
 module AridCache
   extend AridCache::Helpers
   Error = Class.new(StandardError) #:nodoc:
 
+  class << self
+    attr_accessor :framework
+  end
+
   # Set to true to make the :raw option return ids after applying options to them.
   # The deprecated behaviour is to return a CachedResult and ignore all options.
   def self.raw_with_options=(value)
@@ -49,11 +54,9 @@ module AridCache
     base.send(:include, AridCache::ActiveRecord)
   end
 
-  # Initializes AridCache for Rails.
-  #
-  # This method is called by `init.rb`,
-  # which is run by Rails on startup.
-  def self.init_rails
-    ::ActiveRecord::Base.send(:include, AridCache::ActiveRecord)
+  def self.version
+    @version ||= File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip
   end
+
+  self.framework = AridCache::Framework.new
 end

data/lib/arid_cache/cache_proxy.rb

@@ -29,7 +29,7 @@ module AridCache
 
     OPTIONS_FOR_PAGINATE = [:page, :per_page, :total_entries, :finder]
     OPTIONS_FOR_CACHE_PROXY = [:raw, :clear]
-    OPTIONS_FOR_FIND = [ :conditions, :include, :joins, :limit, :offset, :order, :select, :readonly, :group, :having, :from, :lock ]
+    OPTIONS_FOR_FIND = [ :conditions, :where, :include, :includes, :joins, :limit, :offset, :order, :select, :readonly, :group, :having, :from, :lock ]
     OPTIONS_FOR_CACHE = [ :expires_in ]
     OPTIONS_FOR_CACHE_KEY = [ :auto_expire ]
 
@@ -69,7 +69,7 @@ module AridCache
       # Combine the options from the blueprint with the options for this call
       opts = opts.symbolize_keys
       @options = Options.new(@blueprint.nil? ? opts : @blueprint.opts.merge(opts))
-      @options[:receiver] = receiver
+      @options[:receiver_klass] = Utilities.object_class(receiver)
       @cache_key = @receiver.arid_cache_key(@method, @options.opts_for_cache_key)
     end
 

data/lib/arid_cache/cache_proxy/options.rb

@@ -7,13 +7,18 @@ module AridCache
         self.merge!(opts)
       end
 
-      # Filter options for paginate.  Get the :per_page value from the receiver if it's not set.
+      # Filter options for paginate.
       # Set total_entries to +records.size+ if +records+ is supplied
+      # Get the :per_page value from the +result_klass+, or +receiver_klass+ if its set
+      # and responds to +per_page+.  Otherwise default to 30 results per page.
       def opts_for_paginate(records=nil)
         paginate_opts = reject { |k,v| !OPTIONS_FOR_PAGINATE.include?(k) }
         paginate_opts[:finder] = :find_all_by_id unless paginate_opts.include?(:finder)
-        if self[:result_klass].respond_to?(:per_page) && !paginate_opts.include?(:per_page)
-          paginate_opts[:per_page] = self[:result_klass].per_page
+        unless paginate_opts.key?(:per_page)
+          klass = values_at(:result_klass, :receiver_klass).find do |klass|
+            klass.respond_to?(:per_page)
+          end
+          paginate_opts[:per_page] = klass && klass.per_page || 30
         end
         paginate_opts[:total_entries] = records.size unless records.nil?
         paginate_opts
@@ -76,6 +81,18 @@ module AridCache
       def deprecated_raw?
         !!(raw? && !AridCache.raw_with_options)
       end
+
+      # Returns the class of the receiver object or raises IndexError if the
+      # receiver klass has not been set.
+      def receiver_klass
+        fetch :receiver_klass
+      end
+
+      # Returns the class of the result records or raises IndexError if the
+      # result klass has not been set.
+      def result_klass
+        fetch :result_klass
+      end
     end
   end
 end

data/lib/arid_cache/cache_proxy/result_processor.rb

@@ -42,11 +42,11 @@ module AridCache
       # Return true if the result is an enumerable and the first item is
       # an active record.
       def is_activerecord?
-        is_enumerable? && @result.first.is_a?(::ActiveRecord::Base)
+        AridCache.framework.active_record? && is_enumerable? && @result.first.is_a?(::ActiveRecord::Base)
       end
 
       def is_activerecord_reflection?
-        @result.respond_to?(:proxy_reflection) || @result.respond_to?(:proxy_options)
+        AridCache.framework.active_record? && (@result.respond_to?(:proxy_reflection) || @result.respond_to?(:proxy_options) || (AridCache.framework.active_record?(3) && @result.is_a?(::ActiveRecord::Relation)))
       end
 
       def is_cached_result?
@@ -64,7 +64,7 @@ module AridCache
             if is_activerecord_reflection?
               @result = @result.collect { |r| r } # force it to load
             end
-            Utilities.object_class(@options[:receiver]).send(@options[:proxy], @result)
+            @options.receiver_klass.send(@options[:proxy], @result)
           elsif is_activerecord_reflection?
 
             if @options.count_only?
@@ -108,7 +108,7 @@ module AridCache
             end
           filtered = filter_results(results)
           if @cached.nil? && !@options.raw?
-            proxy_result = Utilities.object_class(@options[:receiver]).send(@options[:proxy], filtered)
+            proxy_result = @options.receiver_klass.send(@options[:proxy], filtered)
             if filtered.is_a?(WillPaginate::Collection) && proxy_result.is_a?(Enumerable)
               filtered.replace(proxy_result)
             else
@@ -213,6 +213,8 @@ module AridCache
       # If an arder is specified then
       # order, limit and paginate in the database.
       def fetch_activerecords(records)
+        @options[:result_klass] = result_klass
+
         if records.empty?
           if @options.paginate?
             return records.paginate(@options.opts_for_paginate(records))
@@ -221,26 +223,58 @@ module AridCache
           end
         end
 
-        ids = records.first.is_a?(ActiveRecord) ? records.collect { |record| record[:id] } : records
+        ids = AridCache.framework.active_record? && records.first.is_a?(ActiveRecord) ? records.collect { |record| record[:id] } : records
         find_opts = @options.opts_for_find(ids)
         if order_in_database?
           if @options.paginate?
-            find_opts.merge!(@options.opts_for_paginate(ids))
-            result_klass.paginate(ids, find_opts)
+            if AridCache.framework.active_record?(3)
+              page_opts = @options.opts_for_paginate(ids)
+              WillPaginate::Collection.create(page_opts[:page], page_opts[:per_page], page_opts[:total_entries]) do |pager|
+                result = find_all_by_id(ids, find_opts.merge(:limit => pager.per_page, :offset => pager.offset))
+                pager.replace(result)
+              end
+            else
+              find_opts.merge!(@options.opts_for_paginate(ids))
+              result_klass.paginate(ids, find_opts)
+            end
           else
-            result_klass.find_all_by_id(ids, find_opts)
+            find_all_by_id(ids, find_opts)
           end
         else
           # Limits will have already been applied, remove them from the options for find.
           [:offset, :limit].each { |key| find_opts.delete(key) }
-          result = result_klass.find_all_by_id(ids, find_opts)
+          result = find_all_by_id(ids, find_opts)
           records.is_a?(::WillPaginate::Collection) ? records.replace(result) : result
         end
       end
 
       # Return the klass to use for building results (only applies to ActiveRecord results)
+      # Warning, calling this can trigger Relations/Associations to load.
       def result_klass
-        is_cached_result? ? @result.klass : (@cached.is_a?(AridCache::CacheProxy::CachedResult) ? @cached.klass : Utilities.object_class(@options[:receiver]))
+        is_cached_result? ? @result.klass : (@cached.is_a?(AridCache::CacheProxy::CachedResult) ? @cached.klass : @options[:receiver_klass])
+      end
+
+      def find_all_by_id(ids, find_opts)
+        if AridCache.framework.active_record?(3)
+          option_map = {
+            :conditions => :where,
+            :include => :includes
+          }
+          query = find_opts.inject(result_klass.scoped) do |scope, pair|
+            key, value = pair
+            key = option_map[key] || key
+            scope.send(key, pair[1])
+          end
+          query = query.scoped.where(Utilities.namespaced_column(:id, result_klass) + ' in (?)', ids)
+          # Fix http://breakthebit.org/post/3487560245/rails-3-arel-count-size-length-weirdness
+          query.class_eval do
+            alias_method :size, :length
+            alias_method :count, :length
+          end
+          query
+        else
+          result_klass.find_all_by_id(ids, find_opts)
+        end
       end
     end
   end

data/lib/arid_cache/cache_proxy/utilities.rb

@@ -9,12 +9,7 @@ module AridCache
       # supports the ORDER BY FIELD() function.  For other databases we use
       # a CASE statement.
       def order_by(ids, klass=nil)
-        column = if klass.respond_to?(:table_name)
-          ::ActiveRecord::Base.connection.quote_table_name(klass.table_name) + '.id'
-        else
-          "id"
-        end
-
+        column = namespaced_column(:id, klass)
         if ids.empty?
           nil
         elsif ::ActiveRecord::Base.is_mysql_adapter?
@@ -26,6 +21,16 @@ module AridCache
         end
       end
 
+      # Return the column name quoted and namespaced by the table name, if the klass
+      # responds to +table_name+.  Otherwise just return the column unchanged.
+      def namespaced_column(column, klass=nil)
+        if klass.respond_to?(:table_name)
+          ::ActiveRecord::Base.connection.quote_table_name(klass.table_name) + '.' + column.to_s
+        else
+          column.to_s
+        end
+      end
+
       # Return the object's class or the object if it is a class.
       def object_class(object)
         object.is_a?(Class) ? object : object.class

data/lib/arid_cache/framework.rb

@@ -0,0 +1,22 @@
+module AridCache
+  # A class with framework/application related methods like discovering
+  # which version of Rails we are running under.
+  class Framework
+    def active_record?(major=nil)
+      defined?(::ActiveRecord) && (major.nil? || (major && ::ActiveRecord::VERSION::MAJOR == major))
+    end
+
+    # Include framework hooks for Rails
+    #
+    # This method is called by <tt>init.rb</tt>, which is run by Rails on startup.
+    #
+    # Customize rendering.  Include custom headers and don't render the layout for AJAX.
+    # Insert the Rack::Ajax middleware to rewrite and handle requests.
+    # Add custom attributes to outgoing links.
+    #
+    # Hooks for Rails 3 are installed using Railties.
+    def init
+      ::ActiveRecord::Base.send(:include, AridCache::ActiveRecord) if active_record?
+    end
+  end
+end

data/spec/arid_cache/arid_cache_spec.rb

@@ -32,7 +32,7 @@ describe AridCache do
 
     it "with order option should go to the database to order" do
       lambda {
-        Company.cached_ordered_by_name(:order => 'name DESC')
+        Company.cached_ordered_by_name(:order => 'name DESC').inspect
       }.should query(2)
     end
   end

data/spec/arid_cache/cache_proxy/options_spec.rb

@@ -52,30 +52,52 @@ describe AridCache::CacheProxy::Options do
 
   describe "options for paginate" do
     before :each do
-      @result_klass = Class.new do
+      @receiver_klass = Class.new do
         def self.per_page; 23; end
       end
+      @result_klass = Class.new do
+        def self.per_page; 17; end
+      end
     end
 
-    it "should get per_page from the result_klass" do
-      @opts = new_options(:result_klass => @result_klass).opts_for_paginate
-      @opts[:per_page].should == 23
-    end
-
-    it "should use the provided per_page value" do
-      @opts = new_options(:result_klass => @result_klass, :per_page => 3).opts_for_paginate
-      @opts[:per_page].should == 3
+    it "total_entries should be nil by default" do
+      new_options.opts_for_paginate[:total_entries].should be_nil
     end
 
-    it "should set total_entries" do
-      new_options.opts_for_paginate[:total_entries].should be_nil
-      @opts = new_options.opts_for_paginate((1..10).to_a)
-      @opts[:total_entries].should == 10
+    it "should set total_entries to the size of the collection" do
+      new_options.opts_for_paginate((1..10).to_a)[:total_entries].should == 10
     end
 
     it "should use find_all_by_id as the finder" do
       new_options.opts_for_paginate[:finder].should == :find_all_by_id
     end
+
+    it "per_page should default to 30" do
+      new_options.opts_for_paginate[:per_page].should == 30
+    end
+
+    it "should get per_page from the result class" do
+      new_options(:result_klass => @result_klass).opts_for_paginate[:per_page].should == 17
+    end
+
+    it "should get per_page from the receiver class" do
+      new_options(:receiver_klass => @receiver_klass).opts_for_paginate[:per_page].should == 23
+    end
+
+    it "should get per_page from the result class, then the receiver class" do
+      new_options(
+        :result_klass => @result_klass,
+        :receiver_klass => @receiver_klass
+      ).opts_for_paginate[:per_page].should == 17
+    end
+
+    it "should use per_page if provided" do
+      new_options(
+        :result_klass => @result_klass,
+        :receiver_klass => @receiver_klass,
+        :per_page => 3
+      ).opts_for_paginate[:per_page].should == 3
+    end
   end
 
   describe "proxies" do
@@ -95,4 +117,10 @@ describe AridCache::CacheProxy::Options do
       new_options(:raw => true).deprecated_raw?.should be_false
     end
   end
+
+  describe "receiver_klass" do
+    it "should be the class of the receiver" do
+      new_options(:receiver_klass => User)[:receiver_klass].should be(User)
+    end
+  end
 end

data/spec/arid_cache/cache_proxy/result_processor_spec.rb

@@ -476,9 +476,51 @@ describe AridCache::CacheProxy::ResultProcessor do
       end
 
       it "should fall back to the receiver class" do
-        cache = new_result(@obj, :receiver => User).to_cache
+        cache = new_result(@obj, :receiver_klass => User).to_cache
         cache.klass.should be(User)
       end
     end
   end
+
+  describe "find_all_by_id" do
+    before :each do
+      @user = User.make
+      @user.companies << Company.make
+      @user.companies << Company.make
+      Company.make # there must be more than 2 companies for it to fail
+      @cached = AridCache::CacheProxy::CachedResult.new
+      @cached.ids = @user.companies.reverse.map(&:id)
+      @cached.klass = Company
+      @result = new_result(@cached)
+      mock.proxy(@result).find_all_by_id(@cached.ids, anything)
+    end
+
+    it "should maintain order" do
+      @result.to_result.should == @user.companies.reverse
+    end
+  end
+
+  describe "result_klass" do
+    before :each do
+      @obj = Class.new do
+        def self.per_page; 11; end
+      end.new
+      @options = AridCache::CacheProxy::Options.new(:receiver_klass => @obj.class)
+      @result = new_result(@obj, @options)
+    end
+
+    it "the mock class should define per_page" do
+      @obj.class.per_page.should == 11
+    end
+
+    it "should be the class of the receiver object" do
+      @result.send(:result_klass).should == @obj.class
+    end
+
+    it "should be set on the options when fetch_activerecords is called" do
+      @options[:result_klass].should == nil
+      @result.send(:fetch_activerecords, [])
+      @options[:result_klass].should be(@obj.class)
+    end
+  end
 end

data/spec/arid_cache/cache_proxy_spec.rb

@@ -248,7 +248,7 @@ describe AridCache::CacheProxy do
     end
 
     it "should return records" do
-      @user.cached_get_result.should == @user.companies
+      @user.cached_get_result.should == @user.companies.all
     end
 
     it "should return a count" do

data/spec/spec_helper.rb

@@ -1,19 +1,29 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
 root_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 $LOAD_PATH.unshift(File.join(root_path, '/test/lib')) # add test/lib to the load path
 
 require 'bundler/setup'
 Bundler.require
 
-require 'spec/autorun'
 require 'mock_rails'
 require 'blueprint'
+AridCache.framework.init
 
-WillPaginate.enable_activerecord
-AridCache.init_rails
+require 'will_paginate/version'
+if WillPaginate::VERSION::MAJOR < 3
+  WillPaginate.enable_activerecord
+else
+  require 'will_paginate/collection'
+  require 'will_paginate/finders/active_record'
+  WillPaginate::Finders::ActiveRecord.enable!
+end
 
-Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(root_path, "spec/support/**/*.rb")].each {|f| require f}
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   include ActiveRecordQueryMatchers
   config.mock_with :rr
 
@@ -26,4 +36,4 @@ Spec::Runner.configure do |config|
     full_example_description = "#{self.class.description} #{@method_name}"
     RAILS_DEFAULT_LOGGER.info("\n\n#{full_example_description}\n#{'-' * (full_example_description.length)}")
   end
-end
+end

data/spec/support/matchers.rb

@@ -1,4 +1,4 @@
-Spec::Matchers.define :include_keys do |*expected|
+RSpec::Matchers.define :include_keys do |*expected|
   
   match do |actual|
     check_all_present(actual, expected) == []
@@ -15,7 +15,7 @@ Spec::Matchers.define :include_keys do |*expected|
    end
 end
 
-Spec::Matchers.define :match_object do |object, *expected_matching_keys|
+RSpec::Matchers.define :match_object do |object, *expected_matching_keys|
 
   match do |actual|
     check_specified_keys_match(actual, object, expected_matching_keys) == []

data/test/arid_cache_test.rb

@@ -299,7 +299,7 @@ class AridCacheTest < ActiveSupport::TestCase
     cached_result.ids.push(24342234, 243234132)
     Rails.cache.write(key, cached_result)
     assert_nothing_raised { @user.cached_companies }
-    assert_equal @user.cached_companies, @user.companies
+    assert_equal @user.cached_companies, @user.companies.all
   end
 
   test "should not raise an error if all cached ids cannot be found while paginating" do

data/test/console

@@ -9,9 +9,17 @@ require 'mock_rails'
 require 'blueprint'
 require 'irb'
 
-WillPaginate.enable_activerecord
-AridCache.init_rails
+AridCache.framework.init
 Blueprint.seeds
 
+require 'will_paginate/version'
+if WillPaginate::VERSION::MAJOR < 3
+  WillPaginate.enable_activerecord
+else
+  require 'will_paginate/collection'
+  require 'will_paginate/finders/active_record'
+  WillPaginate::Finders::ActiveRecord.enable!
+end
+
 ARGV.clear
 IRB.start

data/test/lib/add_query_counting_to_active_record.rb

@@ -1,3 +1,5 @@
+require 'active_record'
+
 class << ActiveRecord::Base.connection
   IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
 

data/test/lib/mock_rails.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'fix_active_support_file_store_expires_in'
+require 'active_record'
 
 root_path = File.expand_path(File.join(File.dirname(__FILE__), '../../'))
 RAILS_DEFAULT_LOGGER = ENV["STDOUT"] ? Logger.new(STDOUT) : Logger.new(File.join(root_path, '/test/log/test.log'))
@@ -14,6 +15,11 @@ Rails = Class.new do
   def self.logger
     return RAILS_DEFAULT_LOGGER
   end
+  def self.rails3?
+    ActiveRecord::VERSION::STRING.to_i >= 3
+  rescue
+    false
+  end
 end
 
 # Set loggers for all frameworks
@@ -22,7 +28,7 @@ for framework in ([ :active_record, :action_controller, :action_mailer ])
     framework.to_s.camelize.constantize.const_get("Base").logger = Rails.logger
   end
 end
-ActiveSupport::Dependencies.logger = Rails.logger
+ActiveSupport::Dependencies.logger = Rails.logger if defined?(ActiveSupport::Dependencies)
 Rails.cache.logger = Rails.logger
 
 # Include this last otherwise the logger isn't set properly

data/test/lib/models/company.rb

@@ -1,6 +1,7 @@
 require 'arid_cache'
 
 class Company < ActiveRecord::Base
-  named_scope :owned, :conditions => ['owner_id is not null']
+
+  send(Rails.rails3? ? :scope : :named_scope, :owned, :conditions => ['owner_id is not null'])
   belongs_to :owner, :class_name => 'User'
 end

data/test/lib/models/user.rb

@@ -3,9 +3,9 @@ require 'arid_cache'
 class User < ActiveRecord::Base
   has_many :companies, :foreign_key => :owner_id
   has_many :empty_user_relations  # This must always return an empty list
-  named_scope :companies, :joins => :companies
-  named_scope :successful, :joins => :companies, :conditions => 'companies.employees > 50', :group => 'users.id'
-  
+  send(Rails.rails3? ? :scope : :named_scope, :companies, :joins => :companies)
+  send(Rails.rails3? ? :scope : :named_scope, :successful, :joins => :companies, :conditions => 'companies.employees > 50', :group => 'users.id')
+
   def big_companies
     companies.find :all, :conditions => [ 'employees > 20' ]
   end
@@ -13,7 +13,7 @@ class User < ActiveRecord::Base
   def pet_names
     ['Fuzzy', 'Peachy']
   end
-  
+
   def method_missing(method, *args)
     if method == :is_high?
       true
@@ -21,12 +21,12 @@ class User < ActiveRecord::Base
       super
     end
   end
-  
-  def respond_to?(method)
+
+  def respond_to?(method, include_private=false)
     if method == :respond_not_overridden
       true
     else
       super
     end
   end
-end
+end

data/test/test_helper.rb

@@ -12,9 +12,17 @@ require 'mock_rails'
 require 'blueprint'
 require 'add_query_counting_to_active_record'
 
-WillPaginate.enable_activerecord
-AridCache.init_rails
+require 'will_paginate/version'
+if WillPaginate::VERSION::MAJOR < 3
+  WillPaginate.enable_activerecord
+else
+  require 'will_paginate/collection'
+  require 'will_paginate/finders/active_record'
+  WillPaginate::Finders::ActiveRecord.enable!
+end
+
+AridCache.framework.init
 Blueprint.seeds
 
-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'
+ActiveRecord::Base.logger && 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,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arid_cache
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 7
   prerelease: 
   segments: 
   - 1
-  - 3
-  - 6
-  version: 1.3.6
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Karl Varga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 -07:00
+date: 2011-04-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,6 +90,10 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- Gemfile.rails2
+- Gemfile.rails2.lock
+- Gemfile.rails3
+- Gemfile.rails3.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -102,6 +106,7 @@ files:
 - lib/arid_cache/cache_proxy/options.rb
 - lib/arid_cache/cache_proxy/result_processor.rb
 - lib/arid_cache/cache_proxy/utilities.rb
+- lib/arid_cache/framework.rb
 - lib/arid_cache/helpers.rb
 - lib/arid_cache/inflector.rb
 - lib/arid_cache/inflector/inflections.rb