activerecord-batch_touching 1.0.pre.beta4 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e3ae09116c725e745e467afa1d834b6b2a28bcae4f01d5346e598235bb7d0a8
-  data.tar.gz: 842acced5ccc6df3149f4ae60b2b7f574f1bf04a553a67b54d6832c1501b94ee
+  metadata.gz: f994be54523c59f7878cbcf822ca03552bb3a365215cb3de7f23c05541381c75
+  data.tar.gz: aeab5dbe2bebca4b0b88d2a77ce033b7a288969fe6bddb18c74e332ec729a6bf
 SHA512:
-  metadata.gz: 5339c3f783b5b4e8f667a47437fa26e507353d648fd99f637ea73925c28d07d626c7eeb9a8850552ae4182ebb1d36ae9acb5acbe0e2d42e7b0d9f1664a0d86d7
-  data.tar.gz: bf5025309b66d19d7571ef34a3701eb23d9d8c054b68619bb6ad1f881439b37eb99e2a6fdd67e53dbadccf585ea41ae2703ee09fe10d3a81dd9e422675aa8b56
+  metadata.gz: '0808dfbb8f5ea2fedbd51feaf8c453f9224699017d5c33c54a8c08ff02396b52524b67691937ba9b48b838f84257abf0eab3280500bb976945b7eec7302fc89a'
+  data.tar.gz: 4237add83e7f90d3c6852f3221daa31e798eedc2a2b780193e2eab71ae8d17c831c8d2076d899bfed1e84cf830285d501d820fd34ca942223e0f7b53dc5876f2

data/lib/activerecord/batch_touching/state.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   # = Active Record Batch Touching
   module BatchTouching
-
     # Tracking of the touch state. This class has no class-level data, so you can
     # store per-thread instances in thread-local variables.
     class State # :nodoc:

data/lib/activerecord/batch_touching/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Activerecord
   module BatchTouching
-    VERSION = "1.0"
+    VERSION = "1.1"
   end
 end

data/lib/activerecord/batch_touching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "activerecord/batch_touching/version"
 require "activerecord/batch_touching/state"
 
@@ -20,9 +22,17 @@ module ActiveRecord
     #     Person.first.touch
     #   end
     def transaction(requires_new: nil, isolation: nil, joinable: true, &block)
-      super(requires_new: requires_new, isolation: isolation, joinable: joinable) do
+      result = super(requires_new: requires_new, isolation: isolation, joinable: joinable) do
         BatchTouching.start(requires_new: requires_new, &block)
       end
+
+      if BatchTouching.should_apply_touches?
+        super() do
+          BatchTouching.apply_touches
+        end
+      end
+
+      result
     end
   end
 
@@ -67,7 +77,7 @@ module ActiveRecord
 
       # Disable batch touching for a block
       def disable
-        Thread.current[:batch_touching_disabled] = false
+        Thread.current[:batch_touching_disabled] = true
         yield
       ensure
         Thread.current[:batch_touching_disabled] = false
@@ -77,12 +87,18 @@ module ActiveRecord
         Thread.current[:batch_touching_disabled] || @disabled
       end
 
-      def states
-        Thread.current[:batch_touching_states] ||= []
-      end
+      # Start batching all touches. When done, apply them. (Unless nested.)
+      def start(requires_new:)
+        states.push State.new
+        yield.tap do
+          gather_touches if states.length == 1
+        end
+      ensure
+        merge_transactions unless $! && requires_new
 
-      def current_state
-        states.last
+        # Decrement nesting even if +gather_touches+ raised an error. To ensure the stack of States
+        # is empty after the top-level transaction exits.
+        states.pop
       end
 
       delegate :add_record, to: :current_state
@@ -91,18 +107,40 @@ module ActiveRecord
         states.present? && !disabled?
       end
 
-      # Start batching all touches. When done, apply them. (Unless nested.)
-      def start(options = {})
-        states.push State.new
-        yield.tap do
-          apply_touches if states.length == 1
+      def should_apply_touches?
+        batched_touches.present?
+      end
+
+      def apply_touches
+        batched_touches&.each do |(klass, columns), records|
+          records.reject!(&:destroyed?)
+          touch_records klass, columns, records, batched_touches_time
         end
-      ensure
-        merge_transactions unless $! && options[:requires_new]
 
-        # Decrement nesting even if +apply_touches+ raised an error. To ensure the stack of States
-        # is empty after the top-level transaction exits.
-        states.pop
+        reset!
+      end
+
+      private
+
+      def reset!
+        Thread.current[:batch_touching_batch] = nil
+        Thread.current[:batch_touching_time] = nil
+      end
+
+      def batched_touches
+        Thread.current[:batch_touching_batch]
+      end
+
+      def batched_touches_time
+        Thread.current[:batch_touching_time]
+      end
+
+      def states
+        Thread.current[:batch_touching_states] ||= []
+      end
+
+      def current_state
+        states.last
       end
 
       # When exiting a nested transaction, merge the nested transaction's
@@ -111,56 +149,60 @@ module ActiveRecord
         states[-2].merge!(current_state) if states.length > 1
       end
 
-      # Apply the touches that were batched. We're in a transaction already so there's no need to open one.
-      def apply_touches
+      # Gather all the touches that were batched.
+      def gather_touches
         current_time = ActiveRecord::Base.current_time_from_proper_timezone
-        callbacks_run = Set.new
+        already_touched = Set.new
         all_states = State.new
         while current_state.more_records?
           all_states.merge!(current_state)
           state_records = current_state.records
           current_state.clear_records!
           state_records.each do |(_klass, columns), records|
-            soft_touch_records(columns, records, current_time, callbacks_run)
+            soft_touch_records(columns, records, current_time, already_touched)
           end
         end
 
         # Sort by class name. Having a consistent order can help mitigate deadlocks.
-        sorted_records = all_states.records.keys.sort_by { |k| k.first.name }.map { |k| [k, all_states.records[k]] }.to_h
-        sorted_records.each do |(klass, columns), records|
-          records.reject!(&:destroyed?)
-          touch_records klass, columns, records, current_time if records.present?
-        end
+        sorted_records = all_states.records.keys.sort_by { |k| k.first.name }.to_h { |k| [k, all_states.records[k]] }
+
+        # Save results to a thread so that we can reference these later in their own transaction.
+        Thread.current[:batch_touching_batch] = sorted_records
+        Thread.current[:batch_touching_time] = current_time
+      end
+
+      # Perform DB update to touch records
+      def touch_records(klass, columns, records, time)
+        return if columns.blank? || records.blank?
+
+        sql = columns.map { |column| "#{klass.connection.quote_column_name(column)} = :time" }.join(", ")
+        sql += ", #{klass.locking_column} = #{klass.locking_column} + 1" if klass.locking_enabled?
+
+        klass.unscoped.where(klass.primary_key => records.to_a).update_all([sql, time: time])
       end
 
-      # Only set new timestamp in memory.
-      # Running callbacks also allows us to collect more touches (i.e. touch: true for associations).
-      def soft_touch_records(columns, records, time, callbacks_run)
+      # Set new timestamp in memory, without updating the DB just yet.
+      def soft_touch_records(columns, records, time, already_touched)
+        return if columns.blank? || records.blank?
+
         records.each do |record|
-          record.instance_eval do
-            unless destroyed?
-              columns.each { |column| write_attribute column, time }
-              if locking_enabled?
-                self[self.class.locking_column] += 1
-                clear_attribute_change(self.class.locking_column)
-              end
-              clear_attribute_changes(columns)
-            end
-            unless callbacks_run.include?(record)
-              record._run_touch_callbacks
-              callbacks_run.add(record)
-            end
-          end
+          next if record.destroyed? || already_touched.include?(record)
+
+          soft_touch_record(columns, record, time)
+
+          # Running callbacks also allows us to collect more touches (i.e. touch: true for associations).
+          record._run_touch_callbacks
+          already_touched.add(record)
         end
       end
 
-      # Touch the specified records--non-empty set of instances of the same class.
-      def touch_records(klass, columns, records, time)
-        if columns.present?
-          sql = columns.map { |column| "#{klass.connection.quote_column_name(column)} = :time" }.join(", ")
-          sql += ", #{klass.locking_column} = #{klass.locking_column} + 1" if klass.locking_enabled?
-
-          klass.unscoped.where(klass.primary_key => records.to_a).update_all([sql, time: time])
+      def soft_touch_record(columns, record, time)
+        columns.each { |column| record.write_attribute column, time }
+        if record.locking_enabled?
+          record[record.class.locking_column] += 1
+          record.clear_attribute_changes(columns + [record.class.locking_column])
+        else
+          record.clear_attribute_changes(columns)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-batch_touching
 version: !ruby/object:Gem::Version
-  version: 1.0.pre.beta4
+  version: '1.1'
 platform: ruby
 authors:
 - Brian Morearty
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,6 +151,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Batch up your ActiveRecord "touch" operations for better performance.
   All accumulated "touch" calls will be consolidated into as few database round trips
   as possible.
@@ -136,10 +192,11 @@ files:
 - lib/activerecord/batch_touching.rb
 - lib/activerecord/batch_touching/state.rb
 - lib/activerecord/batch_touching/version.rb
-homepage: ''
+homepage: https://github.com/ProductPlan/activerecord-batch_touching
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -148,12 +205,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key: