dekiru 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f03d8577117755bdd83832d5385e841f9b9062ed9280ff113126678fe246b4
-  data.tar.gz: 6b1b4051c93f6fbacdf95feb0d5f89daafaf4b86ee8c871d8d35dd4c86e9aea7
+  metadata.gz: a1c032693e2658b61ee9744b7e872a4379eb194d9f4e3a4ac1147c4b5025682b
+  data.tar.gz: 14321e4bf0b2574358bfc29147bf801480801181af1c8e40879d8f4357cc7fca
 SHA512:
-  metadata.gz: 15bd327a6571a4d56c7f0ea1fb3931c517496b02003f709a7185e052abb42fc66e5555eec0ba8fa3824cc4f64b4ab3e234517d5615f8287e97e6c6b30aa21a53
-  data.tar.gz: adc18f216af47e11d68daaeb86304a6e0d00351a019bdc516ce14afa89b6e69338248c6c7a29aef7c610cf1ab69945dae7653e107c662f50f57ae9a80f2c6c9f
+  metadata.gz: a5f36a181ddd30cf6500c5d454ceffb5cb058a5aeb5de29b1f44b96eb9eb6fe4796522bd8e0b20f0e3ae09cb5ca83f86688ac7ff1df4421522c0bbacc83ad9ac
+  data.tar.gz: e39f08ff48c0f412c7fbe7ff755b2c2dd77378aca03172bff6622b09d26c6bc7f94e08cefbe5ebdff575504550520da146e7b4f312b9c3b14fef6b6f96242523

data/.github/workflows/rspec.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2"]
+        ruby: ["3.1", "3.2", "3.3"]
     steps:
       - uses: actions/checkout@v4
 

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ```ruby
 require 'dekiru/capybara/helpers'
 RSpec.configure do |config|
-  config.include Dekiru::Capybara::Helpers, type: :feature
+  config.include Dekiru::Capybara::Helpers, type: :system
 end
 ```
 
@@ -55,7 +55,7 @@ wait_for_element_position_stable(element)
 ```ruby
 require 'dekiru/capybara/matchers'
 RSpec.configure do |config|
-  config.include Dekiru::Capybara::Matchers, type: :feature
+  config.include Dekiru::Capybara::Matchers, type: :system
 end
 ```
 
@@ -64,7 +64,7 @@ end
 ```ruby
 # javascriptエラーがあったらテスト失敗するように
 RSpec.configure do |config|
-  config.after(:each, type: :feature) do |example|
+  config.after(:each, type: :system) do |example|
     if example.metadata[:js] == true
       expect(page).to have_no_js_errors
     end
@@ -201,6 +201,46 @@ Dekiru.configure do |config|
 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
+```
+
+
 ## Refinements
 
 ### Dekiru::CamelizeHash

data/dekiru.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Dekiru::VERSION
 
-  gem.required_ruby_version = '>= 3.0.0'
+  gem.required_ruby_version = '>= 3.1.0'
 
-  gem.add_dependency 'rails', '>= 6.1'
+  gem.add_dependency 'rails', '>= 7.0'
   gem.add_dependency 'ruby-progressbar'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/lib/dekiru/data_migration_operator.rb

@@ -30,7 +30,7 @@ module Dekiru
       else
         raise NestedTransactionError if current_transaction_open?
 
-        @result = ActiveRecord::Base.transaction do
+        @result = transaction_provider.within_transaction do
           run(&block)
           log "Finished execution: #{title}"
           confirm?("\nAre you sure to commit?")
@@ -75,10 +75,6 @@ module Dekiru
 
     private
 
-    def current_transaction_open?
-      ActiveRecord::Base.connection.current_transaction.open?
-    end
-
     def log(message)
       if @pb && !@pb.finished?
         @pb.log(message)
@@ -148,5 +144,11 @@ module Dekiru
         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/tasks/db.rake

@@ -2,13 +2,13 @@ namespace :db do
   namespace :migrate do
     desc 'Check migrate conflict'
     task check_conflict: :environment do
-      migrations_status =
-        if ActiveRecord::Base.connection.respond_to?(:migration_context)
-          ActiveRecord::Base.connection.migration_context.current_version.zero? ? [] : ActiveRecord::Base.connection.migration_context.migrations_status
-        else
-          paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
-          ActiveRecord::Migrator.migrations_status(paths)
-        end
+      migration_context =
+          if ActiveRecord::Base.connection_pool.respond_to?(:migration_context)
+            ActiveRecord::Base.connection_pool.migration_context
+          else
+            ActiveRecord::Base.connection.migration_context
+          end
+      migrations_status = migration_context.current_version.zero? ? [] : migration_context.migrations_status
 
       if migrations_status.map(&:third).any? { |name| name.include?('NO FILE') }
         abort 'Migration conflict!'

data/lib/dekiru/transaction_provider.rb

@@ -0,0 +1,11 @@
+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/dekiru/version.rb

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

data/lib/dekiru.rb

@@ -1,10 +1,10 @@
 require 'dekiru/version'
 require 'dekiru/railtie' if defined?(::Rails)
 require 'dekiru/helper'
-require 'dekiru/validators/existence'
 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,11 +21,12 @@ module Dekiru
   end
 
   class Configuration
-    attr_accessor :mail_security_hook, :maintenance_script_directory
+    attr_accessor :mail_security_hook, :maintenance_script_directory, :transaction_provider
 
     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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ files:
 - lib/dekiru/railtie.rb
 - lib/dekiru/task_with_logger.rb
 - lib/dekiru/tasks/db.rake
-- lib/dekiru/validators/existence.rb
+- lib/dekiru/transaction_provider.rb
 - lib/dekiru/version.rb
 - lib/generators/maintenance_script/USAGE
 - lib/generators/maintenance_script/maintenance_script_generator.rb
@@ -147,7 +147,6 @@ files:
 - spec/dekiru/camelize_hash_spec.rb
 - spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/mail_security_interceptor_spec.rb
-- spec/dekiru/validators/existence_spec.rb
 - spec/spec_helper.rb
 - spec/supports/action_mailer.rb
 - spec/supports/mock_active_record.rb
@@ -165,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -180,7 +179,6 @@ test_files:
 - spec/dekiru/camelize_hash_spec.rb
 - spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/mail_security_interceptor_spec.rb
-- spec/dekiru/validators/existence_spec.rb
 - spec/spec_helper.rb
 - spec/supports/action_mailer.rb
 - spec/supports/mock_active_record.rb

data/lib/dekiru/validators/existence.rb

@@ -1,27 +0,0 @@
-#   class Post < ActiveRecord::Base
-#     belongs_to :company
-#     belongs_to :user
-#     validates :user_id, presence: true, existence: { in: -> { company.users } }
-#   end
-
-module ActiveModel
-  module Validations
-    class ExistenceValidator < EachValidator
-      def validate_each(record, attribute, value)
-        ActiveSupport::Deprecation.warn('`ExistenceValidator` is deprecated and will be removed in v0.5. Please use `inclusion: { in: xx }` instead.')
-
-        unless exists?(record, value)
-          record.errors.add(attribute, :existence, **options.except(:in).merge!(value: value))
-        end
-      end
-
-      def exists?(record, value)
-        unless options[:in].respond_to?(:call)
-          raise ArgumentError, '`in` option should be proc'
-        end
-        collection = record.instance_exec(&options[:in])
-        collection.exists?(value)
-      end
-    end
-  end
-end

data/spec/dekiru/validators/existence_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-describe ActiveModel::Validations::ExistenceValidator do
-  let(:user_class) do
-    Class.new do
-      def self.exists?(id)
-        %w[valid_id].member?(id)
-      end
-    end
-  end
-  let(:model_class) do
-    _options = options
-
-    Struct.new(:user_id, :users) do
-      include ActiveModel::Validations
-
-      def self.name
-        'DummyModel'
-      end
-
-      validates :user_id, existence: _options
-    end
-  end
-
-  describe 'validate' do
-    subject(:valid?) do
-      model_class.new(user_id, user_class).valid?
-    end
-
-    context 'with exists id' do
-      let(:user_id) { 'valid_id' }
-      let(:options) { { in: -> { users } } }
-
-      it { is_expected.to eq true }
-    end
-
-    context 'with exists not id' do
-      let(:user_id) { 'invalid_id' }
-      let(:options) { { in: -> { users } } }
-
-      it { is_expected.to eq false }
-    end
-
-    context 'with invalid option' do
-      let(:user_id) { 'valid_id' }
-      let(:options) { { in: user_class } }
-
-      it { expect { valid? }.to raise_error(ArgumentError) }
-    end
-  end
-end