data_migrate 5.1.0 → 6.0.5

data/lib/data_migrate/data_migrator_five.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require "active_record"
+require "data_migrate/config"
 
 module DataMigrate
   class DataMigrator < ActiveRecord::Migrator
-    self.migrations_paths = ["db/data"]
+    def self.migrations_paths
+      [DataMigrate.config.data_migrations_path]
+    end
 
     def self.assure_data_schema_table
       ActiveRecord::Base.establish_connection(db_config)
@@ -42,6 +45,9 @@ module DataMigrate
         /(\d{14})_(.+)\.rb/.match(filename)
       end
 
+      def needs_migration?
+        DataMigrate::DatabaseTasks.pending_migrations.count.positive?
+      end
       ##
       # Provides the full migrations_path filepath
       # @return (String)
@@ -53,9 +59,10 @@ module DataMigrate
         DataMigrate::MigrationContext.new(migrations_paths).migrations_status
       end
 
-      #TODO: this was added to be backward compatible, need to re-evaluate
+      # TODO: this was added to be backward compatible, need to re-evaluate
       def migrations(_migrations_paths)
-        DataMigrate::MigrationContext.new(migrations_paths).migrations
+        #DataMigrate::MigrationContext.new(migrations_paths).migrations
+        DataMigrate::MigrationContext.new(_migrations_paths).migrations
       end
 
       #TODO: this was added to be backward compatible, need to re-evaluate

data/lib/data_migrate/database_tasks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "data_migrate/config"
+
 module DataMigrate
   ##
   # This class extends DatabaseTasks to add a schema_file method.
@@ -26,7 +28,7 @@ module DataMigrate
     end
 
     def self.data_migrations_path
-      "db/data/"
+      DataMigrate.config.data_migrations_path
     end
 
     def self.schema_migrations_path

data/lib/data_migrate/schema_migration_five.rb

@@ -3,7 +3,7 @@ module DataMigrate
   # to allow data/schema combiation tasks
   class SchemaMigration
     def self.pending_schema_migrations
-      all_migrations = ActiveRecord::MigrationContext.new(migrations_paths).migrations
+      all_migrations = DataMigrate::MigrationContext.new(migrations_paths).migrations
       sort_migrations(
         ActiveRecord::Migrator.new(:up, all_migrations).
         pending_migrations.

data/lib/data_migrate/schema_migration_six.rb

@@ -0,0 +1,31 @@
+module DataMigrate
+  # Helper class to getting access to db schema
+  # to allow data/schema combiation tasks
+  class SchemaMigration
+    def self.pending_schema_migrations
+      all_migrations = DataMigrate::MigrationContext.new(migrations_paths).migrations
+      sort_migrations(
+        ActiveRecord::Migrator.new(:up, all_migrations, ActiveRecord::Base.connection.schema_migration).
+        pending_migrations.
+        map {|m| { version: m.version, kind: :schema }}
+      )
+    end
+
+    def self.run(direction, migration_paths, version)
+      ActiveRecord::MigrationContext.new(migration_paths, ActiveRecord::Base.connection.schema_migration).run(direction, version)
+    end
+
+    def self.sort_migrations(set1, set2 = nil)
+      migrations = set1 + (set2 || [])
+      migrations.sort {|a, b|  sort_string(a) <=> sort_string(b)}
+    end
+
+    def self.migrations_paths
+      Rails.application.config.paths["db/migrate"].to_a
+    end
+
+    def self.sort_string(migration)
+      "#{migration[:version]}_#{migration[:kind] == :data ? 1 : 0}"
+    end
+  end
+end

data/lib/data_migrate/status_service.rb

@@ -52,7 +52,7 @@ module DataMigrate
 
     def migration_files(db_list)
       file_list = []
-      Dir.foreach(File.join(root_folder, "db", "data")) do |file|
+      Dir.foreach(File.join(root_folder, DataMigrate.config.data_migrations_path)) do |file|
         # only files matching "20091231235959_some_name.rb" pattern
         if match_data = DataMigrate::DataMigrator.match(file)
           status = db_list.delete(match_data[1]) ? "up" : "down"

data/lib/data_migrate/tasks/data_migrate_tasks.rb

@@ -3,21 +3,17 @@ module DataMigrate
     module DataMigrateTasks
       extend self
       def migrations_paths
-        @migrations_paths ||= begin
-          if Rails.application && Rails.application.paths["data/migrate"]
-            Rails.application.paths["data/migrate"].to_a
-          end
-        end
+        @migrations_paths ||= DataMigrate.config.data_migrations_path
       end
 
       def migrate
         DataMigrate::DataMigrator.assure_data_schema_table
         target_version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
-        if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 2
+        if (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 2) ||
+          Rails::VERSION::MAJOR == 6
           DataMigrate::MigrationContext.new(migrations_paths).migrate(target_version)
         else
-          paths = migrations_paths || "db/data/"
-          DataMigrate::DataMigrator.migrate(paths, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+          DataMigrate::DataMigrator.migrate(migrations_paths, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
         end
       end
     end

data/lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-  VERSION = "5.1.0".freeze
+  VERSION = "6.0.5".freeze
 end

data/lib/generators/data_migration/data_migration_generator.rb

@@ -2,6 +2,7 @@ require "generators/data_migrate"
 require "rails/generators"
 require "rails/generators/active_record/migration"
 require "rails/generators/migration"
+require "data_migrate/config"
 
 module DataMigrate
   module Generators
@@ -13,7 +14,7 @@ module DataMigrate
 
       def create_data_migration
         set_local_assigns!
-        migration_template "data_migration.rb", "db/data/#{file_name}.rb"
+        migration_template "data_migration.rb", data_migrations_file_path
       end
 
       protected
@@ -34,6 +35,14 @@ module DataMigrate
           "ActiveRecord::Migration"
         end
       end
+
+      def data_migrations_file_path
+        File.join(data_migrations_path, "#{file_name}.rb")
+      end
+
+      def data_migrations_path
+        DataMigrate.config.data_migrations_path
+      end
     end
   end
 end

data/spec/data_migrate/config_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe DataMigrate::Config do
+
+  it "sets default data_migrations_path path", :no_override do
+    expect(DataMigrate.config.data_migrations_path).to eq "db/data/"
+  end
+
+  describe "data migration path configured" do
+    before do
+      @before = DataMigrate.config.data_migrations_path
+      DataMigrate.configure do |config|
+        config.data_migrations_path = "db/awesome/"
+      end
+    end
+
+    after do
+      DataMigrate.configure do |config|
+        config.data_migrations_path = @before
+      end
+    end
+
+    it do
+      expect(DataMigrate.config.data_migrations_path).to eq "db/awesome/"
+    end
+  end
+end

data/spec/data_migrate/data_migrator_spec.rb

@@ -9,6 +9,11 @@ describe DataMigrate::DataMigrator do
     }
   end
 
+  before do
+    allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
+    ActiveRecord::Base.establish_connection(db_config)
+  end
+
   describe :load_migrated do
     before do
       allow(subject).to receive(:db_config) { db_config }.at_least(:once)
@@ -56,6 +61,22 @@ describe DataMigrate::DataMigrator do
     end
   end
 
+  describe "#migrations_status" do
+    before do
+      allow(subject).to receive(:db_config) { db_config }.at_least(:once)
+      ActiveRecord::Base.establish_connection(db_config)
+      ::ActiveRecord::SchemaMigration.create_table
+      DataMigrate::DataSchemaMigration.create_table
+    end
+
+    it "returns all migrations statuses" do
+      status = subject.migrations_status
+      expect(status.length).to eq 2
+      expect(status.first).to eq ["down", "20091231235959", "Some name"]
+      expect(status.second).to eq ["down", "20171231235959", "Super update"]
+    end
+  end
+
   describe :match do
     context "when the file does not match" do
       it "returns nil" do

data/spec/data_migrate/database_tasks_spec.rb

@@ -5,7 +5,9 @@ require "spec_helper"
 describe DataMigrate::DatabaseTasks do
   let(:subject) { DataMigrate::DatabaseTasks }
   let(:migration_path) {
-    if Rails::VERSION::MAJOR == 5
+    if Rails::VERSION::MAJOR == 6
+      "spec/db/migrate/6.0"
+    elsif Rails::VERSION::MAJOR == 5
       if Rails::VERSION::MINOR == 2
         "spec/db/migrate/5.2"
       else
@@ -16,15 +18,7 @@ describe DataMigrate::DatabaseTasks do
     end
   }
   let(:data_migrations_path) {
-    if Rails::VERSION::MAJOR == 5
-      if Rails::VERSION::MINOR == 2
-        "spec/db/data"
-      else
-        "spec/db/5.0"
-      end
-    else
-      "spec/db/4.2"
-    end
+    DataMigrate.config.data_migrations_path
   }
   let(:db_config) do
     {

data/spec/data_migrate/migration_context_spec.rb

@@ -2,15 +2,24 @@ require "spec_helper"
 
 describe DataMigrate::DataMigrator do
   let(:context) {
-    DataMigrate::MigrationContext.new("spec/db/data")
+    if (Rails::VERSION::MAJOR == 6)
+      DataMigrate::MigrationContext.new("spec/db/data-6.0")
+    else
+      DataMigrate::MigrationContext.new("spec/db/data")
+    end
   }
   let(:schema_context) {
-    ActiveRecord::MigrationContext.new("spec/db/migrate/5.2")
+    if (Rails::VERSION::MAJOR == 6)
+      ActiveRecord::MigrationContext.new("spec/db/migrate/6.0", ActiveRecord::Base.connection.schema_migration)
+    else
+      ActiveRecord::MigrationContext.new("spec/db/migrate/5.2")
+    end
   }
 
   before do
-    unless Rails::VERSION::MAJOR == 5 and
-           Rails::VERSION::MINOR == 2
+    unless (Rails::VERSION::MAJOR == 5 and
+           Rails::VERSION::MINOR == 2) ||
+           Rails::VERSION::MAJOR == 6
       skip("Tests are only applicable for Rails 5.2")
     end
   end

data/spec/data_migrate/schema_migration_spec.rb

@@ -4,7 +4,9 @@ require "spec_helper"
 
 describe DataMigrate::SchemaMigration do
   let(:migration_path) {
-    if Rails::VERSION::MAJOR == 5
+    if Rails::VERSION::MAJOR == 6
+      "spec/db/migrate/6.0"
+    elsif Rails::VERSION::MAJOR == 5
       if Rails::VERSION::MINOR == 2
         "spec/db/migrate/5.2"
       else

data/spec/data_migrate/status_service_spec.rb

@@ -46,7 +46,7 @@ describe DataMigrate::StatusService do
         VALUES #{fixture_file_timestamps.map { |t| "(#{t})" }.join(', ')}
       SQL
 
-      allow_any_instance_of(service).to receive(:root_folder) { "spec" }
+      allow_any_instance_of(service).to receive(:root_folder) { "./" }
     end
 
     after do
@@ -62,6 +62,15 @@ describe DataMigrate::StatusService do
       expect(stream.read).to include expected
     end
 
+    it "excludes files without .rb extension" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "20181128000207  Excluded file"
+      expect(stream.read).to_not include expected
+    end
+
     it "shows missing file migration" do
       stream = StringIO.new
       service.dump(ActiveRecord::Base.connection, stream)

data/spec/data_migrate/tasks/data_migrate_tasks_spec.rb

@@ -11,21 +11,6 @@ describe DataMigrate::Tasks::DataMigrateTasks do
   end
 
   before do
-    if Rails::VERSION::MAJOR == 5
-      if Rails::VERSION::MINOR == 2
-        allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
-          "spec/db/data"
-        }
-      else
-        allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
-          "spec/db/5.0"
-        }
-      end
-    else
-      allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
-        "spec/db/4.2"
-      }
-    end
     allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
     ActiveRecord::Base.establish_connection(db_config)
   end
@@ -36,9 +21,9 @@ describe DataMigrate::Tasks::DataMigrateTasks do
 
   describe :migrate do
     it do
-      expect {
+       expect {
         DataMigrate::Tasks::DataMigrateTasks.migrate
-      }.to output(/20091231235959 SomeName: migrating/).to_stdout
+       }.to output(/20091231235959 SomeName: migrating/).to_stdout
     end
 
     it do

data/spec/db/{4.2 → 6.0}/20091231235959_some_name.rb

@@ -1,4 +1,4 @@
-class SomeName < ActiveRecord::Migration
+class SomeName < ActiveRecord::Migration[6.0]
   def up
     puts "Doing data migration"
   end

data/spec/db/{4.2 → 6.0}/20171231235959_super_update.rb

@@ -1,4 +1,4 @@
-class SuperUpdate < ActiveRecord::Migration
+class SuperUpdate < ActiveRecord::Migration[6.0]
   def up
     puts "Doing data migration"
   end

data/spec/db/data-6.0/20091231235959_some_name.rb

@@ -0,0 +1,9 @@
+class SomeName < ActiveRecord::Migration[6.0]
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    puts "Undoing SomeName"
+  end
+end

data/spec/db/data-6.0/20171231235959_super_update.rb

@@ -0,0 +1,9 @@
+class SuperUpdate < ActiveRecord::Migration[6.0]
+  def up
+    puts "Doing SuperUpdate"
+  end
+
+  def down
+    puts "Undoing SuperUpdate"
+  end
+end

data/spec/db/data-6.0/20181128000207_excluded_file.rb.other_ext

@@ -0,0 +1 @@
+# This file should be excluded

data/spec/db/data/20181128000207_excluded_file.rb.other_ext

@@ -0,0 +1 @@
+# This file should be excluded

data/spec/db/migrate/6.0/20131111111111_late_migration.rb

@@ -0,0 +1,9 @@
+class LateMigration < ActiveRecord::Migration[6.0]
+  def up
+    puts "Doing schema LateMigration"
+  end
+
+  def down
+    puts "Undoing LateMigration"
+  end
+end

data/spec/db/migrate/6.0/20202020202011_db_migration.rb

@@ -0,0 +1,9 @@
+class DbMigration < ActiveRecord::Migration[6.0]
+  def up
+    puts "Doing schema migration"
+  end
+
+  def down
+    puts "Undoing DbMigration"
+  end
+end

data/spec/generators/data_migration/data_migration_generator_spec.rb

@@ -24,4 +24,37 @@ describe DataMigrate::Generators::DataMigrationGenerator do
       end
     end
   end
+
+  describe :create_data_migration do
+    let(:subject) { DataMigrate::Generators::DataMigrationGenerator.new(['my_migration']) }
+    let(:data_migrations_file_path) { 'abc/my_migration.rb' }
+
+    context 'when custom data migrations path has a trailing slash' do
+      before do
+        DataMigrate.config.data_migrations_path = 'abc/'
+      end
+
+      it 'returns correct file path' do
+        expect(subject).to receive(:migration_template).with(
+          'data_migration.rb', data_migrations_file_path
+        )
+
+        subject.create_data_migration
+      end
+    end
+
+    context 'when custom data migrations path does not have a trailing slash' do
+      before do
+        DataMigrate.config.data_migrations_path = 'abc'
+      end
+
+      it 'returns correct file path' do
+        expect(subject).to receive(:migration_template).with(
+          'data_migration.rb', data_migrations_file_path
+        )
+
+        subject.create_data_migration
+      end
+    end
+  end
 end