identity_cache 0.0.2 → 0.0.3

data/test/memoized_cache_proxy_test.rb

@@ -6,7 +6,7 @@ class MemoizedCacheProxyTest < IdentityCache::TestCase
     IdentityCache.cache_backend = Rails.cache
   end
 
-  def test_chaging_default_cache
+  def test_changing_default_cache
     IdentityCache.cache_backend = ActiveSupport::Cache::MemoryStore.new
     IdentityCache.cache.write('foo', 'bar')
     assert_equal 'bar', IdentityCache.cache.read('foo')
@@ -21,6 +21,17 @@ class MemoizedCacheProxyTest < IdentityCache::TestCase
     end
   end
 
+  def test_read_should_short_circuit_on_falsy_memoized_values
+    Rails.cache.expects(:read).never
+
+    IdentityCache.cache.with_memoization do
+      IdentityCache.cache.write('foo', nil)
+      assert_equal nil, IdentityCache.cache.read('foo')
+      IdentityCache.cache.write('bar', false)
+      assert_equal false, IdentityCache.cache.read('bar')
+    end
+  end
+
   def test_read_should_try_memcached_on_not_memoized_values
     Rails.cache.expects(:read).with('foo').returns('bar')
 
@@ -40,6 +51,29 @@ class MemoizedCacheProxyTest < IdentityCache::TestCase
     end
   end
 
+  def test_read_should_memoize_values
+    IdentityCache.cache_backend = backend = ActiveSupport::Cache::MemoryStore.new
+    backend.write('foo', 'bar')
+
+    IdentityCache.cache.with_memoization do
+      assert_equal 'bar', IdentityCache.cache.read('foo')
+      backend.delete('foo')
+      assert_equal 'bar', IdentityCache.cache.read('foo')
+    end
+  end
+
+  def test_read_multi_should_memoize_values
+    IdentityCache.cache_backend = backend = ActiveSupport::Cache::MemoryStore.new
+    backend.write('foo', 'bar')
+
+    IdentityCache.cache.with_memoization do
+      assert_equal({'foo' => 'bar'}, IdentityCache.cache.read_multi('foo', 'fooz'))
+      backend.delete('foo')
+      backend.write('fooz', 'baz')
+      assert_equal({'foo' => 'bar'}, IdentityCache.cache.read_multi('foo', 'fooz'))
+    end
+  end
+
   def test_read_multi_with_partially_memoized_should_read_missing_keys_from_memcache
     IdentityCache.cache.write('foo', 'bar')
     Rails.cache.write('fooz', 'baz')
@@ -49,6 +83,17 @@ class MemoizedCacheProxyTest < IdentityCache::TestCase
     end
   end
 
+  def test_read_multi_with_blank_values_should_not_hit_the_cache_engine
+    Rails.cache.expects(:read_multi).never
+
+    IdentityCache.cache.with_memoization do
+      IdentityCache.cache.write('foo', [])
+      IdentityCache.cache.write('bar', false)
+      IdentityCache.cache.write('baz', {})
+      assert_equal({'foo' => [], 'bar' => false, 'baz' => {}}, IdentityCache.cache.read_multi('foo', 'bar', 'baz'))
+    end
+  end
+
   def test_with_memoization_should_not_clear_rails_cache_when_the_block_ends
     IdentityCache.cache.with_memoization do
       IdentityCache.cache.write('foo', 'bar')

data/test/normalized_has_many_test.rb

@@ -26,6 +26,18 @@ class NormalizedHasManyTest < IdentityCache::TestCase
   def test_defining_a_denormalized_has_many_cache_caches_the_list_of_associated_ids_on_the_parent_record_during_cache_miss
     fetched_record = Record.fetch(@record.id)
     assert_equal [2, 1], fetched_record.cached_associated_record_ids
+    assert_equal false, fetched_record.associated_records.loaded?
+  end
+
+  def test_fetching_associated_ids_will_populate_the_value_if_the_record_isnt_from_the_cache
+    assert_equal [2, 1], @record.fetch_associated_record_ids
+  end
+
+  def test_fetching_associated_ids_will_use_the_cached_value_if_the_record_is_from_the_cache
+    @record = Record.fetch(@record.id)
+    assert_queries(0) do
+      assert_equal [2, 1], @record.fetch_associated_record_ids
+    end
   end
 
   def test_the_cached_the_list_of_associated_ids_on_the_parent_record_should_not_be_populated_by_default
@@ -122,4 +134,5 @@ class NormalizedHasManyTest < IdentityCache::TestCase
     IdentityCache.cache.expects(:delete).with(@record.primary_cache_index_key).once
     @not_cached.save
   end
+
 end

data/test/recursive_denormalized_has_many_test.rb

@@ -67,14 +67,22 @@ class RecursiveDenormalizedHasManyTest < IdentityCache::TestCase
 
   def test_saving_child_record_should_expire_parent_record
     IdentityCache.cache.expects(:delete).with(@record.primary_cache_index_key)
-    IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
+    if AssociatedRecord.primary_cache_index_enabled
+      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
+    else
+      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key).never
+    end
     @associated_record.name = 'different'
     @associated_record.save!
   end
 
   def test_saving_grand_child_record_should_expire_parent_record
     IdentityCache.cache.expects(:delete).with(@record.primary_cache_index_key)
-    IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
+    if AssociatedRecord.primary_cache_index_enabled
+      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key)
+    else
+      IdentityCache.cache.expects(:delete).with(@associated_record.primary_cache_index_key).never
+    end
     IdentityCache.cache.expects(:delete).with(@deeply_associated_record.primary_cache_index_key)
     @deeply_associated_record.name = 'different'
     @deeply_associated_record.save!
@@ -98,3 +106,10 @@ class RecursiveNormalizedHasManyTest < IdentityCache::TestCase
     record_from_cache_miss = Record.fetch(@record.id)
   end
 end
+
+class DisabledPrimaryIndexTest < RecursiveDenormalizedHasManyTest
+  def setup
+    super
+    AssociatedRecord.disable_primary_cache_index
+  end
+end

data/test/save_test.rb

@@ -7,7 +7,7 @@ class SaveTest < IdentityCache::TestCase
     Record.cache_index :id, :title, :unique => true
 
     @record = Record.create(:title => 'bob')
-    @blob_key = "IDC:blob:Record:#{cache_hash("created_at:datetime,id:integer,title:string,updated_at:datetime")}:1"
+    @blob_key = "IDC:blob:Record:#{cache_hash("created_at:datetime,id:integer,record_id:integer,title:string,updated_at:datetime")}:1"
   end
 
   def test_create
@@ -16,7 +16,7 @@ class SaveTest < IdentityCache::TestCase
 
     IdentityCache.cache.expects(:delete).with("IDC:index:Record:id/title:#{cache_hash('2/bob')}")
     IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('bob')}")
-    IdentityCache.cache.expects(:delete).with("IDC:blob:Record:#{cache_hash("created_at:datetime,id:integer,title:string,updated_at:datetime")}:2").once
+    IdentityCache.cache.expects(:delete).with("IDC:blob:Record:#{cache_hash("created_at:datetime,id:integer,record_id:integer,title:string,updated_at:datetime")}:2").once
     @record.save
   end
 

data/test/schema_change_test.rb

@@ -39,29 +39,22 @@ class SchemaChangeTest < IdentityCache::TestCase
     AssociatedRecord.reset_column_information
     DeeplyAssociatedRecord.reset_column_information
 
-    AssociatedRecord.embedded_schema_hashes = {}
-    Record.embedded_schema_hashes = {}
+    AssociatedRecord.send(:instance_variable_set, :@rails_cache_key_prefix, nil)
+    Record.send(:instance_variable_set, :@rails_cache_key_prefix, nil)
   end
 
-  def test_schema_changes_on_embedded_association_when_the_cached_object_is_already_in_the_cache_should_request_from_the_db
+  def test_schema_changes_on_embedded_association_should_cause_cache_miss_for_old_cached_objects
     record = Record.fetch(@record.id)
     record.fetch_associated
 
     AddColumnToChild.new.up
     read_new_schema
 
-    # Reloading the association queries
-    # SHOW FULL FIELDS FROM `associated_records`
-    # SHOW TABLES LIKE 'associated_records'
-    # SELECT  `associated_records`.* FROM `associated_records`  WHERE `associated_records`.`record_id` = 1 ORDER BY id ASC LIMIT 1.
-    assert_queries(3) do
-      assert_nothing_raised { record.fetch_associated.shiny }
-    end
-
-    assert_no_queries { record.fetch_associated.shiny }
+    Record.expects(:resolve_cache_miss).returns(@record)
+    record = Record.fetch(@record.id)
   end
 
-  def test_schema_changes_on_deeply_embedded_association_when_the_cached_object_is_already_in_the_cache_should_request_from_the_db
+  def test_schema_changes_on_deeply_embedded_association_should_cause_cache_miss_for_old_cached_objects
     record = Record.fetch(@record.id)
     associated_record_from_cache = record.fetch_associated
     associated_record_from_cache.fetch_deeply_associated_records
@@ -69,20 +62,7 @@ class SchemaChangeTest < IdentityCache::TestCase
     AddColumnToDeepChild.new.up
     read_new_schema
 
-    # Loading association queries
-    # SHOW FULL FIELDS FROM `deeply_associated_records`
-    # SHOW FULL FIELDS FROM `associated_records`
-    # SHOW TABLES LIKE 'deeply_associated_records'
-    # SELECT `deeply_associated_records`.* FROM `deeply_associated_records` WHERE `deeply_associated_records`.`associated_record_id` = 1 ORDER BY name DESC.
-    assert_queries(4) do
-      assert_nothing_raised do
-        associated_record_from_cache.fetch_deeply_associated_records.map(&:new_column)
-      end
-    end
-
-    assert_no_queries do
-      associated_record_from_cache.fetch_deeply_associated_records.each{ |obj| assert_nil obj.new_column }
-      record.fetch_associated.fetch_deeply_associated_records.each{ |obj| assert_nil obj.new_column }
-    end
+    Record.expects(:resolve_cache_miss).returns(@record)
+    record = Record.fetch(@record.id)
   end
 end

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require 'mocha/setup'
 require 'active_record'
 require 'helpers/cache'
 require 'helpers/database_connection'
+require 'helpers/active_record_objects'
 
 require File.dirname(__FILE__) + '/../lib/identity_cache'
 
@@ -15,8 +16,22 @@ else
 end
 
 DatabaseConnection.setup
+ActiveSupport::Cache::Store.instrument = true
+
+# This patches AR::MemcacheStore to notify AS::Notifications upon read_multis like the rest of rails does
+class ActiveSupport::Cache::MemCacheStore
+  def read_multi_with_instrumentation(*args, &block)
+    instrument("read_multi", "MULTI", {:keys => args}) do
+      read_multi_without_instrumentation(*args, &block)
+    end
+  end
+
+  alias_method_chain :read_multi, :instrumentation
+end
 
 class IdentityCache::TestCase < MiniTest::Unit::TestCase
+  include ActiveRecordObjects
+
   def setup
     DatabaseConnection.drop_tables
     DatabaseConnection.create_tables
@@ -26,13 +41,7 @@ class IdentityCache::TestCase < MiniTest::Unit::TestCase
 
   def teardown
     IdentityCache.cache.clear
-    ActiveSupport::DescendantsTracker.clear
-    ActiveSupport::Dependencies.clear
-    Object.send :remove_const, 'DeeplyAssociatedRecord'
-    Object.send :remove_const, 'PolymorphicRecord'
-    Object.send :remove_const, 'AssociatedRecord'
-    Object.send :remove_const, 'NotCachedRecord'
-    Object.send :remove_const, 'Record'
+    teardown_models
   end
 
   def assert_nothing_raised
@@ -46,10 +55,27 @@ class IdentityCache::TestCase < MiniTest::Unit::TestCase
   def assert_queries(num = 1)
     counter = SQLCounter.new
     subscriber = ActiveSupport::Notifications.subscribe('sql.active_record', counter)
-      yield
-    ensure
-      ActiveSupport::Notifications.unsubscribe(subscriber)
-      assert_equal num, counter.log.size, "#{counter.log.size} instead of #{num} queries were executed.#{counter.log.size == 0 ? '' : "\nQueries:\n#{counter.log.join("\n")}"}"
+    exception = false
+    yield
+  rescue => e
+    exception = true
+    raise
+  ensure
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+    assert_equal num, counter.log.size, "#{counter.log.size} instead of #{num} queries were executed.#{counter.log.size == 0 ? '' : "\nQueries:\n#{counter.log.join("\n")}"}" unless exception
+  end
+
+  def assert_memcache_operations(num)
+    counter = CacheCounter.new
+    subscriber = ActiveSupport::Notifications.subscribe(/cache_.*\.active_support/, counter)
+    exception = false
+    yield
+  rescue => e
+    exception = true
+    raise
+  ensure
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+    assert_equal num, counter.log.size, "#{counter.log.size} instead of #{num} memcache operations were executed. #{counter.log.size == 0 ? '' : "\nOperations:\n#{counter.log.join("\n")}"}" unless exception
   end
 
   def assert_no_queries
@@ -61,38 +87,6 @@ class IdentityCache::TestCase < MiniTest::Unit::TestCase
   def cache_hash(key)
     CityHash.hash64(key)
   end
-
-  private
-  def setup_models
-    Object.send :const_set, 'DeeplyAssociatedRecord', Class.new(ActiveRecord::Base).tap {|klass|
-      klass.send :include, IdentityCache
-      klass.belongs_to :associated_record
-    }
-
-    Object.send :const_set, 'AssociatedRecord', Class.new(ActiveRecord::Base).tap {|klass|
-      klass.send :include, IdentityCache
-      klass.belongs_to :record
-      klass.has_many :deeply_associated_records, :order => "name DESC"
-    }
-
-    Object.send :const_set, 'NotCachedRecord', Class.new(ActiveRecord::Base).tap {|klass|
-      klass.belongs_to :record, :touch => true
-    }
-
-    Object.send :const_set, 'PolymorphicRecord', Class.new(ActiveRecord::Base).tap {|klass|
-      klass.belongs_to :owner, :polymorphic => true
-    }
-
-    Object.send :const_set, 'Record', Class.new(ActiveRecord::Base).tap {|klass|
-      klass.send :include, IdentityCache
-      klass.belongs_to :record
-      klass.has_many :associated_records, :order => "id DESC"
-      klass.has_many :not_cached_records, :order => "id DESC"
-      klass.has_many :polymorphic_records, :as => 'owner'
-      klass.has_one :polymorphic_record, :as => 'owner'
-      klass.has_one :associated, :class_name => 'AssociatedRecord', :order => "id ASC"
-    }
-  end
 end
 
 class SQLCounter
@@ -120,3 +114,15 @@ class SQLCounter
     self.log << sql
   end
 end
+
+class CacheCounter
+  attr_accessor :log
+
+  def initialize()
+    @log = []
+  end
+
+  def call(name, start, finish, message_id, values)
+    self.log << (values[:keys].try(:join, ', ') || values[:key])
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Camilo Lopez
@@ -13,152 +12,148 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: ar_transaction_changes
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.1
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.1
-    none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: activerecord
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.13
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.13
-    none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: activesupport
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.13
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.13
-    none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: cityhash
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.6.0
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.6.0
-    none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: memcache-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  prerelease: false
-  name: rake
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  prerelease: false
-  name: mocha
+        version: 0.14.0
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  prerelease: false
-  name: mysql2
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  prerelease: false
-  name: debugger
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: Opt in read through ActiveRecord caching.
 email:
 - harry.brundage@shopify.com
@@ -174,16 +169,26 @@ files:
 - README.md
 - Rakefile
 - identity_cache.gemspec
-- lib/belongs_to_caching.rb
 - lib/identity_cache.rb
+- lib/identity_cache/belongs_to_caching.rb
+- lib/identity_cache/cache_key_generation.rb
+- lib/identity_cache/configuration_dsl.rb
+- lib/identity_cache/memoized_cache_proxy.rb
+- lib/identity_cache/parent_model_expiration.rb
+- lib/identity_cache/query_api.rb
 - lib/identity_cache/version.rb
-- lib/memoized_cache_proxy.rb
+- performance/cache_runner.rb
+- performance/cpu.rb
+- performance/externals.rb
+- performance/profile.rb
 - test/attribute_cache_test.rb
 - test/cache_fetch_includes_test.rb
 - test/denormalized_has_many_test.rb
 - test/denormalized_has_one_test.rb
 - test/fetch_multi_test.rb
+- test/fetch_multi_with_batched_associations_test.rb
 - test/fetch_test.rb
+- test/helpers/active_record_objects.rb
 - test/helpers/cache.rb
 - test/helpers/database_connection.rb
 - test/identity_cache_test.rb
@@ -197,33 +202,26 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/Shopify/identity_cache
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -901854368761295247
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -901854368761295247
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: IdentityCache lets you specify how you want to cache your model objects,
   at the model level, and adds a number of convenience methods for accessing those
   objects through the cache. Memcached is used as the backend cache store, and the
@@ -234,7 +232,9 @@ test_files:
 - test/denormalized_has_many_test.rb
 - test/denormalized_has_one_test.rb
 - test/fetch_multi_test.rb
+- test/fetch_multi_with_batched_associations_test.rb
 - test/fetch_test.rb
+- test/helpers/active_record_objects.rb
 - test/helpers/cache.rb
 - test/helpers/database_connection.rb
 - test/identity_cache_test.rb