data_migrate 3.2.0 → 11.3.0

data/lib/data_migrate/rails_helper.rb

@@ -0,0 +1,91 @@
+module DataMigrate
+  class RailsHelper
+    class << self
+      def rails_version_equal_to_or_higher_than_7_2
+        return @equal_to_or_higher_than_7_2 if defined?(@equal_to_or_higher_than_7_2)
+
+        @equal_to_or_higher_than_7_2 = Gem::Dependency.new("railties", ">= 7.2.0.alpha").match?("railties", Gem.loaded_specs["railties"].version, true)
+      end
+
+      def rails_version_equal_to_or_higher_than_7_1
+        return @equal_to_or_higher_than_7_1 if defined?(@equal_to_or_higher_than_7_1)
+
+        @equal_to_or_higher_than_7_1 = Gem::Dependency.new("railties", ">= 7.1.0.alpha").match?("railties", Gem.loaded_specs["railties"].version, true)
+      end
+
+      def rails_version_equal_to_or_higher_than_7_0
+        return @rails_version_equal_to_or_higher_than_7_0 if defined?(@rails_version_equal_to_or_higher_than_7_0)
+
+        @rails_version_equal_to_or_higher_than_7_0 = Gem::Dependency.new("railties", ">= 7.0").match?("railties", Gem.loaded_specs["railties"].version, true)
+      end
+
+      def internal_metadata
+        if rails_version_equal_to_or_higher_than_7_2
+          ActiveRecord::Base.connection_pool.internal_metadata
+        elsif rails_version_equal_to_or_higher_than_7_1
+          ActiveRecord::Base.connection.internal_metadata
+        else
+          ActiveRecord::InternalMetadata
+        end
+      end
+
+      def schema_migration
+        if rails_version_equal_to_or_higher_than_7_2
+          ActiveRecord::Base.connection_pool.schema_migration
+        elsif rails_version_equal_to_or_higher_than_7_1
+          ActiveRecord::Base.connection.schema_migration
+        else
+          ActiveRecord::SchemaMigration
+        end
+      end
+
+      def schema_migration_versions
+        if rails_version_equal_to_or_higher_than_7_1
+          schema_migration.versions
+        else
+          schema_migration.all.pluck(:version)
+        end
+      end
+
+      def schema_create_version(version)
+        if rails_version_equal_to_or_higher_than_7_1
+          schema_migration.create_version(version)
+        else
+          schema_migration.create(version: version)
+        end
+      end
+
+      def data_schema_delete_version(version)
+        if rails_version_equal_to_or_higher_than_7_1
+          data_schema_migration.delete_version(version)
+        else
+          data_schema_migration.where(version: version.to_s).delete_all
+        end
+      end
+
+      def data_schema_migration
+        if rails_version_equal_to_or_higher_than_7_2
+          DataMigrate::DataSchemaMigration.new(ActiveRecord::Tasks::DatabaseTasks.migration_connection_pool)
+        elsif rails_version_equal_to_or_higher_than_7_1
+          DataMigrate::DataSchemaMigration.new(ActiveRecord::Tasks::DatabaseTasks.migration_connection)
+        else
+          DataMigrate::DataSchemaMigration
+        end
+      end
+
+      def data_migrator(
+        direction,
+        migrations,
+        schema_migration = DataMigrate::RailsHelper.schema_migration,
+        internal_metadata = DataMigrate::RailsHelper.internal_metadata,
+        target_version = nil
+      )
+        if rails_version_equal_to_or_higher_than_7_1
+          DataMigrate::DataMigrator.new(direction, migrations, schema_migration, internal_metadata, target_version)
+        else
+          DataMigrate::DataMigrator.new(direction, migrations, schema_migration, target_version)
+        end
+      end
+    end
+  end
+end

data/lib/data_migrate/schema_dumper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DataMigrate
+  ##
+  # Provides the capability to write the current data schema version to
+  # the data_schema file Based on ActiveRecord::SchemaDumper
+  class SchemaDumper
+    private_class_method :new
+
+    class << self
+      def dump(connection = ActiveRecord::Base.connection, stream = $stdout)
+        new(connection).dump(stream)
+        stream
+      end
+    end
+
+    def dump(stream)
+      define_params = @version ? "version: #{@version}" : ""
+
+      stream.puts "DataMigrate::Data.define(#{define_params})"
+
+      stream
+    end
+
+    private
+
+    def initialize(connection)
+      @connection = connection
+      all_versions =  DataMigrate::RailsHelper.data_schema_migration.normalized_versions
+
+      @version = begin
+                    all_versions.max
+                  rescue StandardError
+                    0
+                  end
+    end
+  end
+end

data/lib/data_migrate/schema_migration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+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, DataMigrate::RailsHelper.schema_migration, DataMigrate::RailsHelper.internal_metadata).
+        pending_migrations.
+        map {|m| { version: m.version, kind: :schema }}
+      )
+    end
+
+    def self.run(direction, migration_paths, version)
+      ActiveRecord::MigrationContext.new(migration_paths, DataMigrate::RailsHelper.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
+      spec_name = DataMigrate.config.spec_name
+      # The positional argument true is to include pre-release versions, such as 7.1.0.alpha
+      if spec_name && Gem::Dependency.new("railties", ">= 7.0").match?("railties", Gem.loaded_specs["railties"].version, true)
+        ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: spec_name).migrations_paths
+      elsif spec_name && Gem::Dependency.new("railties", "~> 6.1").match?("railties", Gem.loaded_specs["railties"].version)
+        ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, spec_name: spec_name).migrations_paths
+      else
+        Rails.application.config.paths["db/migrate"].to_a
+      end
+    end
+
+    def self.sort_string(migration)
+      "#{migration[:version]}_#{migration[:kind] == :data ? 1 : 0}"
+    end
+  end
+end

data/lib/data_migrate/status_service.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DataMigrate
+  class StatusService
+    class << self
+      def dump(connection = ActiveRecord::Base.connection, stream = $stdout)
+        new(connection).dump(stream)
+        stream
+      end
+    end
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def root_folder
+      Rails.root
+    end
+
+    def dump(stream)
+      output(stream)
+    end
+
+    private
+
+    def table_name
+      DataMigrate::RailsHelper.data_schema_migration.table_name
+    end
+
+    def output(stream)
+      unless DataMigrate::RailsHelper.data_schema_migration.table_exists?
+        stream.puts "Data migrations table does not exist yet."
+        return
+      end
+
+      # output
+      stream.puts "\ndatabase: #{database_name}\n\n"
+      stream.puts "#{"Status".center(8)}  #{"Migration ID".ljust(14)}  Migration Name"
+      stream.puts "-" * 50
+      db_list.each do |status, version, name|
+        stream.puts "#{status.center(8)}  #{version.ljust(14)}  #{name}"
+      end
+      stream.puts
+    end
+
+    def database_name
+      if Gem::Dependency.new("railties", "~> 7.0").match?("railties", Gem.loaded_specs["railties"].version)
+        ActiveRecord::Base.connection_db_config.configuration_hash[:database]
+      elsif Gem::Dependency.new("railties", "~> 6.1").match?("railties", Gem.loaded_specs["railties"].version)
+        ActiveRecord::Base.connection_config[:database]
+      end
+    end
+
+    def db_list
+      DataMigrate::DataMigrator.migrations_status
+    end
+  end
+end

data/lib/data_migrate/tasks/data_migrate_tasks.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module DataMigrate
+  module Tasks
+    module DataMigrateTasks
+      extend self
+
+      def migrations_paths
+        @migrations_paths ||= Array.wrap(DataMigrate.config.data_migrations_path)
+      end
+
+      def dump
+        if dump_schema_after_migration?
+          filename = DataMigrate::DatabaseTasks.schema_file
+          ActiveRecord::Base.establish_connection(DataMigrate.config.db_configuration) if DataMigrate.config.db_configuration
+          File.open(filename, "w:utf-8") do |file|
+            DataMigrate::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+          end
+        end
+      end
+
+      def migrate
+        target_version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+
+        DataMigrate::DataMigrator.create_data_schema_table
+        DataMigrate::MigrationContext.new(migrations_paths).migrate(target_version)
+      end
+
+      def abort_if_pending_migrations(migrations, message)
+        if migrations.any?
+          puts "You have #{migrations.size} pending #{'migration'.pluralize(migrations.size)}:"
+          migrations.each do |pending_migration|
+            puts "  %4d %s" % [pending_migration[:version], pending_migration[:name]]
+          end
+          abort message
+        end
+      end
+
+      def dump_schema_after_migration?
+        if ActiveRecord.respond_to?(:dump_schema_after_migration)
+          ActiveRecord.dump_schema_after_migration
+        else
+          ActiveRecord::Base.dump_schema_after_migration
+        end
+      end
+
+      def status
+        DataMigrate::StatusService.dump
+      end
+
+      def status_with_schema
+        db_list_data = ActiveRecord::Base.connection.select_values(
+          "SELECT version FROM #{DataMigrate::RailsHelper.data_schema_migration.table_name}"
+        )
+        db_list_schema = DataMigrate::RailsHelper.schema_migration_versions
+        file_list = []
+
+        migrations_paths.each do |path|
+          Dir.foreach(File.join(Rails.root, path)) do |file|
+            # only files matching "20091231235959_some_name.rb" pattern
+            if match_data = /(\d{14})_(.+)\.rb/.match(file)
+              status = db_list_data.delete(match_data[1]) ? 'up' : 'down'
+              file_list << [status, match_data[1], match_data[2], 'data']
+            end
+          end
+        end
+
+        DataMigrate::SchemaMigration.migrations_paths.map do |path|
+          Dir.children(path) if Dir.exist?(path)
+        end.flatten.compact.each do |file|
+          # only files matching "20091231235959_some_name.rb" pattern
+          if match_data = /(\d{14})_(.+)\.rb/.match(file)
+            status = db_list_schema.delete(match_data[1]) ? 'up' : 'down'
+            file_list << [status, match_data[1], match_data[2], 'schema']
+          end
+        end
+
+        file_list.sort!{|a,b| "#{a[1]}_#{a[3] == 'data' ? 1 : 0}" <=> "#{b[1]}_#{b[3] == 'data' ? 1 : 0}" }
+
+        # output
+        puts "\ndatabase: #{database_name}\n\n"
+        puts "#{"Status".center(8)} #{"Type".center(8)}  #{"Migration ID".ljust(14)} Migration Name"
+        puts "-" * 60
+        file_list.each do |file|
+          puts "#{file[0].center(8)} #{file[3].center(8)} #{file[1].ljust(14)}  #{file[2].humanize}"
+        end
+        db_list_schema.each do |version|
+          puts "#{'up'.center(8)}  #{version.ljust(14)}  *** NO SCHEMA FILE ***"
+        end
+        db_list_data.each do |version|
+          puts "#{'up'.center(8)}  #{version.ljust(14)}  *** NO DATA FILE ***"
+        end
+        puts
+      end
+
+      private
+
+      def database_name
+        if Gem::Dependency.new("railties", "~> 7.0").match?("railties", Gem.loaded_specs["railties"].version)
+          ActiveRecord::Base.connection_db_config.database
+        elsif Gem::Dependency.new("railties", "~> 6.1").match?("railties", Gem.loaded_specs["railties"].version)
+          ActiveRecord::Base.connection_config[:database]
+        end
+      end
+    end
+  end
+end

data/lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-    VERSION = '3.2.0'.freeze
+  VERSION = "11.3.0".freeze
 end

data/lib/data_migrate.rb

@@ -1,8 +1,21 @@
-require File.join(File.dirname(__FILE__), 'data_migrate', 'data_migrator')
-require File.join(File.dirname(__FILE__), 'data_migrate', 'data_schema_migration')
-if Rails::VERSION::MAJOR >= 5
-  require File.join(File.dirname(__FILE__), 'data_migrate', 'migration_five')
-else
-  require File.join(File.dirname(__FILE__), 'data_migrate', 'migration')
+# frozen_string_literal: true
+
+require File.join(File.dirname(__FILE__), "data_migrate", "rails_helper")
+require File.join(File.dirname(__FILE__), "data_migrate", "data_migrator")
+require File.join(File.dirname(__FILE__), "data_migrate", "data_schema_migration")
+require File.join(File.dirname(__FILE__), "data_migrate", "data_schema")
+require File.join(File.dirname(__FILE__), "data_migrate", "database_tasks")
+require File.join(File.dirname(__FILE__), "data_migrate", "schema_dumper")
+require File.join(File.dirname(__FILE__), "data_migrate", "status_service")
+require File.join(File.dirname(__FILE__), "data_migrate", "migration_context")
+require File.join(File.dirname(__FILE__), "data_migrate", "railtie")
+require File.join(File.dirname(__FILE__), "data_migrate", "tasks/data_migrate_tasks")
+require File.join(File.dirname(__FILE__), "data_migrate", "config")
+require File.join(File.dirname(__FILE__), "data_migrate", "schema_migration")
+require File.join(File.dirname(__FILE__), "data_migrate", "database_configurations_wrapper")
+
+module DataMigrate
+  def self.root
+    File.dirname(__FILE__)
+  end
 end
-require File.join(File.dirname(__FILE__), 'data_migrate', 'railtie')

data/lib/generators/data_migrate.rb

@@ -1,9 +1,22 @@
 require 'rails/generators/named_base'
+
 module DataMigrate
   module Generators
     class DataMigrationGenerator < Rails::Generators::NamedBase #:nodoc:
-      def self.source_root
-         @_data_migrate_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), generator_name, 'templates'))
+      class << self
+        def source_root
+          build_data_migrate_source_root
+        end
+
+        private
+
+        def build_data_migrate_source_root
+          if DataMigrate.config.data_template_path == DataMigrate::Config::DEFAULT_DATA_TEMPLATE_PATH
+            File.expand_path(File.join(File.dirname(__FILE__), generator_name, 'templates'))
+          else
+            File.expand_path(File.dirname(DataMigrate.config.data_template_path))
+          end
+        end
       end
     end
   end

data/lib/generators/data_migration/data_migration_generator.rb

@@ -1,32 +1,24 @@
-require 'generators/data_migrate'
-require 'rails/generators'
-require 'rails/generators/migration'
+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
     class DataMigrationGenerator < Rails::Generators::NamedBase
       namespace "data_migration"
-      include Rails::Generators::Migration
+      include ActiveRecord::Generators::Migration
 
-      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
       def create_data_migration
         set_local_assigns!
-        migration_template 'data_migration.rb', "db/data/#{file_name}.rb"
+        migration_template template_path, data_migrations_file_path
       end
 
       protected
 
-      attr_reader :migration_action
-
-      def self.next_migration_number(dirname)
-        if ActiveRecord::Base.timestamped_migrations
-          Time.new.utc.strftime("%Y%m%d%H%M%S")
-        else
-          "%.3d" % (current_migration_number(dirname) + 1)
-        end
-      end
-
       def set_local_assigns!
         if file_name =~ /^(add|remove)_.*_(?:to|from)_(.*)/
           @migration_action = $1
@@ -34,12 +26,21 @@ module DataMigrate
         end
       end
 
+      def template_path
+        DataMigrate.config.data_template_path
+      end
+
       def migration_base_class_name
-        if ActiveRecord.version >= Gem::Version.new('5.0')
-          "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
-        else
-          'ActiveRecord::Migration'
-        end
+        "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+
+      def data_migrations_file_path
+        File.join(data_migrations_path, "#{file_name}.rb")
+      end
+
+      # Use the first path in the data_migrations_path as the target directory
+      def data_migrations_path
+        Array.wrap(DataMigrate.config.data_migrations_path).first
       end
     end
   end

data/lib/generators/data_migration/templates/data_migration.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 class <%= migration_class_name %> < <%= migration_base_class_name %>
-  def self.up
+  def up
   end
 
-  def self.down
+  def down
     raise ActiveRecord::IrreversibleMigration
   end
 end