migration_data 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcfa827b7ff6fe4bf4509b6c4a5d148a52ad5328312de09c482b6532d3bdf893
-  data.tar.gz: 7ce0546a76606344b3b17c0e26bfae78724c66556e3c928cefc8a2919910489c
+  metadata.gz: 2e38d42f09ec6e1f9ad7d4a5f2ed30b09620d96cacf0b0e350e075e48a903c01
+  data.tar.gz: 8b89215996f8767f76d3bbcb00cf877df9926081a5002eb08b02264659a381db
 SHA512:
-  metadata.gz: bb1ed960aadd4db399fd6a9d0b1881484bfa494cbe654cc995114b6c23e0031d78ae77d9b1e2f888c72df885f77c33d69e9d8bb3e4f8a9df67f34b084fee6146
-  data.tar.gz: 6ed2163de0401cf380e786a823358d714f948eb968a3132c33a1672dfaac5a2e83e7c04b6b74cb0a14c767ab36ab1254a227cee71c7b3ce0ea9eef7c0380ea37
+  metadata.gz: 3946bc0b85d77e9371343b1e88c3cc5184fbb060ccbbbba7db76b2ed3cfa0c94025244ed9298029cb2cd928b39b2933f86c0177a9d458c65677a681e457a7afa
+  data.tar.gz: c5c064d32d9852fd5bd66b36e74a5816d773f9bbb15e7f3985304f9f11a5215e66a441478840bc110da8a08a7d540c3541558a20658a8927e2b05b0c3c202cf3

data/README.md

@@ -10,9 +10,9 @@ some techniques which help to avoid these pitfalls. For example, define model
 classes in the migrations or write raw SQL. But they don't help in 100% of all cases.
 This gem promises to solve this problem in a simple way.
 
-Currently the gem supports Rails 4 and Rails 5.
+In short, this gem promotes writing the code migrates data in separate methods of a schema migration. That separates concerns and allows writing tests for these methods. Also, they optionally can be skipped.
 
-If you still don't understand what this gem is for please check out [this blog post](http://railsguides.net/2014/01/30/change-data-in-migrations-like-a-boss/).
+If it's still not clear what this gem is for please check out [this blog post](http://railsguides.net/2014/01/30/change-data-in-migrations-like-a-boss/).
 
 ## Installation
 
@@ -30,7 +30,7 @@ Or install it yourself as:
 
 ## Usage
 
-In your migration define a `data` method:
+In your migration define a `#data` method:
 
 ```ruby
 class CreateUsers < ActiveRecord::Migration
@@ -48,11 +48,41 @@ class CreateUsers < ActiveRecord::Migration
 end
 ```
 
-That's it. Now when you run migrations with the `rake db:migrate` command the `data` method will be run on `up`.
-When you rollback migrations with the `rake db:rollback` command the `rollback` method will be run on `down`.
+Now when migrations run with `rake db:migrate` command the `#data` method is executed right after the standard `#change` or `#up` method.
+
+When migrations roll back with `rake db:rollback` command the `#rollback` is executed right after the standard `#change` or `#down` method.
+
+It might appear that a data migration should run *before* the standard `#change`, `#up`, and `#down` methods. Define `#data_before` and `#rollback_before` methods for "up" and "down" directions correspondingly. There are also `#data_after` and `#rollback_after` methods for symmetry in that case, but basically they play the same role as `#data` and `#rollback` methods.
+
+All these methods can be defined in one migration. They are executed in the following order when migration is run on up:
+- `#data_before`
+- `#change/up`
+- `#data`
+- `#data_after`
+
+and on down:
+
+- `#rollback_before`
+- `#change/down`
+- `#rollback`
+- `#rollback_after`.
 
 > Note: in some circumstances, the `reset_column_information` method should be called on a model which table is changed in the migration. Especially when you are certain that there should be present some column for a model but it's absent for some reason. Read more about this in the [official Rails docs](http://guides.rubyonrails.org/v4.1/migrations.html#using-models-in-your-migrations).
 
+## Skipping data migrations execution
+
+At some point, one might realize that data migrations should not run on particular environments, e.g. `test`.
+
+On performing migrations in `test` environment, a data migration might try to add the same data that has already been added by seeds. In that case, migrations might fail with a duplication error.
+
+Use `MigrationData.config.skip = true` to skip data migrations execution. One might put this code in an initializer, e.g. `config/initializers/migration_data.rb`:
+
+```ruby
+if Rails.env.test?
+  MigrationData.config.skip = true
+end
+```
+
 ## Testing migrations
 
 To keep your migrations working don't forget to write tests for them. It's preferably to put the tests for migrations into `spec/db/migrations` folder, but actually it's up to you. Possible `RSpec` test (`spec/db/migrations/create_user.rb`) for the migration looks like this:
@@ -83,20 +113,6 @@ end
 
 The helper to load migrations `require_migration` is defined in the `migration_data/testing`. So you should to require it to have access to this convenient require extension.
 
-## Skipping data migrations execution
-
-At some point, one might realize that data migrations should not run on particular environments, e.g. `test`.
-
-On performing migrations in `test` environment, a data migration might try to add the same data that has already been added by seeds. In that case, migrations might fail with a duplication error.
-
-Use `MigrationData.config.skip = true` to skip data migrations execution. One might put this code in an initializer, e.g. `config/initializers/migration_data.rb`:
-
-```ruby
-if Rails.env.test?
-  MigrationData.config.skip = true
-end
-```
-
 ## Contributing
 
 1. Fork it ( http://github.com/ka8725/migration_data/fork )

data/lib/migration_data/active_record/migration.rb

@@ -14,15 +14,26 @@ module MigrationData
       def self.included(base)
         base.class_eval do
           def exec_migration_with_data(conn, direction)
+            data_before if should_run?(direction == :up, :data_before)
+            rollback_before if should_run?(direction == :down, :rollback_before)
+
             origin_exec_migration(conn, direction)
             ::ActiveRecord::Base.connection.schema_cache.clear!
-            return if MigrationData.config.skip_data_on_test
-            data if direction == :up && respond_to?(:data)
-            rollback if direction == :down && respond_to?(:rollback)
+
+            data if should_run?(direction == :up, :data)
+            data_after if should_run?(direction == :up, :data_after)
+            rollback if should_run?(direction == :down, :rollback)
+            rollback_after if should_run?(direction == :down, :rollback_after)
           end
 
           alias origin_exec_migration exec_migration
           alias exec_migration exec_migration_with_data
+
+          private
+
+          def should_run?(is_ok_direction, method_name)
+            is_ok_direction && !MigrationData.config.skip && respond_to?(method_name)
+          end
         end
       end
     end

data/lib/migration_data/config.rb

@@ -1,5 +1,6 @@
 module MigrationData
-  @config = Struct.new(:skip_data_on_test).new(false)
+  @config = Struct.new(:skip).new(false)
+
   def self.config
     @config
   end

data/lib/migration_data/version.rb

@@ -1,3 +1,3 @@
 module MigrationData
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/test/migration_test.rb

@@ -1,15 +1,36 @@
 require 'test_helper'
 
 class MyMigration < ActiveRecord::Migration[4.2]
-  attr_reader :migrated_data, :rolled_back_data
+  attr_reader :migrated_data_before,
+              :migrated_data,
+              :migrated_data_after,
+              :rolled_back_data_before,
+              :rolled_back_data,
+              :rolled_back_data_after
+
+  def data_before
+    @migrated_data_before = true
+  end
 
   def data
     @migrated_data = true
   end
 
+  def data_after
+    @migrated_data_after = true
+  end
+
+  def rollback_before
+    @rolled_back_data_before = true
+  end
+
   def rollback
     @rolled_back_data = true
   end
+
+  def rollback_after
+    @rolled_back_data_after = true
+  end
 end
 
 describe MyMigration do
@@ -20,42 +41,50 @@ describe MyMigration do
   describe '#migrate' do
     it 'runs #data on up direction' do
       @migration.migrate(:up)
+      assert @migration.migrated_data_before
       assert @migration.migrated_data
+      assert @migration.migrated_data_after
     end
 
     it "doesn't run #data on down direction" do
       @migration.migrate(:down)
+      assert_nil @migration.migrated_data_before
       assert_nil @migration.migrated_data
+      assert_nil @migration.migrated_data_after
     end
 
     it 'runs #rollback on down direction' do
       @migration.migrate(:down)
+      assert @migration.rolled_back_data_before
       assert @migration.rolled_back_data
+      assert @migration.rolled_back_data_after
     end
 
     it "doesn't run #rollback on up direction" do
       @migration.migrate(:up)
+      assert_nil @migration.rolled_back_data_before
       assert_nil @migration.rolled_back_data
+      assert_nil @migration.rolled_back_data_after
     end
-  end
 
-  describe "#migrate with Rails.env = test and skip_data_on_test = true" do
-    before do
-      @old_skip, MigrationData.config.skip_data_on_test = MigrationData.config.skip_data_on_test, true
-    end
+    describe 'when skipping' do
+      before do
+        @old_skip, MigrationData.config.skip = MigrationData.config.skip, true
+      end
 
-    after do
-      MigrationData.config.skip_data_on_test = @old_skip
-    end
+      after do
+        MigrationData.config.skip = @old_skip
+      end
 
-    it "doesn't runs #data" do
-      @migration.migrate(:up)
-      refute @migration.migrated_data
-    end
+      it "doesn't runs #data" do
+        @migration.migrate(:up)
+        refute @migration.migrated_data
+      end
 
-    it "doesn't runs #rollback" do
-      @migration.migrate(:down)
-      refute @migration.rolled_back_data
+      it "doesn't runs #rollback" do
+        @migration.migrate(:down)
+        refute @migration.rolled_back_data
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: migration_data
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Koleshko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler