nonschema_migrations 6.5.1 → 6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e935824796ce13a066ffb1ae249e290b68fa98a0795b1b6030c5c29317d343
-  data.tar.gz: 6e0570efd5a054f192dcd231b66b05b241e56b9f03e46ede56f2322416c5f501
+  metadata.gz: 100815f15b1c5bcfac2cd4fd1904f193ce2ba046dc733b7d43eb062747eb8e35
+  data.tar.gz: d5a5919d9f65337f9d514c9ba1be5467b4551a174a9cdaacd0245b34a9077b24
 SHA512:
-  metadata.gz: 2d8f77a424fd97f377ea19cdb52b2ce8c9633452139c2e9102d9b6345195fa6e5ae25a78eb5753f4a23fd9ba847897caf8ac9cefd19cee6003dfac7b03d45c80
-  data.tar.gz: 346ee88888703f2266f60588b5ac7ac0744740ce419c07b3c2fb464cd61fd330bc7289b8b722b655e642ebec456b3aa3b091759c5ad64a15c2f87203cea3688b
+  metadata.gz: 0d4708792141afdfab8455724bd8bfeb63a0a2ae1d89fe6cbeb828aed608b0b8087874f81f616c70bdb322c60091a5a8394f33925145aad73df5a2aa785ab244
+  data.tar.gz: 43bc32be4cd67f4156e2f26f3d9c457b6f1aed62a7f5cba1b3aac02b9df9a324147fdbfbd35342bfe8cdd54d796c1bb7b6ce37edff3a63538f6af676c25e2854

data/README.md

@@ -4,16 +4,17 @@
 
 _Please use the version number of this gem in lockstep with your Rails version._
 
-| Rails Version    |   |   Use Version of This Gem     |     |           
-|--------------|------------------|---------------------------------------------|-----|
-| Rails 4.x, 4.1.x, 4.2  |   | v1.0.1  (Released Jun 1, 2019)          |     |
-| Rails 5.0        |    | v2.0.1 (Released Jun 1, 2019)                |     |
-| Rails 5.1        |    | v3.0.1 (Released Jun 1, 2019)                |     | 
-| Rails 5.2        |    | v4.0.2 (Released Jun 2, 2019)                |     |
-| Rails 6.0        |    | v5.1.2.1 (Released Nov 17, 2021)               |    |
-| Rails 7.0.0.alpha2  |    | v6.0.alpha2 (Released Nov 17, 2021)                 |    |
-| Rails 7             |    | v6.5 (Released Jan 11, 2022)                 |    |
-
+| Rails Version         |   | Use Version of This Gem          |     |           
+|-----------------------|------------------|----------------------------------|-----|
+| Rails 4.x, 4.1.x, 4.2 |   | v1.0.1  (Released Jun 1, 2019)   |     |
+| Rails 5.0             |    | v2.0.1 (Released Jun 1, 2019)    |     |
+| Rails 5.1             |    | v3.0.1 (Released Jun 1, 2019)    |     | 
+| Rails 5.2             |    | v4.0.2 (Released Jun 2, 2019)    |     |
+| Rails 6.0             |    | v5.1.2.1 (Released Nov 17, 2021) |    |
+| Rails 7.0             |    |  v6.5.1 (Released Jan 4, 2024), ~v6.5.0 (Released Jan 11, 2022)~   |    |
+| Rails 7.1             |    | not yet compatible               |    |
+
+Note: yanked version 6.5 was not compatible with Rails 7.1. For Rails 7.0 please bump this gem to 6.5.1. 
 
 ## Introduction
 
@@ -99,9 +100,6 @@ Migrate up the specified versions.
 ## rails data:rollback
 Rollback the last version. Generally data migrations don't have any "down" associated with them so use this only under extreme circumstances. 
 
-
-#
-
 By default your data migration will run in a single transaction (just like a schema migration).
 
 To turn this off, add `disable_ddl_transaction!` to the top of your migration, like so:
@@ -138,29 +136,34 @@ advantage: your app is down only for schema migrations and you can let the data
 1. Deploy to heroku with preboot on
 2. Heroku switches the incoming requests to use the new app
 3. Run data migrations (while new app is up & running)
-
 advantage: your app is never down and you can run data migrations in the background
 
-
-
 ## Heroku Pipeline
-
-
-Release tasks should dbe **db:migrate**
-in `release-tasks.sh`
+To use data migrations on the pipeline, the `release-tasks.sh` file should contain only the db:migrate
 ``` 
-bundle exec rails db:migrate
+# Step to execute
+bundle exec rails db:migrate 
+# check for a good exit
+if [ 0 -ne 0 ]
+then
+  puts '*** RELEASE COMMAND FAILED'
+  # something went wrong; convey that and exit
+  exit 1
+fi
 ```
 
 
-The postdeply task shoul dbe **data:migrate**
+The postdeply task should be **data:migrate**
 in `app.json`
 ```
 "scripts":  {
    "postdeploy": "bundle exec rails data:migrate"
 }
 ```
-Using data migration is like seed data.
-
-However, the above setup will run only for REVIEW APPS. You will still need to manually run the data migration for staging + production. 
+The above setup will run data migtrations only for REVIEW APPS. 
+You will still need to manually run the data migration for staging + production. 
 
+If you want to use the data migrations for staging + production, remove the postdeploy script from `app.json` and change release-tasks.sh to :
+```
+bundle exec rails db:migrate data:migrate
+```

data/lib/active_record/data_migration.rb

@@ -4,6 +4,21 @@ require 'active_record/base'
 
 module ActiveRecord
   class DataMigration < ActiveRecord::Base
+    def initialize(migrations)
+
+      @migration_struct = migrations
+    end
+
+
+    def up
+      Migrator.new(:up, @migration_struct).migrate
+    end
+
+    def down
+      Migrator.new(:down, @migration_struct).migrate
+    end
+
+
     class << self
       def primary_key
         nil
@@ -49,4 +64,4 @@ module ActiveRecord
       super.to_i
     end
   end
-end
+end

data/lib/active_record/data_tasks.rb

@@ -0,0 +1,91 @@
+
+# frozen_string_literal: true
+
+require "active_record/database_configurations"
+
+module ActiveRecord
+  module Tasks # :nodoc:
+    class DatabaseNotSupported < StandardError; end # :nodoc:
+
+
+    module DataTasks
+      ##
+      # :singleton-method:
+      # Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:schema:dump
+      # It can be used as a string/array (the typical case) or a hash (when you use multiple adapters)
+      # Example:
+      #   ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = {
+      #     mysql2: ['--no-defaults', '--skip-add-drop-table'],
+      #     postgres: '--no-tablespaces'
+      #   }
+      mattr_accessor :structure_dump_flags, instance_accessor: false
+
+      ##
+      # :singleton-method:
+      # Extra flags passed to database CLI tool when calling db:schema:load
+      # It can be used as a string/array (the typical case) or a hash (when you use multiple adapters)
+      mattr_accessor :structure_load_flags, instance_accessor: false
+
+      extend self
+
+      attr_writer :data_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
+      attr_accessor :database_configuration
+
+
+      def self.data_migrations_table_name
+        "data_migrations"
+      end
+
+      def check_protected_environments!(environment = env)
+        return if ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"]
+
+        configs_for(env_name: environment).each do |db_config|
+          check_current_protected_environment!(db_config)
+        end
+      end
+
+      def data_dir
+        @data_dir ||= Rails.application.config.paths["data"].first
+      end
+
+      def migrations_paths
+        @migrations_paths ||= Rails.application.paths["data/migrate"].to_a
+      end
+
+      def parse_migration_filename(filename)
+        File.basename(filename).scan(Migration::MigrationFilenameRegexp).first
+      end
+
+      def migration_files
+        paths = Array(Rails.root.join('db', 'data_migrate'))
+        Dir[*paths.flat_map { |path| "#{path}/**/[0-9]*_*.rb" }]
+      end
+
+      def migrate(version = nil)
+        # get all data migrations in data/migrations
+        # get list of data migrations in database
+        already_done = ActiveRecord::Base.connection.execute("SELECT version FROM data_migrations").map { |record| record['version'].to_i }
+
+        data_migrations =  migration_files.map do |file|
+          version, name, scope = parse_migration_filename(file)
+          raise IllegalMigrationNameError.new(file) unless version
+          version = version.to_i
+          name = name.camelize
+
+          MigrationProxy.new(name, version, file, scope)
+        end
+        data_migrations.reject! do |mig|
+          already_done.include?(mig.version)
+        end
+        data_migrations.each do |migration|
+          require migration.filename
+          (eval(migration.name).new).migrate(:up)
+
+          # push the migration into the database
+          ActiveRecord::Base.connection.execute("INSERT INTO data_migrations (version) VALUES (#{migration.version})")
+        end
+      end
+    end
+  end
+end
+

data/lib/nonschema_migrations/version.rb

@@ -1,3 +1,3 @@
 module NonSchemaMigrations
-  VERSION = "6.5.1"
+  VERSION = "6.6"
 end

data/lib/nonschema_migrator.rb

@@ -1,179 +1,211 @@
-class NonschemaMigrator < ActiveRecord::Migrator
-  # This class related to data migration.
-  # Used in rake tasks (rake data:[migrate|rollback|up|down])
-
-  def initialize(direction, migrations, no_op, target_version = nil)
-    @direction         = direction
-    @target_version    = target_version
-    @migrated_versions = nil
-    @migrations        = migrations
-
-    validate(@migrations)
-
-    ActiveRecord::InternalMetadata.create_table
-  end
-
-  if defined?(ActiveRecord::MigrationContext)
-    class NonSchemaMigration < ActiveRecord::SchemaMigration
-      def self.table_name
-        NonschemaMigrator.schema_migrations_table_name
-      end
-    end
-
-    class MigrationContext < ActiveRecord::MigrationContext
-      def initialize(migrations_paths, data_migration)
-
-        # super(migrations_paths, data_migration)
-        @migrations_paths = migrations_paths
-
-        @schema_migration = NonschemaMigrator::NonSchemaMigration
-      end
-
-      def new_migrator(*args)
-        result = NonschemaMigrator.new(*args)
-        result.migration_context = self
-        result
-      end
-
-      # these methods are copied from ActiveRecord::Migrator
-      # replaced:
-      #  1.) ActiveRecord::NonSchemaMigration with @schema_migration
-      #  2.) ActiveRecord::Migrator.new with new_migrator
-
-      def get_all_versions
-        if @schema_migration.table_exists?
-          @schema_migration.all_versions.map(&:to_i)
-        else
-          []
-        end
-      end
-
-      def migrations_status
-        db_list = @schema_migration.normalized_versions
-
-        file_list = migration_files.map do |file|
-          version, name, scope = parse_migration_filename(file)
-          raise IllegalMigrationNameError.new(file) unless version
-          version = @schema_migration.normalize_migration_number(version)
-          status = db_list.delete(version) ? "up" : "down"
-          [status, version, (name + scope).humanize]
-        end.compact
-
-        db_list.map! do |version|
-          ["up", version, "********** NO FILE **********"]
-        end
-
-        (db_list + file_list).sort_by { |_, version, _| version }
-      end
-
-      def rollback(steps)
-        move(:down, steps)
-      end
+require_relative "./active_record/data_tasks.rb"
 
-      def move(direction, steps)
-        migrator = new_migrator(direction, migrations, nil, schema_migration)
+class NonschemaMigrator
 
-        if current_version != 0 && !migrator.current_migration
-          raise UnknownMigrationVersionError.new(current_version)
-        end
+  # include ActiveRecord::Tasks::DatabaseTasks
 
-        start_index =
-          if current_version == 0
-            0
-          else
-            migrator.migrations.index(migrator.current_migration)
-          end
-
-        finish = migrator.migrations[start_index + steps]
-        version = finish ? finish.version : 0
-        send(direction, version)
-      end
-
-      def up(target_version = nil)
-        selected_migrations = if block_given?
-                                migrations.select { |m| yield m }
-                              else
-                                migrations
-                              end
-
-        new_migrator(:up, selected_migrations, nil, target_version).migrate
-      end
-
-      def down(target_version = nil)
-        selected_migrations = if block_given?
-                                migrations.select { |m| yield m }
-                              else
-                                migrations
-                              end
-
-        new_migrator(:down, selected_migrations, nil, target_version).migrate
-      end
-    end
-
-    class << self
-      def context(path)
-        NonschemaMigrator::MigrationContext.new(path, ActiveRecord::DataMigration)
-      end
-
-      def new_migrator(path, *args)
-        result = self.new(*args)
-        result.migration_context=context(path)
-        result
-      end
-
-      def migrate(path)
-        context(path).migrate()
-      end
-
-      def rollback(path, steps = 1)
-        context(path).rollback(steps)
-      end
-
-      def run(direction, path, target_version)
-        new_migrator(path, direction, context(path).migrations, nil, target_version).run
-      end
-    end
+  # This class related to data migration.
+  # Used in rake tasks (rake data:[migrate|rollback|up|down])
 
-    def migration_context=(context)
-      @migration_context = context
-    end
 
-    def load_migrated
-      @migrated_versions = Set.new(@migration_context.get_all_versions)
-    end
+  def self.migrate(version = nil)
+    ActiveRecord::Tasks::DataTasks.migrate(version)
   end
 
-  def record_version_state_after_migrating(version)
-    if down?
-      migrated.delete(version)
-      ActiveRecord::DataMigration.where(:version => version.to_s).delete_all
-    else
-      migrated << version
-      ActiveRecord::DataMigration.create!(:version => version.to_s)
-    end
+  def self.rollback
+    ActiveRecord::Tasks::DataTasks.rollback
   end
 
-
-  class <<self
-    def migrations_path
-      MIGRATIONS_PATH
-    end
-
-    def schema_migrations_table_name
-      'data_migrations'
-    end
-
-    def schema_migrations_table_name
-      ActiveRecord::DataMigration.table_name
-    end
-
-    def get_all_versions(connection = ActiveRecord::Base.connection)
-      if connection.table_exists?(schema_migrations_table_name)
-        ActiveRecord::DataMigration.all.map { |x| x.version.to_i }.sort
-      else
-        []
-      end
-    end
+  def initialize(direction, migrations, no_op, target_version = nil)
+    # @direction         = direction
+    # @target_version    = target_version
+    # @migrated_versions = nil
+    # @migrations        = migrations
+    #
+    # validate(@migrations)
+    #
+    # ActiveRecord::DataMigration.create_table
   end
+
+  # if defined?(ActiveRecord::MigrationContext)
+  #   class NonSchemaMigration < ActiveRecord::SchemaMigration
+  #     def self.table_name
+  #       NonschemaMigrator.schema_migrations_table_name
+  #     end
+  #
+  #     def self.get_all_versions
+  #       versions
+  #     end
+  #
+  #     def versions
+  #       sm = Arel::SelectManager.new(arel_table)
+  #       sm.project(arel_table[primary_key])
+  #       sm.order(arel_table[primary_key].asc)
+  #
+  #       connection.select_values(sm, "#{self.class} Load")
+  #     end
+  #   end
+  #
+  #   class MigrationContext < ActiveRecord::MigrationContext
+  #     def initialize(migrations_paths, data_migration)
+  #
+  #       # super(migrations_paths, data_migration)
+  #       @migrations_paths = migrations_paths
+  #
+  #       @schema_migration = NonschemaMigrator::NonSchemaMigration
+  #     end
+  #
+  #     def new_migrator(*args)
+  #       result = NonschemaMigrator.new(*args)
+  #       result.migration_context = self
+  #       result
+  #     end
+  #
+  #     def schema_migrations_table_name
+  #       'data_migrations'
+  #     end
+  #
+  #     # these methods are copied from ActiveRecord::Migrator
+  #     # replaced:
+  #     #  1.) ActiveRecord::NonSchemaMigration with @schema_migration
+  #     #  2.) ActiveRecord::Migrator.new with new_migrator
+  #
+  #     def get_all_versions
+  #       byebug
+  #       if connection.table_exists?(schema_migrations_table_name)
+  #         @schema_migration.all_versions.map(&:to_i)
+  #       else
+  #         []
+  #       end
+  #     end
+  #
+  #     def migrations_status
+  #       db_list = @schema_migration.normalized_versions
+  #
+  #       file_list = migration_files.map do |file|
+  #         version, name, scope = parse_migration_filename(file)
+  #         raise IllegalMigrationNameError.new(file) unless version
+  #         version = @schema_migration.normalize_migration_number(version)
+  #         status = db_list.delete(version) ? "up" : "down"
+  #         [status, version, (name + scope).humanize]
+  #       end.compact
+  #
+  #       db_list.map! do |version|
+  #         ["up", version, "********** NO FILE **********"]
+  #       end
+  #
+  #       (db_list + file_list).sort_by { |_, version, _| version }
+  #     end
+  #
+  #     def rollback(steps)
+  #       move(:down, steps)
+  #     end
+  #
+  #     def move(direction, steps)
+  #       migrator = new_migrator(direction, migrations, nil, schema_migration)
+  #
+  #       if current_version != 0 && !migrator.current_migration
+  #         raise UnknownMigrationVersionError.new(current_version)
+  #       end
+  #
+  #       start_index =
+  #         if current_version == 0
+  #           0
+  #         else
+  #           migrator.migrations.index(migrator.current_migration)
+  #         end
+  #
+  #       finish = migrator.migrations[start_index + steps]
+  #       version = finish ? finish.version : 0
+  #       send(direction, version)
+  #     end
+  #
+  #     def up(target_version = nil)
+  #       selected_migrations = if block_given?
+  #                               migrations.select { |m| yield m }
+  #                             else
+  #                               migrations
+  #                             end
+  #
+  #       new_migrator(:up, selected_migrations, nil, target_version).migrate
+  #     end
+  #
+  #     def down(target_version = nil)
+  #       selected_migrations = if block_given?
+  #                               migrations.select { |m| yield m }
+  #                             else
+  #                               migrations
+  #                             end
+  #
+  #       new_migrator(:down, selected_migrations, nil, target_version).migrate
+  #     end
+  #   end
+  #
+  #   class << self
+  #     def context(path)
+  #       NonschemaMigrator::MigrationContext.new(path, ActiveRecord::DataMigration)
+  #     end
+  #
+  #     def new_migrator(path, *args)
+  #       result = self.new(*args)
+  #       result.migration_context=context(path)
+  #       result
+  #     end
+  #
+  #     def migrate(path)
+  #       context(path).migrate()
+  #     end
+  #
+  #     def rollback(path, steps = 1)
+  #       context(path).rollback(steps)
+  #     end
+  #
+  #     def run(direction, path, target_version)
+  #       new_migrator(path, direction, context(path).migrations, nil, target_version).run
+  #     end
+  #   end
+  #
+  #   def migration_context=(context)
+  #     @migration_context = context
+  #   end
+  #
+  #   def load_migrated
+  #     @migrated_versions = Set.new(@migration_context.get_all_versions)
+  #   end
+  #
+  #   def schema_migrations_table_name
+  #     'data_migrations'
+  #   end
+  #
+  # end
+  #
+  # def record_version_state_after_migrating(version)
+  #   if down?
+  #     migrated.delete(version)
+  #     ActiveRecord::DataMigration.where(:version => version.to_s).delete_all
+  #   else
+  #     migrated << version
+  #     ActiveRecord::DataMigration.create!(:version => version.to_s)
+  #   end
+  # end
+  #
+  #
+  # class <<self
+  #   def migrations_path
+  #     MIGRATIONS_PATH
+  #   end
+  #
+  #   def schema_migrations_table_name
+  #     'data_migrations'
+  #   end
+  #
+  #   def get_all_versions(connection = ActiveRecord::Base.connection)
+  #     if connection.table_exists?(schema_migrations_table_name)
+  #       ActiveRecord::DataMigration.all.map { |x| x.version.to_i }.sort
+  #     else
+  #       []
+  #     end
+  #   end
+  # end
 end
 

data/lib/tasks/data.rb

@@ -12,15 +12,9 @@ namespace :data do
 
   desc "rollback data migration (#{MIGRATIONS_PATH})"
   task :rollback => :data_migration_dependencies do
-    NonschemaMigrator.rollback(MIGRATIONS_PATH)
+    NonschemaMigrator.rollback
   end
 
-  desc "honeybear (#{MIGRATIONS_PATH})"
-  task :honeybear => :data_migration_dependencies do
-    puts "hello honeybear"
-  end
-
-
   namespace :migrate do
     desc %Q{runs the "up" for a given _data_ migration VERSION}
     task :up => :data_migration_dependencies do

metadata

@@ -1,33 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: nonschema_migrations
 version: !ruby/object:Gem::Version
-  version: 6.5.1
+  version: '6.6'
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
+        version: '7.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
+        version: '7.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
 description: Separate schema-only migrations from nonschema (data) migrations in your
@@ -62,6 +62,7 @@ files:
 - gemfiles/rails_5_2.gemfile.lock
 - gemfiles/rails_6_0.gemfile
 - lib/active_record/data_migration.rb
+- lib/active_record/data_tasks.rb
 - lib/generators/data_migration_generator.rb
 - lib/generators/data_migrations/install_generator.rb
 - lib/generators/data_migrations/templates/create_data_migrations.rb