second_level_cache 2.5.2 → 2.6.3

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/mixin.rb

@@ -71,23 +71,11 @@ module SecondLevelCache
 
     def write_second_level_cache
       return unless klass.second_level_cache_enabled?
-      # Avoid rewrite cache again, when record has been soft deleted
-      return if respond_to?(:deleted?) && send(:deleted?)
 
       marshal = RecordMarshal.dump(self)
       expires_in = klass.second_level_cache_options[:expires_in]
-      expire_changed_association_uniq_keys
       SecondLevelCache.cache_store.write(second_level_cache_key, marshal, expires_in: expires_in)
     end
-
     alias update_second_level_cache write_second_level_cache
-
-    def expire_changed_association_uniq_keys
-      reflections = klass.reflections.select { |_, reflection| reflection.belongs_to? }
-      changed_keys = reflections.map { |_, reflection| reflection.foreign_key } & previous_changes.keys
-      changed_keys.each do |key|
-        SecondLevelCache.cache_store.delete(klass.send(:cache_uniq_key, key => previous_changes[key][0]))
-      end
-    end
   end
 end

data/lib/second_level_cache/record_marshal.rb

@@ -2,54 +2,21 @@
 
 module RecordMarshal
   class << self
-    # dump ActiveRecord instace with only attributes.
-    # ["User",
-    #  {"id"=>30,
-    #  "email"=>"dddssddd@gmail.com",
-    #  "created_at"=>2012-07-25 18:25:57 UTC
-    #  }
-    # ]
-
+    # dump ActiveRecord instance with only attributes before type cast.
     def dump(record)
-      [record.class.name, record.attributes]
+      [record.class.name, record.attributes_before_type_cast]
     end
 
     # load a cached record
-    def load(serialized)
+    def load(serialized, &block)
       return unless serialized
-      # fix issues 19
-      # fix 2.1.2 object.changed? ActiveRecord::SerializationTypeMismatch: Attribute was supposed to be a Hash, but was a String. -- "{:a=>\"t\", :b=>\"x\"}"
-      # fix 2.1.4 object.changed? is true
-      # fix Rails 4.2 is deprecating `serialized_attributes` without replacement to Rails 5 is deprecating `serialized_attributes` without replacement
-      klass = serialized[0].constantize
-      attributes = serialized[1]
-
-      # for ActiveRecord 5.0.0
-      klass.columns.each do |c|
-        name = c.name
-        cast_type = klass.attribute_types[name]
-        next unless cast_type.is_a?(::ActiveRecord::Type::Serialized)
-        coder = cast_type.coder
-        next if attributes[name].nil? || attributes[name].is_a?(String)
-        if coder.is_a?(::ActiveRecord::Coders::YAMLColumn)
-          attributes[name] = coder.dump(attributes[name]) if attributes[name].is_a?(coder.object_class)
-        elsif coder.is_a?(::ActiveRecord::Store::IndifferentCoder)
-          # https://github.com/rails/rails/blob/5b14129/activerecord/lib/active_record/store.rb#L179
-          attributes[name] = coder.dump(attributes[name])
-        elsif coder == ::ActiveRecord::Coders::JSON
-          attributes[name] = attributes[name].to_json
-        end
-      end
-
-      klass.defined_enums.each do |key, value|
-        attributes[key] = value[attributes[key]] if attributes[key].is_a?(String)
-      end
 
-      klass.instantiate(attributes)
+      serialized[0].constantize.instantiate(serialized[1], &block)
     end
 
-    def load_multi(serializeds)
-      serializeds.map { |serialized| load(serialized) }
+    # load multi cached records
+    def load_multi(serializeds, &block)
+      serializeds.map { |serialized| load(serialized, &block) }
     end
   end
 end

data/lib/second_level_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecondLevelCache
-  VERSION = "2.5.2"
+  VERSION = "2.6.3"
 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
@@ -76,6 +76,16 @@ module ActiveRecordTestCaseHelper
     model.column_names.include?(column_name.to_s)
   end
 
+  def savepoint
+    if ActiveRecord::Base.connection.supports_savepoints?
+      ActiveRecord::Base.connection.begin_transaction(joinable: false)
+      yield
+      ActiveRecord::Base.connection.rollback_transaction
+    else
+      yield
+    end
+  end
+
   class SQLCounter
     class << self
       attr_accessor :ignored_sql, :log, :log_all

data/test/fetch_by_uniq_key_test.rb

@@ -6,14 +6,30 @@ class FetchByUinqKeyTest < ActiveSupport::TestCase
   def setup
     @user = User.create name: "hooopo", email: "hoooopo@gmail.com"
     @post = Post.create slug: "foobar", topic_id: 2
+    @cache_prefix = SecondLevelCache.configure.cache_key_prefix
   end
 
   def test_cache_uniq_key
-    assert_equal User.send(:cache_uniq_key, name: "hooopo"), "uniq_key_User_name_hooopo"
-    assert_equal User.send(:cache_uniq_key, foo: 1, bar: 2), "uniq_key_User_foo_1,bar_2"
-    assert_equal User.send(:cache_uniq_key, foo: 1, bar: nil), "uniq_key_User_foo_1,bar_"
+    assert_equal User.send(:cache_uniq_key, name: "hooopo"), "#{@cache_prefix}/uniq_key_User_name_hooopo"
+    assert_equal User.send(:cache_uniq_key, foo: 1, bar: 2), "#{@cache_prefix}/uniq_key_User_foo_1,bar_2"
+    assert_equal User.send(:cache_uniq_key, foo: 1, bar: nil), "#{@cache_prefix}/uniq_key_User_foo_1,bar_"
     long_val = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
-    assert_equal User.send(:cache_uniq_key, foo: 1, bar: long_val), "uniq_key_User_foo_1,bar_#{Digest::MD5.hexdigest(long_val)}"
+    assert_equal User.send(:cache_uniq_key, foo: 1, bar: long_val), "#{@cache_prefix}/uniq_key_User_foo_1,bar_#{Digest::MD5.hexdigest(long_val)}"
+    assert Contribution.send(:cache_uniq_key, user_id: 1, date: Time.current.to_date), "#{@cache_prefix}/uniq_key_Contribution_user_id_1,date_#{Time.current.to_date}"
+  end
+
+  def test_record_attributes_equal_where_values
+    book = Book.new
+    assert_no_queries do
+      book.title = "foobar"
+      assert Book.send(:record_attributes_equal_where_values?, book, title: :foobar)
+      book.discount_percentage = 60.00
+      assert Book.send(:record_attributes_equal_where_values?, book, discount_percentage: "60")
+      book.publish_date = Time.current.to_date
+      assert Book.send(:record_attributes_equal_where_values?, book, publish_date: Time.current.to_date.to_s)
+      book.title = nil
+      assert Book.send(:record_attributes_equal_where_values?, book, title: nil)
+    end
   end
 
   def test_should_query_from_db_using_primary_key
@@ -51,4 +67,31 @@ class FetchByUinqKeyTest < ActiveSupport::TestCase
     user = User.fetch_by_uniq_key(@user.name, :name)
     assert_equal user, @user
   end
+
+  def test_should_return_correct_when_destroy_old_record_and_create_same_new_record
+    savepoint do
+      uniq_key = { email: "#{Time.now.to_i}@foobar.com" }
+      old_user = User.create(uniq_key)
+      new_user = old_user.deep_dup
+      assert_equal old_user, User.fetch_by_uniq_keys(uniq_key)
+      old_user.destroy
+
+      # Dirty id cache should be removed
+      assert_queries(2) { assert_nil User.fetch_by_uniq_keys(uniq_key) }
+      assert_queries(1) { assert_nil User.fetch_by_uniq_keys(uniq_key) }
+
+      new_user.save
+      assert_equal new_user, User.fetch_by_uniq_keys(uniq_key)
+    end
+  end
+
+  def test_should_return_correct_when_old_record_modify_uniq_key_and_new_record_use_same_uniq_key
+    savepoint do
+      uniq_key = { email: @user.email }
+      assert_equal @user, User.fetch_by_uniq_keys(uniq_key)
+      @user.update_attribute(:email, "#{Time.now.to_i}@foobar.com")
+      new_user = User.create(uniq_key)
+      assert_equal new_user, User.fetch_by_uniq_keys(uniq_key)
+    end
+  end
 end

data/test/finder_methods_test.rb

@@ -59,6 +59,45 @@ class FinderMethodsTest < ActiveSupport::TestCase
     refute_equal @user.name, @from_db.name
   end
 
+  def test_should_fetch_from_db_if_where_use_string
+    @user.write_second_level_cache
+    assert_queries(:any) do
+      assert_nil User.unscoped.where(id: @user.id).where("name = 'nonexistent'").first
+    end
+    assert_queries(:any) do
+      assert_raises ActiveRecord::RecordNotFound do
+        User.where("name = 'nonexistent'").find(@user.id)
+      end
+    end
+  end
+
+  def test_should_fetch_from_db_when_use_eager_load
+    @user.write_second_level_cache
+    assert_queries(:any) do
+      assert_sql(/LEFT\sOUTER\sJOIN\s\"books\"/m) do
+        User.eager_load(:books).find(@user.id)
+      end
+    end
+  end
+
+  def test_should_fetch_from_db_when_use_includes
+    @user.write_second_level_cache
+    assert_queries(:any) do
+      assert_sql(/SELECT\s\"books\"\.\*\sFROM\s\"books\"/m) do
+        User.includes(:books).find(@user.id)
+      end
+    end
+  end
+
+  def test_should_fetch_from_db_when_use_preload
+    @user.write_second_level_cache
+    assert_queries(:any) do
+      assert_sql(/SELECT\s\"books\"\.\*\sFROM\s\"books\"/m) do
+        User.preload(:books).find(@user.id)
+      end
+    end
+  end
+
   def test_where_and_first_should_with_cache
     @user.write_second_level_cache
     assert_no_queries do

data/test/has_one_association_test.rb

@@ -20,10 +20,16 @@ class HasOneAssociationTest < ActiveSupport::TestCase
     clean_user = user.reload
     assert_equal User, clean_user.forked_from_user.class
     assert_equal @user.id, user.forked_from_user.id
-    # clean_user = user.reload
-    # assert_no_queries do
-    #   clean_user.forked_from_user
-    # end
+    # If ForkedUserLink second_level_cache_enabled is true
+    user.reload
+    assert_no_queries do
+      user.forked_from_user
+    end
+    # IF ForkedUserLink second_level_cache_enabled is false
+    user.reload
+    ForkedUserLink.without_second_level_cache do
+      assert_queries(1) { user.forked_from_user }
+    end
   end
 
   def test_has_one_with_conditions
@@ -49,4 +55,10 @@ class HasOneAssociationTest < ActiveSupport::TestCase
     @account.update(user_id: @user.id + 1)
     assert_nil @user.reload.account
   end
+
+  def test_should_one_query_when_has_one_target_is_null
+    Namespace.destroy_all
+    @user.reload
+    assert_queries(1) { @user.namespace }
+  end
 end

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
+  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

@@ -4,12 +4,17 @@ ActiveRecord::Base.connection.create_table(:books, force: true) do |t|
   t.string  :title
   t.string  :body
   t.integer :user_id
+  t.decimal :discount_percentage, precision: 5, scale: 2
   t.integer :images_count, default: 0
+  t.date    :publish_date
+  t.boolean :normal, default: true, nil: false
 end
 
-class Book < ActiveRecord::Base
+class Book < ApplicationRecord
   second_level_cache
 
+  default_scope -> { where(normal: true) }
+
   belongs_to :user, counter_cache: true
   has_many :images, as: :imagable
 end

data/test/model/contribution.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+ActiveRecord::Base.connection.create_table(:contributions, force: true) do |t|
+  t.integer :user_id
+  t.text    :data
+  t.date    :date
+end
+
+class Contribution < ApplicationRecord
+  second_level_cache
+
+  validates_uniqueness_of :user_id, scope: :date, if: -> { user_id_changed? || date_changed? }
+  belongs_to :user
+end

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/paranoid.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+ActiveRecord::Base.connection.create_table(:paranoids, force: true) do |t|
+  t.datetime :deleted_at
+end
+
+class Paranoid < ApplicationRecord
+  second_level_cache
+  acts_as_paranoid
+end