second_level_cache 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6cfa929a72e1977223e5fc958b58ead3b3fa81daccbf38d4efe7e4ffc1d608d
-  data.tar.gz: 5709808afb6c5ee8d5937e1ce944005b528c4550e30d0db08b067864a5984d83
+  metadata.gz: 0056aa765b7668e44d115f964c4fb11f1632ecf99206145c89aed0fb58f2b4d0
+  data.tar.gz: a4fb19d6ff3859c728c7d8a43f28f64bb092c89226772de31b5b22f1e57e2cf6
 SHA512:
-  metadata.gz: ee4e3935b1cf774fe00e1432878ffee6104ad5b15c5ad4d6994521b9d5bb7fa183fcbdd97ba3dfd509317f7cd30ebabc0b5f89c18c0dd7aaad028474ef3f7d74
-  data.tar.gz: 173d12fbd5b5b440e37f9d219f9229f0146751debd5c8fa18e54b684ea257ec81a707a46a5b1e39309f9b7bb07784c921ea6a2737d3a681bb7480c9bb8ca6ebf
+  metadata.gz: 32f1cb2460325a2291d2732c2f3ec906c7c16c2c5838564df7bfa56f362c0049d37c1ef2658db6c057faf31183869bbd8d6fc4702f4056f0a8bc4d143933cc68
+  data.tar.gz: 46e242047cd4e0c1c3651dc3e7ff03028d044a96b6c4c915d994114226c5ed30c8668248b14caac8165b51a283ba6ab9455badc5c27c6f7a31468753086216c4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+2.6.1
+-------
+
+- Improve proload debug log output, and deprecated logger method. (#106)
+
 2.6.0
 -------
 

data/lib/second_level_cache.rb

@@ -5,6 +5,7 @@ require "second_level_cache/config"
 require "second_level_cache/record_marshal"
 require "second_level_cache/record_relation"
 require "second_level_cache/active_record"
+require "second_level_cache/log_subscriber"
 
 module SecondLevelCache
   def self.configure

data/lib/second_level_cache/active_record/belongs_to_association.rb

@@ -21,10 +21,9 @@ module SecondLevelCache
         end
 
         private
-
-        def second_level_cache_key
-          owner[reflection.foreign_key]
-        end
+          def second_level_cache_key
+            owner[reflection.foreign_key]
+          end
       end
     end
   end

data/lib/second_level_cache/active_record/fetch_by_uniq_key.rb

@@ -18,10 +18,10 @@ module SecondLevelCache
         record = where(where_values).first
         if record
           SecondLevelCache.cache_store.write(cache_key, record.id)
-          return record
+          record
         else
           SecondLevelCache.cache_store.delete(cache_key)
-          return nil
+          nil
         end
       end
 
@@ -42,21 +42,20 @@ module SecondLevelCache
       end
 
       private
-
-      def cache_uniq_key(where_values)
-        keys = where_values.collect do |k, v|
-          v = Digest::MD5.hexdigest(v) if v.respond_to?(:size) && v.size >= 32
-          [k, v].join("_")
+        def cache_uniq_key(where_values)
+          keys = where_values.collect do |k, v|
+            v = Digest::MD5.hexdigest(v) if v.respond_to?(:size) && v.size >= 32
+            [k, v].join("_")
+          end
+
+          ext_key = keys.join(",")
+          "uniq_key_#{name}_#{ext_key}"
         end
 
-        ext_key = keys.join(",")
-        "uniq_key_#{name}_#{ext_key}"
-      end
-
-      def record_attributes_equal_where_values?(record, where_values)
-        # https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-type_for_attribute
-        where_values.all? { |k, v| record&.read_attribute(k) == type_for_attribute(k).cast(v) }
-      end
+        def record_attributes_equal_where_values?(record, where_values)
+          # https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-type_for_attribute
+          where_values.all? { |k, v| record&.read_attribute(k) == type_for_attribute(k).cast(v) }
+        end
     end
   end
 end

data/lib/second_level_cache/active_record/finder_methods.rb

@@ -55,49 +55,48 @@ module SecondLevelCache
       end
 
       private
+        # readonly_value - active_record/relation/query_methods.rb Rails 5.1 true/false
+        def cachable?
+          second_level_cache_enabled? &&
+            limit_one? &&
+            # !eager_loading? &&
+            includes_values.blank? &&
+            preload_values.blank? &&
+            eager_load_values.blank? &&
+            select_values.blank? &&
+            order_values_can_cache? &&
+            readonly_value.blank? &&
+            joins_values.blank? &&
+            !@klass.locking_enabled? &&
+            where_clause_predicates_all_equality?
+        end
 
-      # readonly_value - active_record/relation/query_methods.rb Rails 5.1 true/false
-      def cachable?
-        second_level_cache_enabled? &&
-          limit_one? &&
-          # !eager_loading? &&
-          includes_values.blank? &&
-          preload_values.blank? &&
-          eager_load_values.blank? &&
-          select_values.blank? &&
-          order_values_can_cache? &&
-          readonly_value.blank? &&
-          joins_values.blank? &&
-          !@klass.locking_enabled? &&
-          where_clause_predicates_all_equality?
-      end
-
-      def order_values_can_cache?
-        return true if order_values.empty?
-        return false unless order_values.one?
-        return true if order_values.first == klass.primary_key
-        return false unless order_values.first.is_a?(::Arel::Nodes::Ordering)
-        return true if order_values.first.expr == klass.primary_key
-        order_values.first.expr.try(:name) == klass.primary_key
-      end
+        def order_values_can_cache?
+          return true if order_values.empty?
+          return false unless order_values.one?
+          return true if order_values.first == klass.primary_key
+          return false unless order_values.first.is_a?(::Arel::Nodes::Ordering)
+          return true if order_values.first.expr == klass.primary_key
+          order_values.first.expr.try(:name) == klass.primary_key
+        end
 
-      def where_clause_predicates_all_equality?
-        where_clause.send(:predicates).size == where_values_hash.size
-      end
+        def where_clause_predicates_all_equality?
+          where_clause.send(:predicates).size == where_values_hash.size
+        end
 
-      def where_values_match_cache?(record)
-        where_values_hash.all? do |key, value|
-          if value.is_a?(Array)
-            value.include?(record.read_attribute(key))
-          else
-            record.read_attribute(key) == value
+        def where_values_match_cache?(record)
+          where_values_hash.all? do |key, value|
+            if value.is_a?(Array)
+              value.include?(record.read_attribute(key))
+            else
+              record.read_attribute(key) == value
+            end
           end
         end
-      end
 
-      def limit_one?
-        limit_value.blank? || limit_value == 1
-      end
+        def limit_one?
+          limit_value.blank? || limit_value == 1
+        end
     end
   end
 end

data/lib/second_level_cache/active_record/has_one_association.rb

@@ -11,17 +11,17 @@ module SecondLevelCache
 
           through = reflection.options[:through]
           record  = if through
-                      return super unless klass.reflections[through.to_s].klass.second_level_cache_enabled?
-                      begin
-                        reflection.klass.find(owner.send(through).read_attribute(reflection.foreign_key))
-                      rescue StandardError
-                        nil
-                      end
-                    else
-                      uniq_keys = { reflection.foreign_key => owner[reflection.active_record_primary_key] }
-                      uniq_keys[reflection.type] = owner.class.base_class.name if reflection.options[:as]
-                      klass.fetch_by_uniq_keys(uniq_keys)
-                    end
+            return super unless klass.reflections[through.to_s].klass.second_level_cache_enabled?
+            begin
+              reflection.klass.find(owner.send(through).read_attribute(reflection.foreign_key))
+            rescue StandardError
+              nil
+            end
+          else
+            uniq_keys = { reflection.foreign_key => owner[reflection.active_record_primary_key] }
+            uniq_keys[reflection.type] = owner.class.base_class.name if reflection.options[:as]
+            klass.fetch_by_uniq_keys(uniq_keys)
+          end
 
           return nil unless record
           record.tap { |r| set_inverse_instance(r) }

data/lib/second_level_cache/active_record/preloader.rb

@@ -15,23 +15,23 @@ module SecondLevelCache
           records_from_cache = ::SecondLevelCache.cache_store.read_multi(*map_cache_keys)
 
           record_marshals = if RAILS6
-                              RecordMarshal.load_multi(records_from_cache.values) do |record|
-                                # This block is copy from:
-                                # https://github.com/rails/rails/blob/6-0-stable/activerecord/lib/active_record/associations/preloader/association.rb#L101
-                                owner = owners_by_key[convert_key(record[association_key_name])].first
-                                association = owner.association(reflection.name)
-                                association.set_inverse_instance(record)
-                              end
-                            else
-                              RecordMarshal.load_multi(records_from_cache.values, &block)
-                            end
+            RecordMarshal.load_multi(records_from_cache.values) do |record|
+              # This block is copy from:
+              # https://github.com/rails/rails/blob/6-0-stable/activerecord/lib/active_record/associations/preloader/association.rb#L101
+              owner = owners_by_key[convert_key(record[association_key_name])].first
+              association = owner.association(reflection.name)
+              association.set_inverse_instance(record)
+            end
+          else
+            RecordMarshal.load_multi(records_from_cache.values, &block)
+          end
 
           # 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 = record_marshals.map { |record| record.read_attribute(association_key_name).to_s }
           missed_ids = ids.map(&:to_s) - hitted_ids
-          ::SecondLevelCache.logger.debug("missed #{association_key_name} -> #{missed_ids.join(',')} | hitted #{association_key_name} -> #{hitted_ids.join(',')}")
+          ActiveSupport::Notifications.instrument("preload.second_level_cache", key: association_key_name, hit: hitted_ids, miss: missed_ids)
           return SecondLevelCache::RecordRelation.new(record_marshals) if missed_ids.empty?
 
           records_from_db = super(missed_ids, &block)
@@ -41,10 +41,9 @@ module SecondLevelCache
         end
 
         private
-
-        def write_cache(record)
-          record.write_second_level_cache
-        end
+          def write_cache(record)
+            record.write_second_level_cache
+          end
       end
     end
   end

data/lib/second_level_cache/config.rb

@@ -11,6 +11,7 @@ module SecondLevelCache
       end
 
       def logger
+        ActiveSupport::Deprecation.warn("logger is deprecated and will be removed from SecondLevelCache 2.7.0")
         @logger ||= Rails.logger if defined?(Rails)
         @logger ||= Logger.new(STDOUT)
       end

data/lib/second_level_cache/log_subscriber.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SecondLevelCache
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # preload.second_level_cache
+    def preload(event)
+      prefix = color("SecondLevelCache", CYAN)
+      miss_ids = (event.payload[:miss] || []).join(",")
+      hit_ids = (event.payload[:hit] || []).join(",")
+      debug "  #{prefix} preload #{event.payload[:key]} miss [#{miss_ids}], hit [#{hit_ids}]"
+    end
+  end
+end
+
+SecondLevelCache::LogSubscriber.attach_to :second_level_cache

data/lib/second_level_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecondLevelCache
-  VERSION = "2.6.0"
+  VERSION = "2.6.1"
 end

data/second_level_cache.gemspec

@@ -1,12 +1,13 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/second_level_cache/version', __FILE__)
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path("../lib/second_level_cache/version", __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Hooopo']
-  gem.email         = ['hoooopo@gmail.com']
-  gem.description   = 'Write Through and Read Through caching library inspired by CacheMoney and cache_fu, support  ActiveRecord 4.'
+  gem.authors       = ["Hooopo"]
+  gem.email         = ["hoooopo@gmail.com"]
+  gem.description   = "Write Through and Read Through caching library inspired by CacheMoney and cache_fu, support  ActiveRecord 4."
   gem.summary       = <<-SUMMARY
   SecondLevelCache is a write-through and read-through caching library inspired by Cache Money and cache_fu, support only Rails3 and ActiveRecord.
 
@@ -15,26 +16,26 @@ Gem::Specification.new do |gem|
   Write-Through: As objects are created, updated, and deleted, all of the caches are automatically kept up-to-date and coherent.
   SUMMARY
 
-  gem.homepage      = 'https://github.com/hooopo/second_level_cache'
+  gem.homepage      = "https://github.com/hooopo/second_level_cache"
 
-  gem.files         = Dir.glob('lib/**/*.rb') + [
-    'README.md',
-    'Rakefile',
-    'Gemfile',
-    'CHANGELOG.md',
-    'second_level_cache.gemspec'
+  gem.files         = Dir.glob("lib/**/*.rb") + [
+    "README.md",
+    "Rakefile",
+    "Gemfile",
+    "CHANGELOG.md",
+    "second_level_cache.gemspec"
   ]
-  gem.test_files    = Dir.glob('test/**/*.rb')
+  gem.test_files    = Dir.glob("test/**/*.rb")
   gem.executables   = gem.files.grep(%r{^bin/})
-  gem.name          = 'second_level_cache'
-  gem.require_paths = ['lib']
+  gem.name          = "second_level_cache"
+  gem.require_paths = ["lib"]
   gem.version       = SecondLevelCache::VERSION
 
-  gem.add_runtime_dependency 'activesupport', ['>= 5.2', '< 7']
-  gem.add_runtime_dependency 'activerecord', ['>= 5.2', '< 7']
+  gem.add_runtime_dependency "activerecord", [">= 5.2", "< 7"]
+  gem.add_runtime_dependency "activesupport", [">= 5.2", "< 7"]
 
-  gem.add_development_dependency 'sqlite3', '> 1.4'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'database_cleaner'
-  gem.add_development_dependency 'rubocop', "~> 0.52.0"
+  gem.add_development_dependency "database_cleaner"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency "sqlite3", "> 1.4"
 end

data/test/active_record_test_case_helper.rb

@@ -21,7 +21,7 @@ module ActiveRecordTestCaseHelper
     yield
 
     stream_io.rewind
-    return captured_stream.read
+    captured_stream.read
   ensure
     captured_stream.close
     captured_stream.unlink

data/test/model/account.rb

@@ -7,7 +7,7 @@ ActiveRecord::Base.connection.create_table(:accounts, force: true) do |t|
   t.timestamps null: false
 end
 
-class Account < ActiveRecord::Base
+class Account < ApplicationRecord
   second_level_cache expires_in: 3.days
   belongs_to :user, foreign_key: :user_id, inverse_of: :account
 end

data/test/model/animal.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:animals, force: true) do |t|
   t.timestamps null: false
 end
 
-class Animal < ActiveRecord::Base
+class Animal < ApplicationRecord
   second_level_cache
 end
 

data/test/model/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/model/book.rb

@@ -10,7 +10,7 @@ ActiveRecord::Base.connection.create_table(:books, force: true) do |t|
   t.boolean :normal, default: true, nil: false
 end
 
-class Book < ActiveRecord::Base
+class Book < ApplicationRecord
   second_level_cache
 
   default_scope -> { where(normal: true) }

data/test/model/contribution.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:contributions, force: true) do |t|
   t.date    :date
 end
 
-class Contribution < ActiveRecord::Base
+class Contribution < ApplicationRecord
   second_level_cache
 
   validates_uniqueness_of :user_id, scope: :date, if: -> { user_id_changed? || date_changed? }

data/test/model/image.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:images, force: true) do |t|
   t.integer :imagable_id
 end
 
-class Image < ActiveRecord::Base
+class Image < ApplicationRecord
   second_level_cache
 
   belongs_to :imagable, polymorphic: true, counter_cache: true

data/test/model/order.rb

@@ -7,7 +7,7 @@ ActiveRecord::Base.connection.create_table(:orders, force: true, id: :uuid) do |
   t.timestamps null: false
 end
 
-class Order < ActiveRecord::Base
+class Order < ApplicationRecord
   second_level_cache
 
   has_many :order_items

data/test/model/order_item.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:order_items, force: true, id: :uuid)
   t.string :order_id
 end
 
-class OrderItem < ActiveRecord::Base
+class OrderItem < ApplicationRecord
   second_level_cache
   belongs_to :order, touch: true
 end

data/test/model/post.rb

@@ -6,7 +6,7 @@ ActiveRecord::Base.connection.create_table(:posts, force: true) do |t|
   t.integer :topic_id
 end
 
-class Post < ActiveRecord::Base
+class Post < ApplicationRecord
   second_level_cache
   belongs_to :topic, touch: true
 end

data/test/model/topic.rb

@@ -7,7 +7,7 @@ ActiveRecord::Base.connection.create_table(:topics, force: true) do |t|
   t.timestamps null: false
 end
 
-class Topic < ActiveRecord::Base
+class Topic < ApplicationRecord
   second_level_cache
 
   has_many :posts

data/test/model/user.rb

@@ -26,7 +26,7 @@ ActiveRecord::Base.connection.create_table(:namespaces, force: true) do |t|
   t.timestamps null: false
 end
 
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   CACHE_VERSION = 3
   second_level_cache(version: CACHE_VERSION, expires_in: 3.days)
   acts_as_paranoid
@@ -46,13 +46,13 @@ class User < ActiveRecord::Base
   enum status: %i[active archived]
 end
 
-class Namespace < ActiveRecord::Base
+class Namespace < ApplicationRecord
   second_level_cache version: 1, expires_in: 3.days
 
   belongs_to :user
 end
 
-class ForkedUserLink < ActiveRecord::Base
+class ForkedUserLink < ApplicationRecord
   second_level_cache version: 1, expires_in: 1.day
 
   belongs_to :forked_from_user, class_name: "User"

data/test/test_helper.rb

@@ -16,6 +16,7 @@ require "second_level_cache"
 
 ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
 
+require "model/application_record"
 require "model/user"
 require "model/book"
 require "model/image"
@@ -33,10 +34,6 @@ SecondLevelCache.configure do |config|
   config.cache_store = ActiveSupport::Cache::MemoryStore.new
 end
 
-SecondLevelCache.logger.level = Logger::INFO
-ActiveSupport::Cache::MemoryStore.logger = SecondLevelCache.logger
-ActiveRecord::Base.logger = SecondLevelCache.logger
-
 module ActiveSupport
   class TestCase
     setup do

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: second_level_cache
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Hooopo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,19 +51,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,19 +93,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: '1.4'
 description: Write Through and Read Through caching library inspired by CacheMoney
   and cache_fu, support  ActiveRecord 4.
 email:
@@ -129,6 +129,7 @@ files:
 - lib/second_level_cache/active_record/persistence.rb
 - lib/second_level_cache/active_record/preloader.rb
 - lib/second_level_cache/config.rb
+- lib/second_level_cache/log_subscriber.rb
 - lib/second_level_cache/mixin.rb
 - lib/second_level_cache/record_marshal.rb
 - lib/second_level_cache/record_relation.rb
@@ -143,6 +144,7 @@ files:
 - test/has_one_association_test.rb
 - test/model/account.rb
 - test/model/animal.rb
+- test/model/application_record.rb
 - test/model/book.rb
 - test/model/contribution.rb
 - test/model/image.rb
@@ -211,6 +213,7 @@ test_files:
 - test/model/topic.rb
 - test/model/animal.rb
 - test/model/order.rb
+- test/model/application_record.rb
 - test/model/post.rb
 - test/model/user.rb
 - test/fetch_by_uniq_key_test.rb