Upstream and allow engines

.github/workflows/gempush.yml

@@ -3,7 +3,7 @@ name: Ruby Gem
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build:

Changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 8.5.0
+
+Allow custom templates [bazay](https://github.com/bazay)
+
+## 8.4.0
+
+Avoid Globally Accessible Functions for All Rake Tasks [berniechiu](https://github.com/berniechiu)
+
+## 8.3.0
+
+Add delegation to exists? for use by third parties [foxondo](https://github.com/foxondo)
+
+## 8.2.0
+
+Delegate to anonymous subclass of AR::SchemaMigration [foxondo](https://github.com/foxondo)
+
 ## 8.1.1
 
 Revert 8.1.0 changes

README.md

@@ -108,6 +108,7 @@ You can override this setting in `config/initializers/data_migrate.rb`
 ```ruby
 DataMigrate.configure do |config|
   config.data_migrations_path = 'db/awesomepath/'
+  config.data_template_path = Rails.root.join("lib", "awesomepath", "custom_data_migration.rb")
   config.db_configuration = {
     'host' => '127.0.0.1',
     'database' => 'awesome_database',

data_migrate.gemspec

@@ -38,13 +38,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
-  s.post_install_message = <<-POST_INSTALL_MESSAGE
-#{"*" * 80}
-data-migrate: IMPORTANT: Breaking change introduced for migrations from v2.
-
-Failure to run the migration can have serious consequences.
-See Readme for more info.
-#{"*" * 80}
-POST_INSTALL_MESSAGE
 end

lib/data_migrate.rb

@@ -19,4 +19,7 @@
 end
 
 module DataMigrate
+  def self.root
+    File.dirname(__FILE__)
+  end
 end

lib/data_migrate/config.rb

@@ -12,13 +12,22 @@ def config
   end
 
   class Config
-    attr_accessor :data_migrations_gen_path, :data_migrations_path, :db_configuration, :spec_name
+    attr_accessor :data_migrations_path, :data_migrations_gen_path, :data_template_path, :db_configuration, :spec_name
+
+    DEFAULT_DATA_TEMPLATE_PATH = "data_migration.rb"
 
     def initialize
       @data_migrations_path = "db/data/"
-      @data_migrations_gen_path = "db/data/"
+      @data_migrations_gen_path = "db/data"
+      @data_template_path = DEFAULT_DATA_TEMPLATE_PATH
       @db_configuration = nil
       @spec_name = nil
     end
+
+    def data_template_path=(value)
+      @data_template_path = value.tap do |path|
+        raise ArgumentError, "File not found: '#{path}'" unless path == DEFAULT_DATA_TEMPLATE_PATH || File.exists?(path)
+      end
+    end
   end
 end

lib/data_migrate/data_schema.rb

@@ -30,10 +30,12 @@ def migrated
 
     def versions
       @versions ||= begin
-        versions = []
-        Dir.foreach(DataMigrate::DataMigrator.full_migrations_path) do |file|
-          match_data = DataMigrate::DataMigrator.match(file)
-          versions << match_data[1].to_i if match_data
+        versions = Set.new
+        DataMigrate::DataMigrator.migrations_paths.each do |path|
+          Dir.foreach(path) do |file|
+            match_data = DataMigrate::DataMigrator.match(file)
+            versions << match_data[1].to_i if match_data
+          end
         end
         versions
       end

lib/data_migrate/data_schema_migration.rb

@@ -1,15 +1,14 @@
 module DataMigrate
-  class DataSchemaMigration < ::ActiveRecord::SchemaMigration
-
+  class DataSchemaMigration
     class << self
-      def table_name
-        ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix
-      end
+      delegate :table_name, :primary_key, :create_table, :normalized_versions, :create, :create!, :table_exists?, :exists?, :where, to: :instance
 
-      def primary_key
-        "version"
+      def instance
+        @instance ||= Class.new(::ActiveRecord::SchemaMigration) do
+          define_singleton_method(:table_name) { ActiveRecord::Base.table_name_prefix + 'data_migrations' + ActiveRecord::Base.table_name_suffix }
+          define_singleton_method(:primary_key) { "version" }
+        end
       end
     end
   end
 end
-

lib/data_migrate/database_tasks.rb

@@ -47,6 +47,40 @@ def check_schema_file(filename)
           Kernel.abort message
         end
       end
+
+      def pending_migrations
+        sort_migrations(
+          pending_schema_migrations,
+          pending_data_migrations
+        )
+      end
+
+      def sort_migrations set_1, set_2=nil
+        migrations = set_1 + (set_2 || [])
+        migrations.sort{|a,b|  sort_string(a) <=> sort_string(b)}
+      end
+
+      def sort_string migration
+        "#{migration[:version]}_#{migration[:kind] == :data ? 1 : 0}"
+      end
+
+      def data_migrations_path
+        ::DataMigrate.config.data_migrations_path
+      end
+
+      def run_migration(migration, direction)
+        if migration[:kind] == :data
+          ::ActiveRecord::Migration.write("== %s %s" % ['Data', "=" * 71])
+          ::DataMigrate::DataMigrator.run(direction, data_migrations_path, migration[:version])
+        else
+          ::ActiveRecord::Migration.write("== %s %s" % ['Schema', "=" * 69])
+          ::DataMigrate::SchemaMigration.run(
+            direction,
+            ::DataMigrate::SchemaMigration.migrations_paths,
+            migration[:version]
+          )
+        end
+      end
     end
 
     # This overrides ActiveRecord::Tasks::DatabaseTasks
@@ -121,6 +155,5 @@ def self.past_migrations(sort = nil)
 
       sort == "asc" ? sort_migrations(migrations) : sort_migrations(migrations).reverse
     end
-
   end
 end

lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-  VERSION = "8.1.1".freeze
+  VERSION = "8.5.0".freeze
 end

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

lib/generators/data_migration/data_migration_generator.rb

@@ -14,7 +14,7 @@ class DataMigrationGenerator < Rails::Generators::NamedBase
 
       def create_data_migration
         set_local_assigns!
-        migration_template "data_migration.rb", data_migrations_file_path
+        migration_template template_path, data_migrations_file_path
       end
 
       protected
@@ -26,6 +26,10 @@ def set_local_assigns!
         end
       end
 
+      def template_path
+        DataMigrate.config.data_template_path
+      end
+
       def migration_base_class_name
         "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
       end

spec/data_migrate/config_spec.rb

@@ -1,12 +1,16 @@
 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
 
+  it "sets default data_template_path path", :no_override do
+    expect(DataMigrate.config.data_template_path).to eq DataMigrate::Config::DEFAULT_DATA_TEMPLATE_PATH
+  end
+
   describe "data migration path configured" do
+    subject { DataMigrate.config.data_migrations_path }
     before do
       @before = DataMigrate.config.data_migrations_path
       DataMigrate.configure do |config|
@@ -20,8 +24,43 @@
       end
     end
 
-    it do
-      expect(DataMigrate.config.data_migrations_path).to eq "db/awesome/"
+    it "equals the custom data migration path" do
+      is_expected.to eq "db/awesome/"
+    end
+  end
+
+  describe "data template path configured" do
+    subject { DataMigrate.config.data_template_path }
+
+    before do
+      @before = DataMigrate.config.data_template_path
+      DataMigrate.configure do |config|
+        config.data_template_path = data_template_path
+      end
+    end
+
+    let(:data_template_path) do
+      File.join(DataMigrate.root, "generators", "data_migration", "templates", "data_migration.rb")
+    end
+
+    after do
+      DataMigrate.configure do |config|
+        config.data_template_path = @before
+      end
+    end
+
+    it "equals the custom data template path" do
+      is_expected.to eq data_template_path
+    end
+
+    context "when path does not exist" do
+      subject { DataMigrate.config.data_template_path = invalid_path }
+
+      let(:invalid_path) { "lib/awesome/templates/data_migration.rb" }
+
+      it "checks that file exists on setting config var" do
+        expect { subject }.to raise_error { ArgumentError.new("File not found: '#{data_template_path}'") }
+      end
     end
   end
 end

spec/generators/data_migration/data_migration_generator_spec.rb

@@ -4,7 +4,8 @@
 require 'generators/data_migration/data_migration_generator'
 
 describe DataMigrate::Generators::DataMigrationGenerator do
-  let(:subject) { DataMigrate::Generators::DataMigrationGenerator }
+  subject { DataMigrate::Generators::DataMigrationGenerator }
+
   describe :next_migration_number do
     it "next migration" do
       Timecop.freeze("2016-12-03 22:15:26 -0800") do
@@ -19,14 +20,18 @@
   end
 
   describe :migration_base_class_name do
-    let(:subject) { DataMigrate::Generators::DataMigrationGenerator.new(['my_migration']) }
+    subject { generator.send(:migration_base_class_name) }
+
+    let(:generator) { DataMigrate::Generators::DataMigrationGenerator.new(['my_migration']) }
+
     it "returns the correct base class name" do
-      expect(subject.send(:migration_base_class_name)).to eq("ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]")
+      is_expected.to eq("ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]")
     end
   end
 
   describe :create_data_migration do
-    let(:subject) { DataMigrate::Generators::DataMigrationGenerator.new(['my_migration']) }
+    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
@@ -35,7 +40,7 @@
       end
 
       it 'returns correct file path' do
-        expect(subject).to receive(:migration_template).with(
+        is_expected.to receive(:migration_template).with(
           'data_migration.rb', data_migrations_file_path
         )
 
@@ -49,12 +54,48 @@
       end
 
       it 'returns correct file path' do
-        expect(subject).to receive(:migration_template).with(
+        is_expected.to receive(:migration_template).with(
           'data_migration.rb', data_migrations_file_path
         )
 
         subject.create_data_migration
       end
     end
   end
+
+  describe ".source_root" do
+    subject { described_class.source_root }
+
+    let(:default_source_root) do
+      File.expand_path(
+        File.dirname(File.join(DataMigrate.root, "generators", "data_migration", "templates", "data_migration.rb"))
+      )
+    end
+
+    it { is_expected.to eq default_source_root }
+
+    context "when DateMigrate.config.data_template_path is set" do
+      before do
+        @before = DataMigrate.config.data_template_path
+        DataMigrate.configure do |config|
+          config.data_template_path = data_template_path
+        end
+      end
+
+      let(:data_template_path) do
+        File.join(DataMigrate.root, "generators", "data_migration", "templates", "data_migration.rb")
+      end
+      let(:expected_source_root) { File.dirname(data_template_path) }
+
+      after do
+        DataMigrate.configure do |config|
+          config.data_template_path = @before
+        end
+      end
+
+      it "reads directory from config data template path" do
+        is_expected.to eq expected_source_root
+      end
+    end
+  end
 end