identity_cache 0.0.1

data/test/recursive_denormalized_has_many_test.rb

@@ -0,0 +1,97 @@
+require "test_helper"
+
+class RecursiveDenormalizedHasManyTest < IdentityCache::TestCase
+  def setup
+    super
+    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
+    Record.cache_has_many :associated_records, :embed => true
+    Record.cache_has_one :associated
+
+    @record = Record.new(:title => 'foo')
+
+    @associated_record = AssociatedRecord.new(:name => 'bar')
+    @record.associated_records << AssociatedRecord.new(:name => 'baz')
+    @record.associated_records << @associated_record
+
+    @deeply_associated_record = DeeplyAssociatedRecord.new(:name => "corge")
+    @associated_record.deeply_associated_records << @deeply_associated_record
+    @associated_record.deeply_associated_records << DeeplyAssociatedRecord.new(:name => "qux")
+
+    @record.save
+    @record.reload
+    @associated_record.reload
+  end
+
+  def test_cache_fetch_includes
+    assert_equal [{:associated_records => [:deeply_associated_records]}, :associated => [:deeply_associated_records]], Record.cache_fetch_includes
+  end
+
+  def test_uncached_record_from_the_db_will_use_normal_association_for_deeply_associated_records
+    expected = @associated_record.deeply_associated_records
+    record_from_db = Record.find(@record.id)
+    assert_equal expected, record_from_db.fetch_associated_records[0].fetch_deeply_associated_records
+  end
+
+  def test_on_cache_miss_record_should_embed_associated_objects_and_return
+    record_from_cache_miss = Record.fetch(@record.id)
+    expected = @associated_record.deeply_associated_records
+
+    child_record_from_cache_miss = record_from_cache_miss.fetch_associated_records[0]
+    assert_equal @associated_record, child_record_from_cache_miss
+    assert_equal expected, child_record_from_cache_miss.fetch_deeply_associated_records
+  end
+
+  def test_on_cache_hit_record_should_return_embed_associated_objects
+    Record.fetch(@record.id) # warm cache
+    expected = @associated_record.deeply_associated_records
+
+    Record.any_instance.expects(:associated_records).never
+    AssociatedRecord.any_instance.expects(:deeply_associated_records).never
+
+    record_from_cache_hit = Record.fetch(@record.id)
+    child_record_from_cache_hit = record_from_cache_hit.fetch_associated_records[0]
+    assert_equal @associated_record, child_record_from_cache_hit
+    assert_equal expected, child_record_from_cache_hit.fetch_deeply_associated_records
+  end
+
+  def test_on_cache_miss_child_record_fetch_should_include_nested_associations_to_avoid_n_plus_ones
+    record_from_cache_miss = Record.fetch(@record.id)
+    expected = @associated_record.deeply_associated_records
+    
+    assert record_from_cache_miss.fetch_associated_records[0].deeply_associated_records.loaded?
+    assert record_from_cache_miss.fetch_associated_records[1].deeply_associated_records.loaded?
+  end
+  
+  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)
+    @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)
+    IdentityCache.cache.expects(:delete).with(@deeply_associated_record.primary_cache_index_key)
+    @deeply_associated_record.name = 'different'
+    @deeply_associated_record.save!
+  end
+
+end
+
+class RecursiveNormalizedHasManyTest < IdentityCache::TestCase
+  def setup
+    super
+    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
+    Record.cache_has_many :associated_records, :embed => false
+
+    @record = Record.new(:title => 'foo')
+    @record.save
+    @record.reload
+  end
+
+  def test_cache_repopulation_should_not_fetch_non_embedded_associations
+    Record.any_instance.expects(:fetch_associated_records).never
+    record_from_cache_miss = Record.fetch(@record.id)
+  end
+end

data/test/save_test.rb

@@ -0,0 +1,64 @@
+require "test_helper"
+
+class SaveTest < IdentityCache::TestCase
+  def setup
+    super
+    Record.cache_index :title, :unique => true
+    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"
+  end
+
+  def test_create
+    @record = Record.new
+    @record.title = 'bob'
+
+    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
+    @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("IDC:index:Record:id/title:#{cache_hash('1/fred')}")
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('fred')}")
+    IdentityCache.cache.expects(:delete).with(@blob_key)
+
+    # Delete index id, delete index id/title
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:id/title:#{cache_hash('1/bob')}")
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('bob')}")
+
+    @record.title = 'fred'
+    @record.save
+  end
+
+  def test_destroy
+    # Regular flow: delete data blob, delete index id, delete index id/tile
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:id/title:#{cache_hash('1/bob')}")
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('bob')}")
+    IdentityCache.cache.expects(:delete).with(@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("IDC:index:Record:id/title:#{cache_hash('1/bob')}")
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('bob')}")
+    IdentityCache.cache.expects(:delete).with(@blob_key)
+
+    @record.title = 'fred'
+    @record.destroy
+  end
+
+  def test_touch_will_expire_the_caches
+    # Regular flow: delete data blob, delete index id, delete index id/tile
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:id/title:#{cache_hash('1/bob')}")
+    IdentityCache.cache.expects(:delete).with("IDC:index:Record:title:#{cache_hash('bob')}")
+    IdentityCache.cache.expects(:delete).with(@blob_key)
+
+    @record.touch
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'active_record'
+require 'helpers/cache'
+require 'helpers/database_connection'
+
+require File.dirname(__FILE__) + '/../lib/identity_cache'
+
+DatabaseConnection.setup
+
+class IdentityCache::TestCase < MiniTest::Unit::TestCase
+  def setup
+    DatabaseConnection.drop_tables
+    DatabaseConnection.create_tables
+
+    setup_models
+  end
+
+  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'
+  end
+
+  def assert_nothing_raised
+    yield
+  end
+
+  def assert_not_nil(*args)
+    assert *args
+  end
+
+  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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: identity_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Camilo Lopez
+- Tom Burns
+- Harry Brundage
+- Dylan Smith
+- Tobias Lütke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ar_transaction_changes
+  requirement: &70221938344660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221938344660
+- !ruby/object:Gem::Dependency
+  name: cityhash
+  requirement: &70221938344160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221938344160
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70221938343780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221938343780
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70221938343320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221938343320
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &70221938342900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221938342900
+description: Opt in read through ActiveRecord caching.
+email:
+- harry.brundage@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- identity_cache.gemspec
+- lib/belongs_to_caching.rb
+- lib/identity_cache.rb
+- lib/identity_cache/version.rb
+- lib/memoized_cache_proxy.rb
+- test/attribute_cache_test.rb
+- test/denormalized_has_many_test.rb
+- test/denormalized_has_one_test.rb
+- test/fetch_multi_test.rb
+- test/fetch_test.rb
+- test/helpers/cache.rb
+- test/helpers/database_connection.rb
+- test/identity_cache_test.rb
+- test/index_cache_test.rb
+- test/memoized_cache_proxy_test.rb
+- test/normalized_belongs_to_test.rb
+- test/normalized_has_many_test.rb
+- test/recursive_denormalized_has_many_test.rb
+- test/save_test.rb
+- test/test_helper.rb
+homepage: https://github.com/Shopify/identity_cache
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 460007319304896635
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 460007319304896635
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+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
+  database is only hit when a copy of the object cannot be found in Memcached.
+test_files:
+- test/attribute_cache_test.rb
+- test/denormalized_has_many_test.rb
+- test/denormalized_has_one_test.rb
+- test/fetch_multi_test.rb
+- test/fetch_test.rb
+- test/helpers/cache.rb
+- test/helpers/database_connection.rb
+- test/identity_cache_test.rb
+- test/index_cache_test.rb
+- test/memoized_cache_proxy_test.rb
+- test/normalized_belongs_to_test.rb
+- test/normalized_has_many_test.rb
+- test/recursive_denormalized_has_many_test.rb
+- test/save_test.rb
+- test/test_helper.rb