identity_cache 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmQyZjllMTVlOTNiMmUxMDkxMzJlNzYzYjY0ODZlMmQ4Y2E0YTNkNA==
-  data.tar.gz: !binary |-
-    OGQ2MDc5Zjk2NmY3MTcwMmIxNDkzYjczNTZjMmJhNjMwMWI1ZjJjYg==
+SHA1:
+  metadata.gz: 2692fa11451bb0243fcb3450d6f6c2550110afea
+  data.tar.gz: dbd4fa2555037a5ddd90e36f2aea9ae03fff6907
 SHA512:
-  metadata.gz: !binary |-
-    MmM4NmJmMTY2MDRkNDdkYzRjMDg3NTQ4OTRlMzgyOWJiYzY4Y2RjMDQxZDQ0
-    NDA2NzYwZGIyN2UzMjVkNGU1MTI1ZTViNDU4YThkNTAxNGYyY2UxMWU5Y2U4
-    MzhjN2JjMDkyMWVmYjhkMWRmMmIyMmVmZjI4NzJkYTExZGZiYmM=
-  data.tar.gz: !binary |-
-    Yjg4MTdkOGI0OTJmY2ZkMWEwMDY0NjViMDE2MjdiMDg4NTkzZTc0MmU1YjEy
-    NzI1Nzc0ZjQ0ODk1YWY0M2ExMDdjNWNjMjQ5OGY3Y2YyMTcyNzQ3MjA3OTY3
-    YWMxMTlkZTgxNjQ0OTgyYmY3YzY5OWYzY2QyY2NlZjZkNzUwYTQ=
+  metadata.gz: 61e4b2e382f4a3706a5851ab2d8268bac77941a318b1ef81ad4babc4439b45a3e6c361a123e8d0bfeec2e136f8b0b8815825d1163a5d2a4c28f92c2bb11024d1
+  data.tar.gz: 830d6ef767b8b62167bd7f016966d56f6c1d1bf99c501c75293d4731cd61f58683396f622a654190c39e91ab7fd5e6b6cdad5051ead943306ffff27ad86399c1

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+*.lock
 InstalledFiles
 _yardoc
 coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -2,12 +2,16 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - jruby-19mode
+  - 2.1.0
+  - jruby
+gemfile:
+  - Gemfile
+  - Gemfile.rails4
 services:
   - memcache
   - mysql
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: jruby
 before_script:
   - mysql -e 'create database identity_cache_test'

data/Gemfile

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

data/Gemfile.rails4

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in identity_cache.gemspec
+gemspec
+
+gem 'activerecord', '~> 4.0.1'
+gem 'activesupport', '~> 4.0.1'
+gem 'dalli'

data/README.md

@@ -244,4 +244,5 @@ Harry Brundage (@hornairs)
 Dylan Smith (@dylanahsmith)  
 Tobias Lütke (@tobi)  
 John Duff (@jduff)  
-Francis Bogsany (@fbogsany)
+Francis Bogsany (@fbogsany)  
+Arthur Neves (@arthurnn)

data/identity_cache.gemspec

@@ -15,10 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = IdentityCache::VERSION
 
-
-  gem.add_dependency('ar_transaction_changes', '0.0.1')
-  gem.add_dependency('activerecord', '~> 3.2.12')
-  gem.add_dependency('activesupport', '~> 3.2.12')
+  gem.add_dependency('ar_transaction_changes', '= 0.0.3')
+  gem.add_dependency('activerecord', '>= 3.2', '< 4.1')
 
   gem.add_development_dependency('memcache-client')
   gem.add_development_dependency('rake')
@@ -29,8 +27,6 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency 'activerecord-jdbcmysql-adapter'
     gem.add_development_dependency 'jdbc-mysql'
   else
-    gem.add_development_dependency('debugger')
-    gem.add_development_dependency('ruby-prof')
     gem.add_development_dependency('cityhash', '0.6.0')
     gem.add_development_dependency('mysql2')
   end

data/lib/identity_cache.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'active_support/core_ext/module/attribute_accessors'
 require 'ar_transaction_changes'
 
 require "identity_cache/version"
@@ -26,6 +27,9 @@ module IdentityCache
     attr_accessor :readonly
     attr_writer :logger
 
+    mattr_accessor :cache_namespace
+    self.cache_namespace = "IDC:#{CACHE_VERSION}:".freeze
+
     def included(base) #:nodoc:
       raise AlreadyIncludedError if base.respond_to? :cache_indexes
 
@@ -43,7 +47,11 @@ module IdentityCache
     # +cache_adaptor+ - A ActiveSupport::Cache::Store
     #
     def cache_backend=(cache_adaptor)
-      cache.cache_backend = cache_adaptor
+      if @cache
+        cache.cache_backend = cache_adaptor
+      else
+        @cache = MemoizedCacheProxy.new(cache_adaptor)
+      end
     end
 
     def cache

data/lib/identity_cache/belongs_to_caching.rb

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

data/lib/identity_cache/cache_key_generation.rb

@@ -19,8 +19,8 @@ module IdentityCache
     end
 
     def self.embedded_associations(klass)
-      if klass.respond_to?(:all_cached_associations_needing_population)
-        klass.all_cached_associations_needing_population
+      if klass.respond_to?(:all_embedded_associations)
+        klass.all_embedded_associations
       else
         {}
       end
@@ -45,7 +45,8 @@ module IdentityCache
       end
 
       def rails_cache_key_namespace
-        DEFAULT_NAMESPACE
+        ns = IdentityCache.cache_namespace
+        ns.is_a?(Proc) ? ns.call(self) : ns
       end
 
       private
@@ -59,17 +60,25 @@ module IdentityCache
     end
 
     def secondary_cache_index_key_for_current_values(fields) # :nodoc:
-      self.class.rails_cache_index_key_for_fields_and_values(fields, fields.collect {|field| self.send(field)})
+      self.class.rails_cache_index_key_for_fields_and_values(fields, current_values_for_fields(fields))
     end
 
     def secondary_cache_index_key_for_previous_values(fields) # :nodoc:
       self.class.rails_cache_index_key_for_fields_and_values(fields, old_values_for_fields(fields))
     end
 
+    def attribute_cache_key_for_attribute_and_current_values(attribute, fields) # :nodoc:
+      self.class.rails_cache_key_for_attribute_and_fields_and_values(attribute, fields, current_values_for_fields(fields))
+    end
+
     def attribute_cache_key_for_attribute_and_previous_values(attribute, fields) # :nodoc:
       self.class.rails_cache_key_for_attribute_and_fields_and_values(attribute, fields, old_values_for_fields(fields))
     end
 
+    def current_values_for_fields(fields) # :nodoc:
+      fields.collect {|field| self.send(field)}
+    end
+
     def old_values_for_fields(fields) # :nodoc:
       fields.map do |field|
         field_string = field.to_s

data/lib/identity_cache/configuration_dsl.rb

@@ -52,7 +52,7 @@ module IdentityCache
         arg_list = (0...fields.size).collect { |i| "arg#{i}" }.join(',')
 
         if options[:unique]
-          self.instance_eval(ruby = <<-CODE, __FILE__, __LINE__)
+          self.instance_eval(ruby = <<-CODE, __FILE__, __LINE__ + 1)
             def fetch_by_#{field_list}(#{arg_list})
               identity_cache_single_value_dynamic_fetcher(#{fields.inspect}, [#{arg_list}])
             end
@@ -63,7 +63,7 @@ module IdentityCache
             end
           CODE
         else
-          self.instance_eval(ruby = <<-CODE, __FILE__, __LINE__)
+          self.instance_eval(ruby = <<-CODE, __FILE__, __LINE__ + 1)
             def fetch_by_#{field_list}(#{arg_list})
               identity_cache_multiple_value_dynamic_fetcher(#{fields.inspect}, [#{arg_list}])
             end
@@ -170,7 +170,7 @@ module IdentityCache
         field_list = fields.join("_and_")
         arg_list = (0...fields.size).collect { |i| "arg#{i}" }.join(',')
 
-        self.instance_eval(ruby = <<-CODE, __FILE__, __LINE__)
+        self.instance_eval(<<-CODE, __FILE__, __LINE__ + 1)
           def fetch_#{attribute}_by_#{field_list}(#{arg_list})
             attribute_dynamic_fetcher(#{attribute.inspect}, #{fields.inspect}, [#{arg_list}])
           end
@@ -210,7 +210,7 @@ module IdentityCache
 
 
         unless instance_methods.include?(options[:cached_accessor_name].to_sym)
-          self.class_eval(ruby = <<-CODE, __FILE__, __LINE__)
+          self.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
             def #{options[:cached_accessor_name]}
               fetch_denormalized_cached_association('#{options[:records_variable_name]}', :#{association})
             end
@@ -235,7 +235,7 @@ module IdentityCache
         options[:population_method_name]  ||= "populate_#{association}_cache"
         options[:prepopulate_method_name] ||= "prepopulate_fetched_#{association}"
 
-        self.class_eval(ruby = <<-CODE, __FILE__, __LINE__)
+        self.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
           attr_reader :#{options[:ids_variable_name]}
 
           def #{options[:cached_ids_name]}
@@ -281,7 +281,7 @@ module IdentityCache
         child_class.send(:include, ArTransactionChanges) unless child_class.include?(ArTransactionChanges)
         child_class.send(:include, ParentModelExpiration) unless child_class.include?(ParentModelExpiration)
 
-        child_class.class_eval(ruby = <<-CODE, __FILE__, __LINE__)
+        child_class.class_eval(<<-CODE, __FILE__, __LINE__ + 1)
           after_commit :expire_parent_cache
           after_touch  :expire_parent_cache
 

data/lib/identity_cache/query_api.rb

@@ -9,7 +9,7 @@ module IdentityCache
       base.private_class_method :set_embedded_association
       base.private_class_method :get_embedded_association
       base.private_class_method :add_cached_associations_to_coder
-      base.instance_eval(ruby = <<-CODE, __FILE__, __LINE__)
+      base.instance_eval(<<-CODE, __FILE__, __LINE__ + 1)
         private :expire_cache, :was_new_record?, :fetch_denormalized_cached_association,
                 :populate_denormalized_cached_association
       CODE
@@ -26,8 +26,9 @@ module IdentityCache
       end
 
       # Default fetcher added to the model on inclusion, it behaves like
-      # ActiveRecord::Base.find_by_id
+      # ActiveRecord::Base.where(id: id).first
       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?
 
@@ -40,7 +41,7 @@ module IdentityCache
           end
 
         else
-          self.find_by_id(id)
+          self.where(id: id).first
         end
       end
 
@@ -95,8 +96,10 @@ module IdentityCache
               @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
               @association_cache = {}
               @aggregation_cache = {}
+              @_start_transaction_state = {}
               @readonly = @destroyed = @marked_for_destruction = false
               @new_record = false
+              @column_types = self.class.column_types if self.class.respond_to?(:column_types)
             end
           else
             record.init_with(coder)
@@ -115,7 +118,7 @@ module IdentityCache
           association = reflection.association_class.new(record, reflection)
           association.target = coder_or_array.map {|e| record_from_coder(e) }
           association.target.each {|e| association.set_inverse_instance(e) }
-          association.proxy
+          association
         else
           record_from_coder(coder_or_array)
         end
@@ -175,9 +178,9 @@ module IdentityCache
       end
 
       def resolve_cache_miss(id)
-        self.find_by_id(id, :include => cache_fetch_includes).tap do |object|
-          object.try(:populate_association_caches)
-        end
+        object = self.includes(cache_fetch_includes).where(id: id).try(:first)
+        object.try(:populate_association_caches)
+        object
       end
 
       def all_embedded_associations
@@ -223,7 +226,7 @@ module IdentityCache
       def find_batch(ids, options = {})
         @id_column ||= columns.detect {|c| c.name == "id"}
         ids = ids.map{ |id| @id_column.type_cast(id) }
-        records = where('id IN (?)', ids).includes(cache_fetch_includes(options[:includes])).all
+        records = where('id IN (?)', ids).includes(cache_fetch_includes(options[:includes])).to_a
         records_by_id = records.index_by(&:id)
         records = ids.map{ |id| records_by_id[id] }
         mismatching_ids = records.compact.map(&:id) - ids
@@ -334,7 +337,8 @@ module IdentityCache
       ivar_full_name = :"@#{ivar_name}"
       if IdentityCache.should_cache?
         populate_denormalized_cached_association(ivar_name, association_name)
-        IdentityCache.unmap_cached_nil_for(instance_variable_get(ivar_full_name))
+        assoc = IdentityCache.unmap_cached_nil_for(instance_variable_get(ivar_full_name))
+        assoc.is_a?(ActiveRecord::Associations::CollectionAssociation) ? assoc.reader : assoc
       else
         send(association_name.to_sym)
       end
@@ -388,7 +392,14 @@ module IdentityCache
 
     def expire_attribute_indexes # :nodoc:
       cache_attributes.try(:each) do |(attribute, fields)|
-        IdentityCache.cache.delete(attribute_cache_key_for_attribute_and_previous_values(attribute, fields)) unless was_new_record?
+        unless was_new_record?
+          old_cache_attribute_key = attribute_cache_key_for_attribute_and_previous_values(attribute, fields)
+          IdentityCache.cache.delete(old_cache_attribute_key)
+        end
+        new_cache_attribute_key = attribute_cache_key_for_attribute_and_current_values(attribute, fields)
+        if new_cache_attribute_key != old_cache_attribute_key
+          IdentityCache.cache.delete(new_cache_attribute_key)
+        end
       end
     end
 

data/lib/identity_cache/version.rb

@@ -1,4 +1,4 @@
 module IdentityCache
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   CACHE_VERSION = 3
 end

data/performance/cache_runner.rb

@@ -18,11 +18,11 @@ require File.dirname(__FILE__) + '/../test/helpers/database_connection'
 require File.dirname(__FILE__) + '/../test/helpers/cache'
 
 def create_record(id)
-  r = Record.new(id)
+  Item.new(id)
 end
 
 def database_ready(count)
-  Record.where(:id => (1..count)).count == count
+  Item.where(:id => (1..count)).count == count
 rescue
   false
 end
@@ -35,10 +35,10 @@ def create_database(count)
 
   DatabaseConnection.setup
   # set up associations
-  Record.cache_has_one :associated
-  Record.cache_has_many :associated_records, :embed => true
-  Record.cache_has_many :normalized_associated_records, :embed => false
-  Record.cache_index :title, :unique => :true
+  Item.cache_has_one :associated
+  Item.cache_has_many :associated_records, :embed => true
+  Item.cache_has_many :normalized_associated_records, :embed => false
+  Item.cache_index :title, :unique => :true
   AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
 
   return if database_ready(count)
@@ -46,10 +46,10 @@ def create_database(count)
 
   DatabaseConnection.drop_tables
   DatabaseConnection.create_tables
-  existing = Record.all
+  existing = Item.all
   (1..count).to_a.each do |i|
     unless existing.any? { |e| e.id == i }
-      a = Record.new
+      a = Item.new
       a.id = i
       a.associated = AssociatedRecord.new(name: "Associated for #{i}")
       a.associated_records
@@ -77,7 +77,7 @@ end
 class FindRunner < CacheRunner
   def run
     (1..@count).each do |i|
-      ::Record.find(i)
+      ::Item.find(i)
     end
   end
 end
@@ -93,7 +93,7 @@ class FetchMissRunner < CacheRunner
 
   def run
     (1..@count).each do |i|
-      rec = ::Record.fetch(i)
+      rec = ::Item.fetch(i)
       rec.fetch_associated
       rec.fetch_associated_records
     end
@@ -105,7 +105,7 @@ class DoubleFetchMissRunner < CacheRunner
 
   def run
     (1..@count).each do |i|
-      rec = ::Record.fetch(i)
+      rec = ::Item.fetch(i)
       rec.fetch_associated
       rec.fetch_associated_records
       rec.fetch_normalized_associated_records
@@ -117,7 +117,7 @@ module HitRunner
   def prepare
     IdentityCache.cache.clear
     (1..@count).each do |i|
-      rec = ::Record.fetch(i)
+      rec = ::Item.fetch(i)
       rec.fetch_normalized_associated_records
     end
   end
@@ -128,7 +128,7 @@ class FetchHitRunner < CacheRunner
 
   def run
     (1..@count).each do |i|
-      rec = ::Record.fetch(i)
+      rec = ::Item.fetch(i)
       # these should all be no cost
       rec.fetch_associated
       rec.fetch_associated_records
@@ -141,7 +141,7 @@ class DoubleFetchHitRunner < CacheRunner
 
   def run
     (1..@count).each do |i|
-      rec = ::Record.fetch(i)
+      rec = ::Item.fetch(i)
       # these should all be no cost
       rec.fetch_associated
       rec.fetch_associated_records
@@ -149,4 +149,3 @@ class DoubleFetchHitRunner < CacheRunner
     end
   end
 end
-

data/test/attribute_cache_test.rb

@@ -6,12 +6,11 @@ class AttributeCacheTest < IdentityCache::TestCase
   def setup
     super
     AssociatedRecord.cache_attribute :name
-    AssociatedRecord.cache_attribute :record, :by => [:id, :name]
 
-    @parent = Record.create!(:title => 'bob')
+    @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,name:string,record_id:integer")}:1"
+    @blob_key = "#{NAMESPACE}blob:AssociatedRecord:#{cache_hash("id:integer,item_id:integer,name:string")}:1"
   end
 
   def test_attribute_values_are_returned_on_cache_hits
@@ -21,17 +20,16 @@ class AttributeCacheTest < IdentityCache::TestCase
 
   def test_attribute_values_are_fetched_and_returned_on_cache_misses
     IdentityCache.cache.expects(:read).with(@name_attribute_key).returns(nil)
-    Record.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
+    Item.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
     assert_equal 'foo', AssociatedRecord.fetch_name_by_id(1)
   end
 
   def test_attribute_values_are_stored_in_the_cache_on_cache_misses
-
     # Cache miss, so
     IdentityCache.cache.expects(:read).with(@name_attribute_key).returns(nil)
 
     # Grab the value of the attribute from the DB
-    Record.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
+    Item.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
 
     # And write it back to the cache
     IdentityCache.cache.expects(:write).with(@name_attribute_key, 'foo').returns(nil)
@@ -39,6 +37,19 @@ class AttributeCacheTest < IdentityCache::TestCase
     assert_equal 'foo', AssociatedRecord.fetch_name_by_id(1)
   end
 
+  def test_nil_is_stored_in_the_cache_on_cache_misses
+    # Cache miss, so
+    IdentityCache.cache.expects(:read).with(@name_attribute_key).returns(nil)
+
+    # Grab the value of the attribute from the DB
+    Item.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns(nil)
+
+    # And write it back to the cache
+    IdentityCache.cache.expects(:write).with(@name_attribute_key, IdentityCache::CACHED_NIL).returns(nil)
+
+    assert_equal nil, AssociatedRecord.fetch_name_by_id(1)
+  end
+
   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)
@@ -59,17 +70,27 @@ class AttributeCacheTest < IdentityCache::TestCase
   end
 
   def test_cached_attribute_values_are_expired_from_the_cache_when_a_new_record_is_saved
-    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}blob:AssociatedRecord:#{cache_hash("id:integer,name:string,record_id:integer")}:2")
+    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}")
+    # attribute cache delete
+    IdentityCache.cache.expects(:delete).with("#{NAMESPACE}attribute:AssociatedRecord:name:id:#{cache_hash(new_id)}")
     @parent.associated_records.create(:name => 'bar')
   end
 
   def test_fetching_by_attribute_delegates_to_block_if_transactions_are_open
     IdentityCache.cache.expects(:read).with(@name_attribute_key).never
 
-    Record.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
+    Item.connection.expects(:select_value).with("SELECT `name` FROM `associated_records` WHERE `id` = 1 LIMIT 1").returns('foo')
 
     @record.transaction do
       assert_equal 'foo', AssociatedRecord.fetch_name_by_id(1)
     end
   end
+
+  def test_previously_stored_cached_nils_are_busted_by_new_record_saves
+    assert_equal nil, AssociatedRecord.fetch_name_by_id(2)
+    AssociatedRecord.create(:name => "Jim")
+    assert_equal "Jim", AssociatedRecord.fetch_name_by_id(2)
+  end
 end