kasket 0.9.1 → 1.0.0

data/lib/kasket.rb

@@ -12,15 +12,17 @@ module Kasket
   CONFIGURATION = {:max_collection_size => 100}
 
   class Version
-    MAJOR = 0
-    MINOR = 9
-    PATCH = 1
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 
   module_function
 
   def setup(options = {})
+    return if ActiveRecord::Base.extended_by.member?(Kasket::ConfigurationMixin)
+
     CONFIGURATION[:max_collection_size] = options[:max_collection_size] if options[:max_collection_size]
 
     ActiveRecord::Base.extend(Kasket::ConfigurationMixin)

data/lib/kasket/read_mixin.rb

@@ -55,15 +55,19 @@ module Kasket
 
       def store_in_kasket(key, records)
         if records.size == 1
-          Kasket.cache.write(key, records.first.instance_variable_get(:@attributes).dup)
-        elsif records.size <= Kasket::CONFIGURATION[:max_collection_size]
-          instance_keys = records.map do |record|
-            instance_key = kasket_key_for_id(record.id)
-            Kasket.cache.write(instance_key, record.instance_variable_get(:@attributes).dup)
-            instance_key
+          if records.first.kasket_cacheable?
+            Kasket.cache.write(key, records.first.instance_variable_get(:@attributes).dup)
           end
+        elsif records.size <= Kasket::CONFIGURATION[:max_collection_size]
+          if records.all?(&:kasket_cacheable?)
+            instance_keys = records.map do |record|
+              instance_key = kasket_key_for_id(record.id)
+              Kasket.cache.write(instance_key, record.instance_variable_get(:@attributes).dup)
+              instance_key
+            end
 
-          Kasket.cache.write(key, instance_keys) if key.is_a?(String)
+            Kasket.cache.write(key, instance_keys) if key.is_a?(String)
+          end
         end
         records
       end

data/lib/kasket/write_mixin.rb

@@ -26,8 +26,12 @@ module Kasket
         @kasket_key ||= new_record? ? nil : self.class.kasket_key_for_id(id)
       end
 
+      def kasket_cacheable?
+        true
+      end
+
       def store_in_kasket
-        if !readonly? && kasket_key
+        if kasket_cacheable? && kasket_key
           Kasket.cache.write(kasket_key, @attributes.dup)
         end
       end

data/test/cacheable_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+class CacheableTest < ActiveSupport::TestCase
+  context "#store_in_kasket" do
+    should "only cache object that are kasket_cacheable?" do
+      post = Post.send(:instantiate, { 'id' => 1, 'title' => 'Hello' })
+
+      post.expects(:kasket_cacheable?).returns(true)
+      Kasket.cache.expects(:write).once
+      post.store_in_kasket
+
+      post.expects(:kasket_cacheable?).returns(false)
+      Kasket.cache.expects(:write).never
+      post.store_in_kasket
+    end
+  end
+
+  context "caching of results of find" do
+    setup do
+      @post_database_result = { 'id' => 1, 'title' => 'Hello' }
+      @post_records = [Post.send(:instantiate, @post_database_result)]
+      Post.stubs(:find_by_sql_without_kasket).returns(@post_records)
+
+      @comment_database_result = [{ 'id' => 1, 'body' => 'Hello' }, { 'id' => 2, 'body' => 'World' }]
+      @comment_records = @comment_database_result.map {|r| Comment.send(:instantiate, r)}
+      Comment.stubs(:find_by_sql_without_kasket).returns(@comment_records)
+    end
+
+    context "with just one result" do
+      should "write result in cache if it is kasket_cacheable?" do
+        Post.any_instance.expects(:kasket_cacheable?).returns(true)
+        Kasket.cache.expects(:write).once
+        Post.find(1)
+      end
+
+      should "not write result in cache if it is not kasket_cacheable?" do
+        Post.any_instance.expects(:kasket_cacheable?).returns(false)
+        Kasket.cache.expects(:write).never
+        Post.find(1)
+      end
+    end
+
+    context "with several results" do
+      should "write result in cache if all results are kasket_cacheable?" do
+        Comment.any_instance.stubs(:kasket_cacheable?).returns(true)
+        Kasket.cache.expects(:write).times(@comment_records.size + 1)
+        Comment.all(:conditions => {:post_id => 1})
+      end
+
+      should "not write result in cache if any of them are not kasket_cacheable?" do
+        @comment_records[0].expects(:kasket_cacheable?).returns(true)
+        @comment_records[1].expects(:kasket_cacheable?).returns(false)
+        Kasket.cache.expects(:write).never
+        Comment.all(:conditions => {:post_id => 1})
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -4,6 +4,11 @@ require 'bundler'
 Bundler.setup
 Bundler.require(:default, :development)
 
+if defined?(Debugger)
+  ::Debugger.start
+  ::Debugger.settings[:autoeval] = true if ::Debugger.respond_to?(:settings)
+end
+
 require 'test/unit'
 require 'active_record/fixtures'
 
@@ -42,10 +47,15 @@ $LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)
 module Rails
   module_function
   CACHE = ActiveSupport::Cache::MemoryStore.new
+  LOGGER = Logger.new(STDOUT)
 
   def cache
     CACHE
   end
+
+  def logger
+    LOGGER
+  end
 end
 
 require 'test_models'

data/test/read_mixin_test.rb

@@ -37,7 +37,8 @@ class ReadMixinTest < ActiveSupport::TestCase
       assert_equal(@comment_database_result, stored_value.map {|key| Kasket.cache.read(key)})
 
       Comment.expects(:find_by_sql_without_kasket).never
-      assert_equal(@comment_records, Comment.find_by_sql('SELECT * FROM `comments` WHERE (post_id = 1)'))
+      records = Comment.find_by_sql('SELECT * FROM `comments` WHERE (post_id = 1)')
+      assert_equal(@comment_records, records.sort {|c1, c2| c1.id <=> c2.id})
     end
 
     context "modifying results" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kasket
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
-  - 0
-  - 9
   - 1
-  version: 0.9.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mick Staugaard
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-05 00:00:00 +01:00
+date: 2011-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,7 +108,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: sqlite3
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -142,6 +142,7 @@ files:
 - lib/kasket.rb
 - README.rdoc
 - test/cache_expiry_test.rb
+- test/cacheable_test.rb
 - test/configuration_mixin_test.rb
 - test/database.yml
 - test/dirty_test.rb
@@ -185,12 +186,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A write back caching layer on active record
 test_files: 
 - test/cache_expiry_test.rb
+- test/cacheable_test.rb
 - test/configuration_mixin_test.rb
 - test/database.yml
 - test/dirty_test.rb