data-migration 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37438001715cc268d2f647d68ee27c6a49d3a4c879187d61a2779523b1d34fb9
-  data.tar.gz: 55d7277c0848aa1395ab004ec986a3d268e18feebbe5fdbe7766b5658ef2a561
+  metadata.gz: c5f01e486573054202526bf5fa21c9acb04b7c1093928cc5c1f1fa42a5d04a67
+  data.tar.gz: dbe195a0ee725c658de65fd75190f38a7fe86cc74564945c75388e04de906f1c
 SHA512:
-  metadata.gz: 1d655d2e86118b04fdb4f778e3afa611caab5dc95bd048e71f24baf6235b4c7c8fad1cdc2a70d8a15fb6f5491f942d7f272f91bb2b618f9e1541dfae4a443310
-  data.tar.gz: 72542f7c60d054c70b62b39468edb645c1a3cf777ea07fd30ca710f90bdc9aa8ca66d89979ace38ed2eb48f97740757c836cda7a31169e83031a7b84609c542c
+  metadata.gz: 92812fe8790d454531b66618f6f142f69dec5a3e46e75bdb7e22bf914c10c9e23739709a5e300a750882b7c806edb604da5eb023332a6133e8de332beb6963b5
+  data.tar.gz: f2109fed76e5508ff160f87109d5c4fefa011233257248b8dcd4ca678b5594e27ef85d8883c9a08c0583485748a769299c02bc09e8cd86ca47250530cbc95fee

data/CHANGELOG.md

@@ -1,7 +1,18 @@
-# 1.1.0
+# CHANGELOG
+
+## 1.3.0
+
+- Fix data migration tasks table generator
+- Update README with better examples
+
+## 1.2.0
+
+- Wrap Task.status enum with ActiveRecord version check
+
+## 1.1.0
 
 - Fix gem main file name to be `data-migration.rb` instead of `data_migration.rb`
 
-# 1.0.0
+## 1.0.0
 
 - Initial version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    data-migration (1.1.0)
+    data-migration (1.3.0)
       activejob (> 5)
       activerecord (> 5)
       activesupport (> 5)

data/README.md

@@ -39,26 +39,32 @@ Using RubyGems:
 gem install data-migration
 ```
 
-## Gemfile
+### Gemfile
 
 ```ruby
 gem "data-migration"
 ```
 
-## Usage
-
-### Run data migrations
+### Data migration tasks table
 
 ```sh
-bin/rails db:migrate:data 20241207120000_create_users
+bin/rails g data_migration:install data_migration_tasks
 ```
 
+## Usage
+
 ### Generate data migration job
 
 ```sh
 bin/rails g data_migration create_users
 ```
 
+### Run data migrations
+
+```sh
+bin/rails db:migrate:data 20241207120000_create_users
+```
+
 ## Configuration
 
 ### Set data migrations directory

data/lib/data-migration.rb

@@ -3,7 +3,7 @@ require "data_migration/job"
 require "data_migration/task"
 
 module DataMigration
-  VERSION = "1.1.0".freeze
+  VERSION = "1.3.0".freeze
 
   module_function
 
@@ -17,7 +17,7 @@ module DataMigration
 
   def notify(message, context: {})
     if Object.const_defined?(:ActionReporter)
-      ActionReporter.notify(message, context:)
+      ActionReporter.notify(message, context: context.presence || {})
     elsif Object.const_defined?(:Rails)
       Rails.logger.info("#{message} #{context.inspect}")
     end

data/lib/data_migration/config.rb

@@ -35,7 +35,7 @@ module DataMigration
 
     attr_writer :operator_resolver
     def operator_resolver(&block)
-      if block_given?
+      if block.present?
         @operator_resolver = block
       else
         @operator_resolver ||= -> do
@@ -50,7 +50,7 @@ module DataMigration
 
     attr_writer :monitoring_context
     def monitoring_context(&block)
-      if block_given?
+      if block.present?
         @monitoring_context = block
       else
         @monitoring_context ||= ->(migration) do

data/lib/data_migration/job.rb

@@ -18,7 +18,7 @@ module DataMigration
         return
       end
 
-      task.job_check_in!(job_id, job_args:, job_kwargs:)
+      task.job_check_in!(job_id, job_args: job_args, job_kwargs: job_kwargs)
 
       require migration_path
       klass_name = migration_name.gsub(/^[0-9_]+/, "").camelize

data/lib/data_migration/task.rb

@@ -2,6 +2,7 @@ require "active_record"
 
 module DataMigration
   class JobConcurrencyLimitError < StandardError; end
+
   class JobConflictError < StandardError; end
 
   def self.tasks_table_name
@@ -18,16 +19,21 @@ module DataMigration
       self.jobs_limit ||= DataMigration.config.default_jobs_limit
     end
 
-    enum :status, {
+    STATUS_OPTIONS = {
       started: "started",
       performing: "performing",
       paused: "paused",
       completed: "completed"
     }
+    if ActiveRecord::VERSION::MAJOR >= 7
+      enum :status, STATUS_OPTIONS
+    else
+      enum status: STATUS_OPTIONS
+    end
 
     validates :name, presence: true
-    validates :pause_minutes, numericality: { greater_than_or_equal_to: 0, only_integer: true }, if: -> { pause_minutes.present? }
-    validates :jobs_limit, numericality: { greater_than_or_equal_to: 0, only_integer: true }, if: -> { jobs_limit.present? }
+    validates :pause_minutes, numericality: {greater_than_or_equal_to: 0, only_integer: true}, if: -> { pause_minutes.present? }
+    validates :jobs_limit, numericality: {greater_than_or_equal_to: 0, only_integer: true}, if: -> { jobs_limit.present? }
     validate :file_should_exist
 
     after_save do
@@ -50,7 +56,7 @@ module DataMigration
     end
 
     def self.perform_now(name, **kwargs)
-      create!(name:).perform_now(**kwargs)
+      create!(name: name).perform_now(**kwargs)
     end
 
     def perform_now(**perform_args)
@@ -59,7 +65,7 @@ module DataMigration
     end
 
     def self.perform_later(name, **kwargs)
-      create!(name:).perform_later(**kwargs)
+      create!(name: name).perform_later(**kwargs)
     end
 
     def perform_later(**perform_args)
@@ -68,7 +74,7 @@ module DataMigration
     end
 
     def self.prepare(name, pause_minutes: nil, jobs_limit: nil)
-      create!(name:, pause_minutes:, jobs_limit:)
+      create!(name: name, pause_minutes: pause_minutes, jobs_limit: jobs_limit)
     end
 
     def self.root_path

data/lib/generators/data_migration/install_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+require "rails/generators/active_record"
+require "rails/generators/active_record/migration/migration_generator"
+
+module DataMigration
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::MigrationGenerator
+      source_root File.expand_path("../templates", __FILE__)
+
+      attr_reader :table_exists, :table_columns
+      def create_migration_file
+        if ActiveRecord::Base.connection.table_exists?(name)
+          puts "\e[31mWARNING: Table `#{name}` already exists\e[0m"
+          @table_exists = true
+          @table_columns = ActiveRecord::Base.connection.columns(name)
+        end
+
+        set_local_assigns!
+        validate_file_name!
+        migration_template "install_#{name}.rb", "#{DataMigration.config.schema_migrations_path}/install_#{file_name}.rb"
+      end
+
+      def migration_parent
+        "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/{templates → data_migration/templates}/install_data_migration_tasks.rb.tt

@@ -1,4 +1,8 @@
 class <%= migration_class_name %> < <%= migration_parent %>
+  <% if table_exists %>
+    # Current columns: "<%= table_columns.map(&:name).join("\", \"") %>"
+  <% end %>
+
   def self.up
     create_table :<%= DataMigration.tasks_table_name %>, force: true do |t|
       t.string "name", null: false

data/spec/fixtures/data_migrations/20241206200114_create_batch_users.rb

@@ -4,6 +4,6 @@ class CreateBatchUsers
 
     User.find_or_create_by(email: "test_#{index}@example.com")
 
-    enqueue(index: index + 1, background:)
+    enqueue(index: index + 1, background: background)
   end
 end

data/spec/generators/install_generator_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
-require "generators/install_generator"
+require "generators/data_migration/install_generator"
 
-describe InstallGenerator, type: :generator do
+describe DataMigration::Generators::InstallGenerator, type: :generator do
   include FileUtils
 
   subject(:generator) { described_class.start params }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data-migration
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -180,10 +180,10 @@ files:
 - lib/data_migration/config.rb
 - lib/data_migration/job.rb
 - lib/data_migration/task.rb
+- lib/generators/data_migration/install_generator.rb
+- lib/generators/data_migration/templates/install_data_migration_tasks.rb.tt
 - lib/generators/data_migration_generator.rb
-- lib/generators/install_generator.rb
 - lib/generators/templates/data_migration.rb.tt
-- lib/generators/templates/install_data_migration_tasks.rb.tt
 - spec/data_migration/config_spec.rb
 - spec/data_migration/job_spec.rb
 - spec/data_migration/task_spec.rb

data/lib/generators/install_generator.rb

@@ -1,17 +0,0 @@
-require "rails/generators"
-require "rails/generators/active_record"
-require "rails/generators/active_record/migration/migration_generator"
-
-class InstallGenerator < ActiveRecord::Generators::MigrationGenerator
-  source_root File.expand_path("../templates", __FILE__)
-
-  def create_migration_file
-    set_local_assigns!
-    validate_file_name!
-    migration_template "install_#{name}.rb", "#{DataMigration.config.schema_migrations_path}/#{file_name}.rb"
-  end
-
-  def migration_parent
-    "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
-  end
-end