departure 8.1.0 → 8.2.0

data/lib/active_record/connection_adapters/rails_8_1_trilogy_adapter.rb

@@ -1,8 +1,8 @@
-require 'active_record/connection_adapters/abstract_mysql_adapter'
-require 'active_record/connection_adapters/trilogy_adapter'
-require 'active_record/connection_adapters/patch_connection_handling'
-require 'departure'
-require 'active_record/connection_adapters/rails_8_1_adapter_behavior'
+require "active_record/connection_adapters/abstract_mysql_adapter"
+require "active_record/connection_adapters/trilogy_adapter"
+require "active_record/connection_adapters/patch_connection_handling"
+require "departure"
+require "active_record/connection_adapters/departure_adapter_behavior"
 
 module ActiveRecord
   module ConnectionAdapters
@@ -13,9 +13,9 @@ module ActiveRecord
         end
       end
 
-      ADAPTER_NAME = 'Percona'.freeze
+      ADAPTER_NAME = "Percona".freeze
 
-      include Rails81AdapterBehavior
+      include DepartureAdapterBehavior::Rails8
     end
   end
 end

data/lib/departure/alter_argument.rb

@@ -4,7 +4,7 @@ module Departure
   # Represents the '--alter' argument of Percona's pt-online-schema-change
   # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html
   class AlterArgument
-    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*[\n]* /
+    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*\n* /
 
     attr_reader :table_name
 
@@ -21,8 +21,8 @@ module Departure
       #
       # Removes the grave marks, if they are there, so we can get the table_name
       @table_name = String(match)
-                      .split(' ')[2]
-                      .delete('`')
+        .split(" ")[2]
+        .delete("`")
     end
 
     # Returns the '--alter' pt-online-schema-change argument as a string. See
@@ -40,9 +40,9 @@ module Departure
     # @return [String]
     def parsed_statement
       @parsed_statement ||= statement
-        .gsub(ALTER_TABLE_REGEX, '')
-        .gsub('`', '\\\`')
-        .gsub(/\\n/, '')
+        .gsub(ALTER_TABLE_REGEX, "")
+        .gsub("`", '\\\`')
+        .gsub("\\n", "")
         .gsub('"', '\\\"')
     end
   end

data/lib/departure/cli_generator.rb

@@ -1,24 +1,24 @@
-require 'departure/dsn'
-require 'departure/option'
-require 'departure/alter_argument'
-require 'departure/connection_details'
-require 'departure/user_options'
+require "departure/dsn"
+require "departure/option"
+require "departure/alter_argument"
+require "departure/connection_details"
+require "departure/user_options"
 
 module Departure
   # Generates the equivalent Percona's pt-online-schema-change command to the
   # given SQL statement
   #
   # --no-check-alter is used to allow running CHANGE COLUMN statements. For more details, check:
-  # www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#cmdoption-pt-online-schema-change--[no]check-alter # rubocop:disable Metrics/LineLength
+  # www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#cmdoption-pt-online-schema-change--[no]check-alter
   #
   class CliGenerator
-    COMMAND_NAME = 'pt-online-schema-change'.freeze
+    COMMAND_NAME = "pt-online-schema-change".freeze
     DEFAULT_OPTIONS = Set.new(
       [
-        Option.new('execute'),
-        Option.new('statistics'),
-        Option.new('alter-foreign-keys-method', 'auto'),
-        Option.new('no-check-alter')
+        Option.new("execute"),
+        Option.new("statistics"),
+        Option.new("alter-foreign-keys-method", "auto"),
+        Option.new("no-check-alter")
       ]
     ).freeze
 
@@ -78,7 +78,7 @@ module Departure
       env_variable_options = UserOptions.new
       global_configuration_options = UserOptions.new(Departure.configuration.global_percona_args)
       options = env_variable_options.merge(global_configuration_options).merge(DEFAULT_OPTIONS)
-      options.to_a.join(' ')
+      options.to_a.join(" ")
     end
   end
 end

data/lib/departure/command.rb

@@ -86,7 +86,7 @@ module Departure
       if redirect_stderr
         File.read(error_log_path)
       else
-        ''
+        ""
       end
     end
 

data/lib/departure/configuration.rb

@@ -1,11 +1,11 @@
 module Departure
   class Configuration
     attr_accessor :tmp_path, :global_percona_args, :enabled_by_default, :redirect_stderr,
-                  :disable_rails_advisory_lock_patch
+      :disable_rails_advisory_lock_patch
 
     def initialize
-      @tmp_path = '.'.freeze
-      @error_log_filename = 'departure_error.log'.freeze
+      @tmp_path = ".".freeze
+      @error_log_filename = "departure_error.log".freeze
       @global_percona_args = nil
       @enabled_by_default = true
       @redirect_stderr = true

data/lib/departure/connection_details.rb

@@ -1,4 +1,4 @@
-require 'shellwords'
+require "shellwords"
 module Departure
   # Holds the parameters of the DB connection and formats them to string
   class ConnectionDetails
@@ -26,7 +26,7 @@ module Departure
     #
     # @return [String]
     def database
-      ENV.fetch('PERCONA_DB_NAME', connection_data[:database])
+      ENV.fetch("PERCONA_DB_NAME", connection_data[:database])
     end
 
     # Returns the password fragment of the details string if a password is passed
@@ -36,7 +36,7 @@ module Departure
       if password.present?
         %(--password #{Shellwords.escape(password)} )
       else
-        ''
+        ""
       end
     end
 
@@ -77,7 +77,7 @@ module Departure
     #
     # @return [String]
     def host
-      ENV.fetch('PERCONA_DB_HOST', connection_data[:host]) || 'localhost'
+      ENV.fetch("PERCONA_DB_HOST", connection_data[:host]) || "localhost"
     end
 
     # Returns the database user. If PERCONA_DB_USER is passed its value will be
@@ -85,7 +85,7 @@ module Departure
     #
     # @return [String]
     def user
-      ENV.fetch('PERCONA_DB_USER', connection_data[:username])
+      ENV.fetch("PERCONA_DB_USER", connection_data[:username])
     end
 
     # Returns the database user's password. If PERCONA_DB_PASSWORD is passed its
@@ -93,7 +93,7 @@ module Departure
     #
     # @return [String]
     def password
-      ENV.fetch('PERCONA_DB_PASSWORD', connection_data[:password])
+      ENV.fetch("PERCONA_DB_PASSWORD", connection_data[:password])
     end
 
     # Returns the database socket path. If PERCONA_DB_SOCKET is passed its value
@@ -101,7 +101,7 @@ module Departure
     #
     # @return [String]
     def socket
-      ENV.fetch('PERCONA_DB_SOCKET', connection_data[:socket])
+      ENV.fetch("PERCONA_DB_SOCKET", connection_data[:socket])
     end
 
     # Returns the database's port.

data/lib/departure/db_client.rb

@@ -1,6 +1,6 @@
-require 'open3'
+require "open3"
 
-require 'forwardable'
+require "forwardable"
 
 module Departure
   # It executes pt-online-schema-change commands in a new process and gets its
@@ -40,9 +40,9 @@ module Departure
       command_line = @cli_generator.parse_statement(raw_sql_string)
 
       Command.new(command_line,
-                  Departure.configuration.error_log_path,
-                  @logger,
-                  Departure.configuration.redirect_stderr).run
+        Departure.configuration.error_log_path,
+        @logger,
+        Departure.configuration.redirect_stderr).run
     end
 
     def alter_statement?(raw_sql_string)

data/lib/departure/dsn.rb

@@ -9,13 +9,13 @@ module Departure
     def initialize(database, table_name)
       @database = database
       @table_name = table_name
-      @suffix = ENV.fetch('PERCONA_DSN_SUFFIX', nil)
+      @suffix = ENV.fetch("PERCONA_DSN_SUFFIX", nil)
     end
 
     # Returns the pt-online-schema-change DSN string. See
     # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
     def to_s
-      "D=#{database},t=#{table_name}#{suffix.nil? ? nil : ',' + suffix}"
+      "D=#{database},t=#{table_name}#{"," + suffix unless suffix.nil?}"
     end
 
     private

data/lib/departure/errors.rb

@@ -5,7 +5,7 @@ module Departure
   # status.
   class NoStatusError < Error
     def message
-      'Status could not be retrieved'.freeze
+      "Status could not be retrieved".freeze
     end
   end
 
@@ -29,7 +29,7 @@ module Departure
 
   class CommandNotFoundError < Error
     def message
-      'Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details'
+      "Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details"
     end
   end
 

data/lib/departure/log_sanitizers/password_sanitizer.rb

@@ -1,7 +1,7 @@
 module Departure
   module LogSanitizers
     class PasswordSanitizer
-      PASSWORD_REPLACEMENT = '[filtered_password]'.freeze
+      PASSWORD_REPLACEMENT = "[filtered_password]".freeze
 
       delegate :password_argument, to: :connection_details
 

data/lib/departure/logger.rb

@@ -14,13 +14,13 @@ module Departure
     # @param message [String]
     # @param subitem [Boolean] whether to show message as a nested log item
     def say(message, subitem = false)
-      write "#{subitem ? '   ->' : '--'} #{message}"
+      write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
     # Outputs the text through the stdout adding a new line at the end
     #
     # @param text [String]
-    def write(text = '')
+    def write(text = "")
       puts(sanitize(text))
     end
 

data/lib/departure/option.rb

@@ -27,7 +27,7 @@ module Departure
     def ==(other)
       name == other.name
     end
-    alias eql? ==
+    alias_method :eql?, :==
 
     # Returns the option's hash
     #
@@ -50,7 +50,7 @@ module Departure
     #
     # @return [String]
     def normalize_option(name)
-      if name.start_with?('-')
+      if name.start_with?("-")
         name
       elsif name.length == 1
         "-#{name}"
@@ -64,8 +64,8 @@ module Departure
     # @return [String]
     def value_as_string
       if value.nil?
-        ''
-      elsif value.include?('=')
+        ""
+      elsif value.include?("=")
         " #{value}"
       else
         "=#{value}"

data/lib/departure/rails_adapter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Departure
   class RailsAdapter
@@ -9,6 +9,11 @@ module Departure
     class UnsupportedRailsVersionError < StandardError; end
     class MustImplementError < StandardError; end
 
+    # Describes how a Departure connection adapter is registered with
+    # ActiveRecord: the adapter name apps configure, the class implementing it
+    # and the file that defines the class.
+    Registration = Struct.new(:adapter_name, :class_name, :path)
+
     class << self
       def register_integrations(**args)
         for_current(**args).register_integrations
@@ -29,130 +34,178 @@ module Departure
         self.for(current_version, **args)
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity
       def for(ar_version, db_connection_adapter: nil)
-        # rubocop:enable Metrics/PerceivedComplexity
-        if ar_version::MAJOR == 8 && ar_version::MINOR.positive?
-          if db_connection_adapter == 'trilogy'
-            V8_1_TrilogyAdapter
+        adapters =
+          if ar_version::MAJOR == 8 && ar_version::MINOR.positive?
+            {mysql2: V8_1_Mysql2Adapter, trilogy: V8_1_TrilogyAdapter}
+          elsif ar_version::MAJOR == 8
+            {mysql2: V8_0_Adapter, trilogy: V8_0_TrilogyAdapter}
+          elsif ar_version::MAJOR >= 7 && ar_version::MINOR >= 2
+            {mysql2: V7_2_Adapter, trilogy: V7_2_TrilogyAdapter}
           else
-            V8_1_Mysql2Adapter
+            raise UnsupportedRailsVersionError, "Unsupported Rails version: #{ar_version}"
           end
-        elsif ar_version::MAJOR == 8
-          V8_0_Adapter
-        elsif ar_version::MAJOR >= 7 && ar_version::MINOR >= 2
-          V7_2_Adapter
-        else
-          raise UnsupportedRailsVersionError, "Unsupported Rails version: #{ar_version}"
-        end
+
+        (db_connection_adapter == "trilogy") ? adapters[:trilogy] : adapters[:mysql2]
       end
     end
 
     class BaseAdapter
       class << self
+        # The Registration for the database adapter this class drives.
+        # Subclasses must implement it.
+        def registration
+          raise MustImplementError, "adapter must implement registration"
+        end
+
+        # Every Registration available for this Rails version, so all
+        # Departure adapter names resolve regardless of which one the app
+        # connects through. Registration is lazy: the adapter files are only
+        # loaded when ActiveRecord resolves the adapter name.
+        # Subclasses must implement it.
+        def registrations
+          raise MustImplementError, "adapter must implement registrations"
+        end
+
         def register_integrations
-          raise MustImplementError, 'adapter must implement register_integrations'
+          require registration.path
+          require "departure/rails_patches/active_record_migrator_with_advisory_lock_patch"
+
+          ActiveRecord::Migration.class_eval do
+            include Departure::Migration
+          end
+
+          ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
+
+          registrations.each do |registration|
+            ActiveRecord::ConnectionAdapters.register registration.adapter_name,
+              registration.class_name,
+              registration.path
+          end
         end
 
-        # ActiveRecord::ConnectionAdapters::Mysql2Adapter
-        def create_connection_adapter(**_config)
-          raise MustImplementError, 'adapter must implement create_connection_adapter'
+        def create_connection_adapter(**config)
+          connection_adapter_class.new(config)
         end
 
         def departure_adapter_name
-          'percona'
+          registration.adapter_name
         end
 
         # https://github.com/rails/rails/commit/9ad36e067222478090b36a985090475bb03e398c#diff-de807ece2205a84c0e3de66b0e5ab831325d567893b8b88ce0d6e9d498f923d1
         # Rails Column arity changed to require cast_type in position 2 which required us introducing this indirection
         def new_sql_column(name:,
-                           default_value:,
-                           mysql_metadata:,
-                           null_value:,
-                           **_kwargs)
+          default_value:,
+          mysql_metadata:,
+          null_value:,
+          **_kwargs)
           sql_column.new(name, default_value, mysql_metadata, null_value)
         end
 
         def sql_column
-          ::ActiveRecord::ConnectionAdapters::DepartureAdapter::Column
+          connection_adapter_class::Column
+        end
+
+        private
+
+        def connection_adapter_class
+          require registration.path
+
+          Object.const_get(registration.class_name)
         end
       end
     end
 
     class V7_2_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
-      class << self
-        def register_integrations
-          require 'active_record/connection_adapters/rails_7_2_departure_adapter'
-          require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
-
-          ActiveRecord::Migration.class_eval do
-            include Departure::Migration
-          end
+      MYSQL2_REGISTRATION = Registration.new(
+        "percona",
+        "ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter",
+        "active_record/connection_adapters/rails_7_2_departure_adapter"
+      )
+      TRILOGY_REGISTRATION = Registration.new(
+        "percona_trilogy",
+        "ActiveRecord::ConnectionAdapters::Rails72TrilogyAdapter",
+        "active_record/connection_adapters/rails_7_2_trilogy_adapter"
+      )
 
-          ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-
-          ActiveRecord::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter',
-                                                    'active_record/connection_adapters/rails_7_2_departure_adapter'
+      class << self
+        def registration
+          MYSQL2_REGISTRATION
         end
 
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter.new(config)
+        def registrations
+          [MYSQL2_REGISTRATION, TRILOGY_REGISTRATION]
         end
+      end
+    end
 
-        def sql_column
-          ::ActiveRecord::ConnectionAdapters::Rails72DepartureAdapter::Column
-        end
+    class V7_2_TrilogyAdapter < V7_2_Adapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      # def self so TRILOGY_REGISTRATION resolves through the superclass
+      def self.registration
+        TRILOGY_REGISTRATION
       end
     end
 
     class V8_0_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
-      class << self
-        def register_integrations
-          require 'active_record/connection_adapters/rails_8_0_departure_adapter'
-          require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
-
-          ActiveRecord::Migration.class_eval do
-            include Departure::Migration
-          end
+      MYSQL2_REGISTRATION = Registration.new(
+        "percona",
+        "ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter",
+        "active_record/connection_adapters/rails_8_0_departure_adapter"
+      )
+      TRILOGY_REGISTRATION = Registration.new(
+        "percona_trilogy",
+        "ActiveRecord::ConnectionAdapters::Rails80TrilogyAdapter",
+        "active_record/connection_adapters/rails_8_0_trilogy_adapter"
+      )
 
-          ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-
-          ActiveRecord::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter',
-                                                    'active_record/connection_adapters/rails_8_0_departure_adapter'
+      class << self
+        def registration
+          MYSQL2_REGISTRATION
         end
 
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter.new(config)
+        def registrations
+          [MYSQL2_REGISTRATION, TRILOGY_REGISTRATION]
         end
+      end
+    end
 
-        def sql_column
-          ::ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter::Column
-        end
+    class V8_0_TrilogyAdapter < V8_0_Adapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      # def self so TRILOGY_REGISTRATION resolves through the superclass
+      def self.registration
+        TRILOGY_REGISTRATION
       end
     end
 
     class V8_1_Mysql2Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      MYSQL2_REGISTRATION = Registration.new(
+        "percona",
+        "ActiveRecord::ConnectionAdapters::Rails81Mysql2Adapter",
+        "active_record/connection_adapters/rails_8_1_mysql2_adapter"
+      )
+      TRILOGY_REGISTRATION = Registration.new(
+        "percona_trilogy",
+        "ActiveRecord::ConnectionAdapters::Rails81TrilogyAdapter",
+        "active_record/connection_adapters/rails_8_1_trilogy_adapter"
+      )
+
       class << self
-        def register_integrations
-          require 'active_record/connection_adapters/rails_8_1_mysql2_adapter'
-          register_rails_8_1_integrations
+        def registration
+          MYSQL2_REGISTRATION
         end
 
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails81Mysql2Adapter.new(config)
+        def registrations
+          [MYSQL2_REGISTRATION, TRILOGY_REGISTRATION]
         end
 
         # rubocop:disable Metrics/ParameterLists
         # https://github.com/rails/rails/commit/9ad36e067222478090b36a985090475bb03e398c#diff-de807ece2205a84c0e3de66b0e5ab831325d567893b8b88ce0d6e9d498f923d1
         # Rails Column arity changed to require cast_type in position 2 which required us introducing this indirection
         def new_sql_column(name:,
-                           cast_type:,
-                           default_value:,
-                           mysql_metadata:,
-                           null_value:,
-                           **_kwargs)
+          cast_type:,
+          default_value:,
+          mysql_metadata:,
+          null_value:,
+          **_kwargs)
           # rubocop:enable Metrics/ParameterLists
           sql_column.new(name, cast_type, default_value, mysql_metadata, null_value)
         end
@@ -160,42 +213,13 @@ module Departure
         def sql_column
           ::ActiveRecord::ConnectionAdapters::MySQL::Column
         end
-
-        private
-
-        def register_rails_8_1_integrations
-          require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
-
-          ActiveRecord::Migration.class_eval do
-            include Departure::Migration
-          end
-
-          ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-
-          ActiveRecord::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails81Mysql2Adapter',
-                                                    'active_record/connection_adapters/rails_8_1_mysql2_adapter'
-          ActiveRecord::ConnectionAdapters.register 'percona_trilogy',
-                                                    'ActiveRecord::ConnectionAdapters::Rails81TrilogyAdapter',
-                                                    'active_record/connection_adapters/rails_8_1_trilogy_adapter'
-        end
       end
     end
 
     class V8_1_TrilogyAdapter < V8_1_Mysql2Adapter # rubocop:disable Naming/ClassAndModuleCamelCase
-      class << self
-        def register_integrations
-          require 'active_record/connection_adapters/rails_8_1_trilogy_adapter'
-          register_rails_8_1_integrations
-        end
-
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails81TrilogyAdapter.new(config)
-        end
-
-        def departure_adapter_name
-          'percona_trilogy'
-        end
+      # def self so TRILOGY_REGISTRATION resolves through the superclass
+      def self.registration
+        TRILOGY_REGISTRATION
       end
     end
   end

data/lib/departure/rails_patches/active_record_migrator_with_advisory_lock_patch.rb

@@ -1,8 +1,8 @@
 module Departure
   module RailsPatches
     module ActiveRecordMigratorWithAdvisoryLockPatch
-      RELEASE_LOCK_FAILED_MESSAGE = 'Failed to release advisory lock from ActiveRecordMigratorWithAdvisoryLockPatch'
-                                      .freeze
+      RELEASE_LOCK_FAILED_MESSAGE = "Failed to release advisory lock from ActiveRecordMigratorWithAdvisoryLockPatch"
+        .freeze
 
       def with_advisory_lock
         return super if Departure.configuration.disable_rails_advisory_lock_patch

data/lib/departure/railtie.rb

@@ -1,14 +1,14 @@
-require 'departure'
-require 'lhm' # It's our own Lhm adapter, not the gem
-require 'rails'
+require "departure"
+require "lhm" # It's our own Lhm adapter, not the gem
+require "rails"
 
 module Departure
   class Railtie < Rails::Railtie
     railtie_name :departure
 
-    initializer 'departure.configure' do |app|
+    initializer "departure.configure" do |app|
       Departure.configure do |config|
-        config.tmp_path = app.paths['tmp'].first
+        config.tmp_path = app.paths["tmp"].first
       end
 
       Departure::RailsAdapter.register_integrations