activerecord-batch_touching 1.0.pre.beta2 → 1.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd952639925581e1a9402a4e1542ca8be34e826ee23754742381daea8465f59d
-  data.tar.gz: 061f01b40c568b24b9c383558c63f87bf29e27ded41192ae30d5afc0106294af
+  metadata.gz: 06aa6d889559fed96fed448ffb100324496a79d1e97e147607067f1a3275ab92
+  data.tar.gz: 5a737bed02b7812f0feba746bf2ea19bfece091959bdaa25a465dae634b1c38c
 SHA512:
-  metadata.gz: 25f107a0f99f1e951a5ec5c83115aab53c90676ffbc9652e170566fbd933fa61a18e1649a0a885a29e935fd08aa27dcc26450632c86c69230792cc48f5e6c799
-  data.tar.gz: a231c2bfc1aefd7d56b537c41d5a0f887660a4b4d842e1f066a6e65057402471fe8be1fc456eecb92c901f4e8b45bd13308a6c2a84c7c1f1b8343a7e14463108
+  metadata.gz: b0add569ae81b020e75b5168b00e550d4f69a67cf8e24e5adbb6f45808339ac0d126f69a59bbd0c8620dd073fc762a9cc98283362f9534f3e20197b95da9dc33
+  data.tar.gz: 2d23e326e341927fa8196c566b3101f8850f56632ab93bdb9bf6506e87a451f9c6141801e40c2c6f2743e7a9cfacc535c555161d06003467e1bd29fa59c0f673

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Activerecord
   module BatchTouching
     VERSION = "1.0"

data/lib/activerecord/batch_touching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "activerecord/batch_touching/version"
 require "activerecord/batch_touching/state"
 
@@ -55,34 +57,58 @@ module ActiveRecord
     end
 
     class << self
-      def states
-        Thread.current[:batch_touching_states] ||= []
+      # Disable batch touching globally
+      def disable!
+        @disabled = true
       end
 
-      def current_state
-        states.last
+      # Enable batch touching globally
+      def enable!
+        @disabled = false
       end
 
-      delegate :add_record, to: :current_state
+      # Disable batch touching for a block
+      def disable
+        Thread.current[:batch_touching_disabled] = true
+        yield
+      ensure
+        Thread.current[:batch_touching_disabled] = false
+      end
 
-      def batch_touching?
-        states.present?
+      def disabled?
+        Thread.current[:batch_touching_disabled] || @disabled
       end
 
       # Start batching all touches. When done, apply them. (Unless nested.)
-      def start(options = {})
+      def start(requires_new:)
         states.push State.new
         yield.tap do
           apply_touches if states.length == 1
         end
       ensure
-        merge_transactions unless $! && options[:requires_new]
+        merge_transactions unless $! && 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
       end
 
+      delegate :add_record, to: :current_state
+
+      def batch_touching?
+        states.present? && !disabled?
+      end
+
+      private
+
+      def states
+        Thread.current[:batch_touching_states] ||= []
+      end
+
+      def current_state
+        states.last
+      end
+
       # When exiting a nested transaction, merge the nested transaction's
       # touched records with the outer transaction's touched records.
       def merge_transactions
@@ -91,50 +117,58 @@ module ActiveRecord
 
       # Apply the touches that were batched. We're in a transaction already so there's no need to open one.
       def apply_touches
-        callbacks_run = Set.new
+        current_time = ActiveRecord::Base.current_time_from_proper_timezone
+        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 |_, records|
-            # Run callbacks to collect more touches (i.e. touch: true for associations)
-            records.each do |record|
-              unless callbacks_run.include?(record)
-                record._run_touch_callbacks
-                callbacks_run.add(record)
-              end
-            end
+          state_records.each do |(_klass, columns), records|
+            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 = all_states.records.keys.sort_by { |k| k.first.name }.to_h { |k| [k, all_states.records[k]] }
         sorted_records.each do |(klass, columns), records|
-          touch_records klass, columns, records
+          records.reject!(&:destroyed?)
+          touch_records klass, columns, records, current_time
         end
       end
 
-      # Touch the specified records--non-empty set of instances of the same class.
-      def touch_records(klass, columns, records)
-        if columns.present?
-          current_time = records.first.send(:current_time_from_proper_timezone)
-
-          records.each do |record|
-            record.instance_eval do
-              columns.each { |column| write_attribute column, current_time }
-              if locking_enabled?
-                self[self.class.locking_column] += 1
-                clear_attribute_change(self.class.locking_column)
-              end
-              clear_attribute_changes(columns)
-            end
-          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)} = :current_time" }.join(", ")
-          sql += ", #{klass.locking_column} = #{klass.locking_column} + 1" if klass.locking_enabled?
+        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
+
+      # 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|
+          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
 
-          klass.unscoped.where(klass.primary_key => records.to_a).update_all([sql, current_time: current_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.beta2
+  version: 1.0.pre.rc1
 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-03 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/irphilli/activerecord-batch_touching
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -148,7 +205,7 @@ 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:
   - - ">"