data_migrate 8.1.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2279e8f7ac44136ae9fca448e3a239066cf901e1f8e46813888deed8d2288f5
-  data.tar.gz: c0314320a07bff4ce02e148b4e7026e22155a7eab18e3a69c441f1689880ff0f
+  metadata.gz: ba5ee2c5d78ddb60b5b23067b5103c4f1dba6d1249984dfe2489382cc9bc9f1a
+  data.tar.gz: d6ed21a477ffe26c2705f9582a4f370e1a20807297200ba62988ada34c0f42fc
 SHA512:
-  metadata.gz: '087890b935d8a520994eebebfbfdf6c86b6cd115fbb7629f65e1d56170bd1c013109cbbb5bf737a4a61572db3e1a85e966589f4541c422d772e87fdaf2be2f5f'
-  data.tar.gz: f6a2e6811e8cdb29ab0cfa963a6fc69d4b8694fe09aa6cd0eb9859784cbe9c2c1e5fbaad4b35dee4c3923a0d74ab66c410523818f53e585eeced1cfee0546716
+  metadata.gz: d31827b46b9def6d3be01606f027e040cc340e3c4aebea687980f2eefa4ca86acd92f9fb495c6b25578c69f8cfba78aa8ac6863b276945450e43323ff2458fec
+  data.tar.gz: eec842d6f96134abea3945d27e4d366f8f093ac0cfe14ff7f4931b61c2a872cd21fe4c19e7ccec54dedba470b224bf0b9b199f3c4941cad0d2b896de5211b8ac

data/Changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 8.2.0
+
+Delegate to anonymous subclass of AR::SchemaMigration [foxondo](https://github.com/foxondo)
+
+## 8.1.1
+
+Revert 8.1.0 changes
+
 ## 8.1.0
 
 Avoid globally accessible functions for all rake tasks [berniechiu](https://github.com/berniechiu)

data/README.md

@@ -132,6 +132,27 @@ require 'capistrano/data_migrate'
 
 From now on capistrano will run `rake db:migrate:with_data` in every deploy.
 
+## Rails Engines support
+
+This gem also has a initial support for adding data migrations inside Rails engines.
+Inside the Engine's class initializer (the one that inherits from `Rails::Engine`, usually inside `engines/ENGINE_NAME/lib/engine.rb`) you need to add something like this:
+
+
+```ruby
+module EngineName
+  class Engine < ::Rails::Engine
+    initializer :engine_name do |app|
+      ::DataMigrate.configure do |data_migrate|
+        default_path = ::DataMigrate::Config.new.data_migrations_path
+        data_migrate.data_migrations_path = [default_path, root.join('db', 'data')]
+      end
+    end
+  end
+end
+```
+
+Then, in the Engine's `db/data` folder, you can add data migrations and run them as usual.
+
 ### Contributing
 
 ## Testing

data/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?, :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
-

data/lib/data_migrate/database_tasks.rb

@@ -47,40 +47,6 @@ module DataMigrate
           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,
-            ::Continuation::SchemaMigration.migrations_paths,
-            migration[:version]
-          )
-        end
-      end
     end
 
     # This overrides ActiveRecord::Tasks::DatabaseTasks
@@ -155,5 +121,6 @@ module DataMigrate
 
       sort == "asc" ? sort_migrations(migrations) : sort_migrations(migrations).reverse
     end
+
   end
 end

data/lib/data_migrate/version.rb

@@ -1,3 +1,3 @@
 module DataMigrate
-  VERSION = "8.1.0".freeze
+  VERSION = "8.2.0".freeze
 end

data/tasks/databases.rake

@@ -4,29 +4,29 @@ namespace :db do
   namespace :migrate do
     desc "Migrate the database data and schema (options: VERSION=x, VERBOSE=false)."
     task :with_data => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
 
       ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
       target_version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
       migrations = []
 
       if target_version.nil?
-        migrations = DataMigrate::DatabaseTasks.pending_migrations.map{ |m| m.merge(:direction =>:up) }
+        migrations = pending_migrations.map{ |m| m.merge(:direction =>:up) }
       else
         current_schema_version = ActiveRecord::Migrator.current_version
         schema_migrations = if target_version > current_schema_version
-                              DataMigrate::DatabaseTasks.pending_schema_migrations.keep_if{ |m| m[:version] <= target_version }.map{ |m| m.merge(:direction =>:up) }
+                              pending_schema_migrations.keep_if{ |m| m[:version] <= target_version }.map{ |m| m.merge(:direction =>:up) }
                             elsif target_version < current_schema_version
-                              DataMigrate::DatabaseTasks.past_migrations.keep_if{ |m| m[:version] > target_version }.map{ |m| m.merge(:direction =>:down) }
+                              past_migrations.keep_if{ |m| m[:version] > target_version }.map{ |m| m.merge(:direction =>:down) }
                             else # ==
                               []
                             end
 
-        current_data_version = DataMigrate::DataMigrator.current_version
+        current_data_version = ActiveRecord::Migrator.current_version
         data_migrations = if target_version > current_data_version
-                            DataMigrate::DatabaseTasks.pending_data_migrations.keep_if{ |m| m[:version] <= target_version }.map{ |m| m.merge(:direction =>:up) }
+                            pending_data_migrations.keep_if{ |m| m[:version] <= target_version }.map{ |m| m.merge(:direction =>:up) }
                           elsif target_version < current_data_version
-                            DataMigrate::DatabaseTasks.past_migrations.keep_if{ |m| m[:version] > target_version }.map{ |m| m.merge(:direction =>:down) }
+                            past_migrations.keep_if{ |m| m[:version] > target_version }.map{ |m| m.merge(:direction =>:down) }
                           else # ==
                             []
                           end
@@ -35,9 +35,9 @@ namespace :db do
                      elsif data_migrations.empty?
                        schema_migrations
                      elsif target_version > current_data_version && target_version > current_schema_version
-                       DataMigrate::DatabaseTasks.sort_migrations data_migrations, schema_migrations
+                       sort_migrations data_migrations, schema_migrations
                      elsif target_version < current_data_version && target_version < current_schema_version
-                       DataMigrate::DatabaseTasks.sort_migrations(data_migrations, schema_migrations).reverse
+                       sort_migrations(data_migrations, schema_migrations).reverse
                      elsif target_version > current_data_version && target_version < current_schema_version
                        schema_migrations + data_migrations
                      elsif target_version < current_data_version && target_version > current_schema_version
@@ -46,7 +46,7 @@ namespace :db do
       end
 
       migrations.each do |migration|
-        DataMigrate::DatabaseTasks.run_migration(migration, migration[:direction])
+        run_migration(migration, migration[:direction])
       end
 
       Rake::Task["db:_dump"].invoke
@@ -56,7 +56,7 @@ namespace :db do
     namespace :redo do
       desc 'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
       task :with_data => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
         if ENV["VERSION"]
           Rake::Task["db:migrate:down:with_data"].invoke
           Rake::Task["db:migrate:up:with_data"].invoke
@@ -72,16 +72,16 @@ namespace :db do
       task :with_data => :environment do
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
         raise "VERSION is required" unless version
-        DataMigrate::DataMigrator.assure_data_schema_table
+        assure_data_schema_table
         run_both = ENV["BOTH"] == "true"
-        migrations = DataMigrate::DatabaseTasks.pending_migrations.keep_if{|m| m[:version] == version}
+        migrations = pending_migrations.keep_if{|m| m[:version] == version}
 
         unless run_both || migrations.size < 2
           migrations = migrations.slice(0,1)
         end
 
         migrations.each do |migration|
-          DataMigrate::DatabaseTasks.run_migration(migration, :up)
+          run_migration(migration, :up)
         end
 
         Rake::Task["db:_dump"].invoke
@@ -94,16 +94,16 @@ namespace :db do
       task :with_data => :environment do
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
         raise "VERSION is required" unless version
-        DataMigrate::DataMigrator.assure_data_schema_table
+        assure_data_schema_table
         run_both = ENV["BOTH"] == "true"
-        migrations = DataMigrate::DatabaseTasks.past_migrations.keep_if{|m| m[:version] == version}
+        migrations = past_migrations.keep_if{|m| m[:version] == version}
 
         unless run_both || migrations.size < 2
           migrations = migrations.slice(0,1)
         end
 
         migrations.each do |migration|
-          DataMigrate::DatabaseTasks.run_migration(migration, :down)
+          run_migration(migration, :down)
         end
 
         Rake::Task["db:_dump"].invoke
@@ -123,9 +123,9 @@ namespace :db do
     desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
     task :with_data => :environment do
       step = ENV['STEP'] ? ENV['STEP'].to_i : 1
-      DataMigrate::DataMigrator.assure_data_schema_table
-      DataMigrate::DatabaseTasks.past_migrations[0..(step - 1)].each do | past_migration |
-        DataMigrate::DatabaseTasks.run_migration(past_migration, :down)
+      assure_data_schema_table
+      past_migrations[0..(step - 1)].each do | past_migration |
+        run_migration(past_migration, :down)
       end
 
       Rake::Task["db:_dump"].invoke
@@ -136,7 +136,7 @@ namespace :db do
   namespace :forward do
     desc 'Pushes the schema to the next version (specify steps w/ STEP=n).'
     task :with_data => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
       step = ENV['STEP'] ? ENV['STEP'].to_i : 1
       DataMigrate::DatabaseTasks.forward(step)
       Rake::Task["db:_dump"].invoke
@@ -147,7 +147,7 @@ namespace :db do
   namespace :version do
     desc "Retrieves the current schema version numbers for data and schema migrations"
     task :with_data => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
       puts "Current Schema version: #{ActiveRecord::Migrator.current_version}"
       puts "Current Data version: #{DataMigrate::DataMigrator.current_version}"
     end
@@ -157,7 +157,7 @@ namespace :db do
     desc "Raises an error if there are pending migrations or data migrations"
     task with_data: :environment do
       message = %{Run `rake db:migrate:with_data` to update your database then try again.}
-      DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(DataMigrate::DatabaseTasks.pending_migrations, message)
+      DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(pending_migrations, message)
     end
   end
 
@@ -200,7 +200,7 @@ namespace :data do
   namespace :migrate do
     desc  'Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x).'
     task :redo => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
       if ENV["VERSION"]
         Rake::Task["data:migrate:down"].invoke
         Rake::Task["data:migrate:up"].invoke
@@ -212,10 +212,10 @@ namespace :data do
 
     desc 'Runs the "up" for a given migration VERSION.'
     task :up => :environment do
-      DataMigrate::DataMigrator.assure_data_schema_table
+      assure_data_schema_table
       version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
       raise "VERSION is required" unless version
-      DataMigrate::DataMigrator.run(:up, DataMigrate::DatabaseTasks.data_migrations_path, version)
+      DataMigrate::DataMigrator.run(:up, data_migrations_path, version)
       Rake::Task["data:dump"].invoke
     end
 
@@ -223,8 +223,8 @@ namespace :data do
     task :down => :environment do
       version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
       raise "VERSION is required" unless version
-      DataMigrate::DataMigrator.assure_data_schema_table
-      DataMigrate::DataMigrator.run(:down, DataMigrate::DatabaseTasks.data_migrations_path, version)
+      assure_data_schema_table
+      DataMigrate::DataMigrator.run(:down, data_migrations_path, version)
       Rake::Task["data:dump"].invoke
     end
 
@@ -236,35 +236,35 @@ namespace :data do
 
   desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
   task :rollback => :environment do
-    DataMigrate::DataMigrator.assure_data_schema_table
+    assure_data_schema_table
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
-    DataMigrate::DataMigrator.rollback(DataMigrate::DatabaseTasks.data_migrations_path, step)
+    DataMigrate::DataMigrator.rollback(data_migrations_path, step)
     Rake::Task["data:dump"].invoke
   end
 
   desc 'Pushes the schema to the next version (specify steps w/ STEP=n).'
   task :forward => :environment do
-    DataMigrate::DataMigrator.assure_data_schema_table
+    assure_data_schema_table
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1
     # TODO: No worky for .forward
     # DataMigrate::DataMigrator.forward('db/data/', step)
-    migrations = DataMigrate::DatabaseTasks.pending_data_migrations.reverse.pop(step).reverse
+    migrations = pending_data_migrations.reverse.pop(step).reverse
     migrations.each do | pending_migration |
-      DataMigrate::DataMigrator.run(:up, DataMigrate::DatabaseTasks.data_migrations_path, pending_migration[:version])
+      DataMigrate::DataMigrator.run(:up, data_migrations_path, pending_migration[:version])
     end
     Rake::Task["data:dump"].invoke
   end
 
   desc "Retrieves the current schema version number for data migrations"
   task :version => :environment do
-    DataMigrate::DataMigrator.assure_data_schema_table
+    assure_data_schema_table
     puts "Current data version: #{DataMigrate::DataMigrator.current_version}"
   end
 
   desc "Raises an error if there are pending data migrations"
   task abort_if_pending_migrations: :environment do
     message = %{Run `rake data:migrate` to update your database then try again.}
-    DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(DataMigrate::DatabaseTasks.pending_data_migrations, message)
+    DataMigrate::Tasks::DataMigrateTasks.abort_if_pending_migrations(pending_data_migrations, message)
   end
 
   desc "Create a db/data_schema.rb file that stores the current data version"
@@ -287,3 +287,53 @@ namespace :data do
     end
   end
 end
+
+def pending_migrations
+  DataMigrate::DatabaseTasks.sort_migrations(
+    DataMigrate::DatabaseTasks.pending_schema_migrations,
+    DataMigrate::DatabaseTasks.pending_data_migrations
+  )
+end
+
+def pending_data_migrations
+  DataMigrate::DatabaseTasks.pending_data_migrations
+end
+
+def pending_schema_migrations
+  DataMigrate::DatabaseTasks.pending_schema_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 past_migrations(sort=nil)
+  DataMigrate::DatabaseTasks.past_migrations(sort)
+end
+
+def assure_data_schema_table
+  DataMigrate::DataMigrator.assure_data_schema_table
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_migrate
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Andrew J Vargo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord