dekiru-data_migration 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5005a000366972c658bdda144f38061ca3ccc165138e03fe80a258baa8d6b58
-  data.tar.gz: fe14a8ffcb9546bb6e02f9959f934d09640fbc5dbe99684a779549688dc04f05
+  metadata.gz: 2be3a7af7bab104c9eb7c8461e408d82f0d1605bd5dc882bcd8b011a2b7fb646
+  data.tar.gz: 9467fcfce4288679751724dae8968b586b04beb3383026cb55f4c48139d4102a
 SHA512:
-  metadata.gz: e765f1ac06542de3b8598fe66ac42c16ea89b0b1a6b09da4071e713e5da0f36fd2239b321ea37452da21f4d450ec321196159187407a6ba1c4d56880b869b03a
-  data.tar.gz: 92492fe777e9454d6fd2ab45c55268268403403e21a0242377643b3ea49ce3e8e4c75a44eec1b227acc8cb99beff97f67849ba529e81a85858afd12e74ca400c
+  metadata.gz: 9020fda17cf13c7fc29d4d9bb4f03c543ef5b6516cd80012b864539295e0f7cfc418ded1915e4eaf926ddbdc47f9d65f8376f8c790077a6d174669ae60cf952e
+  data.tar.gz: 4932cce5481c646c3f48f8879a8062efc7c990fa04280e47a5fe65db8515e7921f1bdadbfbc01c6869451a40d8b866859bd4ef4bcb0bf04d62ee93db7735b66e

data/.rubocop.yml

@@ -6,3 +6,8 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"

data/README.md

@@ -32,27 +32,9 @@ Or install it yourself as:
 $ gem install dekiru-data_migration
 ```
 
-## Data Migration Operator
+## Data Migration Class
 
-You can implement the necessary processing for data migration tasks with scripts like the following:
-
-```ruby
-# scripts/demo.rb
-Dekiru::DataMigration::Operator.execute('Grant admin privileges to users') do
-  targets = User.where("email LIKE '%sonicgarden%'")
-
-  log "Target user count: #{targets.count}"
-  find_each_with_progress(targets) do |user|
-    user.update!(admin: true)
-  end
-
-  log "Updated user count: #{User.where("email LIKE '%sonicgarden%'").where(admin: true).count}"
-end
-```
-
-## Data Migration Class (Recommended)
-
-You can also define migration logic as a class, which makes testing easier:
+Define migration logic as a class:
 
 ```ruby
 # scripts/20230118_demo_migration.rb
@@ -95,20 +77,6 @@ end
 DeactivateStaleUsersMigration.run
 ```
 
-If you use the block-based `Operator` directly, pass `in_batches` to `each_with_progress`:
-
-```ruby
-# scripts/deactivate_stale_users.rb
-Dekiru::DataMigration::Operator.execute('Deactivate stale users') do
-  targets = User.where(active: true).where("last_login_at < ?", 1.year.ago)
-
-  log "Target user count: #{targets.count}"
-  each_with_progress(targets.in_batches) do |batch|
-    batch.update_all(active: false)
-  end
-end
-```
-
 #### Specifying the batch size
 
 Pass `batch_size` to `run` to control how many records are fetched per batch. It applies to both paths — `in_batches(of:)` for `migrate_batch` and `find_each(batch_size:)` for `migrate_record`. When omitted, ActiveRecord's default of 1000 is used.
@@ -164,12 +132,10 @@ Total time: 6.35 sec
 
 ## Side Effect Monitoring
 
-By executing with the `warning_side_effects: true` option, side effects that occur during data migration tasks (database writes, job enqueuing, email sending, etc.) will be displayed.
+By passing `warning_side_effects: true` to `run`, side effects that occur during data migration tasks (database writes, job enqueuing, email sending, etc.) will be displayed.
 
 ```ruby
-Dekiru::DataMigration::Operator.execute('Grant admin privileges to users', warning_side_effects: true) do
-  # Processing content...
-end
+DemoMigration.run(warning_side_effects: true)
 ```
 
 Execution result:
@@ -208,14 +174,14 @@ Generated file example:
 
 class DemoMigration < Dekiru::DataMigration::Migration
   def migration_targets
-    # 移行対象を返すActiveRecord::Relationを定義
-    # 例: User.where(some_condition: true)
+    # Return an ActiveRecord::Relation of records to migrate
+    # e.g. User.where(some_condition: true)
     raise NotImplementedError, 'migration_targets method must be implemented'
   end
 
   def migrate_record(record)
-    # 個別レコードの更新処理を定義
-    # 例: record.update!(some_attribute: new_value)
+    # Define the update logic for each record
+    # e.g. record.update!(some_attribute: new_value)
     raise NotImplementedError, 'migrate_record method must be implemented'
   end
 end
@@ -223,17 +189,6 @@ end
 DemoMigration.run
 ```
 
-### Legacy Block-based Approach
-
-For backward compatibility, you can still use the block-based approach:
-
-```ruby
-# scripts/legacy_demo.rb
-Dekiru::DataMigration::Operator.execute('demo_migration') do
-  # write here
-end
-```
-
 ### Output Directory Configuration
 
 The output directory for files is by default the `scripts` directory directly under the application root. You can change the output directory through configuration.
@@ -311,10 +266,10 @@ end
 
 ### Runtime Options
 
+Pass options to `Migration.run`:
+
 ```ruby
-Dekiru::DataMigration::Operator.execute('Title', options) do
-  # Processing content
-end
+DemoMigration.run(warning_side_effects: true, without_transaction: false)
 ```
 
 Available options:

data/lib/dekiru/data_migration/migration.rb

@@ -16,7 +16,7 @@ module Dekiru
         options = options.dup
         migration.batch_size = options.delete(:batch_size)
 
-        Operator.execute(title, options) do
+        Operator.new(title, options).execute do
           migration.instance_variable_set(:@operator_context, self)
           migration.migrate
         end

data/lib/dekiru/data_migration/operator.rb

@@ -12,7 +12,13 @@ module Dekiru
 
       attr_reader :title, :stream, :logger, :result, :canceled, :started_at, :ended_at, :error
 
+      DEPRECATOR = ActiveSupport::Deprecation.new("2.0", "Dekiru::DataMigration")
+
       def self.execute(title, options = {}, &block)
+        DEPRECATOR.warn(
+          "Dekiru::DataMigration::Operator.execute is deprecated and will be removed in 2.0. " \
+          "Use Dekiru::DataMigration::Migration subclass instead."
+        )
         new(title, options).execute(&block)
       end
 

data/lib/dekiru/data_migration/version.rb

@@ -2,6 +2,6 @@
 
 module Dekiru
   module DataMigration
-    VERSION = "1.3.1"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dekiru-data_migration
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - SonicGarden
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.15
 specification_version: 4
 summary: A Ruby on Rails library for executing data migration tasks safely and efficiently.
 test_files: []