ca_ching 0.1.0

data/spec/ca_ching/read_through_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+module CaChing
+  describe ReadThrough do
+    describe 'finding on indexed fields' do
+      before :all do
+        @person = Person.where(:id => 1).to_a_without_cache.first
+        @cache = CaChing::Adapters::Redis.new
+      end
+      
+      before :each do
+        @cache.clear!
+      end
+      
+      describe 'cache hit' do
+        before(:each) do
+          # Prime the cache
+          @cache.insert(Person.where(:id => 1).to_a_without_cache, :for => CaChing::Query::Abstract.new(Person.where(:id => 1)))
+          @cache.insert(Person.where(:name => @person.name).to_a_without_cache, :for => CaChing::Query::Abstract.new(Person.where(:name => @person.name)))
+          @cache.insert(Person.where(:age => @person.age).to_a_without_cache, :for => CaChing::Query::Abstract.new(Person.where(:age => @person.age)))
+          @cache.insert(Person.where(:age => @person.age, :salary => @person.salary).to_a_without_cache, :for => CaChing::Query::Abstract.new(Person.where(:age => @person.age, :salary => @person.salary)))
+          @cache.insert(Article.where(:person_id => @person.id).to_a_without_cache, :for => CaChing::Query::Abstract.new(Article.where(:person_id => @person.id)))
+        end
+        
+        it 'returns the result without querying the database' do          
+          person = Person.find(1)
+          person.from_cache?.should == true
+          person.should == Person.where(:id => 1).to_a_without_cache.first
+        end
+        
+        it 'finds by id' do
+          person = Person.find(1)
+          person.from_cache?.should == true
+          person.should == Person.where(:id => 1).to_a_without_cache.first
+        end
+        
+        describe 'dynamic finders' do
+          it 'finds with one parameter' do
+            person = Person.find_by_name(@person.name)
+            person.from_cache?.should == true
+            person.should == @person
+          end
+          
+          it 'finds with many parameters' do
+            pending
+            
+            person = Person.find_by_name_and_age(@person.name, @person.age)
+            person.from_cache?.should == true
+            person.should == @person
+          end
+          
+          it 'finds all with one parameter' do
+            people = Person.find_all_by_age(@person.age)
+            people.from_cache?.should == true
+            people.map { |p| p.id }.sort.should == Person.where(:age => @person.age).to_a_without_cache.map { |p| p.id }.sort
+          end
+          
+          it 'finds all with many parameters' do
+            pending
+            
+            people = Person.find_all_by_age_and_salary(@person.age, @person.salary)
+            people.from_cache?.should == true
+            people.should == Person.where(:age => @person.age, :salary => @person.salary).to_a_without_cache
+          end
+        end
+        
+        describe 'Arel-style finders' do
+          describe 'where' do
+            it 'finds with one parameter' do
+              people = Person.where(:age => @person.age).all
+              people.from_cache?.should == true
+              people.sort.should == Person.where(:age => @person.age).to_a_without_cache.sort
+            end
+            
+            it 'finds with many parameters' do
+              pending
+              
+              people = Person.where(:age => @person.age, :salary => @person.salary).all
+              people.from_cache?.should == true
+              people.should == Person.where(:age => @person.age, :salary => @person.salary).to_a_without_cache
+            end
+          end
+          
+          describe 'order' do
+            it 'finds if the order matches the order on an indexed field in the query' do
+              people = Person.where(:salary => @person.salary).order('salary DESC').all
+              people.from_cache?.should == true
+              people.should == Person.where(:salary => @person.salary).order('salary DESC').to_a_without_cache
+            end
+            
+            it 'skips the cache if the order does not match an order on an indexed field in the query' do
+              people = Person.where(:salary => @person.salary).order('salary ASC').all
+              people.from_cache?.should == false
+            end
+          end
+          
+          describe 'limit' do
+            it 'limits the returned set to the number specified in limit' do
+              articles = Article.where(:person_id => @person.id).limit(2).all
+              articles.size.should == 2
+              articles.from_cache?.should == true
+            end
+          end
+          
+          describe 'offset' do
+            it 'offsets the returned set by the number specified' do
+              articles = Article.where(:person_id => @person.id).offset(3).all
+              articles.from_cache?.should == true
+              Article.where(:person_id => @person.id).offset(3).to_a_without_cache.should == articles
+            end
+          end
+          
+          describe 'join, include, etc.' do
+            it 'skips the cache' do
+              Article.where(:person_id => @person.id).includes(:person).all.from_cache?.should == false
+            end
+          end
+        end
+      end
+      
+      describe 'cache miss' do
+        it 'stores the result returned from the database' do
+          person = Person.find(1)
+          person.from_cache?.should == false
+          
+          person = Person.find(1)
+          person.from_cache?.should == true
+        end
+        
+        it 'finds by id' do
+          person = Person.find(1)
+          person.from_cache?.should == false
+          
+          person = Person.find(1)
+          person.from_cache?.should == true
+        end
+        
+        describe 'dynamic finders' do
+          it 'finds with one parameter' do
+            person = Person.find_by_name(@person.name)
+            person.from_cache?.should == false
+            
+            person = Person.find_by_name(@person.name)
+            person.from_cache?.should == true
+          end
+          
+          it 'finds with many parameters' do
+            pending
+            
+            person = Person.find_by_name_and_age(@person.name, @person.age)
+            person.from_cache?.should == false
+            
+            person = Person.find_by_name_and_age(@person.name, @person.age)
+            person.from_cache?.should == true
+          end
+          
+          it 'finds all with one parameter' do
+            person = Person.find_all_by_name(@person.name)
+            person.from_cache?.should == false
+            
+            person = Person.find_all_by_name(@person.name)
+            person.from_cache?.should == true
+          end
+          
+          it 'finds all with many parameters' do
+            pending
+            
+            person = Person.find_all_by_name_and_age(@person.name, @person.age)
+            person.from_cache?.should == false
+            
+            person = Person.find_all_by_name_and_age(@person.name, @person.age)
+            person.from_cache?.should == true
+          end
+        end
+        
+        describe 'Arel-style finders' do
+          describe 'where' do
+            it 'finds with one parameter' do
+              person = Person.where(:name => @person.name).all
+              person.from_cache?.should == false
+              
+              person = Person.where(:name => @person.name).all
+              person.from_cache?.should == true
+            end
+            
+            it 'finds with many parameters' do
+              pending
+              person = Person.where(:name => @person.name, :age => @person.age).all
+              person.from_cache?.should == false
+              
+              person = Person.where(:name => @person.name, :age => @person.age).all
+              person.from_cache?.should == true
+            end
+          end
+          
+          describe 'limit' do
+            it 'will cache an incorrect number of items' do
+              true.should == false
+            end
+          end
+        end
+      end
+      
+    end
+    
+    describe 'finding on non-indexed fields' do
+      it 'does not attempt to find via the cache' do
+        Tag.where(:name => 'abc').all.from_cache?.should == false
+        # Do it twice to illustrate that it isn't cached on miss (because there is no miss)
+        Tag.where(:name => 'abc').all.from_cache?.should == false
+      end
+    end    
+  end
+end

data/spec/ca_ching/write_through_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module CaChing
+  describe WriteThrough do
+    before :all do
+      @person = Person.where(:id => 1).to_a_without_cache.first
+      @cache = CaChing::Adapters::Redis.new
+    end
+    
+    before :each do
+      @cache.clear!
+    end
+    
+    it 'updates the cache for a cached object' do
+      ar = Person.where(:id => 1)
+      query = CaChing::Query::Abstract.new(ar)
+      @cache.insert(ar.to_a_without_cache, :for => query)
+      
+      @person.name = @person.name.reverse
+      @person.save
+      
+      @cache.find(CaChing::Query::Abstract.new(ar)).first.name.should == @person.name
+    end
+  end
+end

data/spec/console.rb

@@ -0,0 +1,22 @@
+Bundler.setup
+require 'machinist/active_record'
+require 'sham'
+require 'faker'
+
+Dir[File.expand_path('../../spec/{helpers,support,blueprints}/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+Sham.define do
+  name     { Faker::Name.name }
+  title    { Faker::Lorem.sentence }
+  body     { Faker::Lorem.paragraph }
+  salary   {|index| 30000 + (index * 1000)}
+  note     { Faker::Lorem.words(7).join(' ') }
+  tag_name { Faker::Lorem.words(3).join(' ') }
+end
+
+Schema.create unless ENV['SCHEMA'] == 'no'
+
+require 'ca_ching'
+

data/spec/helpers/ca_ching_helper.rb

@@ -0,0 +1,2 @@
+module CaChingHelper
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'active_record'
+require 'machinist/active_record'
+require 'sham'
+require 'faker'
+
+require 'ca_ching'
+
+Dir[File.expand_path('../{helpers,support,blueprints}/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+Sham.define do
+  name     { Faker::Name.name }
+  title    { Faker::Lorem.sentence }
+  body     { Faker::Lorem.paragraph }
+  salary   {|index| 30000 + (index * 1000)}
+  note     { Faker::Lorem.words(7).join(' ') }
+  tag_name { Faker::Lorem.words(3).join(' ') }
+end
+
+RSpec.configure do |config|
+  CaChing.configure do |config|
+    config.cache = CaChing::Adapters::Redis.new(:host => 'localhost', :port => 6379)
+    config.disabled = true
+  end
+  
+  config.before(:suite) do
+    Schema.create
+    CaChing.disabled = false
+  end
+  
+  config.before(:all) { Sham.reset(:before_all) }
+  config.before(:each) { Sham.reset(:before_each) }
+end

data/spec/support/schema.rb

@@ -0,0 +1,98 @@
+require 'active_record'
+require 'ca_ching'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+class Person < ActiveRecord::Base
+  belongs_to :parent, :class_name => 'Person', :foreign_key => 'parent_id'
+  has_many :children, :class_name => 'Person', :foreign_key => 'parent_id'
+  
+  has_many :articles
+  has_many :comments
+  
+  index :id
+  index :name
+  index :age
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :person
+  has_many :tags
+  has_many :comments
+  
+  index :title
+  index :person_id
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :person
+  belongs_to :article
+end
+
+class Tag < ActiveRecord::Base
+  belongs_to :article
+end
+
+module Schema
+  def self.create
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+
+      ActiveRecord::Schema.define do
+        create_table :people, :force => true do |t|
+          t.integer  :parent_id
+          t.string   :name
+          t.integer  :salary
+          t.integer  :age
+          
+          t.timestamps
+        end
+
+        create_table :articles, :force => true do |t|
+          t.integer :person_id
+          t.string  :title
+          t.text    :body
+          
+          t.timestamps
+        end
+
+        create_table :comments, :force => true do |t|
+          t.integer :article_id
+          t.integer :person_id
+          t.text    :body
+          
+          t.timestamps
+        end
+
+        create_table :tags, :force => true do |t|
+          t.integer :article_id
+          t.string :name
+          
+          t.timestamps
+        end
+      end
+    end
+
+    10.times do
+      person = Person.make
+      3.times do
+        article = Article.make(:person => person)
+        3.times do
+          article.tags = [Tag.make, Tag.make, Tag.make]
+        end
+        10.times do
+          Comment.make(:article => article)
+        end
+      end
+      2.times do
+        Comment.make(:person => person)
+      end
+    end
+
+    Comment.make(:body => 'First post!', :article => Article.make(:title => 'Hello, world!'))
+
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ca_ching
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Latimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: &2155697920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155697920
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2155697420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155697420
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2155696920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155696920
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2155696440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155696440
+description: Write-through ActiveRecord model caching that's right on the money
+email:
+- andrew@elpasoera.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SPEC.md
+- ca_ching.gemspec
+- lib/ca_ching.rb
+- lib/ca_ching/adapters/active_record.rb
+- lib/ca_ching/adapters/redis.rb
+- lib/ca_ching/configuration.rb
+- lib/ca_ching/core_ext/array.rb
+- lib/ca_ching/errors.rb
+- lib/ca_ching/index.rb
+- lib/ca_ching/query/abstract.rb
+- lib/ca_ching/query/calculation.rb
+- lib/ca_ching/query/select.rb
+- lib/ca_ching/read_through.rb
+- lib/ca_ching/version.rb
+- lib/ca_ching/write_through.rb
+- spec/blueprints/articles.rb
+- spec/blueprints/comments.rb
+- spec/blueprints/people.rb
+- spec/blueprints/tags.rb
+- spec/ca_ching/adapters/active_record_spec.rb
+- spec/ca_ching/adapters/redis_spec.rb
+- spec/ca_ching/configuration_spec.rb
+- spec/ca_ching/index_spec.rb
+- spec/ca_ching/query/abstract_spec.rb
+- spec/ca_ching/query/calculation_spec.rb
+- spec/ca_ching/query/select_spec.rb
+- spec/ca_ching/read_through_spec.rb
+- spec/ca_ching/write_through_spec.rb
+- spec/console.rb
+- spec/helpers/ca_ching_helper.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+homepage: http://github.com/ahlatimer/ca_ching
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -832901543252096864
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -832901543252096864
+requirements: []
+rubyforge_project: ca_ching
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Write-through ActiveRecord model caching that's right on the money
+test_files:
+- spec/blueprints/articles.rb
+- spec/blueprints/comments.rb
+- spec/blueprints/people.rb
+- spec/blueprints/tags.rb
+- spec/ca_ching/adapters/active_record_spec.rb
+- spec/ca_ching/adapters/redis_spec.rb
+- spec/ca_ching/configuration_spec.rb
+- spec/ca_ching/index_spec.rb
+- spec/ca_ching/query/abstract_spec.rb
+- spec/ca_ching/query/calculation_spec.rb
+- spec/ca_ching/query/select_spec.rb
+- spec/ca_ching/read_through_spec.rb
+- spec/ca_ching/write_through_spec.rb
+- spec/console.rb
+- spec/helpers/ca_ching_helper.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb