data-migration 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f317e1c1d38d56179e7236be0d37be8105859b653792c8eb4bdae60c0010affa
-  data.tar.gz: df14fb4e41b46c7fffebf89d9367b810128216f285b15da18d8c5b3297f653d4
+  metadata.gz: d0a50f98ed1ef1b0b960cc713e71d64d41219933e0f7071fa9462c8adf69bb18
+  data.tar.gz: d169ccd0f77204e3ce81a10d5c9d39f4b320572a8ca2e269c8502bfea6b8ecc1
 SHA512:
-  metadata.gz: 11da0da9e0b6593df4bd94a728d66f2ecbd5672e3a9819ec90bf58d32f811053b7e8f7890631faa7ea99253f9652e14f5383ece6af4f367ba16971a8cd7b1051
-  data.tar.gz: e93699e6817f780e7d12457742bd4d053ad029b6478f1a86cce911a75bfb49b6567bfb8822030dfdd8a1474fc4ffc47d6ec92519d041449250643b6b7c2c784f
+  metadata.gz: b11fdc6a2879a38416e43b35bc2ea427c4396ca60977cfd919cd945f5563baaf07e398ce1d0cca42f71a936b01a6095ae971bf7320f8eced0059fa19a8c88eb8
+  data.tar.gz: d6d738963fe7473eb84984730f514cce3cebbf0a5ae2e4301734bca5e96c0cb8a5fdbe3998561136a27e1a0930c2162f2dbc713b19f9bded90b9f5dcdf463ac7

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 2.1.0 (2026-11-09)
+
+- Ship `bin/rails db:migrate:data` with `VERSION=` / `NAME=` selection and a migration list when both are blank.
+- Keep the data migration operator on the task when enqueueing and in monitoring context.
+- Report failed data migration job exceptions to ActiveJob hosts instead of discarding them.
+- Reach full line coverage of packaged `lib/` and bind a local pressure probe with ceilings.
+
+## 2.0.1 (2026-10-28)
+
+- Confirm gem release from a clean tree before tagging.
+
 ## 2.0.0 (2026-09-04)
 
 - BREAKING: Require Ruby 3.4 or newer.

data/README.md

@@ -64,9 +64,11 @@ bin/rails g data_migration create_users
 ### Run data migrations
 
 ```sh
-bin/rails db:migrate:data 20241207120000_create_users
+bin/rails db:migrate:data VERSION=20241207120000
 ```
 
+`VERSION` may be the timestamp or the full `timestamp_name` file stem. `NAME=create_users` also works. With neither set, the task lists available migrations and their latest task status.
+
 ## Configuration
 
 ### Set data migrations directory
@@ -104,7 +106,7 @@ end
 - [x] User can generate data migration file under `db/data_migrations` directory with common format
 - [x] User can generate data migration file with test script included
 - [x] User can run specific data migration using Rails console
-- [ ] User can run specific data migration using shell command
+- [x] User can run specific data migration using shell command
 - [x] User can run data migration in background
 - [x] User can run data migration in foreground
 - [x] User can specify operator for data migration

data/data-migration.gemspec

@@ -37,12 +37,9 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "bundler", ">= 2"
   gem.add_development_dependency "rspec", "~> 3"
-  gem.add_development_dependency "polyrun", ">= 2.2.0"
+  gem.add_development_dependency "polyrun", ">= 2.2.9"
   gem.add_development_dependency "prosopite", "~> 2.0"
   gem.add_development_dependency "webmock", "~> 3"
-  gem.add_development_dependency "rspec_junit_formatter", "~> 0.6"
-  gem.add_development_dependency "simplecov", "~> 0.22"
-  gem.add_development_dependency "simplecov-cobertura", "~> 3"
   gem.add_development_dependency "rbs", "~> 3"
   gem.add_development_dependency "standard", "~> 1.52"
   gem.add_development_dependency "standard-custom", "~> 1.0"

data/lib/data-migration.rb

@@ -1,9 +1,12 @@
 require "data_migration/config"
 require "data_migration/job"
 require "data_migration/task"
+require "data_migration/selector"
+require "data_migration/cli"
+require "data_migration/railtie" if defined?(Rails::Railtie)
 
 module DataMigration
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 
   module_function
 
@@ -12,7 +15,7 @@ module DataMigration
   end
 
   def configure
-    yield config
+    yield(config)
   end
 
   def notify(message, context: {})

data/lib/data_migration/cli.rb

@@ -0,0 +1,20 @@
+module DataMigration
+  module Cli
+    module_function
+
+    def run!(env = ENV)
+      version = env["VERSION"]
+      name = env["NAME"]
+
+      if version.to_s.strip.empty? && name.to_s.strip.empty?
+        puts "Available data migrations:"
+        DataMigration::Selector.status_lines.each { |line| puts line }
+        return :listed
+      end
+
+      migration_name = DataMigration::Selector.resolve(version: version, name: name)
+      DataMigration.perform_now(migration_name)
+      :ran
+    end
+  end
+end

data/lib/data_migration/config.rb

@@ -60,10 +60,10 @@ module DataMigration
             data_migration_operator_id: migration.operator&.try(:to_global_id) || migration.operator&.id
           }
           if Object.const_defined?(:ActionReporter)
-            ActionReporter.current_user ||= migration.operator
+            ActionReporter.current_user = migration.operator if migration.operator
             ActionReporter.context(**context)
           elsif Object.const_defined?(:Audited)
-            Audited.store[:audited_user] ||= migration.operator
+            Audited.store[:audited_user] = migration.operator if migration.operator
           else
             Rails.logger.info("Data migration context: #{context.inspect}")
           end

data/lib/data_migration/job.rb

@@ -4,8 +4,6 @@ module DataMigration
   class Job < ActiveJob::Base
     queue_as { DataMigration.config.job_queue_name }
 
-    discard_on StandardError
-
     def perform(task_id, *job_args, **job_kwargs)
       checked_in = false
       failed = false
@@ -45,13 +43,14 @@ module DataMigration
 
       Thread.current[:data_migration_enqueue_called] ||= {}
       Thread.current[:data_migration_enqueue_kwargs] ||= {}
-      migration_class.define_method(:enqueue) do |**enqueue_kwargs|
+      migration = migration_class.new
+      migration.define_singleton_method(:enqueue) do |**enqueue_kwargs|
         Thread.current[:data_migration_enqueue_called][migration_class.name] = true
         Thread.current[:data_migration_enqueue_kwargs][migration_class.name] = enqueue_kwargs
       end
 
       task.update!(status: :performing, pause_minutes: 0)
-      migration_class.new.perform(**job_kwargs)
+      migration.perform(**job_kwargs)
       task.job_check_out!(job_id)
       checked_in = false
 

data/lib/data_migration/railtie.rb

@@ -0,0 +1,9 @@
+require "rails/railtie"
+
+module DataMigration
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path("tasks/data_migration.rake", __dir__)
+    end
+  end
+end

data/lib/data_migration/selector.rb

@@ -0,0 +1,48 @@
+module DataMigration
+  class Selector
+    class Error < StandardError; end
+    class NotFound < Error; end
+    class Ambiguous < Error; end
+
+    def self.resolve(version: nil, name: nil)
+      new(version: version, name: name).resolve
+    end
+
+    def self.status_lines
+      DataMigration::Task.list.map do |migration_name|
+        task = DataMigration::Task.where(name: migration_name).order(id: :desc).first
+        status = task&.status || "not started"
+        "#{migration_name}\t#{status}"
+      end
+    end
+
+    def initialize(version: nil, name: nil)
+      @version = version.to_s.strip.presence
+      @name = name.to_s.strip.presence
+    end
+
+    def resolve
+      raise NotFound, "VERSION or NAME is required" if @version.nil? && @name.nil?
+
+      matches = matching_migrations
+      raise NotFound, "No data migration matches VERSION=#{@version.inspect} NAME=#{@name.inspect}" if matches.empty?
+      raise Ambiguous, "Multiple data migrations match: #{matches.join(", ")}" if matches.size > 1
+
+      matches.first
+    end
+
+    private
+
+    def matching_migrations
+      DataMigration::Task.list.select { |migration_name| match?(migration_name) }
+    end
+
+    def match?(migration_name)
+      return migration_name == @version || migration_name.start_with?("#{@version}_") if @version && @name.nil?
+      return migration_name == @name || migration_name.end_with?("_#{@name}") if @name && @version.nil?
+
+      combined = @version.include?("_") ? @version : "#{@version}_#{@name}"
+      migration_name == combined || migration_name == @version
+    end
+  end
+end

data/lib/data_migration/task.rb

@@ -54,25 +54,27 @@ module DataMigration
     end
 
     def self.perform_now(name, **kwargs)
-      create!(name: name).perform_now(**kwargs)
+      create_with_operator!(name, **kwargs).perform_now(**kwargs)
     end
 
     def perform_now(**perform_args)
-      update!(kwargs: perform_args)
-      self.class.job_class.perform_now(id, **perform_args)
+      job_kwargs = assign_operator_from!(perform_args)
+      update!(kwargs: job_kwargs)
+      self.class.job_class.perform_now(id, **job_kwargs)
     end
 
     def self.perform_later(name, **kwargs)
-      create!(name: name).perform_later(**kwargs)
+      create_with_operator!(name, **kwargs).perform_later(**kwargs)
     end
 
     def perform_later(**perform_args)
-      update!(kwargs: perform_args)
-      self.class.job_class.perform_later(id, **perform_args)
+      job_kwargs = assign_operator_from!(perform_args)
+      update!(kwargs: job_kwargs)
+      self.class.job_class.perform_later(id, **job_kwargs)
     end
 
-    def self.prepare(name, pause_minutes: nil, jobs_limit: nil)
-      create!(name: name, pause_minutes: pause_minutes, jobs_limit: jobs_limit)
+    def self.prepare(name, pause_minutes: nil, jobs_limit: nil, operator: nil)
+      create!(name: name, pause_minutes: pause_minutes, jobs_limit: jobs_limit, operator: operator)
     end
 
     def self.root_path
@@ -129,6 +131,23 @@ module DataMigration
 
     private
 
+    def self.create_with_operator!(name, **kwargs)
+      attributes = {name: name}
+      attributes[:operator] = kwargs[:operator] if kwargs.key?(:operator)
+      create!(**attributes)
+    end
+    private_class_method :create_with_operator!
+
+    def assign_operator_from!(perform_args)
+      job_kwargs = perform_args.dup
+      if job_kwargs.key?(:operator)
+        self.operator = job_kwargs.delete(:operator)
+      else
+        self.operator ||= DataMigration.config.operator_resolver.call
+      end
+      job_kwargs
+    end
+
     def file_should_exist
       errors.add(:name, "is not found") unless file_exists?
     end

data/lib/data_migration/tasks/data_migration.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  namespace :migrate do
+    desc "Run a data migration with VERSION= and/or NAME= (lists migrations when both are blank)"
+    task data: :environment do
+      DataMigration::Cli.run!
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
 # USAGE: within remote console run one of the following commands
-# - rails db:migrate:data <%= migration_number %>_<%= migration_file_name %>
+# - bin/rails db:migrate:data VERSION=<%= migration_number %>
 # - DataMigration.perform_now("<%= migration_number %>_<%= migration_file_name %>")
 # - DataMigration.perform_later("<%= migration_number %>_<%= migration_file_name %>")
-# - DataMigration.prepare("<%= migration_number %>_<%= migration_file_name %>", pause: 1.minute, jobs_limit: 2).perform_later
+# - DataMigration.prepare("<%= migration_number %>_<%= migration_file_name %>", pause_minutes: 1, jobs_limit: 2).perform_later
 
 class <%= migration_class_name %>
   def perform(**kwargs)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data-migration
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrei Makarov
@@ -99,14 +99,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.9
 - !ruby/object:Gem::Dependency
   name: prosopite
   requirement: !ruby/object:Gem::Requirement
@@ -135,48 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -330,9 +288,13 @@ files:
 - README.md
 - data-migration.gemspec
 - lib/data-migration.rb
+- lib/data_migration/cli.rb
 - lib/data_migration/config.rb
 - lib/data_migration/job.rb
+- lib/data_migration/railtie.rb
+- lib/data_migration/selector.rb
 - lib/data_migration/task.rb
+- lib/data_migration/tasks/data_migration.rake
 - lib/generators/data_migration/install_generator.rb
 - lib/generators/data_migration/templates/install_data_migration_tasks.rb.tt
 - lib/generators/data_migration_generator.rb