identity_cache 0.5.1 → 1.0.0

data/lib/identity_cache/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module IdentityCache
+  class Railtie < Rails::Railtie
+    initializer "identity_cache.setup" do |app|
+      app.config.eager_load_namespaces << IdentityCache
+    end
+  end
+end

data/lib/identity_cache/record_not_found.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module IdentityCache
+  class RecordNotFound < ActiveRecord::RecordNotFound
+  end
+end

data/lib/identity_cache/should_use_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module IdentityCache
   module ShouldUseCache
     extend ActiveSupport::Concern

data/lib/identity_cache/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module IdentityCache
-  VERSION = "0.5.1"
-  CACHE_VERSION = 7
+  VERSION = "1.0.0"
+  CACHE_VERSION = 8
 end

data/lib/identity_cache/with_primary_index.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+module IdentityCache
+  module WithPrimaryIndex
+    extend ActiveSupport::Concern
+
+    include WithoutPrimaryIndex
+
+    def expire_cache
+      expire_primary_index
+      super
+    end
+
+    # @api private
+    def expire_primary_index # :nodoc:
+      self.class.expire_primary_key_cache_index(id)
+    end
+
+    # @api private
+    def primary_cache_index_key # :nodoc:
+      self.class.cached_primary_index.cache_key(id)
+    end
+
+    module ClassMethods
+      # @api private
+      def cached_primary_index
+        @cached_primary_index ||= Cached::PrimaryIndex.new(self)
+      end
+
+      def primary_cache_index_enabled
+        true
+      end
+
+      # Declares a new index in the cache for the class where IdentityCache was
+      # included.
+      #
+      # IdentityCache will add a fetch_by_field1_and_field2_and_...field for every
+      # index.
+      #
+      # == Example:
+      #
+      #  class Product
+      #    include IdentityCache
+      #    cache_index :name, :vendor
+      #  end
+      #
+      # Will add Product.fetch_by_name_and_vendor
+      #
+      # == Parameters
+      #
+      # +fields+ Array of symbols or strings representing the fields in the index
+      #
+      # == Options
+      # * unique: if the index would only have unique values. Default is false
+      #
+      def cache_index(*fields, unique: false)
+        attribute_proc = -> { primary_key }
+        cache_attribute_by_alias(attribute_proc, alias_name: :id, by: fields, unique: unique)
+
+        field_list = fields.join("_and_")
+        arg_list = (0...fields.size).collect { |i| "arg#{i}" }.join(',')
+
+        if unique
+          instance_eval(<<-CODE, __FILE__, __LINE__ + 1)
+            def fetch_by_#{field_list}(#{arg_list}, includes: nil)
+              id = fetch_id_by_#{field_list}(#{arg_list})
+              id && fetch_by_id(id, includes: includes)
+            end
+
+            # exception throwing variant
+            def fetch_by_#{field_list}!(#{arg_list}, includes: nil)
+              fetch_by_#{field_list}(#{arg_list}, includes: includes) or raise IdentityCache::RecordNotFound
+            end
+          CODE
+        else
+          instance_eval(<<-CODE, __FILE__, __LINE__ + 1)
+            def fetch_by_#{field_list}(#{arg_list}, includes: nil)
+              ids = fetch_id_by_#{field_list}(#{arg_list})
+              ids.empty? ? ids : fetch_multi(ids, includes: includes)
+            end
+          CODE
+        end
+
+        if fields.length == 1
+          instance_eval(<<-CODE, __FILE__, __LINE__ + 1)
+            def fetch_multi_by_#{field_list}(index_values, includes: nil)
+              ids = fetch_multi_id_by_#{field_list}(index_values).values.flatten(1)
+              return ids if ids.empty?
+              fetch_multi(ids, includes: includes)
+            end
+          CODE
+        end
+      end
+
+      # Similar to ActiveRecord::Base#exists? will return true if the id can be
+      # found in the cache or in the DB.
+      def exists_with_identity_cache?(id)
+        !!fetch_by_id(id)
+      end
+
+      # Default fetcher added to the model on inclusion, it behaves like
+      # ActiveRecord::Base.where(id: id).first
+      def fetch_by_id(id, includes: nil)
+        ensure_base_model
+        raise_if_scoped
+        record = cached_primary_index.fetch(id)
+        prefetch_associations(includes, [record]) if record && includes
+        record
+      end
+
+      # Default fetcher added to the model on inclusion, it behaves like
+      # ActiveRecord::Base.find, but will raise IdentityCache::RecordNotFound
+      # if the id is not in the cache.
+      def fetch(id, includes: nil)
+        fetch_by_id(id, includes: includes) || raise(
+          IdentityCache::RecordNotFound, "Couldn't find #{name} with ID=#{id}"
+        )
+      end
+
+      # Default fetcher added to the model on inclusion, if behaves like
+      # ActiveRecord::Base.find_all_by_id
+      def fetch_multi(*ids, includes: nil)
+        ensure_base_model
+        raise_if_scoped
+        ids.flatten!(1)
+        records = cached_primary_index.fetch_multi(ids)
+        prefetch_associations(includes, records) if includes
+        records
+      end
+
+      # Invalidates the primary cache index for the associated record. Will not invalidate cached attributes.
+      def expire_primary_key_cache_index(id)
+        cached_primary_index.expire(id)
+      end
+    end
+  end
+end

data/lib/identity_cache/without_primary_index.rb

@@ -1,10 +1,31 @@
+# frozen_string_literal: true
 module IdentityCache
   module WithoutPrimaryIndex
     extend ActiveSupport::Concern
 
-    included do |base|
-      base.send(:include, IdentityCache)
-      base.primary_cache_index_enabled = false
+    include ArTransactionChanges
+    include IdentityCache::BelongsToCaching
+    include IdentityCache::CacheKeyGeneration
+    include IdentityCache::ConfigurationDSL
+    include IdentityCache::QueryAPI
+    include IdentityCache::CacheInvalidation
+    include IdentityCache::ShouldUseCache
+    include ParentModelExpiration
+
+    def self.append_features(base) #:nodoc:
+      raise AlreadyIncludedError if base.include?(WithoutPrimaryIndex)
+      super
+    end
+
+    included do
+      class_attribute(:cached_model)
+      self.cached_model = self
+    end
+
+    module ClassMethods
+      def primary_cache_index_enabled
+        false
+      end
     end
   end
 end

data/performance/cache_runner.rb

@@ -1,4 +1,5 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+# frozen_string_literal: true
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
 require 'active_record'
 require 'active_support/core_ext'
 require 'active_support/cache'
@@ -6,25 +7,19 @@ require 'identity_cache'
 require 'memcached_store'
 require 'active_support/cache/memcached_store'
 
-$memcached_port = 11211
-$mysql_port = 3306
-
 require File.dirname(__FILE__) + '/../test/helpers/active_record_objects'
 require File.dirname(__FILE__) + '/../test/helpers/database_connection'
+require File.dirname(__FILE__) + '/../test/helpers/cache_connection'
 
 IdentityCache.logger = Logger.new(nil)
-IdentityCache.cache_backend = ActiveSupport::Cache::MemcachedStore.new("localhost:#{$memcached_port}", :support_cas => true)
-
-if ActiveRecord.gem_version < Gem::Version.new('5') && ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks=)
-  ActiveRecord::Base.raise_in_transactional_callbacks = true
-end
+CacheConnection.setup
 
 def create_record(id)
   Item.new(id)
 end
 
 def database_ready(count)
-  Item.where(:id => (1..count)).count == count
+  Item.where(id: (1..count)).count == count
 rescue
   false
 end
@@ -42,26 +37,25 @@ def create_database(count)
   DatabaseConnection.create_tables
   existing = Item.all
   (1..count).to_a.each do |i|
-    unless existing.any? { |e| e.id == i }
-      a = Item.new
-      a.id = i
-      a.associated = AssociatedRecord.new(name: "Associated for #{i}")
-      a.associated_records
-      (1..5).each do |j|
-        a.associated_records << AssociatedRecord.new(name: "Has Many #{j} for #{i}")
-        a.normalized_associated_records << NormalizedAssociatedRecord.new(name: "Normalized Has Many #{j} for #{i}")
-      end
-      a.save
+    next if existing.any? { |e| e.id == i }
+    a = Item.new
+    a.id = i
+    a.associated = AssociatedRecord.new(name: "Associated for #{i}")
+    a.associated_records
+    (1..5).each do |j|
+      a.associated_records << AssociatedRecord.new(name: "Has Many #{j} for #{i}")
+      a.normalized_associated_records << NormalizedAssociatedRecord.new(name: "Normalized Has Many #{j} for #{i}")
     end
+    a.save
   end
 ensure
   helper.teardown_models
 end
 
 def setup_embedded_associations
-  Item.cache_has_one :associated
-  Item.cache_has_many :associated_records, :embed => true
-  AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
+  Item.cache_has_one(:associated, embed: true)
+  Item.cache_has_many(:associated_records, embed: true)
+  AssociatedRecord.cache_has_many(:deeply_associated_records, embed: true)
 end
 
 class CacheRunner
@@ -86,7 +80,7 @@ CACHE_RUNNERS = []
 class FindRunner < CacheRunner
   def run
     (1..@count).each do |i|
-      ::Item.includes(:associated, {:associated_records => :deeply_associated_records}).find(i)
+      ::Item.includes(:associated, associated_records: :deeply_associated_records).find(i)
     end
   end
 end
@@ -109,18 +103,18 @@ end
 module DeletedRunner
   def prepare
     super
-    (1..@count).each {|i| ::Item.find(i).send(:expire_cache) }
+    (1..@count).each { |i| ::Item.find(i).expire_cache }
   end
 end
 
 module ConflictRunner
   def prepare
     super
-    records = (1..@count).map {|id| ::Item.find(id) }
+    records = (1..@count).map { |id| ::Item.find(id) }
     orig_resolve_cache_miss = ::Item.method(:resolve_cache_miss)
 
     ::Item.define_singleton_method(:resolve_cache_miss) do |id|
-      records[id-1].send(:expire_cache)
+      records[id - 1].expire_cache
       orig_resolve_cache_miss.call(id)
     end
     IdentityCache.cache.clear
@@ -131,16 +125,16 @@ module DeletedConflictRunner
   include ConflictRunner
   def prepare
     super
-    (1..@count).each {|i| ::Item.find(i).send(:expire_cache) }
+    (1..@count).each { |i| ::Item.find(i).expire_cache }
   end
 end
 
 class EmbedRunner < CacheRunner
   def setup_models
     super
-    Item.cache_has_one :associated
-    Item.cache_has_many :associated_records, :embed => true
-    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => true
+    Item.cache_has_one(:associated, embed: true)
+    Item.cache_has_many(:associated_records, embed: true)
+    AssociatedRecord.cache_has_many(:deeply_associated_records, embed: true)
   end
 
   def run
@@ -180,9 +174,9 @@ CACHE_RUNNERS << FetchEmbedDeletedConflictRunner
 class NormalizedRunner < CacheRunner
   def setup_models
     super
-    Item.cache_has_one :associated # :embed => false isn't supported
-    Item.cache_has_many :associated_records, :embed => :ids
-    AssociatedRecord.cache_has_many :deeply_associated_records, :embed => :ids
+    Item.cache_has_one(:associated, embed: :id)
+    Item.cache_has_many(:associated_records, embed: :ids)
+    AssociatedRecord.cache_has_many(:deeply_associated_records, embed: :ids)
   end
 
   def run

data/performance/cpu.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'benchmark'
 
@@ -19,7 +20,7 @@ ensure
   obj.cleanup
 end
 
-def benchmark(runners, label_width=0)
+def benchmark(runners, label_width = 0)
   IdentityCache.cache.clear
   runners.each do |runner|
     print "#{runner.name}: ".ljust(label_width)
@@ -28,7 +29,7 @@ def benchmark(runners, label_width=0)
 end
 
 def bmbm(runners)
-  label_width = runners.map{ |r| r.name.size }.max + 2
+  label_width = runners.map { |r| r.name.size }.max + 2
   width = label_width + Benchmark::CAPTION.size
 
   puts 'Rehearsal: '.ljust(width, '-')

data/performance/externals.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'benchmark'
 require 'ruby-prof'
@@ -7,8 +8,8 @@ require_relative 'cache_runner'
 RUNS = 1000
 RubyProf.measure_mode = RubyProf::CPU_TIME
 
-EXTERNALS = {"Memcache" => ["MemCache#set", "MemCache#get"],
-             "Database" => ["Mysql2::Client#query"]}
+EXTERNALS = { "Memcache" => ["MemCache#set", "MemCache#get"],
+              "Database" => ["Mysql2::Client#query"] }
 
 def run(obj)
   obj.prepare
@@ -26,7 +27,7 @@ def count_externals(results)
   count = {}
   results.split(/\n/).each do |line|
     fields = line.split
-    if ext = EXTERNALS.detect { |e| e[1].any? { |method| method == fields[-1] } }
+    if (ext = EXTERNALS.detect { |e| e[1].any? { |method| method == fields[-1] } })
       count[ext[0]] ||= 0
       count[ext[0]] += fields[-2].to_i
     end

data/performance/profile.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'benchmark'
 require 'stackprof'
@@ -21,15 +22,15 @@ end
 
 create_database(RUNS)
 
-if runner_name = ENV['RUNNER']
-  if runner = CACHE_RUNNERS.find{ |r| r.name == runner_name }
+if (runner_name = ENV['RUNNER'])
+  if (runner = CACHE_RUNNERS.find { |r| r.name == runner_name })
     run(runner.new(RUNS), filename: ENV['FILENAME'])
   else
     puts "Couldn't find cache runner #{runner_name.inspect}"
-    exit 1
+    exit(1)
   end
 else
-  CACHE_RUNNERS.each do |runner|
-    run(runner.new(RUNS))
+  CACHE_RUNNERS.each do |cache_runner|
+    run(cache_runner.new(RUNS))
   end
 end

data/railgun.yml

@@ -0,0 +1,16 @@
+# https://dev-accel.shopify.io/dev/railgun/Railgun-Config
+name: identity-cache
+
+vm:
+  image:      /opt/dev/misc/railgun-images/default
+  ip_address: 192.168.64.98
+  memory:     1G
+  cores:      2
+
+volumes:
+  root: 1G
+
+services:
+  - mysql
+  - postgresql
+  - memcached

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Camilo Lopez
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ar_transaction_changes
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: memcached
   requirement: !ruby/object:Gem::Requirement
@@ -160,16 +160,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: stackprof
   requirement: !ruby/object:Gem::Requirement
@@ -184,24 +184,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Opt in read through ActiveRecord caching.
+description: Opt-in read through Active Record caching.
 email:
 - gems@shopify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/probots.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.rails42
-- Gemfile.rails50
 - LICENSE
 - README.md
 - Rakefile
 - dev.yml
+- gemfiles/Gemfile.latest-release
+- gemfiles/Gemfile.rails-edge
+- gemfiles/Gemfile.rails52
 - identity_cache.gemspec
 - lib/identity_cache.rb
 - lib/identity_cache/belongs_to_caching.rb
@@ -209,48 +213,45 @@ files:
 - lib/identity_cache/cache_hash.rb
 - lib/identity_cache/cache_invalidation.rb
 - lib/identity_cache/cache_key_generation.rb
+- lib/identity_cache/cache_key_loader.rb
+- lib/identity_cache/cached.rb
+- lib/identity_cache/cached/association.rb
+- lib/identity_cache/cached/attribute.rb
+- lib/identity_cache/cached/attribute_by_multi.rb
+- lib/identity_cache/cached/attribute_by_one.rb
+- lib/identity_cache/cached/belongs_to.rb
+- lib/identity_cache/cached/embedded_fetching.rb
+- lib/identity_cache/cached/prefetcher.rb
+- lib/identity_cache/cached/primary_index.rb
+- lib/identity_cache/cached/recursive/association.rb
+- lib/identity_cache/cached/recursive/has_many.rb
+- lib/identity_cache/cached/recursive/has_one.rb
+- lib/identity_cache/cached/reference/association.rb
+- lib/identity_cache/cached/reference/has_many.rb
+- lib/identity_cache/cached/reference/has_one.rb
 - lib/identity_cache/configuration_dsl.rb
+- lib/identity_cache/encoder.rb
+- lib/identity_cache/expiry_hook.rb
 - lib/identity_cache/fallback_fetcher.rb
+- lib/identity_cache/load_strategy/eager.rb
+- lib/identity_cache/load_strategy/lazy.rb
+- lib/identity_cache/load_strategy/load_request.rb
+- lib/identity_cache/load_strategy/multi_load_request.rb
 - lib/identity_cache/memoized_cache_proxy.rb
 - lib/identity_cache/parent_model_expiration.rb
 - lib/identity_cache/query_api.rb
+- lib/identity_cache/railtie.rb
+- lib/identity_cache/record_not_found.rb
 - lib/identity_cache/should_use_cache.rb
 - lib/identity_cache/version.rb
+- lib/identity_cache/with_primary_index.rb
 - lib/identity_cache/without_primary_index.rb
 - performance/cache_runner.rb
 - performance/cpu.rb
 - performance/externals.rb
 - performance/profile.rb
+- railgun.yml
 - shipit.rubygems.yml
-- test/attribute_cache_test.rb
-- test/cache_fetch_includes_test.rb
-- test/cache_hash_test.rb
-- test/cache_invalidation_test.rb
-- test/deeply_nested_associated_record_test.rb
-- test/denormalized_has_many_test.rb
-- test/denormalized_has_one_test.rb
-- test/fetch_multi_test.rb
-- test/fetch_test.rb
-- test/fixtures/serialized_record.mysql2
-- test/fixtures/serialized_record.postgresql
-- test/helpers/active_record_objects.rb
-- test/helpers/database_connection.rb
-- test/helpers/serialization_format.rb
-- test/helpers/update_serialization_format.rb
-- test/identity_cache_test.rb
-- test/index_cache_test.rb
-- test/memoized_attributes_test.rb
-- test/memoized_cache_proxy_test.rb
-- test/normalized_belongs_to_test.rb
-- test/normalized_has_many_test.rb
-- test/normalized_has_one_test.rb
-- test/prefetch_associations_test.rb
-- test/readonly_test.rb
-- test/recursive_denormalized_has_many_test.rb
-- test/save_test.rb
-- test/schema_change_test.rb
-- test/serialization_format_change_test.rb
-- test/test_helper.rb
 homepage: https://github.com/Shopify/identity_cache
 licenses: []
 metadata: {}
@@ -262,48 +263,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 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
   database is only hit when a copy of the object cannot be found in Memcached.
-test_files:
-- test/attribute_cache_test.rb
-- test/cache_fetch_includes_test.rb
-- test/cache_hash_test.rb
-- test/cache_invalidation_test.rb
-- test/deeply_nested_associated_record_test.rb
-- test/denormalized_has_many_test.rb
-- test/denormalized_has_one_test.rb
-- test/fetch_multi_test.rb
-- test/fetch_test.rb
-- test/fixtures/serialized_record.mysql2
-- test/fixtures/serialized_record.postgresql
-- test/helpers/active_record_objects.rb
-- test/helpers/database_connection.rb
-- test/helpers/serialization_format.rb
-- test/helpers/update_serialization_format.rb
-- test/identity_cache_test.rb
-- test/index_cache_test.rb
-- test/memoized_attributes_test.rb
-- test/memoized_cache_proxy_test.rb
-- test/normalized_belongs_to_test.rb
-- test/normalized_has_many_test.rb
-- test/normalized_has_one_test.rb
-- test/prefetch_associations_test.rb
-- test/readonly_test.rb
-- test/recursive_denormalized_has_many_test.rb
-- test/save_test.rb
-- test/schema_change_test.rb
-- test/serialization_format_change_test.rb
-- test/test_helper.rb
+test_files: []