second_level_cache 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c4b3cf277afefb0bc9e4943fe03fbd45ad1c487
-  data.tar.gz: 6869caa60874ba8b133552c4a32db346e86bd0fa
+SHA256:
+  metadata.gz: d4a105d17a40787d4a614e3870220cc480befc73713872f7d427f009d36c7eea
+  data.tar.gz: 1488f0f970f62dc8605d4a669b2b8b9e0b88cc1eb9e7f26961ab2611983b1f41
 SHA512:
-  metadata.gz: e02c7b7980021f26efd958825dd3c69a06717f6a07c93e94ae812a7bf89383fe44482699e59c6fb78728cdeb935bba86b7e727a7a0142d83ad0ae17d51981f9a
-  data.tar.gz: 1d6f9f6f1f335f4ad5f3507491b15cf9034d9a74029a1c751bf792fe67b6c294a295ad221c6f909c8bac638599d0d717514d58297d1b4c0a4f5aeada4af3c418
+  metadata.gz: f240c1fb0e9388e873e8fb40506dca51f12c867447ef091d5d88adb828f1a6d53a151be1aab047028172df4c298a4a691fdc3792d1e3df14c53d6c024557c73c
+  data.tar.gz: 44d71c5531ef6c704303b9e02173b439feff1a0884120b3bd56e07c96a6482baba8218ba1e42201f1ca0a06a1e344440390b0944e5833266e1d04bf6fc7ea79a

data/CHANGELOG.md

@@ -1,56 +1,63 @@
+2.4.0
+---------
+
+- Fix for support Rails 5.2;
+- Now second_level_cache 2.4.x has required Rails > 5.2;
+- Enable `frozen_string_literal = true`;
+
 2.3.1
------
+-------
 
 - Fix some cases will raise "uninitialized constant SecondLevelCache::Mixin" error. (#66)
 
 2.3.0
------
+-------
 
 * Use Model schema digest as cache_version, so you don't need set `:version` option now. (#60)
 * Fix `store` serialize option (#62)
 * Remove `acts_as_cached` method now! Please use `second_level_cache`. (#59)
 
 2.2.7
------
+-------
 
 * Use `second_level_cache` instead of `acts_as_cached` method to setup in model. (#56)
 
 2.2.6
------
+-------
 
 * Fix warning in Ruby 2.4.0. (#54)
 
 2.2.5
------
+-------
 
 * Flush cache when belongs_to keys are changed; (#51)
 * Fix #52 in ActiveRecord 5.0.1, `records_for` API has changed, it's want an `ActiveRecord::Relation` instance to include a `load` method, but second_level_cached returned an Array. (#53)
 * Fix Rails 5.0.1 `@second_level_cache_enabled` not define warning.
 
 2.2.4
------
+-------
 
 * Fix update conflict in same thread or request context for Cache object. (#49)
 
 2.2.3
------
+-------
 
 * Fix issue with Rails enums. (#43)
 * Fix to update cache on `update_columns`, `update_attribute`. (#43)
 
 2.2.2
------
+-------
 
 * Add `where(id: n).first`, `where(id: n).last` hit cache support. This improve will avoid some gems query database, for example: [devise](https://github.com/plataformatec/devise) `current_user` method.
 
 2.2.1
------
+-------
 
 * ActiveRecord 5 ready! Do not support ActiveRecord 4 and lower versions now (use second_level_cache 2.1.x).
 * Requirement Ruby 2.3+.
 
 2.0.0
------
+-------
 
 * ActiveRecord 4 ready!
 * read multi support for preloading. `Article.includes(:user).limit(5).to_a` will fetch all articles' users from cache preferentially.
@@ -58,65 +65,65 @@
 * remove support for find_by_xx which will be removed in Rails 4.1
 
 1.6.2
------
+-------
 
 * [can disable/enable fetch_by_uinq_key method]
 * [Fix Bug: serialized attribute columns marshal issue #11]
 
 1.6.1
------
+-------
 
 * [Fix bug: undefined method `select_all_column?' for []:ActiveRecord::Relation] by sishen
 
 1.6.0
------
+-------
 
 * [write through cache]
 * [disable SecondLevelCache for spicial model]
 * [only cache `SELECT *` query]
 
 1.5.1
------
+-------
 
 * [use new marshal machanism to avoid clear assocation cache manually]
 
 1.5.0
------
+-------
 
 * [add cache version to quick clear cache for special model]
 
 1.4.1
------
+-------
 
 * [fix errors when belongs_to association return nil]
 
 1.4.0
------
+-------
 
 * [cache has one assciation]
 
 1.3.2
------
+-------
 
 * [fix has one assciation issue]
 
 1.3.1
------
+-------
 
 * [clean cache after update_column/increment!/decrement!]
 
 1.3.0
------
+-------
 
 * [clean cache after touch]
 
 1.2.1
------
+-------
 
 * [fix polymorphic association bug]
 
 1.2.0
------
+-------
 
 * [clear cache after update_counters](https://github.com/csdn-dev/second_level_cache/commit/240dde81199124092e0e8ad0500c167ac146e301)
 

data/Gemfile

@@ -1,5 +1,7 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 5.1.0'
+gem "rails", "~> 5.2.0.rc"

data/README.md

@@ -16,7 +16,13 @@ Write-Through: As objects are created, updated, and deleted, all of the caches a
 
 In your gem file:
 
-ActiveRecord 5:
+ActiveRecord 5.2:
+
+```ruby
+gem 'second_level_cache', '~> 2.4.0'
+```
+
+ActiveRecord 5.0.x, 5.1.x:
 
 ```ruby
 gem 'second_level_cache', '~> 2.3.0'

data/Rakefile

@@ -1,10 +1,12 @@
 #!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 task default: :test
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib' << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "lib" << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
 end

data/lib/second_level_cache.rb

@@ -1,8 +1,10 @@
-require 'active_support/all'
-require 'second_level_cache/config'
-require 'second_level_cache/record_marshal'
-require 'second_level_cache/record_relation'
-require 'second_level_cache/active_record'
+# frozen_string_literal: true
+
+require "active_support/all"
+require "second_level_cache/config"
+require "second_level_cache/record_marshal"
+require "second_level_cache/record_relation"
+require "second_level_cache/active_record"
 
 module SecondLevelCache
   def self.configure

data/lib/second_level_cache/active_record.rb

@@ -1,12 +1,14 @@
-require 'second_level_cache/mixin'
-require 'second_level_cache/active_record/base'
-require 'second_level_cache/active_record/core'
-require 'second_level_cache/active_record/fetch_by_uniq_key'
-require 'second_level_cache/active_record/finder_methods'
-require 'second_level_cache/active_record/persistence'
-require 'second_level_cache/active_record/belongs_to_association'
-require 'second_level_cache/active_record/has_one_association'
-require 'second_level_cache/active_record/preloader'
+# frozen_string_literal: true
+
+require "second_level_cache/mixin"
+require "second_level_cache/active_record/base"
+require "second_level_cache/active_record/core"
+require "second_level_cache/active_record/fetch_by_uniq_key"
+require "second_level_cache/active_record/finder_methods"
+require "second_level_cache/active_record/persistence"
+require "second_level_cache/active_record/belongs_to_association"
+require "second_level_cache/active_record/has_one_association"
+require "second_level_cache/active_record/preloader"
 
 # http://api.rubyonrails.org/classes/ActiveSupport/LazyLoadHooks.html
 # ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
@@ -18,5 +20,8 @@ ActiveSupport.on_load(:active_record) do
 
   ActiveRecord::Associations::BelongsToAssociation.send(:prepend, SecondLevelCache::ActiveRecord::Associations::BelongsToAssociation)
   ActiveRecord::Associations::HasOneAssociation.send(:prepend, SecondLevelCache::ActiveRecord::Associations::HasOneAssociation)
-  ActiveRecord::Associations::Preloader::BelongsTo.send(:prepend, SecondLevelCache::ActiveRecord::Associations::Preloader::BelongsTo)
+
+  # Rails 5.2 has removed ActiveRecord::Associations::Preloader::BelongsTo
+  # https://github.com/rails/rails/pull/31079
+  ActiveRecord::Associations::Preloader::Association.send(:prepend, SecondLevelCache::ActiveRecord::Associations::Preloader::BelongsTo)
 end

data/lib/second_level_cache/active_record/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Base

data/lib/second_level_cache/active_record/belongs_to_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Associations

data/lib/second_level_cache/active_record/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Core

data/lib/second_level_cache/active_record/fetch_by_uniq_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module FetchByUniqKey
@@ -7,7 +9,7 @@ module SecondLevelCache
         if obj_id
           begin
             return find(obj_id)
-          rescue
+          rescue StandardError
             return nil
           end
         end
@@ -41,10 +43,10 @@ module SecondLevelCache
       def cache_uniq_key(where_values)
         keys = where_values.collect do |k, v|
           v = Digest::MD5.hexdigest(v) if v && v.size >= 32
-          [k, v].join('_')
+          [k, v].join("_")
         end
 
-        ext_key = keys.join(',')
+        ext_key = keys.join(",")
         "uniq_key_#{name}_#{ext_key}"
       end
     end

data/lib/second_level_cache/active_record/finder_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module FinderMethods
@@ -54,7 +56,7 @@ module SecondLevelCache
         end
 
         record = super(limit)
-        record.write_second_level_cache if record
+        record&.write_second_level_cache
         record
       end
 

data/lib/second_level_cache/active_record/has_one_association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Associations

data/lib/second_level_cache/active_record/persistence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Persistence

data/lib/second_level_cache/active_record/preloader.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module ActiveRecord
     module Associations
       class Preloader
         module BelongsTo
-          def records_for(ids)
-            return super(ids) unless klass.second_level_cache_enabled?
+          def records_for(ids, &block)
+            return super(ids, &block) unless reflection.is_a?(::ActiveRecord::Reflection::BelongsToReflection)
+            return super(ids, &block) unless klass.second_level_cache_enabled?
 
             map_cache_keys = ids.map { |id| klass.second_level_cache_key(id) }
             records_from_cache = ::SecondLevelCache.cache_store.read_multi(*map_cache_keys)
             # NOTICE
             # Rails.cache.read_multi return hash that has keys only hitted.
             # eg. Rails.cache.read_multi(1,2,3) => {2 => hit_value, 3 => hit_value}
-            hitted_ids = records_from_cache.map { |key, _| key.split('/')[2] }
+            hitted_ids = records_from_cache.map { |key, _| key.split("/")[2] }
             missed_ids = ids.map(&:to_s) - hitted_ids
 
             ::SecondLevelCache.logger.info "missed ids -> #{missed_ids.join(',')} | hitted ids -> #{hitted_ids.join(',')}"
@@ -22,7 +25,7 @@ module SecondLevelCache
               return SecondLevelCache::RecordRelation.new(record_marshals)
             end
 
-            records_from_db = super(missed_ids)
+            records_from_db = super(missed_ids, &block)
             records_from_db.map do |r|
               write_cache(r)
             end

data/lib/second_level_cache/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   class Config
     class << self
@@ -14,7 +16,7 @@ module SecondLevelCache
       end
 
       def cache_key_prefix
-        @cache_key_prefix ||= 'slc'
+        @cache_key_prefix ||= "slc"
       end
     end
   end

data/lib/second_level_cache/mixin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   module Mixin
     extend ActiveSupport::Concern
@@ -39,7 +41,7 @@ module SecondLevelCache
         return @cache_version if defined? @cache_version
         # This line is copy from:
         # https://github.com/rails/rails/blob/f9a5f48/activerecord/lib/active_record/core.rb#L236
-        attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ', '
+        attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ", "
         model_schema_digest = Digest::MD5.hexdigest(attr_list)
         @cache_version = "#{second_level_cache_options[:version]}/#{model_schema_digest}"
       end

data/lib/second_level_cache/record_marshal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RecordMarshal
   class << self
     # dump ActiveRecord instace with only attributes.

data/lib/second_level_cache/record_relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SecondLevelCache
   class RecordRelation < Array
     # A fake Array for fix ActiveRecord 5.0.1 records_for method changed bug

data/lib/second_level_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecondLevelCache
-  VERSION = '2.3.3'.freeze
+  VERSION = "2.4.0"
 end

data/second_level_cache.gemspec

@@ -30,12 +30,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = SecondLevelCache::VERSION
 
-  gem.add_runtime_dependency 'activesupport', ['>= 5.0.0', '< 5.2']
-  gem.add_runtime_dependency 'activerecord', ['>= 5.0.0', '< 5.2']
+  gem.add_runtime_dependency 'activesupport', ['>= 5.2.0.rc', '< 6']
+  gem.add_runtime_dependency 'activerecord', ['>= 5.2.0.rc', '< 6']
 
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'database_cleaner', '~> 1.3.0'
-  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'rubocop', "~> 0.52.0"
 end

data/test/active_record_test_case_helper.rb

@@ -1,4 +1,6 @@
-require 'active_support/test_case'
+# frozen_string_literal: true
+
+require "active_support/test_case"
 
 module ActiveRecordTestCaseHelper
   def teardown
@@ -48,7 +50,7 @@ module ActiveRecordTestCaseHelper
     x = yield
     the_log = ignore_none ? SQLCounter.log_all : SQLCounter.log
     if num == :any
-      assert_operator the_log.size, :>=, 1, '1 or more queries expected, but none were executed.'
+      assert_operator the_log.size, :>=, 1, "1 or more queries expected, but none were executed."
     else
       mesg = "#{the_log.size} instead of #{num} queries were executed.#{the_log.empty? ? '' : "\nQueries:\n#{the_log.join("\n")}"}"
       assert_equal num, the_log.size, mesg
@@ -110,13 +112,13 @@ module ActiveRecordTestCaseHelper
 
       # FIXME: this seems bad. we should probably have a better way to indicate
       # the query was cached
-      return if 'CACHE' == values[:name]
+      return if values[:name] == "CACHE"
 
       self.class.log_all << sql
-      self.class.log << sql unless ignore =~ sql
+      self.class.log << sql unless ignore.match?(sql)
     end
 
-    ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
+    ActiveSupport::Notifications.subscribe("sql.active_record", SQLCounter.new)
   end
 end