Add update_on option to batch_update (#26)

Author: frodsan

.rubocop.yml

@@ -23,6 +23,9 @@ Metrics/PerceivedComplexity:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: false
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord_batch_update (1.2.0)
+    activerecord_batch_update (1.3.0)
       activerecord (>= 7.2)
       activesupport (>= 7.2)
 

lib/activerecord_batch_update.rb

@@ -14,7 +14,14 @@ module ActiveRecordBatchUpdate
   # which will re-insert the objects if they were deleted in another thread
 
   module ClassMethods
-    def batch_update(entries, columns:, batch_size: 100, validate: true, clear_attribute_changes: true)
+    def batch_update(
+      entries,
+      columns:,
+      update_on: primary_key,
+      batch_size: 100,
+      validate: true,
+      clear_attribute_changes: true
+    )
       batch_update_ensure_entries_are_same_class!(entries)
 
       columns = column_names if columns == :all
@@ -24,13 +31,13 @@ def batch_update(entries, columns:, batch_size: 100, validate: true, clear_attri
       entries.each { _1.updated_at = Time.current } if has_attribute?('updated_at')
       entries.each(&:validate!) if validate
 
-      primary_keys = Array.wrap(primary_key).map(&:to_s)
+      update_on = Array.wrap(update_on).map(&:to_s)
 
       updated_count = batch_update_statements(
         entries.map do |entry|
-          (primary_keys + (entry.changed & columns)).to_h { [_1, entry.read_attribute(_1)] }
+          (update_on + (entry.changed & columns)).to_h { [_1, entry.read_attribute(_1)] }
         end,
-        update_on: primary_keys,
+        update_on: update_on,
         batch_size: batch_size
       ).sum do |sql|
         connection.update(sql)

spec/activerecord_batch_update_spec.rb

@@ -321,6 +321,20 @@
       end
     end
 
+    context 'with a custom update_on' do
+      let!(:cat1) { Cat.create!(name: 'Figaro', owner_name: 'Geppetto') }
+      let!(:cat2) { Cat.create!(name: 'Garfield', owner_name: 'Jon Arbuckle') }
+
+      it 'matches records using the specified column instead of the primary key' do
+        expect do
+          cat1.name = 'Nala'
+          cat2.name = 'Simba'
+          Cat.batch_update([cat1, cat2], columns: :name, update_on: :owner_name)
+        end.to change { cat1.reload.name }.to('Nala')
+                                          .and(change { cat2.reload.name }.to('Simba'))
+      end
+    end
+
     context 'when the entries are not the same class' do
       let(:dog) do
         Class.new do

spec/spec_helper.rb

@@ -22,6 +22,7 @@
     create_table :cats, force: true do |t|
       t.column :name, :string
       t.column :birthday, :date
+      t.column :owner_name, :string
       t.column :bitcoin_address, :string
       t.column :updated_at, :timestamp
       t.column :created_at, :timestamp