monarch_migrate 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814685cc086ec84d8f1e877c80134db4c702b9d06602f4169f99dc82c1cd1ca8
-  data.tar.gz: 726adc5a2087bec90a6fa1fc1ec965d633c4de35f69298da2b42e7e043026af8
+  metadata.gz: d70afb71a32546dd38ae87d4e39956c97bd095c56cc957266a159edb4cbfc3cb
+  data.tar.gz: 2b95f318d045045dba0cb712bc0aa647d95717688e2cb258702e9bea9c398d6f
 SHA512:
-  metadata.gz: 665c315826067e28509312d5cf9ef8729803dfb105a123aad44f81df9c0c2f46cd185f9d5381939def677d68553a150c37d2e1d5f040b2b281dc6085b47e31d9
-  data.tar.gz: ff6cb7e01f9071363eb561f392c80e8b8e97b371f853f79f35f1f4a594b8165f4e063d9225ec1ff3af992874a57ef081d16455a049fe547bfe8c6a354578a8d3
+  metadata.gz: f97b549b57586af15371dfadba856b9d506989d210a76ae21cc85e20d0eff097ca58fd26a1901760c8755d0b45be6583bfabc2f9f71e288cd0949d1ab98df150
+  data.tar.gz: 6f773f40eb0028229a75aa58055b3765580261f4c50d21bd01ab64ab5b5f8f001129626f442d022825d9038729a6bdf2519dcff425b31febeed681230257347c

data/Gemfile.lock

@@ -1,73 +1,73 @@
 PATH
   remote: .
   specs:
-    monarch_migrate (0.4.0)
+    monarch_migrate (0.6.0)
       rails (>= 5.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.3)
-      actionpack (= 7.0.3)
-      activesupport (= 7.0.3)
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.3)
-      actionpack (= 7.0.3)
-      activejob (= 7.0.3)
-      activerecord (= 7.0.3)
-      activestorage (= 7.0.3)
-      activesupport (= 7.0.3)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.3)
-      actionpack (= 7.0.3)
-      actionview (= 7.0.3)
-      activejob (= 7.0.3)
-      activesupport (= 7.0.3)
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.3)
-      actionview (= 7.0.3)
-      activesupport (= 7.0.3)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.3)
-      actionpack (= 7.0.3)
-      activerecord (= 7.0.3)
-      activestorage (= 7.0.3)
-      activesupport (= 7.0.3)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.3)
-      activesupport (= 7.0.3)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.3)
-      activesupport (= 7.0.3)
+    activejob (7.0.3.1)
+      activesupport (= 7.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activerecord (7.0.3)
-      activemodel (= 7.0.3)
-      activesupport (= 7.0.3)
-    activestorage (7.0.3)
-      actionpack (= 7.0.3)
-      activejob (= 7.0.3)
-      activerecord (= 7.0.3)
-      activesupport (= 7.0.3)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -82,12 +82,12 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     digest (3.1.0)
     erubi (1.10.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     loofah (2.18.0)
       crass (~> 1.0.2)
@@ -98,7 +98,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     net-imap (0.2.3)
       digest
       net-protocol
@@ -114,7 +114,7 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.6)
+    nokogiri (1.13.7)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -124,48 +124,48 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.6.0)
-    rack (2.2.3.1)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.3)
-      actioncable (= 7.0.3)
-      actionmailbox (= 7.0.3)
-      actionmailer (= 7.0.3)
-      actionpack (= 7.0.3)
-      actiontext (= 7.0.3)
-      actionview (= 7.0.3)
-      activejob (= 7.0.3)
-      activemodel (= 7.0.3)
-      activerecord (= 7.0.3)
-      activestorage (= 7.0.3)
-      activesupport (= 7.0.3)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       bundler (>= 1.15.0)
-      railties (= 7.0.3)
+      railties (= 7.0.3.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (7.0.3)
-      actionpack (= 7.0.3)
-      activesupport (= 7.0.3)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.4.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-rails (5.0.1)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -173,7 +173,7 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.10.2)
+    rspec-support (3.11.0)
     rubocop (1.29.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
@@ -183,13 +183,13 @@ GEM
       rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
+    sqlite3 (1.4.4)
     standard (1.12.1)
       rubocop (= 1.29.1)
       rubocop-performance (= 1.13.3)
@@ -198,11 +198,11 @@ GEM
     timeout (0.3.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,31 @@
-# Sensible Data Migrations for Rails
+# monarch_migrate [![Build Status][ci-image]][ci] [![Gem Version][version-image]][version]
 
-## Why
+A library for Rails developers who are not willing to leave data migrations to chance.
+
+<br />
+
+## Table of Contents
+
+- [Rationale](#rationale)
+- [Install](#install)
+- [Usage](#usage)
+  - [Create a Data Migration](#create-a-data-migration)
+  - [Running Data Migrations](#running-data-migrations)
+  - [Display Status of Data Migrations](#display-status-of-data-migrations)
+  - [Reverting Data Migrations](#reverting-data-migrations)
+  - [Background Tasks in Data Migrations](#background-tasks-in-data-migrations)
+- [Testing](#testing)
+  - [RSpec](#rspec)
+  - [TestUnit](#testunit)
+- [Suggested Workflow](#suggested-workflow)
+- [Known Issues and Limitations](#known-issues-and-limitations)
+- [Trivia](#trivia)
+- [Acknowledgments](#acknowledgments)
+- [License](#license)
+
+
+## Rationale
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 <blockquote>
   <p>The main purpose of Rails' migration feature is to issue commands that modify the schema using a consistent process. Migrations can also be used to add or modify data. This is useful in an existing database that can't be destroyed and recreated, such as a production database.</p>
@@ -9,30 +34,35 @@
   </a>
 </blockquote>
 
-The motivation behind Rails' migration mechanism is schema modification. Using it
-for data changes in the database comes second. Yet, adding or modifying data via
-regular migrations can be problematic.
+The motivation behind Rails' migration mechanism is schema modification.
+Using it for data changes in the database comes second. Yet, adding or
+modifying data via regular migrations can be problematic.
 
-The first issue is that application deployment now depends on the data migration
+One issue is that application deployment now depends on the data migration
 to be completed. This may not be a problem with small databases but large
 databases with millions of records will respond with hanging or failed migrations.
 
 Another issue is that data migration files tend to stay in `db/migrate` for posterity.
 As a result, they will run whenever a developer sets up their local development environment.
-This is unnecessary for a pristine database. Especially when there are [scripts][2] to
+This is unnecessary for a pristine database. Especially with [scripts][seed-scripts] to
 seed the correct data.
 
-The purpose of `monarch_migrate` is to solve the above issues by separating data from schema migrations.
+The purpose of `monarch_migrate` is to solve the above issues and to:
+
+- Provide a [uniform process](#suggested-workflow) for modifying data in the database.
+- Separate data migrations from schema migrations.
+- Allow automated testing of data migrations.
 
-It is assumed that:
+It assumes that:
 
-- You run data migrations *only* on production and rely on seed [scripts][2] i.e. `dev:prime` for local development.
+- You run data migrations only on production and rely on seed [scripts][seed-scripts] for local development.
 - You run data migrations manually.
-- You want to write tests your data migrations.
+- You want to test data migrations in a thorough and automated manner.
 
 
 
 ## Install
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 Add the gem to your Gemfile:
 
@@ -48,45 +78,45 @@ After you install the gem, you need to run the generator:
 rails generate monarch_migrate:install
 ```
 
-The install generator creates a migration file that adds a `data_migration_records`
-table. It is where the gem keeps track of data migrations we have already ran.
+The install generator creates a schema migration file that adds a `data_migration_records`
+table. It is where the gem keeps track of data migrations we have ran.
 
+Run the schema migration to create the table:
 
+```shell
+rails db:migrate
+```
 
-## Usage
 
-Data migrations have a similar structure to regular migrations in Rails. Files are
-put into `db/data_migrate` and follow the same naming pattern.
 
-Let's start with an example.
+## Usage
+<sup>[(Back to top)](#table-of-contents)</sup>
 
-Suppose we have designed a system where users have first and last names. Time passes and
-it becomes clear this is [wrong][3]. Now, we want to put things right and come
-up with the following plan:
+Data migrations have a similar structure to regular migrations in Rails.
+Files follow the same naming pattern but reside in `db/data_migrate`.
 
-1. Add a `name` column to `users` table to hold person's full name.
-2. Adapt the `User` model and use a data migration to update existing records.
-3. Drop `first_name` and `last_name` columns.
 
-To create the data migration to update existing user records, run:
+### Create a Data Migration
 
 ```shell
 rails generate data_migration backfill_users_name
 ```
 
-In contrast to regular migrations, there is no need to inherit any classes:
+Edit the newly created file to define the data migration:
 
 ```ruby
 # db/data_migrate/20220605083010_backfill_users_name.rb
 ActiveRecord::Base.connection.execute(<<-SQL)
   UPDATE users SET name = concat(first_name, ' ', last_name) WHERE name IS NULL;
 SQL
-
-SearchIndex::RebuildJob.perform_later
 ```
 
-As seen above, it is plain ruby code where you can refer to any object you
-need. Each data migration runs in a separate transaction.
+In contrast to regular migrations, there is no need to inherit any classes. It is plain
+ruby code where you can refer to any object you need. If the database adapter supports
+transactions, each data migration will automatically be wrapped in a separate transaction.
+
+
+### Running Data Migrations
 
 To run pending data migrations:
 
@@ -94,19 +124,52 @@ To run pending data migrations:
 rails data:migrate
 ```
 
-Or a specific version:
+To run a specific version:
 
 ```shell
 rails data:migrate VERSION=20220605083010
 ```
 
 
+### Display Status of Data Migrations
+
+You can see the status of data migrations with:
+
+```shell
+rails data:migrate:status
+```
+
+### Reverting Data Migrations
+
+Rollback functionality is not provided by design. Create another data migration instead.
+
+
+### Background Tasks in Data Migrations
+
+After the data manipulation is complete, you may want to trigger a long running task.
+Yet, there are [some pitfalls](#long-running-tasks-in-migrations) to be aware of.
+
+To avoid them, use an after-commit callback:
+
+```ruby
+# db/data_migrate/20220605083010_backfill_users_name.rb
+ActiveRecord::Base.connection.execute(<<-SQL)
+  UPDATE users SET name = concat(first_name, ' ', last_name) WHERE name IS NULL;
+SQL
+
+after_commit do
+  SearchIndex::RebuildJob.perform_later
+end
+```
+
+
 ## Testing
+<sup>[(Back to top)](#table-of-contents)</sup>
 
-Testing data migrations can be the difference between simply rerunning
-the migration and having to recover from a data loss.
+Testing data migrations can be the difference between rerunning
+the migration and having to recover from a data loss. This is
+why `monarch_migrate` includes test helpers for both RSpec and TestUnit.
 
-This is why `monarch_migrate` includes test helpers for both RSpec and TestUnit.
 
 ### RSpec
 
@@ -128,7 +191,7 @@ describe "20220605083010_backfill_users_name", type: :data_migration do
     # or if you're using FactoryBot:
     # user = create(:user, first_name: "Guybrush", last_name: "Threepwood", name: nil)
 
-    expect(subject).to change { user.reload.name }.to("Guybrush Threepwood")
+    expect { subject }.to change { user.reload.name }.to("Guybrush Threepwood")
   end
 
   it "does not assign name to already migrated users" do
@@ -136,7 +199,7 @@ describe "20220605083010_backfill_users_name", type: :data_migration do
     # or if you're using FactoryBot:
     # user = create(:user, first_name: "", last_name: "", name: "Guybrush Threepwood")
 
-    expect(subject).not_to change { user.reload.name }
+    expect { subject }.not_to change { user.reload.name }
   end
 
   context "when the user has no last name" do
@@ -145,7 +208,7 @@ describe "20220605083010_backfill_users_name", type: :data_migration do
       # or if you're using FactoryBot:
       # user = create(:user, first_name: "Guybrush", last_name: nil, name: nil)
 
-      expect(subject).to change { user.reload.name }.to("Guybrush")
+      expect { subject }.to change { user.reload.name }.to("Guybrush")
     end
   end
 
@@ -200,21 +263,30 @@ class BackfillUsersNameTest < MonarchMigrate::TestCase
 end
 ```
 
-Data migrations become obsolete, once the data manipulation successfully completes.
-So are the corresponding tests. These will fail after database columns are dropped
-e.g. `first_name` and `last_name`.
+In certain cases, it makes sense to also test with manually running the data migration
+against a production clone of the database.
 
-One solution is to use the following development workflow:
 
-1. Implement the data migration using TDD.
+
+## Suggested Workflow
+<sup>[(Back to top)](#table-of-contents)</sup>
+
+Data migrations become obsolete, once the data manipulation successfully completes. The same applies for the corresponding tests.
+
+The suggested development workflow is:
+
+1. Implement the data migration. Use TDD, if appropriate.
 1. Commit, push and wait for CI to pass.
 1. Request review from peers.
 1. Once approved, remove the test files in a consecutive commit and push again.
 1. Merge into trunk.
 
-This will also keep the test files in repo's history for posterity.
+This will keep the test files in repo's history for posterity.
+
+
 
 ## Known Issues and Limitations
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 The following issues and limitations are not necessary inherent to `monarch_migrate`.
 Some are innate to migrations in general.
@@ -233,7 +305,7 @@ Typically, data migrations relate closely to business models. In an ideal Rails
 data manipulations would depend on model logic to enforce validation, conform to
 business rules, etc. Hence, it is very tempting to use ActiveRecord models in migrations.
 
-Here is a regular Rails migration for our example:
+Here a regular Rails migration:
 
 ```ruby
 # db/migrate/20220605083010_backfill_users_name.rb
@@ -266,10 +338,10 @@ end
 Unfortunately, with regular Rails migrations we will still face issue 4.
 
 To avoid it, we need to separate data from schema migrations and not run data
-migrations locally. With seed [scripts][2], there is no need to run them anyway.
+migrations locally. With seed [scripts][seed-scripts], there is no need to run them anyway.
 
 Keep the above in mind when referencing ActiveRecord models in data migrations. Ideally,
-limit their use and do as much processing as possible in Postgres.
+limit their use and do as much processing as possible in the database.
 
 
 ### Long-running Tasks in Migrations
@@ -278,11 +350,16 @@ As mentioned, each data migration runs in a separate transaction.
 A long-running task within a migration keeps the transaction open for
 the duration of the task. As a result, the migration may hang or fail.
 
-To avoid this, run such tasks asynchronously.
+You could run such tasks asynchronously (i.e. in a background job) but the task may start
+before the transaction commits. This is a [known issue][sync-issue]. In addition,
+a database under load can suffer from longer commit times.
+
+See [Background Tasks in Data Migrations](#background-tasks-in-data-migrations).
 
 
 
 ## Trivia
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 One of the most impressive migrations on Earth is the multi-generational
 round trip of the monarch butterfly.
@@ -302,13 +379,8 @@ Genetically speaking, this is an incredible data migration!
 
 
 
-## See Also
-
-Alternative gems
-
-- https://github.com/OffgridElectric/rails-data-migrations
-- https://github.com/ilyakatz/data-migrate
-- https://github.com/jasonfb/nonschema_migrations
+## Acknowledgments
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 Articles
 
@@ -318,11 +390,22 @@ Articles
 - [Ruby on Rails Model Patterns and Anti-patterns](https://blog.appsignal.com/2020/11/18/rails-model-patterns-and-anti-patterns.html)
 - [Rails Migrations with Zero Downtime](https://www.cloudbees.com/blog/rails-migrations-zero-downtime)
 
+Alternative gems
+
+- https://github.com/OffgridElectric/rails-data-migrations
+- https://github.com/ilyakatz/data-migrate
+- https://github.com/jasonfb/nonschema_migrations
+
 
 
 ## License
+<sup>[(Back to top)](#table-of-contents)</sup>
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-[2]: https://thoughtbot.com/blog/priming-the-pump
-[3]: https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/
+[ci-image]: https://github.com/lunohodov/monarch/actions/workflows/ci.yml/badge.svg
+[ci]: https://github.com/lunohodov/monarch/actions/workflows/ci.yml
+[seed-scripts]: https://thoughtbot.com/blog/priming-the-pump
+[sync-issue]: https://github.com/mperham/sidekiq/wiki/FAQ#why-am-i-seeing-a-lot-of-cant-find-modelname-with-id12345-errors-with-sidekiq
+[version-image]: https://badge.fury.io/rb/monarch_migrate.svg
+[version]: https://badge.fury.io/rb/monarch_migrate

data/lib/monarch_migrate/migration.rb

@@ -4,6 +4,7 @@ module MonarchMigrate
   class Migration
     def initialize(path)
       @path = path.to_s
+      @after_commit_callback = nil
     end
 
     def filename
@@ -22,27 +23,34 @@ module MonarchMigrate
       !MigrationRecord.exists?(version: version)
     end
 
-    def run(io = nil)
-      io ||= File.open(File::NULL, "w")
+    def after_commit(&block)
+      @after_commit_callback = block
+    end
 
+    def run
       ActiveRecord::Base.connection.transaction do
-        io.puts "Running data migration #{version}: #{name}"
+        puts "Running data migration #{version}: #{name}"
 
         begin
           instance_eval File.read(path), path
           MigrationRecord.create!(version: version)
-          io.puts "Migration complete"
+          puts "Migration complete"
         rescue => e
-          io.puts "Migration failed due to #{e}"
-          raise ActiveRecord::Rollback
+          puts "Migration failed due to #{e}"
+          # Deliberately raising ActiveRecord::Rollback does not
+          # pass on the exception and the callback will be triggered
+          raise
         end
 
-        io.puts
+        puts
       end
+
+      after_commit_callback&.call
     end
 
     private
 
     attr_reader :path
+    attr_reader :after_commit_callback
   end
 end

data/lib/monarch_migrate/migrator.rb

@@ -20,14 +20,12 @@ module MonarchMigrate
       migrations.select(&:pending?)
     end
 
-    def run(io = nil)
-      io ||= File.open(File::NULL, "w")
-
+    def run
       if pending_migrations.any?
-        io.puts "Running #{pending_migrations.size} data migrations"
-        pending_migrations.sort_by(&:version).each { |m| m.run(io) }
+        puts "Running #{pending_migrations.size} data migrations"
+        pending_migrations.sort_by(&:version).each(&:run)
       else
-        io.puts "No data migrations pending"
+        puts "No data migrations pending"
         []
       end
     end

data/lib/monarch_migrate/tasks.rake

@@ -3,7 +3,7 @@ require "monarch_migrate"
 namespace :data do
   desc "Run pending data migrations, or a single version specified by environment variable VERSION"
   task migrate: :environment do
-    MonarchMigrate.migrator.run($stdout)
+    MonarchMigrate.migrator.run
   end
 
   namespace :migrate do

data/lib/monarch_migrate/testing.rb

@@ -1,11 +1,13 @@
 require "active_support/core_ext/string"
-require "stringio"
+require "active_support/testing/stream"
 
 module MonarchMigrate
   module Testing
     MigrationRunError = Class.new(RuntimeError)
 
     module Helpers
+      include ::ActiveSupport::Testing::Stream
+
       def data_migration
         @data_migration ||=
           begin
@@ -17,9 +19,8 @@ module MonarchMigrate
       end
 
       def run_data_migration
-        output = StringIO.new
-        data_migration.run(output)
-        output.string.tap { ensure_no_error(_1) }
+        output = capture(:stdout) { data_migration.run }
+        ensure_no_error(output)
       end
 
       protected

data/lib/monarch_migrate/version.rb

@@ -1,3 +1,3 @@
 module MonarchMigrate
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monarch_migrate
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yanko Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails