dekiru 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1c032693e2658b61ee9744b7e872a4379eb194d9f4e3a4ac1147c4b5025682b
-  data.tar.gz: 14321e4bf0b2574358bfc29147bf801480801181af1c8e40879d8f4357cc7fca
+  metadata.gz: 54931a9e4393d521550361c655a87e561e548691c3be644cb2b881e4a9c55aa9
+  data.tar.gz: 663476875859ca0dcd5a5fa755f1b48c26eadbeca4df848f717ed8cde5aea9be
 SHA512:
-  metadata.gz: a5f36a181ddd30cf6500c5d454ceffb5cb058a5aeb5de29b1f44b96eb9eb6fe4796522bd8e0b20f0e3ae09cb5ca83f86688ac7ff1df4421522c0bbacc83ad9ac
-  data.tar.gz: e39f08ff48c0f412c7fbe7ff755b2c2dd77378aca03172bff6622b09d26c6bc7f94e08cefbe5ebdff575504550520da146e7b4f312b9c3b14fef6b6f96242523
+  metadata.gz: 6c6ad53a0f07879ddcaed43927406cc58dbc176d346655f400539fc27685f1470239358c2cea4a29ec4c9c2f375fce40fed98cc2cb521e2a0e8b382026357e7a
+  data.tar.gz: 3d9074d7047a77b7089cc7b9d4e4bdacd8e6c9273dd03649227e073d0c84e7c5f8286bc03cba48072c121f8c244d7e87d6e358260aed5ada59c73ccdc70d208c

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/README.md

@@ -124,122 +124,7 @@ end
 
 ## Data Migration Operator
 
-実行しながら進捗を表示したり、処理の最後に実行の確認をしたりといった、データ移行作業をするときに必要な処理を以下のような script を作成することで、実現できるようになります。
-
-```ruby
-# scripts/demo.rb
-Dekiru::DataMigrationOperator.execute('Demo migration') do
-  targets = User.where("email LIKE '%sonicgarden%'")
-
-  log "all targets 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
-```
-
-```
-$ bin/rails r scripts/demo.rb
-Start: Demo migration at 2019-05-24 18:29:57 +0900
-
-all targets count: 30
-Time: 00:00:00 |=================>>| 100% Progress
-updated user count: 30
-
-Are you sure to commit? (yes/no) > yes
-
-Finished successfully: Demo migration
-Total time: 6.35 sec
-```
-
-また`warning_side_effects: true`オプションを付けて実行することで、データ移行作業で発生した副作用が表示されるようになります。
-
-```ruby
-Dekiru::DataMigrationOperator.execute('Demo migration', warning_side_effects: true) do
-  # ...
-end
-```
-
-```
-$ bin/rails r scripts/demo.rb
-Start: Demo migration at 2019-05-24 18:29:57 +0900
-
-all targets count: 30
-Time: 00:00:00 |=================>>| 100% Progress
-updated user count: 30
-
-Write Queries!!
-30 call: Update "users" SET ...
-
-Enqueued Jobs!!
-10 call: NotifyJob
-
-Deliverd Mailers!!
-10 call: UserMailer
-
-Are you sure to commit? (yes/no) > yes
-```
-
-ジェネレータを使って `Dekiru::DataMigrationOperator` を使ったメンテナンススクリプトを生成することができます。ファイル名にはスクリプトファイルを生成した日付が prefix として付与されます。
-
-```
-$ bin/rails g maintenance_script demo_migration
-$ cat scripts/20230118_demo_migration.rb
-Dekiru::DataMigrationOperator.execute('demo_migration') do
-  # write here
-end
-```
-
-ファイルの出力先ディレクトリは、デフォルトではアプリケーションルート直下の `scripts` ディレクトリです。設定で出力先ディレクトリを変更することもできます。
-
-```ruby
-# config/initializer/dekiru.rb
-Dekiru.configure do |config|
-  config.maintenance_script_directory = 'scripts/maintenance'
-end
-```
-
-### Dekiru::TransactionProvider
-
-`Dekiru::DataMigrationOperator` を使うスクリプトにおいて、複数データベースへの書き込みが必要な場合など、`ActiveRecord::Base.transaction` によるトランザクション開始だけでは不十分な場合があります。`Dekiru::TransactionProvider` を実装することで `Dekiru::DataMigrationOperator` のトランザクション開始の挙動をカスタマイズすることができます。
-
-以下のようなアプリケーションコードがあるとします。
-
-```ruby
-class LegacyRecord < ApplicationRecord
-  connects_to database: { writing: :legacy, reading: :legacy }
-end
-
-class ApplicationRecord < ActiveRecord::Base
-  connects_to database: { writing: :primary, reading: :primary }
-
-  def self.with_legacy_transaction
-    ActiveRecord::Base.transaction do
-      LegacyRecord.transaction do
-        yield
-      end
-    end
-  end
-end
-```
-
-`Dekiru::DataMigrationOperator` においても `ApplicationRecord.with_legacy_transaction` を使ってトランザクション開始するために、以下のような設定を用意します。
-
-```ruby
-# config/initializer/dekiru.rb
-class MyTransactionProvider < Dekiru::TransactionProvider
-  def within_transaction(&)
-    ApplicationRecord.with_legacy_transaction(&)
-  end
-end
-
-Dekiru.configure do |config|
-  config.transaction_provider = MyTransactionProvider.new
-end
-```
-
+For data migration operations, please use the separate [`dekiru-data_migration` gem](https://github.com/SonicGarden/dekiru-data_migration) which provides the `Dekiru::DataMigrationOperator` functionality.
 
 ## Refinements
 

data/dekiru.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 3.1.0'
 
   gem.add_dependency 'rails', '>= 7.0'
-  gem.add_dependency 'ruby-progressbar'
+  gem.add_dependency 'dekiru-data_migration'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop'

data/lib/dekiru/version.rb

@@ -1,3 +1,3 @@
 module Dekiru
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/lib/dekiru.rb

@@ -1,10 +1,8 @@
 require 'dekiru/version'
 require 'dekiru/railtie' if defined?(::Rails)
 require 'dekiru/helper'
-require 'dekiru/data_migration_operator'
 require 'dekiru/mail_security_interceptor'
 require 'dekiru/camelize_hash'
-require 'dekiru/transaction_provider'
 
 require 'active_support'
 require 'active_support/all'
@@ -21,12 +19,10 @@ module Dekiru
   end
 
   class Configuration
-    attr_accessor :mail_security_hook, :maintenance_script_directory, :transaction_provider
+    attr_accessor :mail_security_hook
 
     def initialize
       @mail_security_hook = false # default
-      @maintenance_script_directory = 'scripts'
-      @transaction_provider = TransactionProvider.new
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dekiru
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-progressbar
+  name: dekiru-data_migration
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -133,19 +133,13 @@ files:
 - lib/dekiru/capybara/helpers/wait_for_position_stable.rb
 - lib/dekiru/capybara/legacy_helpers.rb
 - lib/dekiru/capybara/matchers.rb
-- lib/dekiru/data_migration_operator.rb
 - lib/dekiru/helper.rb
 - lib/dekiru/mail_security_interceptor.rb
 - lib/dekiru/railtie.rb
 - lib/dekiru/task_with_logger.rb
 - lib/dekiru/tasks/db.rake
-- lib/dekiru/transaction_provider.rb
 - lib/dekiru/version.rb
-- lib/generators/maintenance_script/USAGE
-- lib/generators/maintenance_script/maintenance_script_generator.rb
-- lib/generators/maintenance_script/templates/maintenance_script.rb.erb
 - spec/dekiru/camelize_hash_spec.rb
-- spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/mail_security_interceptor_spec.rb
 - spec/spec_helper.rb
 - spec/supports/action_mailer.rb
@@ -177,7 +171,6 @@ specification_version: 4
 summary: Usefull helper methods for Ruby on Rails
 test_files:
 - spec/dekiru/camelize_hash_spec.rb
-- spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/mail_security_interceptor_spec.rb
 - spec/spec_helper.rb
 - spec/supports/action_mailer.rb

data/lib/dekiru/data_migration_operator.rb

@@ -1,154 +0,0 @@
-require 'ruby-progressbar'
-
-module Dekiru
-  class DataMigrationOperator
-    class NestedTransactionError < StandardError ; end
-
-    attr_reader :title, :stream, :logger, :result, :canceled, :started_at, :ended_at, :error
-
-    def self.execute(title, options = {}, &block)
-      self.new(title, options).execute(&block)
-    end
-
-    def initialize(title, options = {})
-      @title = title
-      @options = options
-      @logger = @options.fetch(:logger) { Logger.new(Rails.root.join("log/data_migration_#{Time.current.strftime("%Y%m%d%H%M")}.log")) }
-      @stream = @options.fetch(:output, $stdout)
-      @without_transaction = @options.fetch(:without_transaction, false)
-      @side_effects = Hash.new do |hash, key|
-        hash[key] = Hash.new(0)
-      end
-    end
-
-    def execute(&block)
-      @started_at = Time.current
-      log "Start: #{title} at #{started_at}\n\n"
-      if @without_transaction
-        run(&block)
-        @result = true
-      else
-        raise NestedTransactionError if current_transaction_open?
-
-        @result = transaction_provider.within_transaction do
-          run(&block)
-          log "Finished execution: #{title}"
-          confirm?("\nAre you sure to commit?")
-        end
-      end
-      log "Finished successfully: #{title}" if @result == true
-    rescue => e
-      @error = e
-      @result = false
-    ensure
-      @ended_at = Time.current
-      log "Total time: #{self.duration.round(2)} sec"
-
-      raise error if error
-
-      return @result
-    end
-
-    def duration
-      ((self.ended_at || Time.current) - self.started_at)
-    end
-
-    def each_with_progress(enum, options = {})
-      options = options.dup
-      options[:total] ||= ((enum.size == Float::INFINITY ? nil : enum.size) rescue nil)
-      options[:format] ||= options[:total] ? '%a |%b>>%i| %p%% %t' : '%a |%b>>%i| ??%% %t'
-      options[:output] = stream
-
-      @pb = ::ProgressBar.create(options)
-      enum.each do |item|
-        yield item
-        @pb.increment
-      end
-      @pb.finish
-    end
-
-    def find_each_with_progress(target_scope, options = {}, &block)
-      # `LocalJumpError: no block given (yield)` が出る場合、 find_each メソッドが enumerator を返していない可能性があります
-      # 直接 each_with_progress を使うか、 find_each が enumerator を返すように修正してください
-      each_with_progress(target_scope.find_each, options, &block)
-    end
-
-    private
-
-    def log(message)
-      if @pb && !@pb.finished?
-        @pb.log(message)
-      else
-        stream.puts(message)
-      end
-
-      logger&.info(message.squish)
-    end
-
-    def confirm?(message = 'Are you sure?')
-      loop do
-        stream.print "#{message} (yes/no) > "
-        case STDIN.gets.strip
-        when 'yes'
-          newline
-          return true
-        when 'no'
-          newline
-          cancel!
-        end
-      end
-    end
-
-    def newline
-      stream.puts('')
-    end
-
-    def cancel!
-      log "Canceled: #{title}"
-      raise ActiveRecord::Rollback
-    end
-
-    def handle_notification(*args)
-      event = ActiveSupport::Notifications::Event.new(*args)
-
-      increment_side_effects(:enqueued_jobs, event.payload[:job].class.name)  if event.payload[:job]
-      increment_side_effects(:deliverd_mailers, event.payload[:mailer]) if event.payload[:mailer]
-
-      if event.payload[:sql] && /\A\s*(insert|update|delete)/i.match?(event.payload[:sql])
-        increment_side_effects(:write_queries, event.payload[:sql])
-      end
-    end
-
-    def increment_side_effects(type, value)
-      @side_effects[type][value] += 1
-    end
-
-    def warning_side_effects(&block)
-      ActiveSupport::Notifications.subscribed(method(:handle_notification), /^(sql|enqueue|deliver)/) do
-        instance_eval(&block)
-      end
-
-      @side_effects.each do |name, items|
-        newline
-        log "#{name.to_s.titlecase}!!"
-        items.sort_by { |v, c| c }.reverse.slice(0, 20).each do |value, count|
-          log "#{count} call: #{value}"
-        end
-      end
-    end
-
-    def run(&block)
-      if @options.fetch(:warning_side_effects, true)
-        warning_side_effects(&block)
-      else
-        instance_eval(&block)
-      end
-    end
-
-    def transaction_provider
-      Dekiru.configuration.transaction_provider
-    end
-
-    delegate :current_transaction_open?, to: :transaction_provider
-  end
-end

data/lib/dekiru/transaction_provider.rb

@@ -1,11 +0,0 @@
-module Dekiru
-  class TransactionProvider
-    def within_transaction(&)
-      ActiveRecord::Base.transaction(&)
-    end
-
-    def current_transaction_open?
-      ActiveRecord::Base.connection.current_transaction.open?
-    end
-  end
-end

data/lib/generators/maintenance_script/USAGE

@@ -1,8 +0,0 @@
-Description:
-    Create database maintenance script using Dekiru::DataMigrationOperator
-
-Example:
-    rails generate maintenance_script UpdateUserName
-
-    This will create:
-        scripts/XXX_update_user_name.rb

data/lib/generators/maintenance_script/maintenance_script_generator.rb

@@ -1,16 +0,0 @@
-require 'rails/generators'
-
-class MaintenanceScriptGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path('templates', __dir__)
-
-  def copy_maintenance_script_file
-    template 'maintenance_script.rb.erb',
-             "#{Dekiru.configuration.maintenance_script_directory}/#{filename_date}_#{file_name}.rb"
-  end
-
-  private
-
-  def filename_date
-    Time.current.strftime('%Y%m%d')
-  end
-end

data/lib/generators/maintenance_script/templates/maintenance_script.rb.erb

@@ -1,3 +0,0 @@
-Dekiru::DataMigrationOperator.execute('<%= @name %>') do
-  # write here
-end

data/spec/dekiru/data_migration_operator_spec.rb

@@ -1,226 +0,0 @@
-require "spec_helper"
-
-describe Dekiru::DataMigrationOperator do
-  let(:dummy_stream) do
-    class Dekiru::DummyStream
-      attr_reader :out
-
-      def initialize
-        @out = ''
-      end
-
-      def puts(text)
-        @out = out << "#{text}\n"
-      end
-
-      def print(text)
-        @out = out << text
-      end
-
-      def tty?
-        false
-      end
-
-      def flush
-      end
-    end
-    Dekiru::DummyStream.new
-  end
-  let(:without_transaction) { false }
-  let(:operator) do
-    op = Dekiru::DataMigrationOperator.new('dummy', output: dummy_stream, logger: nil, without_transaction: without_transaction)
-    allow(op).to receive(:current_transaction_open?) { false }
-    op
-  end
-
-  describe '#execute' do
-    it 'confirm で yes' do
-      allow(STDIN).to receive(:gets) do
-        "yes\n"
-      end
-
-      expect do
-        operator.execute { log 'processing'; sleep 1.0 }
-      end.not_to raise_error
-
-      expect(operator.result).to eq(true)
-      expect(operator.duration).to be_within(0.1).of(1.0)
-      expect(operator.error).to eq(nil)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('Finished successfully:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-
-    it 'confirm で no' do
-      allow(STDIN).to receive(:gets) do
-        "no\n"
-      end
-
-      expect do
-        operator.execute { log 'processing'; sleep 1.0 }
-      end.to raise_error(ActiveRecord::Rollback)
-
-      expect(operator.result).to eq(false)
-      expect(operator.duration).to be_within(0.1).of(1.0)
-      expect(operator.error.class).to eq(ActiveRecord::Rollback)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('Canceled:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-
-    it '処理中に例外' do
-      expect do
-        operator.execute { raise ArgumentError }
-      end.to raise_error(ArgumentError)
-
-      expect(operator.result).to eq(false)
-      expect(operator.error.class).to eq(ArgumentError)
-      expect(operator.stream.out).not_to include('Are you sure to commit?')
-      expect(operator.stream.out).not_to include('Canceled:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-
-    context 'トランザクション内で呼び出された場合' do
-      before { allow(operator).to receive(:current_transaction_open?) { true } }
-
-      it '例外が発生すること' do
-        expect { operator.execute { log 'processing'; sleep 1.0 } }.to raise_error(Dekiru::DataMigrationOperator::NestedTransactionError)
-      end
-    end
-
-    context 'without_transaction: true のとき' do
-      let(:without_transaction) { true }
-
-      it 'トランザクションがかからないこと' do
-        expect do
-          operator.execute { log 'processing'; sleep 1.0 }
-        end.not_to raise_error
-
-        expect(operator.result).to eq(true)
-        expect(operator.duration).to be_within(0.1).of(1.0)
-        expect(operator.error).to eq(nil)
-        expect(operator.stream.out).not_to include('Are you sure to commit?')
-        expect(operator.stream.out).to include('Finished successfully:')
-        expect(operator.stream.out).to include('Total time:')
-      end
-    end
-  end
-
-  describe '#each_with_progress' do
-    it '進捗が表示される' do
-      record = (0...10)
-
-      allow(STDIN).to receive(:gets) do
-        "yes\n"
-      end
-
-      sum = 0
-      operator.execute do
-        each_with_progress(record, title: 'count up number') do |num|
-          sum += num
-        end
-      end
-
-      expect(sum).to eq(45)
-      expect(operator.result).to eq(true)
-      expect(operator.error).to eq(nil)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('count up number:')
-      expect(operator.stream.out).to include('Finished successfully:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-
-    it 'total をオプションで渡すことができる' do
-      class Dekiru::DummyRecord
-        def self.count
-          raise "won't call"
-        end
-
-        def self.each
-          yield 99
-        end
-      end
-
-      allow(STDIN).to receive(:gets) do
-        "yes\n"
-      end
-
-      sum = 0
-      operator.execute do
-        each_with_progress(Dekiru::DummyRecord, title: 'pass total as option', total: 1) do |num|
-          sum += num
-        end
-      end
-
-      expect(sum).to eq(99)
-      expect(operator.result).to eq(true)
-      expect(operator.error).to eq(nil)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('pass total as option:')
-      expect(operator.stream.out).to include('Finished successfully:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-  end
-
-  describe '#find_each_with_progress' do
-    it '進捗が表示される' do
-      record = (0...10).to_a.tap do |r|
-        r.singleton_class.alias_method(:find_each, :each)
-      end
-
-      allow(STDIN).to receive(:gets) do
-        "yes\n"
-      end
-
-      sum = 0
-      operator.execute do
-        find_each_with_progress(record, title: 'count up number') do |num|
-          sum += num
-        end
-      end
-
-      expect(sum).to eq(45)
-      expect(operator.result).to eq(true)
-      expect(operator.error).to eq(nil)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('count up number:')
-      expect(operator.stream.out).to include('Finished successfully:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-
-    it 'total をオプションで渡すことができる' do
-      class Dekiru::DummyRecord
-        def self.count
-          raise "won't call"
-        end
-
-        def self.find_each
-          if block_given?
-            yield 99
-          else
-            Enumerator.new { |y| y << 99 }
-          end
-        end
-      end
-
-      allow(STDIN).to receive(:gets) do
-        "yes\n"
-      end
-
-      sum = 0
-      operator.execute do
-        find_each_with_progress(Dekiru::DummyRecord, title: 'pass total as option', total: 1) do |num|
-          sum += num
-        end
-      end
-
-      expect(sum).to eq(99)
-      expect(operator.result).to eq(true)
-      expect(operator.error).to eq(nil)
-      expect(operator.stream.out).to include('Are you sure to commit?')
-      expect(operator.stream.out).to include('pass total as option:')
-      expect(operator.stream.out).to include('Finished successfully:')
-      expect(operator.stream.out).to include('Total time:')
-    end
-  end
-end