arid_cache 0.1.1 → 0.2.1

data/test/arid_cache_test.rb

@@ -2,9 +2,8 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 class AridCacheTest < ActiveSupport::TestCase
   def setup
-    Rails.cache.clear
-    AridCache.store.delete!
-    get_user
+    FileUtils.rm_r(Rails.cache.cache_path) if File.exists?(Rails.cache.cache_path)
+    @user = User.first
   end
 
   test "initializes needed objects" do
@@ -13,36 +12,28 @@ class AridCacheTest < ActiveSupport::TestCase
   end
       
   test "should respond to methods" do
-    assert User.respond_to?(:clear_cache)
-    assert User.first.respond_to?(:clear_cache)    
+    assert User.respond_to?(:clear_caches)
+    assert @user.respond_to?(:clear_caches)    
     assert_instance_of AridCache::Store, AridCache.store
+    assert_same AridCache::CacheProxy, AridCache.cache
   end
     
   test "should not clobber model methods" do
-    assert_respond_to User.first, :name
+    assert_respond_to @user, :name
     assert_respond_to Company.first, :name
-    assert_nothing_raised { User.first.name }
+    assert_nothing_raised { @user.name }
     assert_nothing_raised { Company.first.name }
-    
-    # Shouldn't mess with your model's method_missing
-    assert_nothing_raised { User.first.is_high? }
-    assert User.first.is_high?  
-  end
-    
-  test "should allow me to cache on the model" do
-    assert_nothing_raised do
-      define_model_cache(User)
-    end
-    #assert_instance_of(Proc, AridCache.store[User.arid_cache_key('companies')].proc)
   end
   
-  test "should allow me to cache on the instance" do
-    assert_nothing_raised do
-      define_instance_cache(@user)
-    end
-    #assert_instance_of(Proc, AridCache.store[AridCache.store.store_key@user.arid_cache_key('companies')].proc)
+  test "should not clobber method_missing" do
+    assert_nothing_raised { @user.is_high? }
+    assert @user.is_high?  
   end
-    
+     
+  test "should not clobber respond_to?" do
+    assert @user.respond_to?(:respond_not_overridden)
+  end
+     
   test "should raise an error on invalid dynamic caches" do
     assert_raises ArgumentError do
       @user.cached_invalid_companies
@@ -51,7 +42,6 @@ class AridCacheTest < ActiveSupport::TestCase
   
   test "should create dynamic caches given valid arguments" do
     assert_nothing_raised { @user.cached_companies }
-    #assert_instance_of(Proc, AridCache.store[@user.arid_cache_key('companies')].proc)
   end
   
   test "counts queries correctly" do
@@ -65,27 +55,20 @@ class AridCacheTest < ActiveSupport::TestCase
   end
   
   test "paginates results" do
-    results = @user.cached_companies(:page => 1, :per_page => 3)
+    results = @user.cached_companies(:page => 1, :per_page => 3, :order => 'name desc')
     assert_kind_of WillPaginate::Collection, results
     assert_equal 3, results.size
     assert_equal @user.companies.count, results.total_entries
     assert_equal 1, results.current_page
   end
   
-  test "overrides default paginate options" do
-    results = @user.cached_companies(:page => 1, :per_page => 3)
-    assert_kind_of WillPaginate::Collection, results
-    assert_equal 3, results.size
-    assert_equal @user.companies.count, results.total_entries    
-  end
-  
-  test "works for different pages" do
+  test "should work for different pages" do
     results = @user.cached_companies(:page => 2, :per_page => 3)
     assert_kind_of WillPaginate::Collection, results
     assert results.size <= 3
     assert_equal @user.companies.count, results.total_entries  
     assert_equal 2, results.current_page  
-  end
+  end  
   
   test "ignores random parameters" do
     result = @user.cached_companies(:invalid => :params, 'random' => 'values', :user_id => 3)
@@ -118,35 +101,57 @@ class AridCacheTest < ActiveSupport::TestCase
     end
   end
   
-  test "calling cache_ defines methods on the object" do
-    assert !User.method_defined?(:cached_favorite_companies)
-    User.cache_favorite_companies(:order => 'name DESC') do
-      User.companies
-    end
-    assert User.respond_to?(:cached_favorite_companies)
-    assert_nothing_raised do
-      User.method(:cached_favorite_companies)
-    end    
-  end
-
   test "applies limit and offset" do
-    @user.cached_limit_companies do
+    result = @user.cached_limit_companies do
       companies
     end
-    assert_equal 2, @user.cached_limit_companies(:limit => 2).size
-    assert_equal 3, @user.cached_limit_companies(:limit => 3).size
+    limit_two_result = @user.cached_limit_companies(:limit => 2)
+    assert_equal 2, limit_two_result.size
+    assert_equal result[0, 2], limit_two_result
+    
+    limit_three_result = @user.cached_limit_companies(:limit => 3)
+    assert_equal 3, limit_three_result.size
+    assert_equal result[0, 3], limit_three_result
+  
+    limit_two_offset_one_result = @user.cached_limit_companies(:limit => 2, :offset => 1)
+    assert_equal 2, limit_two_offset_one_result.size
+    assert_equal result[1, 2], limit_two_offset_one_result
+    
+    offset_one_result = @user.cached_limit_companies(:offset => 1)
+    assert_equal result.size-1, offset_one_result.size
+    assert_equal result[1, result.size], offset_one_result
+            
     assert_equal @user.companies.all(:limit => 2, :offset => 1), @user.cached_limit_companies(:limit => 2, :offset => 1)
     assert_equal @user.companies.size, @user.cached_limit_companies.size    
+    
+    # Careful of this Rails bug: https://rails.lighthouseapp.com/projects/8994/tickets/1349-named-scope-with-group-by-bug
     User.cached_successful_limit_companies do
-      User.successful
+      User.successful.all
     end
-    raise User.cached_successful_limit_companies.inspect
     assert_equal 2, User.cached_successful_limit_companies(:limit => 2).size
     assert_equal 3, User.cached_successful_limit_companies(:limit => 3).size
     assert_equal User.successful.all(:limit => 2, :offset => 1), User.cached_successful_limit_companies(:limit => 2, :offset => 1)
-    assert_equal User.successful.size, User.cached_successful_limit_companies.size  
+    assert_equal User.successful.all.size, User.cached_successful_limit_companies.size  
+  end
+  
+  test "should requery the database for limits with order" do
+    @user.cached_companies # prime the cache
+    assert_equal @user.companies.find(:all, :limit => 3, :order => 'name DESC'), @user.cached_companies(:limit => 3, :order => 'name DESC')
+    assert_equal @user.companies.find(:all, :limit => 3, :order => 'name ASC'), @user.cached_companies(:limit => 3, :order => 'name ASC')
   end
   
+  test "should activate will paginate" do
+    assert_nothing_raised do
+      User.paginate(:page => 1)
+    end
+  end
+  
+  test "should requery the database for paginate with order" do
+    @user.cached_companies # prime the cache
+    assert_equal @user.companies.paginate(:page => 1, :per_page => 3, :order => 'name DESC'), @user.cached_companies(:page => 1, :per_page => 3, :order => 'name DESC')
+    assert_equal @user.companies.paginate(:page => 1, :per_page => 3, :order => 'name ASC'), @user.cached_companies(:page => 1, :per_page => 3, :order => 'name ASC')
+  end
+    
   test "pagination should not result in an extra query" do
     assert_queries(1) do
       @user.cached_big_companies(:page => 1)
@@ -180,7 +185,7 @@ class AridCacheTest < ActiveSupport::TestCase
     assert_equal one.companies, one.cached_companies
     assert_equal two.companies, two.cached_companies
   end
-
+  
   test "should handle arrays of non-active record instances" do
     assert_equal @user.pet_names, @user.cached_pet_names
     assert_equal @user.pet_names, @user.cached_pet_names
@@ -188,25 +193,127 @@ class AridCacheTest < ActiveSupport::TestCase
   end
              
   test "should empty the Rails cache" do
-    define_model_cache(User)
     @user.cached_companies
     User.cached_companies
     assert Rails.cache.exist?(@user.arid_cache_key('companies'))
     assert Rails.cache.exist?(User.arid_cache_key('companies'))
-    User.clear_cache
-    assert Rails.cache.exist?(@user.arid_cache_key('companies'))
-    assert Rails.cache.exist?(User.arid_cache_key('companies'))   
+    User.clear_caches
+    assert !Rails.cache.exist?(@user.arid_cache_key('companies'))
+    assert !Rails.cache.exist?(User.arid_cache_key('companies'))   
   end
-      
-  protected
-
-    def get_user
-      @user = User.first
-      @user.clear_cache
-      define_instance_cache(@user)
-      @user
+  
+  test "should support expiring caches" do
+    # The first query should put the count in the cache.  The second query
+    # should read the count from the cache.  The third query should
+    # reload the cache.
+    assert_queries(2) do
+      User.cached_companies_count(:expires_in => 1.second)
+      User.cached_companies_count(:expires_in => 1.second)
+      sleep(1)
+      User.cached_companies_count(:expires_in => 1.second)
     end
+  end
+  
+  test "should support an auto-expire option" do
+    assert_match %r[users/#{@user.id}-companies], @user.arid_cache_key('companies')
+    assert_equal @user.arid_cache_key('companies'), @user.arid_cache_key('companies', :auto_expire => false)
+    assert_match %r[users/#{@user.id}-\d{14}-companies], @user.arid_cache_key('companies', :auto_expire => true)
     
+    # It doesn't apply to class caches, but shouldn't affect it either
+    assert_equal User.arid_cache_key('companies'), User.arid_cache_key('companies', :auto_expire => true)
+  end
+  
+  test "should turn off auto-expire by default" do
+    assert_queries(2) do
+      @user.cached_companies_count
+      @user.touch
+      @user.cached_companies_count
+    end
+  end
+  
+  test "should reload auto-expired caches" do
+    assert_queries(2) do
+      @user.cached_companies_count(:auto_expire => true)
+      @user.cached_companies_count(:auto_expire => true)
+      @user.updated_at = Time.now + 1.seconds
+      @user.cached_companies_count(:auto_expire => true)
+      @user.cached_companies_count(:auto_expire => true)
+    end
+  end
+        
+  test "should support configuring instance caches" do
+    User.instance_caches { best_companies { companies } }
+    assert_equal @user.companies, @user.cached_best_companies
+  end
+  
+  test "instance caches should work on all instances of the class" do
+    User.instance_caches { best_companies { companies } }
+    assert_equal @user.cached_best_companies, User.first.cached_best_companies
+  end
+  
+  test "should support configuring class caches" do
+    User.class_caches { successful_users { successful } }
+    assert_equal User.successful, User.cached_successful_users
+  end
+  
+  test "should create valid store keys" do
+    assert_equal 'user-key', AridCache.store.send(:class_store_key, User, 'key')
+    assert_equal 'users-key', AridCache.store.send(:instance_store_key, User, 'key')
+    assert_equal AridCache.store.send(:instance_store_key, User, 'key'), AridCache.store.send(:object_store_key, @user, 'key')
+    assert_equal AridCache.store.send(:class_store_key, User, 'key'), AridCache.store.send(:object_store_key, User, 'key')
+  end
+  
+  test "configuring caches should not perform any queries" do
+    User.instance_caches do
+      best_companies { companies }
+    end
+    User.class_caches do
+      best_companies(:order => 'name DESC') { companies.find(:all, :order => 'name DESC') }
+    end
+  end
+  
+  test "should support options in the cache configuration" do
+    User.instance_caches(:auto_expire => true) do
+      expires_in = 1.second
+      best_companies(:expires_in => expires_in) { companies }
+    end
+    assert_queries(2) do
+      @user.cached_best_companies_count
+      @user.updated_at = Time.now + 1.seconds
+      @user.cached_best_companies_count
+      @user.cached_best_companies_count
+    end
+    User.class_caches do
+      most_successful(:order => 'name DESC') { successful.find(:all, :order => 'name DESC') }
+    end
+    # Call it twice to ensure that on the second call the order is applied when retrieving the
+    # records by id
+    assert_equal User.successful.find(:all, :order => 'name DESC'), User.cached_most_successful
+    assert_equal User.successful.find(:all, :order => 'name DESC'), User.cached_most_successful   
+  end
+  
+  #
+  # Tests requiring manual verification by looking at the SQL logs.
+  # TODO move these to a separate class.
+  #
+   
+  test "should preserve original ordering" do
+    # TODO.  This one is hard to test because SQL usually keeps the same ordering
+    # and it's difficult to make it do otherwise.  Best to just inspect the queries
+    # in the log.
+    @user.cached_companies
+    @user.cached_companies
+  end
+  
+  test "should paginate collections in memory" do
+    # TODO.  Tough to test because we can't just count queries
+    # have to look at the SQL in the logs for this one.
+    @user.cached_companies(:page => 2, :per_page => 3)
+    @user.cached_companies(:page => 1, :per_page => 3)
+  end  
+        
+  protected
+
     def assert_queries(num = 1)
       $query_count = 0
       yield
@@ -217,16 +324,4 @@ class AridCacheTest < ActiveSupport::TestCase
     def assert_no_queries(&block)
       assert_queries(0, &block)
     end
-  
-    def define_instance_cache(user)
-      user.cache_companies(:per_page => 2) do
-        user.companies
-      end    
-    end 
-
-    def define_model_cache(model)
-      model.cache_companies(:per_page => 2) do
-        model.companies
-      end    
-    end 
 end

data/test/db/prepare.rb

@@ -13,14 +13,13 @@ ActiveRecord::Base.silence do
   load(File.join(File.dirname(__FILE__), 'schema.rb'))
 end
 
-# Fixtures
-ActiveRecord::Base.silence do
-  Fixtures.create_fixtures(File.join(File.dirname(__FILE__), '..', 'fixtures'), ActiveRecord::Base.connection.tables)
-end
-
 # Models
 Dir[File.join(File.dirname(__FILE__), '..', 'models', '*.rb')].each { |f| require f }
 
+# Populate
+require 'blueprint'
+Blueprint.seeds
+
 class << ActiveRecord::Base.connection
   IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
 

data/test/db/schema.rb

@@ -2,6 +2,7 @@ ActiveRecord::Schema.define do
   create_table "users", :force => true do |t|
     t.column "name",  :text
     t.column "email", :text
+    t.timestamps
   end
   
   create_table "companies", :force => true do |t|
@@ -9,5 +10,6 @@ ActiveRecord::Schema.define do
     t.column "owner_id", :integer
     t.column "country_id", :integer
     t.column "employees", :integer    
+    t.timestamps
   end
 end

data/test/lib/active_support/cache/file_store_extras.rb

@@ -0,0 +1,17 @@
+
+module ActiveSupport
+  module Cache
+    class FileStore < Store
+      alias :original_read :read
+      
+      def read(name, options = {})
+        lastmod = File.mtime(real_file_path(name)) rescue nil
+        if lastmod && options.is_a?(Hash) && options[:expires_in] && ((lastmod + options[:expires_in]) <= Time.now)
+          nil
+        else  
+          original_read(name, options)
+        end
+      end
+    end
+  end    
+end

data/test/lib/blueprint.rb

@@ -0,0 +1,29 @@
+require 'machinist/active_record'
+require 'sham'
+require 'faker'
+
+Sham.name  { Faker::Name.name }
+Sham.company_name { Faker::Company.name }
+Sham.email { Faker::Internet.email }
+
+User.blueprint do
+  name
+  email
+end
+
+Company.blueprint do
+  name { Sham.company_name }
+  employees { rand(200) }
+  #owner
+end
+
+module Blueprint
+  def self.seeds
+    10.times do
+      user = User.make
+      (5 + rand(5)).times do
+        Company.make(:owner => user)
+      end
+    end
+  end
+end

data/test/models/company.rb

@@ -1,5 +1,6 @@
+require 'arid_cache'
 
 class Company < ActiveRecord::Base
   named_scope :owned, :conditions => ['owner_id is not null']
-  belongs_to :owner, :class_name => :User
+  belongs_to :owner, :class_name => 'User'
 end

data/test/models/user.rb

@@ -3,7 +3,7 @@ require 'arid_cache'
 class User < ActiveRecord::Base
   has_many :companies, :foreign_key => :owner_id
   named_scope :companies, :joins => :companies
-  named_scope :successful, :joins => :companies, :conditions => 'companies.employees > 50'
+  named_scope :successful, :joins => :companies, :conditions => 'companies.employees > 50', :group => 'users.id'
   
   def big_companies
     companies.find :all, :conditions => [ 'employees > 20' ]
@@ -20,4 +20,12 @@ class User < ActiveRecord::Base
       super
     end
   end
+  
+  def respond_to?(method)
+    if method == :respond_not_overridden
+      true
+    else
+      super
+    end
+  end
 end

data/test/test_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib')) # AridCache lib
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))       # test lib
 
+require 'fileutils'
 require 'rubygems'
 require 'active_record'
 require 'active_support'
@@ -9,7 +11,13 @@ require 'test/unit' # required by ActiveSupport::TestCase
 require 'will_paginate'
 require 'ruby-debug'
 
-# Activate ARID Cache
+# Activate Will Paginate 
+WillPaginate.enable_activerecord
+
+# Add support for expiring file-cache store.
+require 'active_support/cache/file_store_extras'
+
+# Activate AridCache
 require 'arid_cache'
 AridCache.init_rails
 
@@ -17,8 +25,9 @@ AridCache.init_rails
 log = File.expand_path(File.join(File.dirname(__FILE__), 'log', 'test.log'))
 RAILS_DEFAULT_LOGGER = ENV["STDOUT"] ? Logger.new(STDOUT) : Logger.new(log)
 
-# Setup an in memory-cache
-RAILS_CACHE = ActiveSupport::Cache.lookup_store(:memory_store)
+# Setup the cache. Use the file-store cache because the
+# memory-store cache doesn't delete cache keys...I don't know why.
+RAILS_CACHE = ActiveSupport::Cache.lookup_store(:file_store, "#{File.dirname(__FILE__)}/tmp/cache")
 
 # Mock Rails
 Rails = Class.new do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arid_cache
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Karl Varga
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-25 00:00:00 +08:00
+date: 2010-01-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,17 +23,27 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: will_paginate
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.9
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: will_paginate
+  name: faker
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: machinist
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -43,8 +53,8 @@ dependencies:
         version: "0"
     version: 
 description: |
-  ARID Cache makes caching easy and effective.  ARID cache supports caching on all your model named scopes, class methods and instance methods right out of the box.  ARID cache prevents caching logic from cluttering your models and clarifies your logic by making explicit calls to cached result sets.
-  ARID Cache is designed for handling large, expensive ActiveRecord collections but is equally useful for caching anything else as well.
+  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.
 
 email: kjvarga@gmail.com
 executables: []
@@ -76,8 +86,8 @@ files:
 - test/console
 - test/db/prepare.rb
 - test/db/schema.rb
-- test/fixtures/companies.yml
-- test/fixtures/users.yml
+- test/lib/active_support/cache/file_store_extras.rb
+- test/lib/blueprint.rb
 - test/log/.gitignore
 - test/models/company.rb
 - test/models/user.rb
@@ -116,6 +126,8 @@ test_files:
 - test/arid_cache_test.rb
 - test/db/prepare.rb
 - test/db/schema.rb
+- test/lib/active_support/cache/file_store_extras.rb
+- test/lib/blueprint.rb
 - test/models/company.rb
 - test/models/user.rb
 - test/test_helper.rb

data/test/fixtures/companies.yml

@@ -1,6 +0,0 @@
-<% for digit in 1..15 %>
-acme_<%= digit %>:
-  name: Acme <%= digit %>
-  owner_id: <%= rand(10) %>
-  employees: <%= rand(200) %>
-<% end %>

data/test/fixtures/users.yml

@@ -1,5 +0,0 @@
-<% for digit in 1..10 %>
-user_<%= digit %>:
-  name: Bob <%= digit %>
-  email: bob<%= digit %>@ibm.com
-<% end %>