paper_trail-bulk_writes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d95e8ca4943e9946044920ed171b6ac8b2453d3f6679d7d33d22295de5a5ad0e
-  data.tar.gz: a23c12b374cbff0625383b6d18f2585480f3aca36f517288a4eb5d4ba054a0e0
+  metadata.gz: 5af6edbca4b17762cc0f647c69ee04b52284cd924b826b6a997a65b4b92925ba
+  data.tar.gz: 2baef624ade4173c84c5b54252ee67930f625ee1d97d5e2ed70788d75891900e
 SHA512:
-  metadata.gz: b33946ae81b24bc77d3f3ef25040e5af6d8605003ab5d8ad37f9638a19e680c48e85aa5ff68589ddbc1b0a507ad6781f4d0b64c1b2c62494f03073f1816b0fc6
-  data.tar.gz: 5d3bef3c3c4abd5700ca9d1a30d9aae3f4348ce0381f89c20d136e50ba37668172f4b0a0b73ca0c547dfe2372d300a3607b5036e71a88cadef2184b7b0967d44
+  metadata.gz: 46b8fe04d97334c518edd7344f1a2b2e0a771bb3a6c524611e3fe47000c627dd3cfda33358c88c1889ff9ec654fb8e7d8fd2c8aa732a76959410ca2a0f85669e
+  data.tar.gz: 8b16c7ea07f84084e99f2de9a062e1500e3d018ce024d9d8f48302975a72c9791b3472597d1a51d3b1f72babd7c4187fca3bfb3b11a95c0744ee2aac1da85ccf

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## 0.3.0
+
+- Added: `audited_insert_all` takes `returning:`, a list of column names, and returns an `ActiveRecord::Result` of those columns in input order, like `insert_all`. Without it, it still returns the ids. Works on MySQL too, by reading the rows back.
+
+## 0.2.0
 
 - Fixed: on databases without `INSERT ... RETURNING`, `audited_insert_all` raised `KeyError` when the caller supplied ids typed differently to the column, such as strings out of a CSV or a JSON payload.
 

data/README.md

@@ -60,6 +60,9 @@ Shift.where(id: ids).audited_delete_all
 
 # Returns the new ids, in input order. Rows are inserted with insert_all!.
 Shift.audited_insert_all([{ name: 'a', status: 'draft' }, { name: 'b', status: 'draft' }])
+
+# Pass returning: for other columns; returns an ActiveRecord::Result, like insert_all.
+Shift.audited_insert_all(rows, returning: %w[id status])
 ```
 
 Batches default to 1,000 rows:

data/lib/paper_trail/bulk_writes/insert.rb

@@ -5,39 +5,51 @@ module PaperTrail
     class Insert
       include Versioned
 
-      def initialize(model:, rows:, whodunnit: nil, batch_size: nil)
+      def initialize(model:, rows:, whodunnit: nil, batch_size: nil, returning: nil)
         @model = model
         @rows = rows
         @whodunnit = whodunnit
         @batch_size = batch_size || default_batch_size
+        @returning = returning && Array(returning).map(&:to_s)
       end
 
       def call
-        return [] if rows.empty?
+        inserted = insert_all
+        return inserted.pluck('id') unless returning
 
-        model.transaction { rows.each_slice(batch_size).flat_map { |batch| write(batch) } }
+        ActiveRecord::Result.new(returning, inserted.map { |attributes| attributes.values_at(*returning) })
       end
 
       private
 
-      attr_reader :model, :rows, :whodunnit, :batch_size
+      attr_reader :model, :rows, :whodunnit, :batch_size, :returning
 
       def tracked
         @tracked ||= adapter.tracked(model.column_names) - ['id']
       end
 
+      def fetched
+        @fetched ||= ['id', *tracked] | returning.to_a
+      end
+
+      def insert_all
+        return [] if rows.empty?
+
+        model.transaction { rows.each_slice(batch_size).flat_map { |batch| write(batch) } }
+      end
+
       def write(batch)
         inserted = insert_and_fetch(batch)
         changed = changed_columns(batch)
         adapter.insert(inserted.map { |attributes| version_row(attributes, changed) })
-        inserted.pluck('id')
+        inserted
       end
 
       # Databases with RETURNING (Postgres, SQLite 3.35+, MariaDB 10.5+) hand the
       # inserted rows back.
       def insert_and_fetch(batch)
         if model.connection.supports_insert_returning?
-          model.insert_all!(batch, returning: ['id', *tracked]).to_a
+          model.insert_all!(batch, returning: fetched).to_a
         else
           supplied = supplied_ids(batch)
           model.insert_all!(batch)
@@ -70,7 +82,7 @@ module PaperTrail
       end
 
       def fetch_rows(ids)
-        relation = model.unscoped.where(id: ids).select('id', *tracked)
+        relation = model.unscoped.where(id: ids).select(*fetched)
         by_id = model.connection.select_all(relation).to_a.index_by { |row| row['id'] }
         ids.map { |id| by_id.fetch(id) }
       end

data/lib/paper_trail/bulk_writes/model.rb

@@ -8,8 +8,8 @@ module PaperTrail
       end
 
       module ClassMethods
-        def audited_insert_all(rows, whodunnit: PaperTrail.request.whodunnit)
-          Insert.call(model: self, rows: rows, whodunnit: whodunnit)
+        def audited_insert_all(rows, whodunnit: PaperTrail.request.whodunnit, returning: nil)
+          Insert.call(model: self, rows: rows, whodunnit: whodunnit, returning: returning)
         end
 
         def audited_update_all(attributes:, whodunnit: PaperTrail.request.whodunnit, touch: true)

data/lib/paper_trail/bulk_writes/version.rb

@@ -2,6 +2,6 @@
 
 module PaperTrail
   module BulkWrites
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-bulk_writes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Robinson