identity_cache 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e49bcbf1656c4c055a0c04174a770650888b3349
-  data.tar.gz: ea93b60ce00ff52ea21440ce811a0f1c545cb8b2
+  metadata.gz: 9ae6ab233ca71a68a76c92e46a6819af91b02c39
+  data.tar.gz: 1bf83f15e3957a5b20133cdad5cc80d675496973
 SHA512:
-  metadata.gz: e31e64a5b480adafd760b0364d4881d22fcb4ca09eed09bde2c810d63d5c4db959a06812bd6ec8ff8ebb5f3b58e55b30fde78c2b0c4dfa3d018876849156c263
-  data.tar.gz: 2fd22fce69151ea24d0836d0da19af7c36762c83e73ec7282e59b8298ee55c27e8196b706f9c64ea4152e331d123d0b8c6147d3625b452c6fbf905119bdebbe3
+  metadata.gz: 45ad03a05a496eccb4327ae9ba775174cbf520a25c0087119fcde8de95ec7e77be79b0ab2dd65fcb99ad588af18d8b1992f126551e04daf58bca28d5a0f5c466
+  data.tar.gz: 6e9ecd4f00f97adf917e0ad354cb3cadba716b44dd75fd27d95c9437f564ea70af73312841bb89291b0a4beb5310d87538664b5930e2f572566013ac67b04e25

data/.travis.yml

@@ -1,14 +1,30 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
+
 gemfile:
-  - Gemfile32
-  - Gemfile
+  - Gemfile.rails32
+  - Gemfile.rails40
   - Gemfile.rails41
+  - Gemfile.rails42
+
+env:
+  - DB=mysql2
+  - DB=postgresql
+
 services:
   - memcache
   - mysql
+
+sudo: false
+
 before_script:
   - mysql -e 'create database identity_cache_test'
+  - psql -c 'create database identity_cache_test;' -U postgres
+
+matrix:
+  allow_failures:
+    - gemfile: Gemfile.rails42

data/CHANGELOG.md

@@ -0,0 +1,67 @@
+# IdentityCache changelog
+
+#### Unreleased
+
+- PostgreSQL support
+- Rails 4.2 compatibility
+- Fix: Don't connect to database when calling `IdentityCache.should_use_cache?`
+- Fix: Fix invalid parent cache invalidation if object is embedded in different parents
+
+#### 0.2.2
+
+- Change: memcached is no longer a runtime dependency
+- Use cache for read-only models.
+
+#### 0.2.1
+
+- Add a fallback backend using local memory.
+
+#### 0.2.0
+
+- Memcache CAS support
+
+#### 0.1.0
+
+- Backwards incompatible change: Stop expiring cache on after_touch callback.
+- Change: fetch_multi accepts an array of keys as argument
+- Change: :embed option value from false to :ids for cache_has_many for clarity
+- Fix: Consistently use ActiveRecord / Arel APIs to build SQL queries
+- Fix: `SystemStackError` when fetching more records than the max stack size
+- Fix: Bug in `fetch_multi` in a transaction where results weren't compacted.
+- Fix: Avoid unused preload on fetch_multi with :includes option for cache miss
+- Fix: reload will invalidate the local instance cache
+
+#### 0.0.7
+
+- Add support for non-integer primary keys
+- Fix: Not implemented error for cache_has_one with embed: false
+- Fix: cache key to change when adding a cache_has_many association with :embed => false
+- Fix: Compatibility rails 4.1 for `quote_value`, which needs default column.
+
+#### 0.0.6
+
+- Fix: bug where previously nil-cached attribute caches weren't expired on record creation
+- Fix: cache key to not change when adding a non-embedded association.
+- Perf: Rails 4 Only create `CollectionProxy` when using it
+
+#### 0.0.5
+
+
+#### 0.0.4
+
+- Fix: only marshal attributes, embedded associations and normalized association IDs
+- Add cache version number to cache keys
+- Add test case to ensure version number is updated when the marshalled format changes
+
+#### 0.0.3
+
+- Fix: memoization for multi hits actually work
+- Fix: quotes `SELECT` projection elements on cache misses
+- Add CPU performance benchmark
+- Fix: table names are not hardcoded anymore
+- Logger now differentiates memoized vs non memoized hits
+
+#### 0.0.2
+
+- Fix: Existent embedded entries will no longer raise when `ActiveModel::MissingAttributeError` when accessing a newly created attribute.
+- Fix: Do not marshal raw ActiveRecord associations

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Caching is hard. Chances are that if some feature was left out, it was left out on purpose because it didn't make sense to cache in that way. This is used in production at Shopify so we are very opinionated about the types of features we're going to add. Please start the discussion early, before even adding code, so that we can talk about the feature you are proposing and decide if it makes sense in IdentityCache.
+
+Types of contributions we welcome:
+
+- Bug fixes
+- Performance improvements
+- Documentation and/or clearer interfaces
+
+
+### How To Contribute
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Please keep the following in mind:
+
+- Add a short entry to the "unreleased" section in [CHANGELOG.md](./CHANGELOG.md) describing your changes.
+- Do not change `IdentityCache::VERSION`; this is done as part of the release process.
+
+
+## Contributors
+
+- Camilo Lopez (@camilo)
+- Tom Burns (@boourns)
+- Harry Brundage (@hornairs)
+- Dylan Smith (@dylanahsmith)
+- Tobias Lütke (@tobi)
+- John Duff (@jduff)
+- Francis Bogsanyi (@fbogsany)
+- Arthur Neves (@arthurnn)

data/Gemfile

@@ -1,7 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in identity_cache.gemspec
 gemspec
-
-gem 'activerecord', '~> 4.0.4'
-gem 'activesupport', '~> 4.0.4'

data/{Gemfile32 → Gemfile.rails32}

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in identity_cache.gemspec
 gemspec
 
 gem 'activerecord', '~> 3.2.16'

data/Gemfile.rails40

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activerecord', '~> 4.0.4'
+gem 'activesupport', '~> 4.0.4'

data/Gemfile.rails41

@@ -1,7 +1,5 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in identity_cache.gemspec
 gemspec
 
 gem 'activerecord', '~> 4.1.0'
-gem 'activesupport', '~> 4.1.0'
+gem 'activesupport', '~> 4.1.0'

data/Gemfile.rails42

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activerecord', '~> 4.2.0.rc1'
+gem 'activesupport', '~> 4.2.0.rc1'

data/README.md

@@ -157,25 +157,25 @@ This will read the attribute from the cache or query the database for the attrib
 
 #### cache_index
 
-Options:  
+Options:
 _[:unique]_ Allows you to say that an index is unique (only one object stored at the index) or not unique, which allows there to be multiple objects matching the index key. The default value is false.
 
-Example:  
+Example:
 `cache_index :handle`
 
 #### cache_has_many
 
-Options:  
+Options:
 _[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. When :ids, only the id of the associated records will be included with the parent when caching.
 
 _[:inverse_name]_ Specifies the name of parent object used by the association. This is useful for polymorphic associations when the association is often named something different between the parent and child objects.
 
-Example:  
+Example:
 `cache_has_many :metafields, :inverse_name => :owner, :embed => true`
 
 #### cache_has_one
 
-Options:  
+Options:
 _[:embed]_ When true, specifies that the association should be included with the parent when caching. This means the associated objects will be loaded already when the parent is loaded from the cache and will not need to be fetched on their own. No other values are currently implemented.
 
 _[:inverse_name]_ Specifies the name of parent object used by the association. This is useful for polymorphic associations when the association is often named something different between the parent and child objects.
@@ -185,10 +185,10 @@ Example:
 
 #### cache_attribute
 
-Options:  
+Options:
 _[:by]_ Specifies what key(s) you want the attribute cached by. Defaults to :id.
 
-Example:  
+Example:
 `cache_attribute :target, :by => [:shop_id, :path]`
 
 ## Memoized Cache Proxy
@@ -217,35 +217,8 @@ Since everything is being marshalled and unmarshalled from Memcached changing Ru
 
 IdentityCache is also very much _opt-in_ by deliberate design. This means IdentityCache does not mess with the way normal Rails associations work, and including it in a model won't change any clients of that model until you switch them to use `fetch` instead of `find`. This is because there is no way IdentityCache is ever going to be 100% consistent. Processes die, execeptions happen, and network blips occur, which means there is a chance that some database transaction might commit but the corresponding memcached DEL operation does not make it. This means that you need to think carefully about when you use `fetch` and when you use `find`. For example, at Shopify, we never use any `fetch`ers on the path which moves money around, because IdentityCache could simply be wrong, and we want to charge people the right amount of money. We do however use the fetchers on performance critical paths where absolute correctness isn't the most important thing, and this is what IdentityCache is intended for.
 
-## Note
-
-JRuby will not work with this current version, as we are using the memcached gem internally to interface with memcache.
-
-## Contributing
-
-Caching is hard. Chances are that if some feature was left out, it was left out on purpose because it didn't make sense to cache in that way. This is used in production at Shopify so we are very opinionated about the types of features we're going to add. Please start the discussion early, before even adding code, so that we can talk about the feature you are proposing and decide if it makes sense in IdentityCache.
-
-Types of contributions we are looking for:
-
-- Bug fixes
-- Performance improvements
-- Documentation and/or clearer interfaces
-
-### How To Contribute
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Contributors
+## Notes
 
-Camilo Lopez (@camilo)  
-Tom Burns (@boourns)  
-Harry Brundage (@hornairs)  
-Dylan Smith (@dylanahsmith)  
-Tobias Lütke (@tobi)  
-John Duff (@jduff)  
-Francis Bogsanyi (@fbogsany)
-Arthur Neves (@arthurnn)
+- JRuby will not work with this current version, as we are using the memcached gem internally to interface with memcache.
+- See CHANGELOG.md for a list of changes to the library over time.
+- The librray is MIT licensed and we welcome contributions. See CONTRIBUTING.md for more information.

data/identity_cache.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |gem|
   else
     gem.add_development_dependency('cityhash', '0.6.0')
     gem.add_development_dependency('mysql2')
+    gem.add_development_dependency('pg')
     gem.add_development_dependency('stackprof') if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.1.0")
   end
 end

data/lib/identity_cache.rb

@@ -69,12 +69,13 @@ module IdentityCache
       @logger || Rails.logger
     end
 
-    def should_update_cache? # :nodoc:
-      !readonly && should_use_cache?
+    def should_fill_cache? # :nodoc:
+      !readonly
     end
 
     def should_use_cache? # :nodoc:
-      ActiveRecord::Base.connection.open_transactions == 0
+      pool = ActiveRecord::Base.connection_pool
+      !pool.active_connection? || pool.connection.open_transactions == 0
     end
 
     # Cache retrieval and miss resolver primitive; given a key it will try to

data/lib/identity_cache/cache_fetcher.rb

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

data/lib/identity_cache/configuration_dsl.rb

@@ -273,17 +273,20 @@ module IdentityCache
         child_association = child_class.reflect_on_association(options[:inverse_name])
         raise InverseAssociationError unless child_association
         foreign_key = child_association.association_foreign_key
-        parent_class ||= self.name
 
         child_class.send(:include, ArTransactionChanges) unless child_class.include?(ArTransactionChanges)
         child_class.send(:include, ParentModelExpiration) unless child_class.include?(ParentModelExpiration)
 
+        after_action_name = "expire_parent_cache_#{self.name.underscore}"
+
         child_class.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
-          after_commit :expire_parent_cache
-          after_touch  :expire_parent_cache
+        
+          after_commit :#{after_action_name}
+          after_touch  :#{after_action_name}
+          add_parent_expiration_entry :#{after_action_name}
 
-          def expire_parent_cache
-            expire_parent_cache_on_changes(:#{options[:inverse_name]}, '#{foreign_key}', #{parent_class}, #{options[:only_on_foreign_key_change]})
+          def #{after_action_name}
+            expire_parent_cache_on_changes(:#{options[:inverse_name]}, '#{foreign_key}', #{self.name}, #{options[:only_on_foreign_key_change]})
           end
         CODE
       end

data/lib/identity_cache/fallback_fetcher.rb

@@ -7,15 +7,15 @@ module IdentityCache
     end
 
     def write(key, value)
-      @cache_backend.write(key, value) if IdentityCache.should_update_cache?
+      @cache_backend.write(key, value) if IdentityCache.should_fill_cache?
     end
 
     def delete(key)
-      @cache_backend.delete(key) if IdentityCache.should_update_cache?
+      @cache_backend.delete(key)
     end
 
     def clear
-      @cache_backend.clear if IdentityCache.should_update_cache?
+      @cache_backend.clear
     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) if IdentityCache.should_update_cache?
+          @cache_backend.write(key, replacement_result) if IdentityCache.should_fill_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) if IdentityCache.should_update_cache?
+        @cache_backend.write(key, result) if IdentityCache.should_fill_cache?
       end
       result
     end

data/lib/identity_cache/parent_model_expiration.rb

@@ -1,12 +1,33 @@
 module IdentityCache
   module ParentModelExpiration # :nodoc:
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.class_attribute :parent_expiration_entries
+      base.parent_expiration_entries = Set.new
+    end
+  
+    module ClassMethods
+      private
+
+      def add_parent_expiration_entry(after_action_name)
+        parent_expiration_entries << after_action_name
+      end
+    end
+    
+    def expire_parent_caches
+      self.class.parent_expiration_entries.each do |parent_expiration_entry|
+        send(parent_expiration_entry)
+      end
+    end
+
     def expire_parent_cache_on_changes(parent_name, foreign_key, parent_class, only_on_foreign_key_change)
       new_parent = send(parent_name)
 
       if new_parent && new_parent.respond_to?(:expire_primary_index, true)
         if should_expire_identity_cache_parent?(foreign_key, only_on_foreign_key_change)
           new_parent.send(:expire_primary_index)
-          new_parent.send(:expire_parent_cache) if new_parent.respond_to?(:expire_parent_cache, true)
+          new_parent.send(:expire_parent_caches) if new_parent.respond_to?(:expire_parent_caches, true)
         end
       end
 
@@ -14,7 +35,7 @@ module IdentityCache
         begin
           old_parent = parent_class.find(transaction_changed_attributes[foreign_key])
           old_parent.send(:expire_primary_index) if old_parent.respond_to?(:expire_primary_index, true)
-          old_parent.send(:expire_parent_cache)  if old_parent.respond_to?(:expire_parent_cache, true)
+          old_parent.send(:expire_parent_caches)  if old_parent.respond_to?(:expire_parent_caches, true)
         rescue ActiveRecord::RecordNotFound => e
           # suppress errors finding the old parent if its been destroyed since it will have expired itself in that case
         end

data/lib/identity_cache/query_api.rb

@@ -204,7 +204,7 @@ module IdentityCache
 
       def find_batch(ids)
         @id_column ||= columns.detect {|c| c.name == primary_key}
-        ids = ids.map{ |id| @id_column.type_cast(id) }
+        ids = ids.map{ |id| connection.type_cast(id, @id_column) }
         records = where(primary_key => ids).includes(cache_fetch_includes).to_a
         records_by_id = records.index_by(&:id)
         ids.map{ |id| records_by_id[id] }

data/lib/identity_cache/version.rb

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

data/test/attribute_cache_test.rb

@@ -10,7 +10,6 @@ class AttributeCacheTest < IdentityCache::TestCase
     @parent = Item.create!(:title => 'bob')
     @record = @parent.associated_records.create!(:name => 'foo')
     @name_attribute_key = "#{NAMESPACE}attribute:AssociatedRecord:name:id:#{cache_hash(@record.id.to_s)}"
-    @blob_key = "#{NAMESPACE}blob:AssociatedRecord:#{cache_hash("id:integer,item_id:integer,name:string")}:1"
     IdentityCache.cache.clear
   end
 
@@ -21,9 +20,7 @@ class AttributeCacheTest < IdentityCache::TestCase
 
   def test_attribute_values_are_fetched_and_returned_on_cache_misses
     fetch = Spy.on(IdentityCache.cache, :fetch).and_call_through
-    Item.connection.expects(:exec_query)
-      .with('SELECT  `associated_records`.`name` FROM `associated_records`  WHERE `associated_records`.`id` = 1 LIMIT 1', anything)
-      .returns(ActiveRecord::Result.new(['name'], [['foo']]))
+    expects_fetch_associated_record_name_by_id(1, returns: 'foo')
 
     assert_equal 'foo', AssociatedRecord.fetch_name_by_id(1)
     assert fetch.has_been_called_with?(@name_attribute_key)
@@ -34,9 +31,7 @@ class AttributeCacheTest < IdentityCache::TestCase
     fetch = Spy.on(IdentityCache.cache, :fetch).and_call_through
 
     # Grab the value of the attribute from the DB
-    Item.connection.expects(:exec_query)
-      .with('SELECT  `associated_records`.`name` FROM `associated_records`  WHERE `associated_records`.`id` = 1 LIMIT 1', anything)
-      .returns(ActiveRecord::Result.new(['name'], [['foo']]))
+    expects_fetch_associated_record_name_by_id(1, returns: 'foo')
 
     # And write it back to the cache
     add = Spy.on(fetcher, :add).and_call_through
@@ -52,9 +47,7 @@ class AttributeCacheTest < IdentityCache::TestCase
     fetch = Spy.on(IdentityCache.cache, :fetch).and_call_through
 
     # Grab the value of the attribute from the DB
-    Item.connection.expects(:exec_query)
-      .with('SELECT  `associated_records`.`name` FROM `associated_records`  WHERE `associated_records`.`id` = 1 LIMIT 1', anything)
-      .returns(ActiveRecord::Result.new(['name'], []))
+    expects_fetch_associated_record_name_by_id(1, returns: nil)
 
     # And write it back to the cache
     add = Spy.on(fetcher, :add).and_call_through
@@ -66,27 +59,27 @@ class AttributeCacheTest < IdentityCache::TestCase
 
   def test_cached_attribute_values_are_expired_from_the_cache_when_an_existing_record_is_saved
     IdentityCache.cache.expects(:delete).with(@name_attribute_key)
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    IdentityCache.cache.expects(:delete).with(blob_key_for_associated_record(1))
     @record.save!
   end
 
   def test_cached_attribute_values_are_expired_from_the_cache_when_an_existing_record_with_changed_attributes_is_saved
     IdentityCache.cache.expects(:delete).with(@name_attribute_key)
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    IdentityCache.cache.expects(:delete).with(blob_key_for_associated_record(1))
     @record.name = 'bar'
     @record.save!
   end
 
   def test_cached_attribute_values_are_expired_from_the_cache_when_an_existing_record_is_destroyed
     IdentityCache.cache.expects(:delete).with(@name_attribute_key)
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    IdentityCache.cache.expects(:delete).with(blob_key_for_associated_record(1))
     @record.destroy
   end
 
   def test_cached_attribute_values_are_expired_from_the_cache_when_a_new_record_is_saved
     new_id = 2.to_s
     # primary index delete
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}blob:AssociatedRecord:#{cache_hash("id:integer,item_id:integer,name:string")}:#{new_id}")
+    IdentityCache.cache.expects(:delete).with(blob_key_for_associated_record(new_id))
     # attribute cache delete
     IdentityCache.cache.expects(:delete).with("#{NAMESPACE}attribute:AssociatedRecord:name:id:#{cache_hash(new_id)}")
     @parent.associated_records.create(:name => 'bar')
@@ -95,9 +88,7 @@ class AttributeCacheTest < IdentityCache::TestCase
   def test_fetching_by_attribute_delegates_to_block_if_transactions_are_open
     IdentityCache.cache.expects(:read).with(@name_attribute_key).never
 
-    Item.connection.expects(:exec_query)
-      .with('SELECT  `associated_records`.`name` FROM `associated_records`  WHERE `associated_records`.`id` = 1 LIMIT 1', anything)
-      .returns(ActiveRecord::Result.new(['name'], [['foo']]))
+    expects_fetch_associated_record_name_by_id(1, returns: 'foo')
 
     @record.transaction do
       assert_equal 'foo', AssociatedRecord.fetch_name_by_id(1)
@@ -109,4 +100,22 @@ class AttributeCacheTest < IdentityCache::TestCase
     AssociatedRecord.create(:name => "Jim")
     assert_equal "Jim", AssociatedRecord.fetch_name_by_id(2)
   end
+
+  private
+
+  def blob_key_for_associated_record(id)
+    cache_hash = cache_hash('id:integer,item_id:integer,item_two_id:integer,name:string')
+    "#{NAMESPACE}blob:AssociatedRecord:#{cache_hash}:#{id}"
+  end
+
+  def quoted_table_column(model, column_name)
+    "#{model.quoted_table_name}.#{model.connection.quote_column_name(column_name)}"
+  end
+
+  def expects_fetch_associated_record_name_by_id(id, options={})
+    result = options[:returns] ? [options[:returns]] : []
+    Item.connection.expects(:exec_query)
+      .with(AssociatedRecord.unscoped.select(quoted_table_column(AssociatedRecord, :name)).where(id: id).limit(1).to_sql, any_parameters)
+      .returns(ActiveRecord::Result.new(['name'], [result]))
+  end
 end

data/test/cache_invalidation_test.rb

@@ -3,7 +3,6 @@ require "test_helper"
 class CacheInvalidationTest < IdentityCache::TestCase
   def setup
     super
-    Item.cache_has_many :associated_records, :embed => :ids
 
     @record = Item.new(:title => 'foo')
     @record.associated_records << AssociatedRecord.new(:name => 'bar')
@@ -14,6 +13,8 @@ class CacheInvalidationTest < IdentityCache::TestCase
   end
 
   def test_reload_invalidate_cached_ids
+    Item.cache_has_many :associated_records, :embed => :ids
+
     variable_name = "@#{@record.class.send(:embedded_associations)[:associated_records][:ids_variable_name]}"
 
     @record.fetch_associated_record_ids
@@ -27,6 +28,8 @@ class CacheInvalidationTest < IdentityCache::TestCase
   end
 
   def test_reload_invalidate_cached_objects
+    Item.cache_has_many :associated_records, :embed => :ids
+
     variable_name = "@#{@record.class.send(:embedded_associations)[:associated_records][:records_variable_name]}"
 
     @record.fetch_associated_records
@@ -40,6 +43,8 @@ class CacheInvalidationTest < IdentityCache::TestCase
   end
 
   def test_after_a_reload_the_cache_perform_as_expected
+    Item.cache_has_many :associated_records, :embed => :ids
+
     assert_equal [@baz, @bar], @record.associated_records
     assert_equal [@baz, @bar], @record.fetch_associated_records
 
@@ -49,4 +54,70 @@ class CacheInvalidationTest < IdentityCache::TestCase
     assert_equal [@bar], @record.associated_records
     assert_equal [@bar], @record.fetch_associated_records
   end
+
+  def test_cache_invalidation_expire_properly_if_child_is_embed_in_multiple_parents
+    Item.cache_has_many :associated_records, :embed => true
+    ItemTwo.cache_has_many :associated_records, :embed => true
+
+    baz = AssociatedRecord.new(:name => 'baz')
+
+    record1 = Item.new(:title => 'foo')
+    record1.associated_records << baz
+    record1.save!
+
+    record2 = ItemTwo.new(:title => 'bar')
+    record2.associated_records << baz
+    record2.save!
+
+    record1.class.fetch(record1.id)
+    record2.class.fetch(record2.id)
+
+    expected_keys = [
+      record1.primary_cache_index_key,
+      record2.primary_cache_index_key,
+    ]
+
+    expected_keys.each do |expected_key|
+      assert IdentityCache.cache.fetch(expected_key) { nil }
+    end
+
+    baz.save!
+
+    expected_keys.each do |expected_key|
+      refute IdentityCache.cache.fetch(expected_key) { nil }
+    end
+  end
+
+  def test_cache_invalidation_expire_properly_if_child_is_embed_in_multiple_parents_with_ids
+    Item.cache_has_many :associated_records, :embed => :ids
+    ItemTwo.cache_has_many :associated_records, :embed => :ids
+
+    baz = AssociatedRecord.new(:name => 'baz')
+
+    record1 = Item.new(:title => 'foo')
+    record1.save
+
+    record2 = ItemTwo.new(:title => 'bar')
+    record2.save
+
+    record1.class.fetch(record1.id)
+    record2.class.fetch(record2.id)
+
+    expected_keys = [
+      record1.primary_cache_index_key,
+      record2.primary_cache_index_key,
+    ]
+
+    expected_keys.each do |expected_key|
+      assert IdentityCache.cache.fetch(expected_key) { nil }
+    end
+
+    baz.item = record1
+    baz.item_two = record2
+    baz.save!
+
+    expected_keys.each do |expected_key|
+      refute IdentityCache.cache.fetch(expected_key) { nil }
+    end
+  end
 end

data/test/denormalized_has_many_test.rb

@@ -67,7 +67,7 @@ class DenormalizedHasManyTest < IdentityCache::TestCase
   def test_cached_associations_after_commit_hook_will_not_fail_on_undefined_parent_association
     ar = AssociatedRecord.new
     ar.save
-    assert_nothing_raised { ar.expire_parent_cache }
+    assert_nothing_raised { ar.expire_parent_caches }
   end
 
   def test_cache_without_guessable_inverse_name_raises

data/test/denormalized_has_one_test.rb

@@ -96,7 +96,7 @@ class DenormalizedHasOneTest < IdentityCache::TestCase
   def test_cached_associations_after_commit_hook_will_not_fail_on_undefined_parent_association
     ar = AssociatedRecord.new
     ar.save
-    assert_nothing_raised { ar.expire_parent_cache }
+    assert_nothing_raised { ar.expire_parent_caches }
   end
 
   def test_cache_without_guessable_inverse_name_raises

data/test/fetch_test.rb

@@ -19,7 +19,7 @@ class FetchTest < IdentityCache::TestCase
 
   def test_fetch_with_garbage_input
     Item.connection.expects(:exec_query)
-      .with('SELECT  `items`.* FROM `items`  WHERE `items`.`id` = 0 LIMIT 1', anything)
+      .with(Item.where(id: 0).limit(1).to_sql, any_parameters)
       .returns(ActiveRecord::Result.new([], []))
 
     assert_equal nil, Item.fetch_by_id('garbage')
@@ -188,4 +188,15 @@ class FetchTest < IdentityCache::TestCase
     fetcher.expects(:add).never
     assert_raises(ActiveRecord::RecordNotFound) { Item.fetch(nil) }
   end
+
+  def test_fetch_cache_hit_does_not_checkout_database_connection
+    @record.save!
+    record = Item.fetch(@record.id)
+
+    ActiveRecord::Base.clear_active_connections!
+
+    assert_equal record, Item.fetch(@record.id)
+
+    assert_equal false, ActiveRecord::Base.connection_handler.active_connections?
+  end
 end

data/test/helpers/active_record_objects.rb

@@ -27,6 +27,7 @@ module ActiveRecordObjects
     Object.send :const_set, 'AssociatedRecord', Class.new(base) {
       include IdentityCache
       belongs_to :item, inverse_of: :associated_records
+      belongs_to :item_two, inverse_of: :associated_records
       has_many :deeply_associated_records
       default_scope { order('id DESC') }
     }
@@ -57,6 +58,12 @@ module ActiveRecordObjects
       has_one :associated, :class_name => 'AssociatedRecord'
     }
 
+    Object.send :const_set, 'ItemTwo', Class.new(base) {
+      include IdentityCache
+      has_many :associated_records, inverse_of: :item_two, foreign_key: :item_two_id
+      self.table_name = 'items2'
+    }
+
     Object.send :const_set, 'KeyedRecord', Class.new(base) {
       include IdentityCache
       self.primary_key = "hashed_key"
@@ -72,6 +79,7 @@ module ActiveRecordObjects
     Object.send :remove_const, 'AssociatedRecord'
     Object.send :remove_const, 'NotCachedRecord'
     Object.send :remove_const, 'Item'
+    Object.send :remove_const, 'ItemTwo'
     Object.send :remove_const, 'KeyedRecord'
   end
 end

data/test/helpers/database_connection.rb

@@ -1,12 +1,15 @@
 module DatabaseConnection
   def self.setup
-    DATABASE_CONFIG['port'] ||= $mysql_port
-    ActiveRecord::Base.establish_connection(DATABASE_CONFIG)
-    ActiveRecord::Base.connection
-  rescue
-    ActiveRecord::Base.establish_connection(DATABASE_CONFIG.merge('database' => nil))
-    ActiveRecord::Base.connection.create_database(DATABASE_CONFIG['database'])
-    ActiveRecord::Base.establish_connection(DATABASE_CONFIG)
+    db_config = ENV['DATABASE_URL'] || DEFAULT_CONFIG[ENV.fetch('DB', 'mysql2')]
+    begin
+      ActiveRecord::Base.establish_connection(db_config)
+      ActiveRecord::Base.connection
+    rescue
+      raise unless db_config.is_a?(Hash)
+      ActiveRecord::Base.establish_connection(db_config.merge('database' => nil))
+      ActiveRecord::Base.connection.create_database(db_config['database'])
+      ActiveRecord::Base.establish_connection(db_config)
+    end
   end
 
   def self.drop_tables
@@ -30,7 +33,7 @@ module DatabaseConnection
   TABLES = {
     :polymorphic_records           => [[:string, :owner_type], [:integer, :owner_id], [:timestamps]],
     :deeply_associated_records     => [[:string, :name], [:integer, :associated_record_id], [:timestamps]],
-    :associated_records            => [[:string, :name], [:integer, :item_id]],
+    :associated_records            => [[:string, :name], [:integer, :item_id], [:integer, :item_two_id]],
     :normalized_associated_records => [[:string, :name], [:integer, :item_id], [:timestamps]],
     :not_cached_records            => [[:string, :name], [:integer, :item_id], [:timestamps]],
     :items                         => [[:integer, :item_id], [:string, :title], [:timestamps]],
@@ -38,10 +41,18 @@ module DatabaseConnection
     :keyed_records                 => [[:string, :value], :primary_key => "hashed_key"],
   }
 
-  DATABASE_CONFIG = {
-    'adapter'  => 'mysql2',
-    'database' => 'identity_cache_test',
-    'host'     => '127.0.0.1',
-    'username' => 'root'
+  DEFAULT_CONFIG = {
+    'mysql2' => {
+      'adapter'  => 'mysql2',
+      'database' => 'identity_cache_test',
+      'host'     => '127.0.0.1',
+      'username' => 'root'
+    },
+    'postgresql' => {
+      'adapter'  => 'postgresql',
+      'database' => 'identity_cache_test',
+      'host'     => '127.0.0.1',
+      'username' => 'postgres'
+    }
   }
 end

data/test/helpers/update_serialization_format.rb

@@ -9,9 +9,6 @@ require_relative 'database_connection'
 require_relative 'active_record_objects'
 require 'identity_cache'
 
-$memcached_port = 11211
-$mysql_port = 3306
-
 include SerializationFormat
 include ActiveRecordObjects
 
@@ -19,7 +16,7 @@ DatabaseConnection.setup
 DatabaseConnection.drop_tables
 DatabaseConnection.create_tables
 IdentityCache.logger = Logger.new(nil)
-IdentityCache.cache_backend = ActiveSupport::Cache::MemcachedStore.new("localhost:#{$memcached_port}", :support_cas => true)
+IdentityCache.cache_backend = ActiveSupport::Cache::MemcachedStore.new("localhost:11211", :support_cas => true)
 setup_models
 File.open(serialized_record_file, 'w') {|file| serialize(serialized_record, file) }
 puts "Serialized record to #{serialized_record_file}"

data/test/identity_cache_test.rb

@@ -14,4 +14,13 @@ class IdentityCacheTest < IdentityCache::TestCase
     end
   end
 
+  def test_should_use_cache_outside_transaction
+    assert_equal true, IdentityCache.should_use_cache?
+  end
+
+  def test_should_use_cache_in_transaction
+    ActiveRecord::Base.transaction do
+      assert_equal false, IdentityCache.should_use_cache?
+    end
+  end
 end

data/test/index_cache_test.rb

@@ -15,7 +15,7 @@ class IndexCacheTest < IdentityCache::TestCase
     Item.cache_index :title, :id
 
     Item.connection.expects(:exec_query)
-      .with(regexp_matches(/ WHERE `items`\.`title` = 'garbage' AND `items`\.`id` = 0\z/i), anything)
+      .with(Item.select(:id).where(title: 'garbage', id: 0).to_sql, any_parameters)
       .returns(ActiveRecord::Result.new([], []))
 
     assert_equal [], Item.fetch_by_title_and_id('garbage', 'garbage')
@@ -25,7 +25,7 @@ class IndexCacheTest < IdentityCache::TestCase
     Item.cache_index :title, :id, :unique => true
 
     Item.connection.expects(:exec_query)
-      .with(regexp_matches(/ LIMIT 1\Z/i), anything)
+      .with(regexp_matches(/ LIMIT 1\Z/i), any_parameters)
       .returns(ActiveRecord::Result.new([], []))
 
     assert_equal nil, Item.fetch_by_title_and_id('title', '2')
@@ -87,7 +87,7 @@ class IndexCacheTest < IdentityCache::TestCase
   def test_non_unique_index_fetches_multiple_records
     Item.cache_index :title
     @record.save!
-    record2 = Item.create(:id => 2, :title => 'bob')
+    record2 = Item.create(:title => 'bob') { |item| item.id = 2 }
 
     assert_equal [@record, record2], Item.fetch_by_title('bob')
     assert_equal [1, 2], backend.read(@cache_key)

data/test/readonly_test.rb

@@ -3,7 +3,6 @@ require "test_helper"
 class ReadonlyTest < IdentityCache::TestCase
   def setup
     super
-    IdentityCache.readonly = true
     @key, @value = 'foo', 'bar'
     @record = Item.new
     @record.id = 1
@@ -11,6 +10,8 @@ class ReadonlyTest < IdentityCache::TestCase
     @bob = Item.create!(:title => 'bob')
     @joe = Item.create!(:title => 'joe')
     @fred = Item.create!(:title => 'fred')
+    IdentityCache.cache.clear
+    IdentityCache.readonly = true
   end
 
   def teardown
@@ -25,20 +26,16 @@ class ReadonlyTest < IdentityCache::TestCase
     assert_nil backend.read(@key)
   end
 
-  def test_delete_should_not_update_cache
+  def test_delete_should_update_cache
     backend.write(@key, @value)
-    assert_memcache_operations(0) do
-      fetcher.delete(@key)
-    end
-    assert_equal @value, backend.read(@key)
+    fetcher.delete(@key)
+    assert_equal deleted_value, backend.read(@key)
   end
 
-  def test_clear_should_not_update_cache
+  def test_clear_should_update_cache
     backend.write(@key, @value)
-    assert_memcache_operations(0) do
-      fetcher.clear
-    end
-    assert_equal @value, backend.read(@key)
+    fetcher.clear
+    assert_equal nil, backend.read(@key)
   end
 
   def test_fetch_should_not_update_cache
@@ -76,6 +73,10 @@ class ReadonlyTest < IdentityCache::TestCase
     yield
     assert cas_multi.has_been_called?
   end
+
+  def deleted_value
+    IdentityCache::DELETED
+  end
 end
 
 class FallbackReadonlyTest < ReadonlyTest
@@ -101,4 +102,8 @@ class FallbackReadonlyTest < ReadonlyTest
     assert read_multi.has_been_called?
     refute write.has_been_called?
   end
+
+  def deleted_value
+    nil
+  end
 end

data/test/save_test.rb

@@ -16,21 +16,21 @@ class SaveTest < IdentityCache::TestCase
     @record = Item.new
     @record.title = 'bob'
 
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('2/bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}blob:Item:#{cache_hash("created_at:datetime,id:integer,item_id:integer,title:string,updated_at:datetime")}:2").once
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('2/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete("#{NAMESPACE}blob:Item:#{cache_hash("created_at:datetime,id:integer,item_id:integer,title:string,updated_at:datetime")}:2").once
     @record.save
   end
 
   def test_update
     # Regular flow, write index id, write index id/tile, delete data blob since Record has changed
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/fred')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('fred')}")
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/fred')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('fred')}")
+    expect_cache_delete(@blob_key)
 
     # Delete index id, delete index id/title
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
 
     @record.title = 'fred'
     @record.save
@@ -38,18 +38,18 @@ class SaveTest < IdentityCache::TestCase
 
   def test_destroy
     # Regular flow: delete data blob, delete index id, delete index id/tile
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete(@blob_key)
 
     @record.destroy
   end
 
   def test_destroy_with_changed_attributes
     # Make sure to delete the old cache index key, since the new title never ended up in an index
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete(@blob_key)
 
     @record.title = 'fred'
     @record.destroy
@@ -57,10 +57,26 @@ class SaveTest < IdentityCache::TestCase
 
   def test_touch_will_expire_the_caches
     # Regular flow: delete data blob, delete index id, delete index id/tile
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
-    IdentityCache.cache.expects(:delete).with(@blob_key)
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete(@blob_key)
 
     @record.touch
   end
+
+  def test_expire_cache_works_in_a_transaction
+    expect_cache_delete("#{NAMESPACE}index:Item:id/title:#{cache_hash('1/bob')}")
+    expect_cache_delete("#{NAMESPACE}index:Item:title:#{cache_hash('bob')}")
+    expect_cache_delete(@blob_key)
+
+    ActiveRecord::Base.transaction do
+      @record.send(:expire_cache)
+    end
+  end
+
+  private
+
+  def expect_cache_delete(key)
+    @backend.expects(:write).with(key, IdentityCache::DELETED, anything)
+  end
 end

data/test/test_helper.rb

@@ -10,9 +10,6 @@ require 'active_support/cache/memcached_store'
 
 require File.dirname(__FILE__) + '/../lib/identity_cache'
 
-$memcached_port = 11211
-$mysql_port = 3306
-
 DatabaseConnection.setup
 ActiveSupport::Cache::Store.instrument = true
 
@@ -29,15 +26,14 @@ end
 
 class IdentityCache::TestCase < MiniTest::Unit::TestCase
   include ActiveRecordObjects
-  attr_reader :backend, :fetcher
+  attr_reader :backend
 
   def setup
     DatabaseConnection.drop_tables
     DatabaseConnection.create_tables
 
     IdentityCache.logger = Logger.new(nil)
-    IdentityCache.cache_backend = @backend = ActiveSupport::Cache::MemcachedStore.new("localhost:#{$memcached_port}", :support_cas => true)
-    @fetcher = IdentityCache.cache.cache_fetcher
+    IdentityCache.cache_backend = @backend = ActiveSupport::Cache::MemcachedStore.new("localhost:11211", :support_cas => true)
 
     setup_models
   end
@@ -47,6 +43,12 @@ class IdentityCache::TestCase < MiniTest::Unit::TestCase
     teardown_models
   end
 
+  private
+
+  def fetcher
+    IdentityCache.cache.cache_fetcher
+  end
+
   def assert_nothing_raised
     yield
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Camilo Lopez
@@ -36,7 +36,7 @@ cert_chain:
   fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
   TConQSX2BnZdhIEYW+cKzEC/bLc=
   -----END CERTIFICATE-----
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ar_transaction_changes
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
 - !ruby/object:Gem::Dependency
   name: stackprof
   requirement: !ruby/object:Gem::Requirement
@@ -202,10 +216,13 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.rails32
+- Gemfile.rails40
 - Gemfile.rails41
-- Gemfile32
+- Gemfile.rails42
 - LICENSE
 - README.md
 - Rakefile

data/CHANGELOG

@@ -1,41 +0,0 @@
-Unreleased
-* Consistently use ActiveRecord / Arel APIs to build SQL queries
-	[related #148]
-
-* Stop expiring cache on after_touch callback. [backwards incompatible]
-* fetch_multi accepts an array of keys as argument
-* Fix: SystemStackError when fetching more records than the max stack size
-* Fix: Bug in fetch_multi in a transaction where results weren't compacted.
-* Fix: Avoid unused preload on fetch_multi with :includes option for cache miss
-* Change :embed option value from false to :ids for cache_has_many for clarity
-* Fix: reload will invalidate the local instance cache
-
-0.0.7
-* Fix: Not implemented error for cache_has_one with embed: false
-* Fix: cache key to change when adding a cache_has_many association with :embed => false
-* Add support for non-integer primary keys
-* Fix: Compatibility rails 4.1 for quote_value, which needs default column.
-
-0.0.6
-* Fix: bug where previously nil-cached attribute caches weren't expired on record creation
-* Fix: cache key to not change when adding a non-embedded association.
-* Perf: Rails 4 Only create CollectionProxy when using it
-
-0.0.5
-
-
-0.0.4
-* Fix: only marshal attributes, embedded associations and normalized association IDs
-* Add cache version number to cache keys
-* Add test case to ensure version number is updated when the marshalled format changes
-
-0.0.3
-* Fix: memoization for multi hits actually work
-* Fix: quotes SELECT projection elements on cache misses
-* Add CPU performance benchmark
-* Fix: table names are not hardcoded anymore
-* Logger now differentiates memoized vs non memoized hits
-
-0.0.2
-* Fix: Existent embedded entries will no longer raise when ActiveModel::MissingAttributeError when accessing a newly created attribute.
-* Fix: Do not marshal raw AcriveRecord associations