monarch_migrate 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b59ad47f996564cc02e0577133692329e9a3b7052e2b0e0268c713cbf44b563
-  data.tar.gz: 98ab757d6e2fcdba24451c5f1816555e7ba6d65ba5c47d1dc0ab4cc94d562a7d
+  metadata.gz: 814685cc086ec84d8f1e877c80134db4c702b9d06602f4169f99dc82c1cd1ca8
+  data.tar.gz: 726adc5a2087bec90a6fa1fc1ec965d633c4de35f69298da2b42e7e043026af8
 SHA512:
-  metadata.gz: 296572f26ef2ac623e3409c4048f18ada537588100ada9b42caf08d73d9bd251c5ff9111b1079de512ff95892c3263177393268b860a6624617849f4c15ca49a
-  data.tar.gz: bb9a83dfb41ce4649ae45b58d4aaea1faeb9e47057f10b0161926a472164f15a2485faab8c4448058391f3daf5a1cd19c5c26cad8dd8a4377a7204f93bb4dd18
+  metadata.gz: 665c315826067e28509312d5cf9ef8729803dfb105a123aad44f81df9c0c2f46cd185f9d5381939def677d68553a150c37d2e1d5f040b2b281dc6085b47e31d9
+  data.tar.gz: ff6cb7e01f9071363eb561f392c80e8b8e97b371f853f79f35f1f4a594b8165f4e063d9225ec1ff3af992874a57ef081d16455a049fe547bfe8c6a354578a8d3

data/.github/workflows/ci.yml

@@ -45,5 +45,16 @@ jobs:
       - name: "Reset app database"
         run: bundle exec rake fake:db:reset
 
-      - name: "Run test"
-        run: bundle exec rake
+      - name: "Run tests without acceptance"
+        run: |
+          bundle exec rake test
+
+      - name: "Run acceptance tests for RSpec"
+        run: |
+          bundle add rspec-rails
+          bundle exec rake TEST=test/acceptance/testing_test.rb TESTOPTS="--name='test_rspec_tests'"
+
+      - name: "Run acceptance tests for TestUnit"
+        run: |
+          bundle remove rspec-rails
+          bundle exec rake TEST=test/acceptance/testing_test.rb TESTOPTS="--name='test_test_unit_tests'"

data/.gitignore

@@ -72,11 +72,13 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 # Migration generated during tests
-/test/generators/monarch_migrate/tmp
+/test/generators/**/tmp
 
 # Ignore gem compile directory
 /pkg
 
+/gemfiles/*.lock
+
 # Ignore bundler config.
 /.bundle
 

data/Appraisals

@@ -1,11 +1,14 @@
 appraise "rails_5.2" do
-  gem "railties", "~> 5.2"
+  gem "rails", "~> 5.2"
 end
 
 appraise "rails_6.1" do
-  gem "railties", "~> 6.1"
+  gem "rails", "~> 6.1"
+  gem "net-smtp", require: false
+  gem "net-imap", require: false
+  gem "net-pop", require: false
 end
 
 appraise "rails_7.0" do
-  gem "railties", "~> 7.0"
+  gem "rails", "~> 7.0"
 end

data/Gemfile

@@ -2,3 +2,11 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in *.gemspec
 gemspec name: "monarch_migrate"
+
+gem "appraisal"
+gem "break"
+gem "pry", require: false
+gem "rake"
+gem "rspec-rails"
+gem "sqlite3"
+gem "standard"

data/Gemfile.lock

@@ -2,12 +2,36 @@ PATH
   remote: .
   specs:
     monarch_migrate (0.4.0)
-      activerecord (>= 5.2.0)
-      railties (>= 5.2.0)
+      rails (>= 5.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      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)
+      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)
+      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)
@@ -15,17 +39,34 @@ GEM
       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)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
     actionview (7.0.3)
       activesupport (= 7.0.3)
       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)
+      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)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
     activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -36,26 +77,70 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
+    break (0.40.0)
     builder (3.2.4)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
+    diff-lcs (1.4.4)
+    digest (3.1.0)
     erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
     method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
     minitest (5.15.0)
-    nokogiri (1.13.6-x86_64-darwin)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      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)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -72,6 +157,23 @@ GEM
     rake (13.0.6)
     regexp_parser (2.4.0)
     rexml (3.2.5)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
     rubocop (1.29.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
@@ -91,10 +193,15 @@ GEM
     standard (1.12.1)
       rubocop (= 1.29.1)
       rubocop-performance (= 1.13.3)
+    strscan (3.0.3)
     thor (1.2.1)
+    timeout (0.3.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     zeitwerk (2.5.4)
 
 PLATFORMS
@@ -102,9 +209,11 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
-  minitest
+  break
   monarch_migrate!
+  pry
   rake
+  rspec-rails
   sqlite3
   standard
 

data/README.md

@@ -1,5 +1,7 @@
 # Sensible Data Migrations for Rails
 
+## Why
+
 <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>
   <a href="https://guides.rubyonrails.org/active_record_migrations.html#migrations-and-seed-data">
@@ -8,28 +10,27 @@
 </blockquote>
 
 The motivation behind Rails' migration mechanism is schema modification. Using it
-for data changes in the database comes second.
-
-Yet, adding of modifying data via regular migrations can be problematic.
+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
 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 usually stay in `db/migrate` for posterity.
+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 so when there are [scripts][2] to
+This is unnecessary for a pristine database. Especially when there are [scripts][2] to
 seed the correct data.
 
-In addition, using ActiveRecord models in migrations has its [quirks](#using-activerecord-models-in-migrations).
-
-The purpose of `monarch_migrate` is to solve the above issues with separating data
-from schema migrations.
+The purpose of `monarch_migrate` is to solve the above issues by separating data from schema migrations.
 
-This library assumes that:
+It is assumed 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 manually.
+- You want to write tests your data migrations.
+
+
 
 ## Install
 
@@ -41,40 +42,51 @@ gem "monarch_migrate"
 
 Run the bundle command to install it.
 
-After you install MonarchMigrate, you need to run the generator:
+After you install the gem, you need to run the generator:
 
 ```shell
 rails generate monarch_migrate:install
 ```
 
-The above generates a schema migration which adds a table for keeping track
-of run data migrations.
+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.
+
 
 
 ## Usage
 
-Data migrations in MonarchMigrate have a similar structure to regular migrations
-in Rails. Files are put into `db/data_migrate` and follow the same naming pattern.
+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.
+
+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:
+
+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 a new data migration, run:
+To create the data migration to update existing user records, run:
 
 ```shell
-rails generate monarch_migrate:data_migration downcase_usernames
+rails generate data_migration backfill_users_name
 ```
 
 In contrast to regular migrations, there is no need to inherit any classes:
 
 ```ruby
-# db/data_migrate/20220605083010_downcase_usernames.rb
+# db/data_migrate/20220605083010_backfill_users_name.rb
 ActiveRecord::Base.connection.execute(<<-SQL)
-  UPDATE users SET username = lower(username);
+  UPDATE users SET name = concat(first_name, ' ', last_name) WHERE name IS NULL;
 SQL
 
-SearchIndex.rebuild
+SearchIndex::RebuildJob.perform_later
 ```
 
 As seen above, it is plain ruby code where you can refer to any object you
-need. MonarchMigrate will run each migration in a separate transaction.
+need. Each data migration runs in a separate transaction.
 
 To run pending data migrations:
 
@@ -88,12 +100,127 @@ Or a specific version:
 rails data:migrate VERSION=20220605083010
 ```
 
+
+## Testing
+
+Testing data migrations can be the difference between simply rerunning
+the migration and having to recover from a data loss.
+
+This is why `monarch_migrate` includes test helpers for both RSpec and TestUnit.
+
+### RSpec
+
+For `rspec`, add the following line to your `spec/rails_helper.rb`:
+
+```ruby
+require "monarch_migrate/rspec"
+```
+
+Then:
+
+```ruby
+# spec/data_migrations/20220605083010_backfill_users_name_spec.rb
+describe "20220605083010_backfill_users_name", type: :data_migration do
+  subject { run_data_migration }
+
+  it "assigns user's name" do
+    user = users(:without_name_migrated)
+    # 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")
+  end
+
+  it "does not assign name to already migrated users" do
+    user = users(:with_name_migrated)
+    # or if you're using FactoryBot:
+    # user = create(:user, first_name: "", last_name: "", name: "Guybrush Threepwood")
+
+    expect(subject).not_to change { user.reload.name }
+  end
+
+  context "when the user has no last name" do
+    it "does not leave a trailing space" do
+      user = users(:without_name_migrated)
+      # 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")
+    end
+  end
+
+  # And so on ...
+end
+```
+
+### TestUnit
+
+For `test_unit`, add this line to your `test/test_helper.rb`:
+
+```ruby
+require "monarch_migrate/test_unit"
+```
+
+Then:
+
+```ruby
+# test/data_migrations/20220605083010_backfill_users_name_test.rb
+class BackfillUsersNameTest < MonarchMigrate::TestCase
+  def test_assigns_users_name
+    user = users(:without_name_migrated)
+    # or if you're using FactoryBot:
+    # user = create(:user, first_name: "Guybrush", last_name: "Threepwood", name: nil)
+
+    run_data_migration
+
+    assert_equal "Guybrush Threepwood", user.reload.name
+  end
+
+  def test_does_not_assign_name_to_alredy_migrated_users
+    user = users(:with_name_migrated)
+    # or if you're using FactoryBot:
+    # user = create(:user, first_name: "", last_name: "", name: "Guybrush Threepwood")
+
+    run_data_migration
+
+    assert_equal "Guybrush Threepwood", user.reload.name
+  end
+
+  def test_does_not_leave_trailing_space_when_user_has_no_last_name
+    user = users(:without_name_migrated)
+    # or if you're using FactoryBot:
+    # user = create(:user, first_name: "Guybrush", last_name: nil, name: nil)
+
+    run_data_migration
+
+    assert_equal "Guybrush", user.reload.name
+  end
+
+  # And so on ...
+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`.
+
+One solution is to use the following development workflow:
+
+1. Implement the data migration using TDD.
+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.
+
 ## Known Issues and Limitations
 
-The following issues and limitations are not necessary inherent to MonarchMigrate.
+The following issues and limitations are not necessary inherent to `monarch_migrate`.
 Some are innate to migrations in general.
 
-### Using ActiveRecord Models in Migrations
+
+### Using Models in Migrations
 
 <blockquote>
   <p>The Active Record way claims that intelligence belongs in your models, not in the database.</p>
@@ -106,15 +233,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.
 
-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:
-
-1. Add a `name` column to `users` table to hold the entire name of a person.
-2. Change the `User` model and use a data migration to update existing records.
-3. Drop `first_name` and `last_name` columns.
-
-A regular Rails migration for updating existing records may look something like this:
+Here is a regular Rails migration for our example:
 
 ```ruby
 # db/migrate/20220605083010_backfill_users_name.rb
@@ -155,22 +274,12 @@ limit their use and do as much processing as possible in Postgres.
 
 ### Long-running Tasks in Migrations
 
-As mentioned above, MonarchMigrate (similar to Rails) runs each migration in a separate
-transaction. A long-running task within a migration will keep the transaction open for
+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, we can run such tasks asynchronously.
-
-Back to the previous example:
-
-```ruby
-# db/data_migrate/20220605083010_downcase_usernames.rb
-ActiveRecord::Base.connection.execute(<<-SQL)
-  UPDATE users SET username = lower(username);
-SQL
+To avoid this, run such tasks asynchronously.
 
-SearchIndex::RebuildJob.perform_later
-```
 
 
 ## Trivia
@@ -185,19 +294,21 @@ The population cycles through three to five generations to reach their
 destination. In the end, a new generation of butterflies complete the
 journey their great-great-great-grandparents started.
 
-It is still a mystery to scientists how the new generations know where to go,
+It is a mystery to scientists how the new generations know where to go,
 but they appear to navigate using a combination of the Earth's magnetic field
 and the position of the sun.
 
-Genetically speaking, this is a truly incredible data migration!
+Genetically speaking, this is an incredible data migration!
+
 
 
 ## See Also
 
 Alternative gems
 
-- [nonschema_migrations](https://github.com/jasonfb/nonschema_migrations) - Exactly like schema migrations but for data.
-- [data-migrate](https://github.com/ilyakatz/data-migrate) - A gem to run data migrations alongside schema migrations.
+- https://github.com/OffgridElectric/rails-data-migrations
+- https://github.com/ilyakatz/data-migrate
+- https://github.com/jasonfb/nonschema_migrations
 
 Articles
 
@@ -208,6 +319,7 @@ Articles
 - [Rails Migrations with Zero Downtime](https://www.cloudbees.com/blog/rails-migrations-zero-downtime)
 
 
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,15 +1,24 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "standard/rake"
 
 namespace :fake do
   require_relative "test/fake/application"
   Fake::Application.load_tasks
 end
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new("test") do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
+    .exclude("test/acceptance/**/*_test.rb")
+    .exclude("test/fixtures/**/*_test.rb")
 end
 
-task default: :test
+Rake::TestTask.new("test:acceptance") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/acceptance/*_test.rb"]
+end
+
+task default: %w[test test:acceptance]

data/lib/generators/monarch_migrate/install/USAGE

@@ -2,4 +2,4 @@ Description:
   Generate a schema migration to create the table used for data migrations
 
 Examples:
-    rails generate monarch_migrate:install
+  rails generate monarch_migrate:install

data/lib/generators/monarch_migrate/install/install_generator.rb

@@ -28,7 +28,7 @@ module MonarchMigrate
       end
 
       def migration_table_name
-        MonarchMigrate.data_migrations_table_name
+        MigrationRecord.table_name
       end
 
       private

data/lib/generators/rails/data_migration/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Generate a new data migration
+
+Examples:
+  rails generate data_migration assign_name_to_users

data/lib/generators/{monarch_migrate → rails}/data_migration/data_migration_generator.rb

@@ -1,6 +1,6 @@
 require "rails/generators/active_record"
 
-module MonarchMigrate
+module Rails
   module Generators
     class DataMigrationGenerator < Rails::Generators::NamedBase
       include ActiveRecord::Generators::Migration
@@ -16,6 +16,8 @@ module MonarchMigrate
         )
       end
 
+      hook_for :test_framework, as: :data_migration
+
       private
 
       def validate_file_name!

data/lib/generators/rspec/USAGE

@@ -0,0 +1,12 @@
+Description:
+  Generate a spec for existing data migration.
+
+Examples:
+  Given a data migration `db/data_migrate/200010101011_downcase_users_name.rb`:
+    rails generate rspec:data_migration 200010101011_downcase_users_name
+
+  Alternatively, you can skip the version:
+    rails generate rspec:data_migration downcase_users_name
+
+  This will create:
+    spec/data_migrations/200010101011_downcase_users_name_spec.rb

data/lib/generators/rspec/data_migration_generator.rb

@@ -0,0 +1,37 @@
+module Rspec
+  module Generators
+    class DataMigrationGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_data_migration_test
+        unless data_migration
+          say "Expecting a data migration matching *#{data_migration_pattern} but none found. Aborting..."
+          return
+        end
+
+        template(
+          "data_migration_spec.rb.erb",
+          File.join("spec/data_migrations", "#{described_class}_spec.rb")
+        )
+      end
+
+      private
+
+      def described_class
+        File.basename(data_migration.filename, ".rb")
+      end
+
+      def data_migration_pattern
+        "#{file_name}.rb"
+      end
+
+      def data_migration
+        @data_migration ||=
+          MonarchMigrate.migrator
+            .migrations
+            .reverse
+            .find { |m| m.filename.ends_with?(data_migration_pattern) }
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/data_migration_spec.rb.erb

@@ -0,0 +1,5 @@
+require "rails_helper"
+
+RSpec.describe "<%= described_class %>", type: :data_migration do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/test_unit/USAGE

@@ -0,0 +1,12 @@
+Description:
+  Generate a spec for existing data migration.
+
+Examples:
+  Given a data migration `db/data_migrate/200010101011_downcase_users_name.rb`:
+    rails generate test_unit:data_migration 200010101011_downcase_users_name
+
+  Alternatively, you can skip the version:
+    rails generate test_unit:data_migration downcase_users_name
+
+  This will create:
+    test/data_migrations/200010101011_downcase_users_name_test.rb

data/lib/generators/test_unit/data_migration_generator.rb

@@ -0,0 +1,34 @@
+module TestUnit
+  module Generators
+    class DataMigrationGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "Test"
+
+      def create_data_migration_test
+        unless data_migration
+          say "Expecting a data migration matching *#{data_migration_pattern} but none found. Aborting..."
+          return
+        end
+
+        prefix = File.basename(data_migration.filename, ".rb")
+
+        template "unit_test.rb.erb", File.join("test/data_migrations", "#{prefix}_test.rb")
+      end
+
+      private
+
+      def data_migration_pattern
+        "#{file_name}.rb"
+      end
+
+      def data_migration
+        @data_migration ||=
+          MonarchMigrate.migrator
+            .migrations
+            .reverse
+            .find { |m| m.filename.ends_with?(data_migration_pattern) }
+      end
+    end
+  end
+end

data/lib/generators/test_unit/templates/unit_test.rb.erb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class <%= class_name %>Test < MonarchMigrate::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/lib/monarch_migrate/railtie.rb

@@ -1,3 +1,5 @@
+require "rails"
+
 module MonarchMigrate
   class Railtie < Rails::Railtie
     railtie_name :monarch_migrate

data/lib/monarch_migrate/rspec.rb

@@ -0,0 +1,5 @@
+require "monarch_migrate/testing"
+
+RSpec.configure do |config|
+  config.include MonarchMigrate::Testing::RSpec, type: :data_migration
+end

data/lib/monarch_migrate/test_unit.rb

@@ -0,0 +1,5 @@
+require "monarch_migrate/testing"
+
+class MonarchMigrate::TestCase < ActiveSupport::TestCase
+  include MonarchMigrate::Testing::TestUnit
+end

data/lib/monarch_migrate/testing.rb

@@ -0,0 +1,87 @@
+require "active_support/core_ext/string"
+require "stringio"
+
+module MonarchMigrate
+  module Testing
+    MigrationRunError = Class.new(RuntimeError)
+
+    module Helpers
+      def data_migration
+        @data_migration ||=
+          begin
+            filename = data_migration_basename
+            migrator
+              .migrations
+              .find(method(:not_found)) { |m| m.filename.ends_with?(filename) }
+          end
+      end
+
+      def run_data_migration
+        output = StringIO.new
+        data_migration.run(output)
+        output.string.tap { ensure_no_error(_1) }
+      end
+
+      protected
+
+      def data_migration_basename
+        raise NotImplementedError
+      end
+
+      def data_migration_failed(message)
+        raise NotImplementedError
+      end
+
+      def migrator
+        ::MonarchMigrate.migrator
+      end
+
+      def not_found
+        path = File.join(migrator.path, "*_#{data_migration_basename}")
+        raise <<~MSG
+          \n\r
+          Can not find data migration at path: #{path}
+          \n\r
+        MSG
+      end
+
+      def ensure_no_error(str)
+        if %r{Migration failed}.match?(str)
+          data_migration_failed(<<-CMD)
+            Failed running data migration: #{data_migration.filename}
+            \n\r
+            Output:
+            \n\r
+            \n\r
+            #{str}
+          CMD
+        end
+      end
+    end
+
+    module RSpec
+      include Helpers
+
+      def data_migration_basename
+        spec_path = ::RSpec.current_example.metadata[:file_path]
+        File.basename(spec_path).sub(/_spec\.rb$/, ".rb")
+      end
+
+      def data_migration_failed(message)
+        fail message
+      end
+    end
+
+    module TestUnit
+      include Helpers
+
+      def data_migration_basename
+        File.basename(self.class.name.underscore).sub(/_test$/, ".rb")
+      end
+
+      def data_migration_failed(message)
+        flunk message
+      end
+    end
+  end
+end

data/lib/monarch_migrate/version.rb

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

data/lib/monarch_migrate.rb

@@ -15,6 +15,7 @@ module MonarchMigrate
   end
 end
 
+require "rails"
 require "monarch_migrate/migration"
 require "monarch_migrate/migration_record"
 require "monarch_migrate/migrator"

data/monarch_migrate.gemspec

@@ -20,12 +20,5 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|gemfiles|tmp)/}) }
   end
 
-  spec.add_dependency("activerecord", ">= 5.2.0")
-  spec.add_dependency("railties", ">= 5.2.0")
-
-  spec.add_development_dependency("appraisal")
-  spec.add_development_dependency("minitest")
-  spec.add_development_dependency("rake")
-  spec.add_development_dependency("sqlite3")
-  spec.add_development_dependency("standard")
+  spec.add_dependency("rails", ">= 5.2.0")
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: monarch_migrate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yanko Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,90 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: minitest
-  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: 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: 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: standard
-  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:
 email:
 - yanko.ivanov@gmail.com
@@ -126,18 +42,27 @@ files:
 - Rakefile
 - bin/setup
 - db/schema.rb
-- lib/generators/monarch_migrate/data_migration/USAGE
-- lib/generators/monarch_migrate/data_migration/data_migration_generator.rb
-- lib/generators/monarch_migrate/data_migration/templates/data_migration.rb.erb
 - lib/generators/monarch_migrate/install/USAGE
 - lib/generators/monarch_migrate/install/install_generator.rb
 - lib/generators/monarch_migrate/install/templates/create_data_migration_records.rb.erb
+- lib/generators/rails/data_migration/USAGE
+- lib/generators/rails/data_migration/data_migration_generator.rb
+- lib/generators/rails/data_migration/templates/data_migration.rb.erb
+- lib/generators/rspec/USAGE
+- lib/generators/rspec/data_migration_generator.rb
+- lib/generators/rspec/templates/data_migration_spec.rb.erb
+- lib/generators/test_unit/USAGE
+- lib/generators/test_unit/data_migration_generator.rb
+- lib/generators/test_unit/templates/unit_test.rb.erb
 - lib/monarch_migrate.rb
 - lib/monarch_migrate/migration.rb
 - lib/monarch_migrate/migration_record.rb
 - lib/monarch_migrate/migrator.rb
 - lib/monarch_migrate/railtie.rb
+- lib/monarch_migrate/rspec.rb
 - lib/monarch_migrate/tasks.rake
+- lib/monarch_migrate/test_unit.rb
+- lib/monarch_migrate/testing.rb
 - lib/monarch_migrate/version.rb
 - monarch_migrate.gemspec
 homepage: https://github.com/lunohodov/monarch

data/lib/generators/monarch_migrate/data_migration/USAGE

@@ -1,5 +0,0 @@
-Description:
-  Generate a new data migration
-
-Examples:
-    rails generate monarch_migrate:data_migration assign_name_to_users