identity_cache 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9803848d2879cfdaad2424842b64db3684e1ca4
-  data.tar.gz: 91cd873cffd35d19d66b01c8a10165344b30483d
+SHA256:
+  metadata.gz: 9236be16375bc831c91f69bcc86968cf036c361c173e79cfd8ea4eb43d707787
+  data.tar.gz: 45e4acef2ef66d7262ce1b4c6d7b7fa33762c26fa99f31700cd44a4091dde8c4
 SHA512:
-  metadata.gz: d65519bb48cdae9d0111280e05a89cee2e99a497f31d0140f3e77ca55226865ef8c575ec9bd427e41ba9fd105e304c0a006d2fa4348ce6b06393c0ed607a8e23
-  data.tar.gz: 370c4a4d3406b95b9fe40b33406182286d9586dc07db2f2517a87bb08111fafa776dead8a5430555564aefdb385a9f5ce027c511e87c32924a8e8668af00a863
+  metadata.gz: 7f9c79056ccbb938299b3fb6fd3e62af44f9117140df1b714a758be2aa4d864ffb1df589ba0a6220786db3bdb005326e794ea9340629146e478ffb2f3a3574cf
+  data.tar.gz: abc0e209fe35c8fc5ed6e470221a3e86cdeca23e81fc5c294d817cf3011c9ccf3a8dbf58096414c84be4b6b1e40ce4816b36703ed2b72da7dbafa4a78235e51d

data/.github/probots.yml

@@ -0,0 +1,2 @@
+enabled:
+  - cla

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Install required packages
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install libmysqlclient-dev libpq-dev libsasl2-dev
+    - name: Install bundler and gems
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run rubocop
+      run: |
+        bundle exec rubocop

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6

data/.travis.yml

@@ -1,25 +1,29 @@
 language: ruby
 
 rvm:
-  - '2.2.6'
-  - '2.3.3'
+  - 2.4
+  - 2.6
 
 gemfile:
-  - Gemfile.rails42
-  - Gemfile.rails50
-
-matrix:
-  exclude:
-    - gemfile: Gemfile.rails50
-      env: DB=postgresql
+  - gemfiles/Gemfile.rails52
+  - gemfiles/Gemfile.latest-release
+  - gemfiles/Gemfile.rails-edge
 
 env:
   - DB=mysql2
   - DB=postgresql
 
+jobs:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/Gemfile.rails-edge
+    - rvm: 2.4
+      gemfile: gemfiles/Gemfile.latest-release
+
 services:
   - memcache
   - mysql
+  - postgresql
 
 sudo: false
 
@@ -27,4 +31,15 @@ before_script:
   - mysql -e 'create database identity_cache_test'
   - psql -c 'create database identity_cache_test;' -U postgres
 
+script:
+  - bundle exec rake test
+
 cache: bundler
+
+matrix:
+  exclude:
+    - rvm: 2.2.6
+      gemfile: gemfiles/Gemfile.rails-edge
+
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # IdentityCache changelog
 
+#### 1.0.0
+
+- Remove inverse_name option. Specify inverse_of on the Active Record association instead. (#439)
+- Bump the minimum Active Record version to 5.2 (#438)
+- Remove the default embed option value from cache_has_one (#437)
+- Lazily evaluate nested includes to fetch blobs in batches (#427)
+- Only cache embedded association IDs when present (#397)
+- Add support for ID embedded `has_one` cached associations (#393)
+- Add support for polymorphic `belongs_to` cached associations (#387)
+- Add `fetch_multi_by_*` support for cache_index with a single field (#368)
+- Remove support for rails 4.2 (#355)
+- Type cast values using attribute types before using in cache key (#354)
+- Set inverse cached association for cache_has_one on cache hit (#345)
+- Use `ActiveSupport:Notifications` to notify subscribers of hydration events (#341)
+- Remove disable_primary_cache_index (#335)
+- Remove deprecated `embed: false` cache_has_many option (#335)
+- Fix column name in the preload association query when using custom primary keys (#338)
+- Raise when trying to cache a belong_to association with a scope. Previously the scope was ignored on a cache hit (#323)
+- Remove deprecated `never_set_inverse_association` option (#319)
+- Lazy load associated classes (#306)
+
 #### 0.5.1
 
 - Fix bug in prefetch_associations for cache_has_one associations that may be nil

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 gemspec
 
-gem 'mysql2', '~> 0.3.13'
+gem 'mysql2', '~> 0.5.3'
+gem 'pg', '~> 0.21.0'
+gem 'rubocop'
+gem 'byebug', platform: :mri

data/README.md

@@ -12,6 +12,7 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'identity_cache'
 gem 'cityhash'        # optional, for faster hashing (C-Ruby only)
+gem 'memcached_store' # for CAS support, needed for cache consistency
 ```
 
 And then execute:
@@ -22,7 +23,12 @@ And then execute:
 Add the following to all your environment/*.rb files (production/development/test):
 
 ```ruby
-config.identity_cache_store = :mem_cache_store, Memcached::Rails.new(:servers => ["mem1.server.com"])
+config.identity_cache_store = :memcached_store,
+  Memcached::Rails.new(servers: ["mem1.server.com"],
+    support_cas: true,
+    auto_eject_hosts: false,  # avoids more cache consistency issues
+    expires_in: 6.hours.to_i, # in case of network errors when sending a delete
+  )
 ```
 
 Add an initializer with this code:
@@ -45,10 +51,10 @@ class Product < ActiveRecord::Base
 
   has_many :images
 
-  cache_has_many :images, :embed => true
+  cache_has_many :images, embed: true
 end
 
-# Fetch the product by its id using the primary primary index as well as the embedded images association.
+# Fetch the product by its id using the primary index as well as the embedded images association.
 @product = Product.fetch(id)
 
 # Access the loaded images for the Product.
@@ -64,7 +70,7 @@ IdentityCache lets you lookup records by fields other than `id`. You can have mu
 ``` ruby
 class Product < ActiveRecord::Base
   include IdentityCache
-  cache_index :handle, :unique => true
+  cache_index :handle, unique: true
   cache_index :vendor, :product_type
 end
 
@@ -72,6 +78,9 @@ end
 # If the object isn't in the cache it is pulled from the db and stored in the cache.
 product = Product.fetch_by_handle(handle)
 
+# Fetch multiple products by providing an array of index values.
+products = Product.fetch_multi_by_handle(handles)
+
 products = Product.fetch_by_vendor_and_product_type(vendor, product_type)
 ```
 
@@ -98,7 +107,7 @@ class Product < ActiveRecord::Base
   has_one   :featured_image
 
   cache_has_many :images
-  cache_has_one :featured_image
+  cache_has_one :featured_image, embed: :id
 end
 
 @product.fetch_featured_image
@@ -112,7 +121,7 @@ class Product < ActiveRecord::Base
   include IdentityCache
 end
 
-@product.fetch_multi([1, 2])
+Product.fetch_multi([1, 2])
 ```
 
 ### Embedding Associations
@@ -124,7 +133,7 @@ class Product < ActiveRecord::Base
   include IdentityCache
 
   has_many :images
-  cache_has_many :images, :embed => true
+  cache_has_many :images, embed: true
 end
 
 @product = Product.fetch(id)
@@ -135,32 +144,29 @@ With this code, on cache miss, the product and its associated images will be loa
 
 ### Caching Polymorphic Associations
 
-IdentityCache tries to figure out both sides of an association whenever it can so it can set those up when rebuilding the object from the cache. In some cases this is hard to determine so you can tell IdentityCache what the association should be. This is most often the case when embedding polymorphic associations. The `inverse_name` option on `cache_has_many` and `cache_has_one` lets you specify the inverse name of the association.
+IdentityCache tries to figure out both sides of an association whenever it can so it can set those up when rebuilding the object from the cache. In some cases this is hard to determine so you can tell IdentityCache what the association should be. This is most often the case when embedding polymorphic associations.
 
 ``` ruby
 class Metafield < ActiveRecord::Base
   include IdentityCache
-  belongs_to :owner, :polymorphic => true
+  belongs_to :owner, polymorphic: true
   cache_belongs_to :owner
 end
 
 class Product < ActiveRecord::Base
   include IdentityCache
-  has_many :metafields, :as => 'owner'
-  cache_has_many :metafields, :inverse_name => :owner
+  has_many :metafields, as: :owner
+  cache_has_many :metafields
 end
 ```
 
-The `:inverse_name => :owner` option tells IdentityCache what the association on the other side is named so that it can correctly set the assocation when loading the metafields from the cache.
-
-
 ### Caching Attributes
 
 For cases where you may not need the entire object to be cached, just an attribute from record, `cache_attribute` can be used. This will cache the single attribute by the key specified.
 
 ``` ruby
 class Redirect < ActiveRecord::Base
-  cache_attribute :target, :by => [:shop_id, :path]
+  cache_attribute :target, by: [:shop_id, :path]
 end
 
 Redirect.fetch_target_by_shop_id_and_path(shop_id, path)
@@ -182,22 +188,18 @@ Example:
 #### cache_has_many
 
 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.
+_[: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. Defaults to `:ids`.
 
 Example:
-`cache_has_many :metafields, :inverse_name => :owner, :embed => true`
+`cache_has_many :metafields, embed: true`
 
 #### cache_has_one
 
 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.
+_[: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. When :id, only the id of the associated record will be included with the parent when caching.
 
 Example:
-`cache_has_one :configuration, :embed => true`
+`cache_has_one :configuration, embed: :id`
 
 #### cache_belongs_to
 
@@ -210,7 +212,7 @@ Options:
 _[:by]_ Specifies what key(s) you want the attribute cached by. Defaults to :id.
 
 Example:
-`cache_attribute :target, :by => [:shop_id, :path]`
+`cache_attribute :target, by: [:shop_id, :path]`
 
 ## Memoized Cache Proxy
 
@@ -220,8 +222,8 @@ Cache reads and writes can be memoized for a block of code to serve duplicate id
 class ApplicationController < ActionController::Base
   around_filter :identity_cache_memoization
 
-  def identity_cache_memoization
-    IdentityCache.cache.with_memoization{ yield }
+  def identity_cache_memoization(&block)
+    IdentityCache.cache.with_memoization(&block)
   end
 end
 ```

data/Rakefile

@@ -1,13 +1,14 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 require 'rdoc/task'
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc('Default: run tests and style checks.')
+task(default: [:test, :rubocop])
 
-desc 'Test the identity_cache plugin.'
+desc('Test the identity_cache plugin.')
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
@@ -15,9 +16,17 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-desc 'Update serialization format test fixture.'
+task :rubocop do
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
+
+desc('Update serialization format test fixture.')
 task :update_serialization_format do
-  ruby './test/helpers/update_serialization_format.rb'
+  %w(mysql2 postgresql).each do |db|
+    ENV["DB"] = db
+    ruby './test/helpers/update_serialization_format.rb'
+  end
 end
 
 namespace :benchmark do

data/dev.yml

@@ -3,7 +3,7 @@ name: identity-cache
 up:
   - homebrew:
     - postgresql
-  - ruby: 2.3.3
+  - ruby: 2.4.1
   - railgun
   - bundler
 
@@ -27,6 +27,14 @@ commands:
         bundle exec ruby -I test "$@"
       fi
 
+  style:
+    desc: 'Run rubocop checks'
+    run: bundle exec rubocop "$@"
+
+  check:
+    desc: 'Run tests and style checks'
+    run: bundle exec rake test && bundle exec rubocop
+
   benchmark-cpu:
     desc: 'Run the identity cache CPU benchmark'
     run: bundle exec rake benchmark:cpu
@@ -38,18 +46,3 @@ commands:
   update-serialization-format:
     desc: 'Update serialization format test fixture'
     run: bundle exec rake update_serialization_format
-
-railgun:
-  image: dev:railgun-common-services-0.2.x
-  ip_address: 192.168.64.98
-  memory: 1G
-  cores: 1
-  disk: 1G
-  services:
-    mysql: 3306
-    postgresql: 5432
-    memcached: 11211
-
-packages:
-  - git@github.com:Shopify/dev-shopify.git
-

data/gemfiles/Gemfile.latest-release

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord'
+gem 'activesupport'
+gem "mysql2", ">= 0.4.4"

data/gemfiles/Gemfile.rails-edge

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord', github: 'rails/rails'
+gem 'activesupport', github: 'rails/rails'
+gem "mysql2", ">= 0.4.4"

data/gemfiles/Gemfile.rails52

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec path: '..'
+
+gem 'activerecord', '~> 5.2'
+gem 'activesupport', '~> 5.2'
+gem 'mysql2', '>= 0.4.4', '< 0.6.0'

data/identity_cache.gemspec

@@ -1,24 +1,40 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require File.expand_path('../lib/identity_cache/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Camilo Lopez", "Tom Burns", "Harry Brundage", "Dylan Thacker-Smith", "Tobias Lutke", "Arthur Neves", "Francis Bogsanyi"]
+  gem.authors = [
+    "Camilo Lopez",
+    "Tom Burns",
+    "Harry Brundage",
+    "Dylan Thacker-Smith",
+    "Tobias Lutke",
+    "Arthur Neves",
+    "Francis Bogsanyi",
+  ]
   gem.email         = ["gems@shopify.com"]
-  gem.description   = %q{Opt in read through ActiveRecord caching.}
-  gem.summary       = %q{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.}
+  gem.description   = "Opt-in read through Active Record caching."
+  gem.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."
   gem.homepage      = "https://github.com/Shopify/identity_cache"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files         = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^test/}) }
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
   gem.name          = "identity_cache"
   gem.require_paths = ["lib"]
   gem.version       = IdentityCache::VERSION
 
-  gem.required_ruby_version = '>= 2.2.0'
+  gem.required_ruby_version = '>= 2.4.0'
 
   gem.add_dependency('ar_transaction_changes', '~> 1.0')
-  gem.add_dependency('activerecord', '>= 4.2.0')
+  gem.add_dependency('activerecord', '>= 5.2')
 
   gem.add_development_dependency('memcached', '~> 1.8.0')
   gem.add_development_dependency('memcached_store', '~> 1.0.0')
@@ -32,7 +48,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.dup) >= Gem::Version.new("2.1.0")
+    gem.add_development_dependency('pg', '~> 0.18')
+    gem.add_development_dependency('stackprof')
   end
 end