identity_cache 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d42fb65626667919f039bd01f22d0955abb9b4d
-  data.tar.gz: 9605d139be87f7cd1b1eedae86ccf348de18267b
+  metadata.gz: e49bcbf1656c4c055a0c04174a770650888b3349
+  data.tar.gz: ea93b60ce00ff52ea21440ce811a0f1c545cb8b2
 SHA512:
-  metadata.gz: 6d613cf3510702a00e84f17671c432e7fe48409c425dcd31282d944c6dd9d47cafd14eb064210d0c64a8ec9cbdf2ba236bcd72991a3573a3772d521f8bb4ce0c
-  data.tar.gz: 8057e8f156bde9b022cae3a6fc62d1a3d570453ba3efc1d362b88fcd5137552ab6478dc242079c5791d53f6ca0809a44eb53392fbcd90d3217136c756e873f9b
+  metadata.gz: e31e64a5b480adafd760b0364d4881d22fcb4ca09eed09bde2c810d63d5c4db959a06812bd6ec8ff8ebb5f3b58e55b30fde78c2b0c4dfa3d018876849156c263
+  data.tar.gz: 2fd22fce69151ea24d0836d0da19af7c36762c83e73ec7282e59b8298ee55c27e8196b706f9c64ea4152e331d123d0b8c6147d3625b452c6fbf905119bdebbe3

data/README.md

@@ -55,7 +55,7 @@ Note: You must include the IdentityCache module into the classes where you want
 
 ### Secondary Indexes
 
-IdentifyCache lets you lookup records by fields other than `id`. You can have multiple of these indexes with any other combination of fields:
+IdentityCache lets you lookup records by fields other than `id`. You can have multiple of these indexes with any other combination of fields:
 
 ``` ruby
 class Product < ActiveRecord::Base

data/identity_cache.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('ar_transaction_changes', '~> 1.0')
   gem.add_dependency('activerecord', '>= 3.2')
-  gem.add_dependency('memcached', '~> 1.8.0')
+  gem.add_development_dependency('memcached', '~> 1.8.0')
 
   gem.add_development_dependency('memcached_store', '~> 0.12.6')
   gem.add_development_dependency('rake')

data/lib/identity_cache/belongs_to_caching.rb

@@ -26,7 +26,7 @@ module IdentityCache
       def build_normalized_belongs_to_cache(association, options)
         self.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
           def #{options[:cached_accessor_name]}
-            if IdentityCache.should_cache? && #{options[:foreign_key]}.present? && !association(:#{association}).loaded?
+            if IdentityCache.should_use_cache? && #{options[:foreign_key]}.present? && !association(:#{association}).loaded?
               self.#{association} = #{options[:association_class]}.fetch_by_id(#{options[:foreign_key]})
             else
               #{association}

data/lib/identity_cache/cache_fetcher.rb

@@ -7,15 +7,15 @@ module IdentityCache
     end
 
     def write(key, value)
-      @cache_backend.write(key, value)
+      @cache_backend.write(key, value) if IdentityCache.should_update_cache?
     end
 
     def delete(key)
-      @cache_backend.write(key, IdentityCache::DELETED, :expires_in => IdentityCache::DELETED_TTL.seconds)
+      @cache_backend.write(key, IdentityCache::DELETED, :expires_in => IdentityCache::DELETED_TTL.seconds) if IdentityCache.should_update_cache?
     end
 
     def clear
-      @cache_backend.clear
+      @cache_backend.clear if IdentityCache.should_update_cache?
     end
 
     def fetch_multi(keys, &block)
@@ -34,6 +34,8 @@ module IdentityCache
           break
         end
         result = yield
+        break unless IdentityCache.should_update_cache?
+        result
       end
       unless yielded
         result = yield
@@ -66,6 +68,7 @@ module IdentityCache
         end
 
         break if updates.empty?
+        break unless IdentityCache.should_update_cache?
         updates
       end
       result
@@ -78,7 +81,7 @@ module IdentityCache
     end
 
     def add(key, value)
-      @cache_backend.write(key, value, :unless_exist => true)
+      @cache_backend.write(key, value, :unless_exist => true) if IdentityCache.should_update_cache?
     end
   end
 end

data/lib/identity_cache/configuration_dsl.rb

@@ -247,7 +247,7 @@ module IdentityCache
           end
 
           def #{options[:cached_accessor_name]}
-            if IdentityCache.should_cache? || #{association}.loaded?
+            if IdentityCache.should_use_cache? || #{association}.loaded?
               #{options[:population_method_name]} unless @#{options[:ids_variable_name]} || @#{options[:records_variable_name]}
               @#{options[:records_variable_name]} ||= #{options[:association_class]}.fetch_multi(@#{options[:ids_variable_name]})
             else

data/lib/identity_cache/fallback_fetcher.rb

@@ -7,15 +7,15 @@ module IdentityCache
     end
 
     def write(key, value)
-      @cache_backend.write(key, value)
+      @cache_backend.write(key, value) if IdentityCache.should_update_cache?
     end
 
     def delete(key)
-      @cache_backend.delete(key)
+      @cache_backend.delete(key) if IdentityCache.should_update_cache?
     end
 
     def clear
-      @cache_backend.clear
+      @cache_backend.clear if IdentityCache.should_update_cache?
     end
 
     def fetch_multi(keys, &block)
@@ -24,7 +24,7 @@ module IdentityCache
       unless missed_keys.empty?
         replacement_results = yield missed_keys
         missed_keys.zip(replacement_results) do |key, replacement_result|
-          @cache_backend.write(key, replacement_result)
+          @cache_backend.write(key, replacement_result) if IdentityCache.should_update_cache?
           results[key] = replacement_result
         end
       end
@@ -35,7 +35,7 @@ module IdentityCache
       result = @cache_backend.read(key)
       if result.nil?
         result = yield
-        @cache_backend.write(key, result)
+        @cache_backend.write(key, result) if IdentityCache.should_update_cache?
       end
       result
     end

data/lib/identity_cache/query_api.rb

@@ -22,7 +22,7 @@ module IdentityCache
       def fetch_by_id(id)
         return unless id
         raise NotImplementedError, "fetching needs the primary index enabled" unless primary_cache_index_enabled
-        if IdentityCache.should_cache?
+        if IdentityCache.should_use_cache?
 
           require_if_necessary do
             object = nil
@@ -50,7 +50,7 @@ module IdentityCache
         raise NotImplementedError, "fetching needs the primary index enabled" unless primary_cache_index_enabled
         options = ids.extract_options!
         ids.flatten!(1)
-        records = if IdentityCache.should_cache?
+        records = if IdentityCache.should_use_cache?
           require_if_necessary do
             cache_keys = ids.map {|id| rails_cache_key(id) }
             key_to_id_map = Hash[ cache_keys.zip(ids) ]
@@ -313,7 +313,7 @@ module IdentityCache
 
     def fetch_recursively_cached_association(ivar_name, association_name) # :nodoc:
       ivar_full_name = :"@#{ivar_name}"
-      if IdentityCache.should_cache?
+      if IdentityCache.should_use_cache?
         populate_recursively_cached_association(ivar_name, association_name)
         assoc = IdentityCache.unmap_cached_nil_for(instance_variable_get(ivar_full_name))
         assoc.is_a?(ActiveRecord::Associations::CollectionAssociation) ? assoc.reader : assoc

data/lib/identity_cache/version.rb

@@ -1,4 +1,4 @@
 module IdentityCache
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
   CACHE_VERSION = 5
 end

data/lib/identity_cache.rb

@@ -69,8 +69,12 @@ module IdentityCache
       @logger || Rails.logger
     end
 
-    def should_cache? # :nodoc:
-      !readonly && ActiveRecord::Base.connection.open_transactions == 0
+    def should_update_cache? # :nodoc:
+      !readonly && should_use_cache?
+    end
+
+    def should_use_cache? # :nodoc:
+      ActiveRecord::Base.connection.open_transactions == 0
     end
 
     # Cache retrieval and miss resolver primitive; given a key it will try to
@@ -81,7 +85,7 @@ module IdentityCache
     # +key+ A cache key string
     #
     def fetch(key)
-      if should_cache?
+      if should_use_cache?
         unmap_cached_nil_for(cache.fetch(key) { map_cached_nil_for yield })
       else
         yield
@@ -105,7 +109,7 @@ module IdentityCache
       keys.flatten!(1)
       return {} if keys.size == 0
 
-      result = if should_cache?
+      result = if should_use_cache?
         fetch_in_batches(keys) do |missed_keys|
           results = yield missed_keys
           results.map {|e| map_cached_nil_for e }

data/test/readonly_test.rb

@@ -0,0 +1,104 @@
+require "test_helper"
+
+class ReadonlyTest < IdentityCache::TestCase
+  def setup
+    super
+    IdentityCache.readonly = true
+    @key, @value = 'foo', 'bar'
+    @record = Item.new
+    @record.id = 1
+    @record.title = 'bob'
+    @bob = Item.create!(:title => 'bob')
+    @joe = Item.create!(:title => 'joe')
+    @fred = Item.create!(:title => 'fred')
+  end
+
+  def teardown
+    IdentityCache.readonly = nil
+    super
+  end
+
+  def test_write_should_not_update_cache
+    assert_memcache_operations(0) do
+      fetcher.write(@key, @value)
+    end
+    assert_nil backend.read(@key)
+  end
+
+  def test_delete_should_not_update_cache
+    backend.write(@key, @value)
+    assert_memcache_operations(0) do
+      fetcher.delete(@key)
+    end
+    assert_equal @value, backend.read(@key)
+  end
+
+  def test_clear_should_not_update_cache
+    backend.write(@key, @value)
+    assert_memcache_operations(0) do
+      fetcher.clear
+    end
+    assert_equal @value, backend.read(@key)
+  end
+
+  def test_fetch_should_not_update_cache
+    fetch = Spy.on(IdentityCache.cache, :fetch).and_call_through
+    Item.expects(:resolve_cache_miss).with(1).once.returns(@record)
+
+    assert_readonly_fetch do
+      assert_equal @record, Item.fetch(1)
+    end
+    assert_nil backend.read(@record.primary_cache_index_key)
+    assert fetch.has_been_called_with?(@record.primary_cache_index_key)
+  end
+
+  def test_fetch_multi_should_not_update_cache
+    fetch_multi = Spy.on(IdentityCache.cache, :fetch_multi).and_call_through
+
+    assert_readonly_fetch_multi do
+      assert_equal [@bob, @joe, @fred], Item.fetch_multi(@bob.id, @joe.id, @fred.id)
+    end
+    keys = [@bob, @joe, @fred].map(&:primary_cache_index_key)
+    assert_empty backend.read_multi(*keys)
+    assert fetch_multi.has_been_called_with?(*keys)
+  end
+
+  protected
+
+  def assert_readonly_fetch
+    cas = Spy.on(backend, :cas).and_call_through
+    yield
+    assert cas.has_been_called?
+  end
+
+  def assert_readonly_fetch_multi
+    cas_multi = Spy.on(backend, :cas_multi).and_call_through
+    yield
+    assert cas_multi.has_been_called?
+  end
+end
+
+class FallbackReadonlyTest < ReadonlyTest
+  def setup
+    super
+    IdentityCache.cache_backend = @backend = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  protected
+
+  def assert_readonly_fetch
+    read = Spy.on(backend, :read).and_call_through
+    write = Spy.on(backend, :write).and_call_through
+    yield
+    assert read.has_been_called?
+    refute write.has_been_called?
+  end
+
+  def assert_readonly_fetch_multi
+    read_multi = Spy.on(backend, :read_multi).and_call_through
+    write = Spy.on(backend, :write).and_call_through
+    yield
+    assert read_multi.has_been_called?
+    refute write.has_been_called?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Camilo Lopez
@@ -36,7 +36,7 @@ cert_chain:
   fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
   TConQSX2BnZdhIEYW+cKzEC/bLc=
   -----END CERTIFICATE-----
-date: 2014-06-14 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ar_transaction_changes
@@ -73,7 +73,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -247,6 +247,7 @@ files:
 - test/normalized_belongs_to_test.rb
 - test/normalized_has_many_test.rb
 - test/normalized_has_one_test.rb
+- test/readonly_test.rb
 - test/recursive_denormalized_has_many_test.rb
 - test/save_test.rb
 - test/schema_change_test.rb
@@ -299,6 +300,7 @@ test_files:
 - test/normalized_belongs_to_test.rb
 - test/normalized_has_many_test.rb
 - test/normalized_has_one_test.rb
+- test/readonly_test.rb
 - test/recursive_denormalized_has_many_test.rb
 - test/save_test.rb
 - test/schema_change_test.rb