departure 8.0.0 → 8.2.0

data/lib/departure/rails_adapter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Departure
   class RailsAdapter
@@ -9,8 +9,19 @@ 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
+      end
+
       def version_matches?(version_string, compatibility_string = current_version::STRING)
+        raise "Invalid Gem Version: '#{version_string}'" unless Gem::Version.correct?(version_string)
+
         requirement = Gem::Requirement.new(compatibility_string)
         requirement.satisfied_by?(Gem::Version.new(version_string))
       end
@@ -19,140 +30,182 @@ module Departure
         ActiveRecord::VERSION
       end
 
-      def for_current
-        self.for(current_version)
+      def for_current(**args)
+        self.for(current_version, **args)
       end
 
-      def for(ar_version)
-        if ar_version::MAJOR == 8 && ar_version::MINOR.positive?
-          V8_1_Adapter
-        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
+      def for(ar_version, db_connection_adapter: nil)
+        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
+            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
+          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'
-
-          ActiveSupport.on_load(:active_record) do
-            ActiveRecord::Migration.class_eval do
-              include Departure::Migration
-            end
-
-            ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-          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::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'
-
-          ActiveSupport.on_load(:active_record) do
-            ActiveRecord::Migration.class_eval do
-              include Departure::Migration
-            end
-
-            ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-          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::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter',
-                                                    'active_record/connection_adapters/rails_8_0_departure_adapter'
-        end
-
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter.new(config)
+      class << self
+        def registration
+          MYSQL2_REGISTRATION
         end
 
-        def sql_column
-          ::ActiveRecord::ConnectionAdapters::Rails80DepartureAdapter::Column
+        def registrations
+          [MYSQL2_REGISTRATION, TRILOGY_REGISTRATION]
         end
       end
     end
 
-    class V8_1_Adapter < BaseAdapter # rubocop:disable Naming/ClassAndModuleCamelCase
-      class << self
-        def register_integrations
-          require 'active_record/connection_adapters/rails_8_1_departure_adapter'
-          require 'departure/rails_patches/active_record_migrator_with_advisory_lock_patch'
+    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
 
-          ActiveSupport.on_load(:active_record) do
-            ActiveRecord::Migration.class_eval do
-              include Departure::Migration
-            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"
+      )
 
-            ActiveRecord::Migrator.prepend Departure::RailsPatches::ActiveRecordMigratorWithAdvisoryLockPatch
-          end
-
-          ActiveRecord::ConnectionAdapters.register 'percona',
-                                                    'ActiveRecord::ConnectionAdapters::Rails81DepartureAdapter',
-                                                    'active_record/connection_adapters/rails_8_1_departure_adapter'
+      class << self
+        def registration
+          MYSQL2_REGISTRATION
         end
 
-        def create_connection_adapter(**config)
-          ActiveRecord::ConnectionAdapters::Rails81DepartureAdapter.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
@@ -162,5 +215,12 @@ module Departure
         end
       end
     end
+
+    class V8_1_TrilogyAdapter < V8_1_Mysql2Adapter # rubocop:disable Naming/ClassAndModuleCamelCase
+      # def self so TRILOGY_REGISTRATION resolves through the superclass
+      def self.registration
+        TRILOGY_REGISTRATION
+      end
+    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,15 +1,17 @@
-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
     end
 
     config.after_initialize do

data/lib/departure/runner.rb

@@ -1,5 +1,5 @@
-require 'open3'
-require 'forwardable'
+require "open3"
+require "forwardable"
 
 # Runner is deprecated and used in rails 8.0 and below
 # We will slowly reduce the responsibility of departure to be delegating
@@ -11,7 +11,7 @@ module Departure
   class Runner
     extend ::Forwardable
 
-    def_delegators :raw_connection, :execute, :escape, :close, :affected_rows
+    def_delegators :raw_connection, :escape, :close
 
     # Constructor
     #

data/lib/departure/user_options.rb

@@ -6,7 +6,7 @@ module Departure
     # Constructor
     #
     # @param arguments [String]
-    def initialize(arguments = ENV['PERCONA_ARGS'])
+    def initialize(arguments = ENV["PERCONA_ARGS"])
       @arguments = arguments
     end
 

data/lib/departure/version.rb

@@ -1,3 +1,3 @@
 module Departure
-  VERSION = '8.0.0'.freeze
+  VERSION = "8.2.0".freeze
 end

data/lib/departure.rb

@@ -1,30 +1,28 @@
-require 'active_record'
-require 'active_support/all'
-
-require 'active_record/connection_adapters/for_alter'
-
-require 'departure/version'
-require 'departure/log_sanitizers/password_sanitizer'
-require 'departure/db_client'
-require 'departure/runner'
-require 'departure/cli_generator'
-require 'departure/logger'
-require 'departure/null_logger'
-require 'departure/logger_factory'
-require 'departure/configuration'
-require 'departure/errors'
-require 'departure/command'
-require 'departure/connection_base'
-require 'departure/migration'
-require 'departure/rails_adapter'
-
-require 'departure/railtie' if defined?(Rails)
+require "active_record"
+require "active_support/all"
+
+require "active_record/connection_adapters/for_alter"
+
+require "departure/version"
+require "departure/log_sanitizers/password_sanitizer"
+require "departure/db_client"
+require "departure/runner"
+require "departure/cli_generator"
+require "departure/logger"
+require "departure/null_logger"
+require "departure/logger_factory"
+require "departure/configuration"
+require "departure/errors"
+require "departure/command"
+require "departure/connection_base"
+require "departure/migration"
+require "departure/rails_adapter"
+
+require "departure/railtie" if defined?(Rails)
 
 # We need the OS not to buffer the IO to see pt-osc's output while migrating
 $stdout.sync = true
 
-Departure::RailsAdapter.for_current.register_integrations
-
 module Departure
   class << self
     attr_accessor :configuration

data/lib/lhm/adapter.rb

@@ -1,5 +1,5 @@
-require 'lhm/column_with_sql'
-require 'lhm/column_with_type'
+require "lhm/column_with_sql"
+require "lhm/column_with_type"
 
 module Lhm
   # Translates Lhm DSL to ActiveRecord's one, so Lhm migrations will now go
@@ -37,7 +37,7 @@ module Lhm
     # @param columns [Array<String>, Array<Symbol>, String, Symbol]
     # @param index_name [String]
     def add_index(columns, index_name = nil)
-      options = { name: index_name } if index_name
+      options = {name: index_name} if index_name
       migration.add_index(table_name, columns, options || {})
     end
 
@@ -47,10 +47,10 @@ module Lhm
     # @param index_name [String]
     def remove_index(columns, index_name = nil)
       options = if index_name
-                  { name: index_name }
-                else
-                  { column: columns }
-                end
+        {name: index_name}
+      else
+        {column: columns}
+      end
       migration.remove_index(table_name, options)
     end
 
@@ -76,7 +76,7 @@ module Lhm
     # @param columns [Array<String>, Array<Symbol>, String, Symbol]
     # @param index_name [String]
     def add_unique_index(columns, index_name = nil)
-      options = { unique: true }
+      options = {unique: true}
       options.merge!(name: index_name) if index_name # rubocop:disable Performance/RedundantMerge
 
       migration.add_index(table_name, columns, options)
@@ -93,10 +93,10 @@ module Lhm
     # @param definition [String]
     def column(name, definition)
       @column ||= if definition.is_a?(Symbol)
-                    ColumnWithType.new(name, definition)
-                  else
-                    ColumnWithSql.new(name, definition)
-                  end
+        ColumnWithType.new(name, definition)
+      else
+        ColumnWithSql.new(name, definition)
+      end
     end
 
     def column_attributes(name, definition)

data/lib/lhm/column_with_sql.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Lhm
   # Abstracts the details of a table column definition when specified with a MySQL
@@ -38,7 +38,7 @@ module Lhm
     #
     # @return [Hash]
     def column_options
-      { limit: column.limit, default: column.default, null: column.null }
+      {limit: column.limit, default: column.default, null: column.null}
     end
 
     # Returns the column instance with the provided data
@@ -67,14 +67,14 @@ module Lhm
     # @return [String, NilClass]
     def default_value
       match = if definition.match?(/timestamp|datetime/i)
-                /default '?(.+[^'])'?/i.match(definition)
-              else
-                /default '?(\w+)'?/i.match(definition)
-              end
+        /default '?(.+[^'])'?/i.match(definition)
+      else
+        /default '?(\w+)'?/i.match(definition)
+      end
 
       return unless match
 
-      match[1].downcase != 'null' ? match[1] : nil
+      (match[1].downcase != "null") ? match[1] : nil
     end
 
     # Checks whether the column accepts NULL as specified in the definition
@@ -84,7 +84,7 @@ module Lhm
       match = /((NOT)? NULL)/i.match(definition)
       return true unless match
 
-      match[2]&.downcase == 'not' ? false : true
+      !(match[2]&.downcase == "not")
     end
   end
 end

data/lib/lhm.rb

@@ -1,4 +1,4 @@
-require 'lhm/adapter'
+require "lhm/adapter"
 
 # Defines the same global namespace as LHM's gem does to mimic its API
 # while providing a different behaviour. We delegate all LHM's methods to

data/test_database.rb

@@ -1,6 +1,6 @@
-require 'active_record'
-require 'active_record/connection_adapters/mysql2_adapter'
-require 'departure'
+require "active_record"
+require "active_record/connection_adapters/mysql2_adapter"
+require "departure"
 
 # Setups the test database with the schema_migrations table that ActiveRecord
 # requires for the migrations, plus a table for the Comment model used throught
@@ -12,7 +12,7 @@ class TestDatabase
   # @param config [Hash]
   def initialize(config)
     @config = config
-    @database = config['database']
+    @database = config["database"]
   end
 
   # Creates the test database, the schema_migrations and the comments tables.
@@ -34,8 +34,8 @@ class TestDatabase
   def drop_and_create_schema_migrations_table
     sql = [
       "USE #{@database}",
-      'DROP TABLE IF EXISTS schema_migrations',
-      'CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+      "DROP TABLE IF EXISTS schema_migrations",
+      "CREATE TABLE schema_migrations ( version varchar(255) COLLATE utf8_unicode_ci NOT NULL, UNIQUE KEY unique_schema_migrations (version)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci"
     ]
 
     run_commands(sql)
@@ -57,17 +57,17 @@ class TestDatabase
   def drop_and_create_comments_table
     sql = [
       "USE #{@database}",
-      'DROP TABLE IF EXISTS comments',
-      'CREATE TABLE comments ( id bigint(20) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci'
+      "DROP TABLE IF EXISTS comments",
+      "CREATE TABLE comments ( id bigint(20) NOT NULL AUTO_INCREMENT, PRIMARY KEY (id)) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci"
     ]
 
     run_commands(sql)
   end
 
   def run_commands(sql)
-    conn.execute('START TRANSACTION')
+    conn.execute("START TRANSACTION")
     sql.each { |str| conn.execute(str) }
-    conn.execute('COMMIT')
+    conn.execute("COMMIT")
   end
 
   def conn

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: departure
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -12,6 +12,8 @@ authors:
 - Adrian Serafin
 - Kirk Haines
 - Guillermo Iguaran
+- Austin Story
+- Douglas Soares de Andrade
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -164,6 +166,8 @@ email:
 - adrian@softmad.pl
 - wyhaines@gmail.com
 - guilleiguaran@gmail.com
+- lonnieastory@gmail.com
+- douglas@51street.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -173,8 +177,8 @@ files:
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
+- ".standard.yml"
+- AGENTS.md
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -199,11 +203,15 @@ files:
 - gemfiles/rails_8_0.gemfile.lock
 - gemfiles/rails_8_1.gemfile
 - gemfiles/rails_8_1.gemfile.lock
+- lib/active_record/connection_adapters/departure_adapter_behavior.rb
 - lib/active_record/connection_adapters/for_alter.rb
 - lib/active_record/connection_adapters/patch_connection_handling.rb
 - lib/active_record/connection_adapters/rails_7_2_departure_adapter.rb
+- lib/active_record/connection_adapters/rails_7_2_trilogy_adapter.rb
 - lib/active_record/connection_adapters/rails_8_0_departure_adapter.rb
-- lib/active_record/connection_adapters/rails_8_1_departure_adapter.rb
+- lib/active_record/connection_adapters/rails_8_0_trilogy_adapter.rb
+- lib/active_record/connection_adapters/rails_8_1_mysql2_adapter.rb
+- lib/active_record/connection_adapters/rails_8_1_trilogy_adapter.rb
 - lib/departure.rb
 - lib/departure/alter_argument.rb
 - lib/departure/cli_generator.rb