nkallen-cash 0.1.1

data/spec/cash/active_record_spec.rb

@@ -0,0 +1,190 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module Cash
+  describe Finders do
+    describe 'when the cache is populated' do
+      describe "#find" do
+        describe '#find(id...)' do
+          describe '#find(id)' do
+            it "returns an active record" do
+              story = Story.create!(:title => 'a story')
+              Story.find(story.id).should == story
+            end
+          end
+
+          describe 'when the object is destroyed' do
+            describe '#find(id)' do
+              it "raises an error" do
+                story = Story.create!(:title => "I am delicious")
+                story.destroy
+                lambda { Story.find(story.id) }.should raise_error(ActiveRecord::RecordNotFound)
+              end
+            end
+          end
+
+          describe '#find(id1, id2, ...)' do
+            it "returns an array" do
+              story1, story2 = Story.create!, Story.create!
+              Story.find(story1.id, story2.id).should == [story1, story2]
+            end
+
+            describe "#find(id, nil)" do
+              it "ignores the nils" do
+                story = Story.create!
+                Story.find(story.id, nil).should == story
+              end
+            end
+          end
+
+          describe 'when given nonexistent ids' do
+            describe 'when given one nonexistent id' do
+              it 'raises an error' do
+                lambda { Story.find(1) }.should raise_error(ActiveRecord::RecordNotFound)
+              end
+            end
+
+            describe 'when given multiple nonexistent ids' do
+               it "raises an error" do
+                lambda { Story.find(1, 2, 3) }.should raise_error(ActiveRecord::RecordNotFound)
+              end
+            end
+
+
+            describe '#find(nil)' do
+              it 'raises an error' do
+                lambda { Story.find(nil) }.should raise_error(ActiveRecord::RecordNotFound)
+              end
+            end
+          end
+        end
+
+        describe '#find(object)' do
+          it "coerces arguments to integers" do
+            story = Story.create!
+            Story.find(story.id.to_s).should == story
+          end
+        end
+
+        describe '#find([...])' do
+          describe 'when given an array with valid ids' do
+            it "#finds the object with that id" do
+              story = Story.create!
+              Story.find([story.id]).should == [story]
+            end
+          end
+
+          describe '#find([])' do
+            it 'returns the empty array' do
+              Story.find([]).should == []
+            end
+          end
+
+          describe 'when given nonexistent ids' do
+            it 'raises an error' do
+              lambda { Story.find([1, 2, 3]) }.should raise_error(ActiveRecord::RecordNotFound)
+            end
+          end
+
+          describe 'when given limits and offsets' do
+            describe '#find([1, 2, ...], :limit => ..., :offset => ...)' do
+              it "returns the correct slice of objects" do
+                character1 = Character.create!(:name => "Sam", :story_id => 1)
+                character2 = Character.create!(:name => "Sam", :story_id => 1)
+                character3 = Character.create!(:name => "Sam", :story_id => 1)
+                Character.find(
+                  [character1.id, character2.id, character3.id],
+                  :conditions => { :name => "Sam", :story_id => 1 }, :limit => 2
+                ).should == [character1, character2]
+              end
+            end
+
+            describe '#find([1], :limit => 0)' do
+              it "raises an error" do
+                character = Character.create!(:name => "Sam", :story_id => 1)
+                lambda do
+                  Character.find([character.id], :conditions => { :name => "Sam", :story_id => 1 }, :limit => 0)
+                end.should raise_error(ActiveRecord::RecordNotFound)
+              end
+            end
+          end
+        end
+
+        describe '#find(:first, ..., :offset => ...)' do
+          it "#finds the object in the correct order" do
+            story1 = Story.create!(:title => 'title1')
+            story2 = Story.create!(:title => story1.title)
+            Story.find(:first, :conditions => { :title => story1.title }, :offset => 1).should == story2
+          end
+        end
+
+        describe '#find(:first, :conditions => [])' do
+          it 'works' do
+            story = Story.create!
+            Story.find(:first, :conditions => []).should == story
+          end
+        end
+      end
+
+      describe '#find_by_attr' do
+        describe '#find_by_attr(nil)' do
+          it 'returns nil' do
+            Story.find_by_id(nil).should == nil
+          end
+        end
+
+        describe 'when given non-existent ids' do
+          it 'returns nil' do
+            Story.find_by_id(-1).should == nil
+          end
+        end
+      end
+
+      describe '#find_all_by_attr' do
+        describe 'when given non-existent ids' do
+          it "does not raise an error" do
+            lambda { Story.find_all_by_id([-1, -2, -3]) }.should_not raise_error
+          end
+        end
+      end
+    end
+
+    describe 'when the cache is partially populated' do
+      describe '#find(:all, :conditions => ...)' do
+        it "returns the correct records" do
+          story1 = Story.create!(:title => title = 'once upon a time...')
+          $memcache.flush_all
+          story2 = Story.create!(:title => title)
+          Story.find(:all, :conditions => { :title => story1.title }).should == [story1, story2]
+        end
+      end
+
+      describe '#find(id1, id2, ...)' do
+        it "returns the correct records" do
+          story1 = Story.create!(:title => 'story 1')
+          $memcache.flush_all
+          story2 = Story.create!(:title => 'story 2')
+          Story.find(story1.id, story2.id).should == [story1, story2]
+        end
+      end
+    end
+
+    describe 'when the cache is not populated' do
+      describe '#find(id)' do
+        it "returns the correct records" do
+          story = Story.create!(:title => 'a story')
+          $memcache.flush_all
+          Story.find(story.id).should == story
+        end
+      end
+
+      describe '#find(id1, id2, ...)' do
+        it "handles finds with multiple ids correctly" do
+          story1 = Story.create!
+          story2 = Story.create!
+          $memcache.flush_all
+          Story.find(story1.id, story2.id).should == [story1, story2]
+        end
+      end
+    end
+  end
+end

data/spec/cash/calculations_spec.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module Cash
+  describe Finders do
+    describe 'Calculations' do
+      describe 'when the cache is populated' do
+        before do
+          @stories = [Story.create!(:title => @title = 'asdf'), Story.create!(:title => @title)]
+        end
+
+        describe '#count(:all, :conditions => ...)' do
+          it "does not use the database" do
+            mock(Story.connection).execute.never
+            Story.count(:all, :conditions => { :title => @title }).should == @stories.size
+          end
+        end
+
+        describe '#count(:column, :conditions => ...)' do
+          it "uses the database, not the cache" do
+            mock(Story).get.never
+            Story.count(:title, :conditions => { :title => @title }).should == @stories.size
+          end
+        end
+
+        describe '#count(:all, :distinct => ..., :select => ...)' do
+          it 'uses the database, not the cache' do
+            mock(Story).get.never
+            Story.count(:all, :distinct => true, :select => :title, :conditions => { :title => @title }).should == @stories.collect(&:title).uniq.size
+          end
+        end
+
+        describe 'association proxies' do
+          describe '#count(:all, :conditions => ...)' do
+            it 'does not use the database' do
+              story = Story.create!
+              characters = [story.characters.create!(:name => name = 'name'), story.characters.create!(:name => name)]
+              mock(Story.connection).execute.never
+              story.characters.count(:all, :conditions => { :name => name }).should == characters.size
+            end
+          end
+        end
+      end
+
+      describe 'when the cache is not populated' do
+        describe '#count(:all, ...)' do
+          describe '#count(:all)' do
+            it 'uses the database, not the cache' do
+              mock(Story).get.never
+              Story.count
+            end
+          end
+          
+          describe '#count(:all, :conditions => ...)' do
+            it "populates the count correctly" do
+              Story.create!(:title => title = 'title')
+              $memcache.flush_all
+              Story.count(:all, :conditions => { :title => title }).should == 1
+              Story.fetch("title/#{title}/count").should =~ /1/
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/cash/finders_spec.rb

@@ -0,0 +1,336 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module Cash
+  describe Finders do
+    describe 'Cache Usage' do
+      describe 'when the cache is populated' do
+        describe '#find' do
+          describe '#find(1)' do
+            it 'does not use the database' do
+              story = Story.create!
+              mock(Story.connection).execute.never
+              Story.find(story.id).should == story
+            end
+          end
+
+          describe '#find(object)' do
+            it 'uses the objects quoted id' do
+              story = Story.create!
+              mock(Story.connection).execute.never
+              Story.find(story).should == story
+            end
+          end
+
+          describe '#find(:first, ...)' do
+            describe '#find(:first, :conditions => { :id => ?})' do
+              it "does not use the database" do
+                story = Story.create!
+                mock(Story.connection).execute.never
+                Story.find(:first, :conditions => { :id => story.id }).should == story
+              end
+            end
+
+            describe "#find(:first, :conditions => 'id = ?')" do
+              it "does not use the database" do
+                story = Story.create!
+                mock(Story.connection).execute.never
+                Story.find(:first, :conditions => "id = #{story.id}").should == story
+                Story.find(:first, :conditions => "`stories`.id = #{story.id}").should == story
+                Story.find(:first, :conditions => "`stories`.`id` = #{story.id}").should == story
+              end
+            end
+
+            describe '#find(:first, :readonly => false) and any other options other than conditions are nil' do
+              it "does not use the database" do
+                story = Story.create!
+                mock(Story.connection).execute.never
+                Story.find(:first, :conditions => { :id => story.id }, :readonly => false, :limit => nil, :offset => nil, :joins => nil, :include => nil).should == story
+              end
+            end
+
+            describe '#find(:first, :readonly => true)' do
+              it "uses the database, not the cache" do
+                story = Story.create!
+                mock(Story).get.never
+                Story.find(:first, :conditions => { :id => story.id }, :readonly => true).should == story
+              end
+            end
+
+            describe '#find(:first, :join => ...) or find(..., :include => ...)' do
+              it "uses the database, not the cache" do
+                story = Story.create!
+                mock(Story).get.never
+                Story.find(:first, :conditions => { :id => story.id }, :joins => 'AS stories').should == story
+                Story.find(:first, :conditions => { :id => story.id }, :include => :characters).should == story
+              end
+            end
+
+            describe '#find(:first)' do
+              it 'uses the database, not the cache' do
+                mock(Story).get.never
+                Story.find(:first)
+              end
+            end
+
+            describe '#find(:first, :conditions => "...")' do
+              describe 'on unindexed attributes' do
+                it 'uses the database, not the cache' do
+                  story = Story.create!
+                  mock(Story).get.never
+                  Story.find(:first, :conditions => "type IS NULL")
+                end
+              end
+
+              describe 'on indexed attributes' do
+                describe 'when the attributes are integers' do
+                  it 'does not use the database' do
+                    story = Story.create!
+                    mock(Story.connection).execute.never
+                    Story.find(:first, :conditions => "`stories`.id = #{story.id}") \
+                      .should == story
+                  end
+                end
+
+                describe 'when the attributes are non-integers' do
+                  it 'uses the database, not the cache' do
+                    story = Story.create!(:title => "title")
+                    mock(Story.connection).execute.never
+                    Story.find(:first, :conditions => "`stories`.title = '#{story.title }'") \
+                      .should == story
+                  end
+                end
+              end
+
+              describe '#find(:first, :conditions => [...])' do
+                describe 'with one indexed attribute' do
+                  it 'does not use the database' do
+                    story = Story.create!
+                    mock(Story.connection).execute.never
+                    Story.find(:first, :conditions => ['id = ?', story.id]).should == story
+                  end
+                end
+
+                describe 'with two attributes that match a combo-index' do
+                  it 'does not use the database' do
+                    story = Story.create!(:title => 'title')
+                    mock(Story.connection).execute.never
+                    Story.find(:first, :conditions => ['id = ? AND title = ?', story.id, story.title]).should == story
+                  end
+                end
+              end
+            end
+
+            describe '#find(:first, :conditions => {...})' do
+              it "does not use the database" do
+                story = Story.create!(:title => "Sam")
+                mock(Story.connection).execute.never
+                Story.find(:first, :conditions => { :id => story.id, :title => story.title }).should == story
+              end
+
+              describe 'regardless of hash order' do
+                it 'does not use the database' do
+                  story = Story.create!(:title => "Sam")
+                  mock(Story.connection).execute.never
+                  Story.find(:first, :conditions => { :id => story.id, :title => story.title }).should == story
+                  Story.find(:first, :conditions => { :title => story.title, :id => story.id }).should == story
+                end
+              end
+
+              describe 'on unindexed attribtes' do
+                it 'uses the database, not the cache' do
+                  story = Story.create!
+                  mock(Story).get.never
+                  Story.find(:first, :conditions => { :id => story.id, :type => story.type }).should == story
+                end
+              end
+            end
+          end
+
+          describe 'when there is a with_scope' do
+            describe 'when the with_scope has conditions' do
+              describe 'when the scope conditions is a string' do
+                it "uses the database, not the cache" do
+                  story = Story.create!(:title => title = 'title')
+                  mock(Story.connection).execute.never
+                  Story.send :with_scope, :find => { :conditions => "title = '#{title}'"} do
+                    Story.find(:first, :conditions => { :id => story.id }).should == story
+                  end
+                end
+              end
+
+              describe 'when the find conditions is a string' do
+                it "does not use the database" do
+                  story = Story.create!(:title => title = 'title')
+                  mock(Story.connection).execute.never
+                  Story.send :with_scope, :find => { :conditions => { :id => story.id }} do
+                    Story.find(:first, :conditions => "title = '#{title}'").should == story
+                  end
+                end
+              end
+
+              describe '#find(1, :conditions => ...)' do
+                it "does not use the database" do
+                  story = Story.create!
+                  character = Character.create!(:name => name = 'barbara', :story_id => story)
+                  mock(Character.connection).execute.never
+                  Character.send :with_scope, :find => { :conditions => { :story_id => story.id } } do
+                    Character.find(character.id, :conditions => { :name => name }).should == character
+                  end
+                end
+              end
+            end
+
+            describe 'has_many associations' do
+              describe '#find(1)' do
+                it "does not use the database" do
+                  story = Story.create!
+                  character = story.characters.create!
+                  mock(Character.connection).execute.never
+                  story.characters.find(character.id).should == character
+                end
+              end
+
+              describe '#find(1, 2, ...)' do
+                it "does not use the database" do
+                  story = Story.create!
+                  character1 = story.characters.create!
+                  character2 = story.characters.create!
+                  mock(Character.connection).execute.never
+                  story.characters.find(character1.id, character2.id).should == [character1, character2]
+                end
+              end
+
+              describe '#find_by_attr' do
+                it "does not use the database" do
+                  story = Story.create!
+                  character = story.characters.create!
+                  mock(Character.connection).execute.never
+                  story.characters.find_by_id(character.id).should == character
+                end
+              end
+            end
+          end
+
+          describe '#find(:all)' do
+            it "uses the database, not the cache" do
+              character = Character.create!
+              mock(Character).get.never
+              Character.find(:all).should == [character]
+            end
+
+            describe '#find(:all, :conditions => {...})' do
+              describe 'when the index is not empty' do
+                it 'does not use the database' do
+                  story1 = Story.create!(:title => title = "title")
+                  story2 = Story.create!(:title => title)
+                  mock(Story.connection).execute.never
+                  Story.find(:all, :conditions => { :title => story1.title }).should == [story1, story2]
+                end
+              end
+            end
+
+            describe '#find(:all, :limit => ..., :offset => ...)' do
+              it "cached attributes should support limits and offsets" do
+                character1 = Character.create!(:name => "Sam", :story_id => 1)
+                character2 = Character.create!(:name => "Sam", :story_id => 1)
+                character3 = Character.create!(:name => "Sam", :story_id => 1)
+                mock(Character.connection).execute.never
+
+                Character.find(:all, :conditions => { :name => character1.name, :story_id => character1.story_id }, :limit => 1).should == [character1]
+                Character.find(:all, :conditions => { :name => character1.name, :story_id => character1.story_id }, :offset => 1).should == [character2, character3]
+                Character.find(:all, :conditions => { :name => character1.name, :story_id => character1.story_id }, :limit => 1, :offset => 1).should == [character2]
+              end
+            end
+          end
+
+          describe '#find([...])' do
+            describe '#find([1, 2, ...], :conditions => ...)' do
+              it "uses the database, not the cache" do
+                story1, story2 = Story.create!, Story.create!
+                mock(Story).get.never
+                Story.find([story1.id, story2.id], :conditions => "type IS NULL").should == [story1, story2]
+              end
+            end
+
+            describe '#find([1], :conditions => ...)' do
+              it "uses the database, not the cache" do
+                story1, story2 = Story.create!, Story.create!
+                mock(Story).get.never
+                Story.find([story1.id], :conditions => "type IS NULL").should == [story1]
+              end
+            end
+          end
+
+          describe '#find_by_attr' do
+            describe 'on indexed attributes' do
+              describe '#find_by_id(id)' do
+                it "does not use the database" do
+                  story = Story.create!
+                  mock(Story.connection).execute.never
+                  Story.find_by_id(story.id).should == story
+                end
+              end
+
+              describe '#find_by_title(title)' do
+                it "does not use the database" do
+                  story1 = Story.create!(:title => 'title1')
+                  story2 = Story.create!(:title => 'title2')
+                  mock(Story.connection).execute.never
+                  Story.find_by_title('title1').should == story1
+                end
+              end
+            end
+          end
+
+          describe "Single Table Inheritence" do
+            describe '#find(:all, ...)' do
+              it "does not use the database" do
+                story, epic, oral = Story.create!(:title => title = 'foo'), Epic.create!(:title => title), Oral.create!(:title => title)
+                mock(Story.connection).execute.never
+                Story.find(:all, :conditions => { :title => title }).should == [story, epic, oral]
+                Epic.find(:all, :conditions => { :title => title }).should == [epic, oral]
+                Oral.find(:all, :conditions => { :title => title }).should == [oral]
+              end
+            end
+          end
+        end
+      end
+
+      describe 'when the cache is not populated' do
+        before do
+          @story = Story.create!(:title => 'title')
+          $memcache.flush_all
+        end
+
+        describe '#find(:first, ...)' do
+          it 'populates the cache' do
+            Story.find(:first, :conditions => { :title => @story.title })
+            Story.fetch("title/#{@story.title}").should == [@story.id]
+          end
+        end
+
+        describe '#find_by_attr' do
+          it 'populates the cache' do
+            Story.find_by_title(@story.title)
+            Story.fetch("title/#{@story.title}").should == [@story.id]
+          end
+        end
+
+        describe '#find(:all, :conditions => ...)' do
+          it 'populates the cache' do
+            Story.find(:all, :conditions => { :title => @story.title })
+            Story.fetch("title/#{@story.title}").should == [@story.id]
+          end
+        end
+
+        describe '#find(1)' do
+          it 'populates the cache' do
+            Story.find(@story.id)
+            Story.fetch("id/#{@story.id}").should == [@story]
+          end
+        end
+
+      end
+    end
+  end
+end