activerecord-duplicator 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee612e84f80aefec6371c6e900d058e9934b7b7d095a981e2f52d22291586210
-  data.tar.gz: 2aafb86816d74188a18a82e36c74e1a6c1dcb65b52523c3ee4bafa9db45e1fa3
+  metadata.gz: 017f95574ff90a7fdae2b54b38fd5be60fd6afa33b53a3a59486e159031c9bd1
+  data.tar.gz: a06425a620bae40393fc97b555f0616a8b5bfc87d6e90806089480f4506d3bdf
 SHA512:
-  metadata.gz: f167f08df7e50cc605ff85d3663f3e51cb1b2a11ea88201bf50726b20721e263b8b9f96fee38ad64e42b97cd895f2217fb1968760bdf085351959632c7fec0d1
-  data.tar.gz: 652d33cc38a670dc0eafad296157d6f56c5fd3e4a435082b1bec45706c9a01624730be36992ebd22ac88f335a70def57aad3234480d77816297f879460462cda
+  metadata.gz: 6dd54a10072d5521a176d1d5957246e033a42a2671e220ffc718f53f6442c4d6329241d0ab41aa1cc852585c697a36666d629d9c5f60c03d5b7dede47f986a97
+  data.tar.gz: afc907dc6fb3026b820eb1273500c53f7d51f0bd8ea960092956f81108253faa3d4795473f1a137133cade12f24365a4f8fb8136ff5831a0196e1cc3526f4bad

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.5.0] - 2026-07-07
+
+### Added
+
+- `Session#mark_skip_id(klass, *ids)` and `HandlerApi#mark_skip_id` —
+  register specific ids as skipped without loading records. Equivalent to
+  calling `mark_skip` on each record but avoids the database round-trip
+  when the ids are already known. Composite primary key ids are passed as
+  Arrays.
+
+## [0.4.0] - 2026-07-06
+
+### Fixed
+
+- `Duplicator#duplicate` now accepts `transaction_options: {}` and forwards
+  it to `Session#run`, which forwards it to `root_record.transaction`. In
+  v0.3.0 this plumbing was only wired at the Session#run layer, so callers
+  using the documented `Duplicator#duplicate` entry point had no way to
+  override the outer transaction options.
+
 ## [0.3.0] - 2026-07-06
 
 ### Changed (breaking)

data/README.md

@@ -97,6 +97,28 @@ working), but the default `bulk_insert` path becomes a no-op and any
 echoes the old id back unchanged. `mark_skip_class` only differs from
 per-record `mark_skip` in cost: no enumeration is needed to opt each row in.
 
+### Skipping by id without loading records (`mark_skip_id`)
+
+When the ids to skip are already known (a foreign key column, a prior
+pluck, a config constant), use `mark_skip_id` to register them directly
+without issuing a `SELECT`:
+
+```ruby
+duplicator.duplicate(old_post, associations: [:taggings]) do |session|
+  session.mark_skip_id(Tag, 1, 2, 3)
+end
+```
+
+For composite primary keys pass each id as an Array:
+
+```ruby
+session.mark_skip_id(Item, [tenant_id, 10], [tenant_id, 11])
+```
+
+`mark_skip_id` has the same effect as calling `mark_skip` on the
+corresponding records: `fetch_new_id` returns the old id unchanged for
+each registered id.
+
 ### Registering an id from outside (`store_new_id` / `fetch_new_id`)
 
 If you produce a duplicate yourself (for example a model with a uniqueness

data/lib/active_record/duplicator/handler_api.rb

@@ -19,6 +19,11 @@ module ActiveRecord
         @session.mark_skip(...)
       end
 
+      #: (Class, *untyped) -> void
+      def mark_skip_id(...)
+        @session.mark_skip_id(...)
+      end
+
       #: (*Class) -> void
       def mark_skip_class(...)
         @session.mark_skip_class(...)

data/lib/active_record/duplicator/session.rb

@@ -45,9 +45,7 @@ module ActiveRecord
       # Duplicator-level handler is intentional and does not raise.
       #: (Class) { (HandlerApi, Class, untyped) -> void } -> void
       def on(klass, &block)
-        if @user_handlers.key?(klass)
-          raise DuplicateHandlerError, "handler for #{klass} is already overridden in this session"
-        end
+        raise DuplicateHandlerError, "handler for #{klass} is already overridden in this session" if @user_handlers.key?(klass)
 
         @user_handlers[klass] = block
       end
@@ -63,6 +61,16 @@ module ActiveRecord
         end
       end
 
+      # Declare that the given ids of the given class must not be duplicated,
+      # without loading the records. Equivalent to calling mark_skip on each
+      # record but avoids the database round-trip when the ids are already
+      # known. Each id should have the same shape as the class's primary key
+      # (scalar for a single-column pk, Array for a composite pk).
+      #: (Class, *untyped) -> void
+      def mark_skip_id(klass, *ids)
+        ids.each { |id| store_new_id(klass, old_id: id, new_id: id) }
+      end
+
       # Class-wide equivalent of mark_skip: it is exactly as if every record of
       # each given class had been passed to mark_skip. Handlers still fire
       # (matching the mark_skip case where a handler for the class is invoked

data/lib/active_record/duplicator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class Duplicator
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/active_record/duplicator.rb

@@ -63,11 +63,15 @@ module ActiveRecord
     # If a block is given it is called with the new Session before duplication
     # starts, letting the caller mark_skip or store_new_id for records that
     # were duplicated elsewhere.
-    #: (ActiveRecord::Base, ?associations: untyped) ?{ (Session) -> void } -> ActiveRecord::Base
-    def duplicate(root_record, associations: [], &block)
+    #
+    # transaction_options is forwarded verbatim to Session#run, which forwards
+    # it to `root_record.transaction`. Default is `{}` (plain
+    # `transaction do ... end`).
+    #: (ActiveRecord::Base, ?associations: untyped, ?transaction_options: Hash[Symbol, untyped]) ?{ (Session) -> void } -> ActiveRecord::Base
+    def duplicate(root_record, associations: [], transaction_options: {}, &block)
       session = Session.new(handlers: @handlers, skipped_classes: @skipped_classes)
       block&.call(session)
-      session.run(root_record, associations:)
+      session.run(root_record, associations:, transaction_options:)
     end
   end
 end

data/sig/generated/active_record/duplicator/handler_api.rbs

@@ -15,6 +15,9 @@ module ActiveRecord
       # : (*ActiveRecord::Base) -> void
       def mark_skip: (*ActiveRecord::Base) -> void
 
+      # : (Class, *untyped) -> void
+      def mark_skip_id: (Class, *untyped) -> void
+
       # : (*Class) -> void
       def mark_skip_class: (*Class) -> void
 

data/sig/generated/active_record/duplicator/session.rbs

@@ -47,6 +47,14 @@ module ActiveRecord
       # : (*ActiveRecord::Base) -> void
       def mark_skip: (*ActiveRecord::Base) -> void
 
+      # Declare that the given ids of the given class must not be duplicated,
+      # without loading the records. Equivalent to calling mark_skip on each
+      # record but avoids the database round-trip when the ids are already
+      # known. Each id should have the same shape as the class's primary key
+      # (scalar for a single-column pk, Array for a composite pk).
+      # : (Class, *untyped) -> void
+      def mark_skip_id: (Class, *untyped) -> void
+
       # Class-wide equivalent of mark_skip: it is exactly as if every record of
       # each given class had been passed to mark_skip. Handlers still fire
       # (matching the mark_skip case where a handler for the class is invoked

data/sig/generated/active_record/duplicator.rbs

@@ -49,7 +49,11 @@ module ActiveRecord
     # If a block is given it is called with the new Session before duplication
     # starts, letting the caller mark_skip or store_new_id for records that
     # were duplicated elsewhere.
-    # : (ActiveRecord::Base, ?associations: untyped) ?{ (Session) -> void } -> ActiveRecord::Base
-    def duplicate: (ActiveRecord::Base, ?associations: untyped) ?{ (Session) -> void } -> ActiveRecord::Base
+    #
+    # transaction_options is forwarded verbatim to Session#run, which forwards
+    # it to `root_record.transaction`. Default is `{}` (plain
+    # `transaction do ... end`).
+    # : (ActiveRecord::Base, ?associations: untyped, ?transaction_options: Hash[Symbol, untyped]) ?{ (Session) -> void } -> ActiveRecord::Base
+    def duplicate: (ActiveRecord::Base, ?associations: untyped, ?transaction_options: Hash[Symbol, untyped]) ?{ (Session) -> void } -> ActiveRecord::Base
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-duplicator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - SmartHR