identity_cache 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463112ddb217364a26a8232ef1958c45bdb24fc7dcd891be3e7d4db4ca4d29a4
-  data.tar.gz: 13ea742aca4c33f710a6f8a229f6cf0531dba50291c1ec7c67bce735028ce527
+  metadata.gz: 0daa9d36baa2b4c2e08dc8c29ab55274a1dbfab1d0146010720a68bfe9eff20e
+  data.tar.gz: '08708fb388587b7def00967250321904ffbfa9c071aca71f6b360ea22ec0ab8f'
 SHA512:
-  metadata.gz: d4c3cae9c3c4a6444f62d84242326da8901e0aa66895c8b6d2916930a5824fe402299d5e7c6270982e37fa9cd97991310756320aea0fb93b64a1f515a27f1c1f
-  data.tar.gz: 5512f9b845a4bc9ea8821d6e8563bc4307ba46a32fe32f1f5d2a708b624be3a5ed72c1b64fe2a9ade21f52ffa8d6c3220e23bc3bb433249bceb4d6eacdf7ba67
+  metadata.gz: 61e4c7010330259878bb07f61a806b2b8d21d3cfbc67d07074cd9dddafd69471c6aa50ebdf880e39b9a0dba7203d0215f1336829842457ea877e3f065ce8e98e
+  data.tar.gz: e1d0f10f2a4a3ff678b4b89b60547c342ab6a0ce8f5d1623ebcdb29c227e08ee7da8234c32ed3388b745aa11f4be1989d5a554a521152bdd72ebaa9c92cc9747

data/.gitignore

@@ -16,3 +16,4 @@ test/version_tmp
 tmp
 .rubocop-http*
 .byebug_history
+gemfiles/*.lock

data/CHANGELOG.md

@@ -2,9 +2,13 @@
 
 ## Unreleased
 
+## 1.6.3
+
+- Split the `with_deferred_parent_expiration` and `with_deferred_parent_expiration`. (#578)
+
 ## 1.6.2
 
-- Support deferred expiry of associations and attributes. Add a rake task to create test database.
+- Support deferred expiry of associations and attributes. Add a rake task to create test database. (#577)
 
 ## 1.6.1
 

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    identity_cache (1.6.2)
+    identity_cache (1.6.3)
       activerecord (>= 7.0)
       ar_transaction_changes (~> 1.1)
 

data/Rakefile

@@ -9,14 +9,82 @@ require "rdoc/task"
 desc("Default: run tests and style checks.")
 task(default: [:test, :rubocop])
 
-desc("Test the identity_cache plugin.")
-Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = true
+namespace :test do
+  desc "Test the identity_cache plugin with default Gemfile"
+  Rake::TestTask.new(:default) do |t|
+    t.libs << "lib"
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = true
+  end
+
+  desc "Test the identity_cache plugin with minimum supported dependencies"
+  task :min_supported do
+    gemfile = File.expand_path("gemfiles/Gemfile.min-supported", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_min_supported) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_min_supported"].invoke
+  end
+
+  desc "Test the identity_cache plugin with latest released dependencies"
+  task :latest_release do
+    gemfile = File.expand_path("gemfiles/Gemfile.latest-release", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_latest_release) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_latest_release"].invoke
+  end
+
+  desc "Test the identity_cache plugin with rails edge dependencies"
+  task :rails_edge do
+    gemfile = File.expand_path("gemfiles/Gemfile.rails-edge", __dir__)
+    ENV["BUNDLE_GEMFILE"] = gemfile
+
+    puts "\nInstalling dependencies for #{gemfile}..."
+    Bundler.with_unbundled_env do
+      system("bundle install --gemfile #{gemfile}") || abort("Bundle install failed")
+    end
+
+    puts "Running tests with #{gemfile}..."
+    Rake::TestTask.new(:run_rails_edge) do |t|
+      t.libs << "lib"
+      t.libs << "test"
+      t.pattern = "test/**/*_test.rb"
+      t.verbose = true
+    end
+    Rake::Task["run_rails_edge"].invoke
+  end
 end
 
+desc "Run default tests"
+task test: ["test:default"]
+
+desc "Run all tests (default, min_supported, latest_release, rails_edge)"
+task test_all: ["test:default", "test:min_supported", "test:latest_release", "test:rails_edge"]
+
 task :rubocop do
   require "rubocop/rake_task"
   RuboCop::RakeTask.new

data/dev.yml

@@ -24,6 +24,10 @@ commands:
         bundle exec ruby -I test "$@"
       fi
 
+  test-all:
+    desc: "Run tests for all gemfiles (default, min_supported, latest_release, rails_edge)"
+    run: bundle exec rake test_all
+
   style:
     desc: "Run rubocop checks"
     run: bundle exec rubocop "$@"

data/lib/identity_cache/parent_model_expiration.rb

@@ -47,6 +47,10 @@ module IdentityCache
       add_parents_to_cache_expiry_set(parents_to_expire)
       parents_to_expire.select! { |parent| parent.class.primary_cache_index_enabled }
       parents_to_expire.reduce(true) do |all_expired, parent|
+        if Thread.current[:idc_deferred_parent_expiration]
+          Thread.current[:idc_parent_records_for_cache_expiry] << parent
+          next parent
+        end
         parent.expire_primary_index && all_expired
       end
     end

data/lib/identity_cache/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module IdentityCache
-  VERSION = "1.6.2"
+  VERSION = "1.6.3"
   CACHE_VERSION = 8
 end

data/lib/identity_cache.rb

@@ -60,6 +60,8 @@ module IdentityCache
 
   class InverseAssociationError < StandardError; end
 
+  class NestedDeferredParentBlockError < StandardError; end
+
   class NestedDeferredCacheExpirationBlockError < StandardError; end
 
   class UnsupportedScopeError < StandardError; end
@@ -202,6 +204,48 @@ module IdentityCache
       result
     end
 
+    # Executes a block with deferred parent expiration, ensuring that the parent
+    # records' cache expiration is deferred until the block completes. When the block
+    # completes, it triggers expiration of the primary index for the parent records.
+    # Raises a NestedDeferredParentBlockError if a deferred parent expiration block
+    # is already active on the current thread.
+    #
+    # == Parameters:
+    # No parameters.
+    #
+    # == Raises:
+    # NestedDeferredParentBlockError if a deferred parent expiration block is already active.
+    #
+    # == Yield:
+    # Runs the provided block with deferred parent expiration.
+    #
+    # == Returns:
+    # The result of executing the provided block.
+    #
+    # == Ensures:
+    # Cleans up thread-local variables related to deferred parent expiration regardless
+    # of whether the block raises an exception.
+    def with_deferred_parent_expiration
+      raise NestedDeferredParentBlockError if Thread.current[:idc_deferred_parent_expiration]
+
+      if Thread.current[:idc_deferred_expiration]
+        deprecator.deprecation_warning("`with_deferred_parent_expiration`")
+      end
+
+      Thread.current[:idc_deferred_parent_expiration] = true
+      Thread.current[:idc_parent_records_for_cache_expiry] = Set.new
+
+      result = yield
+
+      Thread.current[:idc_deferred_parent_expiration] = nil
+      Thread.current[:idc_parent_records_for_cache_expiry].each(&:expire_primary_index)
+
+      result
+    ensure
+      Thread.current[:idc_deferred_parent_expiration] = nil
+      Thread.current[:idc_parent_records_for_cache_expiry]&.clear
+    end
+
     # Executes a block with deferred cache expiration, ensuring that the records' (parent,
     # children and attributes) cache expiration is deferred until the block completes. When
     # the block completes, it issues delete_multi calls for all the records and attributes
@@ -225,6 +269,10 @@ module IdentityCache
     def with_deferred_expiration
       raise NestedDeferredCacheExpirationBlockError if Thread.current[:idc_deferred_expiration]
 
+      if Thread.current[:idc_deferred_parent_expiration]
+        deprecator.deprecation_warning("`with_deferred_parent_expiration`")
+      end
+
       Thread.current[:idc_deferred_expiration] = true
       Thread.current[:idc_records_to_expire] = Set.new
       Thread.current[:idc_attributes_to_expire] = Set.new
@@ -268,6 +316,10 @@ module IdentityCache
       ParentModelExpiration.install_all_pending_parent_expiry_hooks
     end
 
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("1.7.0", "IdentityCache")
+    end
+
     private
 
     def fetch_in_batches(keys, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identity_cache
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Camilo Lopez
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: IdentityCache lets you specify how you want to cache your model objects,