departure 8.1.0 → 8.2.0

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.1.0'.freeze
+  VERSION = "8.2.0".freeze
 end

data/lib/departure.rb

@@ -1,24 +1,24 @@
-require 'active_record'
-require 'active_support/all'
+require "active_record"
+require "active_support/all"
 
-require 'active_record/connection_adapters/for_alter'
+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/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 "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

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.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -177,8 +177,7 @@ files:
 - ".gitignore"
 - ".pryrc"
 - ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
+- ".standard.yml"
 - AGENTS.md
 - Appraisals
 - CHANGELOG.md
@@ -204,11 +203,13 @@ 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_adapter_behavior.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

data/.rubocop.yml

@@ -1,66 +0,0 @@
----
-inherit_from:
-  - .rubocop_todo.yml
-
-require:
-  - rubocop-performance
-
-AllCops:
-  TargetRubyVersion: 3.4.x
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Max: 20
-  Exclude:
-    - 'spec/*'
-    - 'spec/**/*'
-
-Metrics/BlockNesting:
-  Max: 4
-
-Metrics/ClassLength:
-  Max: 250
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - 'departure.gemspec'
-    - 'test_database.rb'
-
-Metrics/MethodLength:
-  Max: 30
-
-Metrics/ModuleLength:
-  Max: 250
-
-Metrics/ParameterLists:
-  Max: 5
-
-Performance/Casecmp:
-  Enabled: false
-
-Style/CommandLiteral:
-  Exclude:
-    - 'test_database.rb'
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false # We never ended up being forced to do this for Ruby 3.x
-
-Style/MultilineBlockChain:
-  Exclude:
-    - 'spec/integration_spec.rb'
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/RedundantPercentQ:
-  Exclude:
-    - 'departure.gemspec'

data/.rubocop_todo.yml

@@ -1,238 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2024-02-08 17:09:11 UTC using RuboCop version 1.60.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'departure.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'departure.gemspec'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/DotPosition:
-  Exclude:
-    - 'spec/integration/indexes_spec.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/active_record/connection_adapters/for_alter.rb'
-    - 'lib/active_record/connection_adapters/percona_adapter.rb'
-    - 'lib/departure/alter_argument.rb'
-    - 'lib/departure/log_sanitizers/password_sanitizer.rb'
-    - 'lib/departure/migration.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: IndentationWidth.
-# SupportedStyles: special_inside_parentheses, consistent, align_brackets
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'spec/integration/indexes_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
-Layout/LeadingCommentSpace:
-  Exclude:
-    - 'lib/active_record/connection_adapters/for_alter.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideHashLiteralBraces:
-  Exclude:
-    - 'spec/active_record/connection_adapters/percona_adapter_spec.rb'
-
-# Offense count: 9
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: enums
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'spec/integration/change_table_spec.rb'
-    - 'spec/integration/columns_spec.rb'
-    - 'spec/integration/data_migrations_spec.rb'
-    - 'spec/integration/foreign_keys_spec.rb'
-    - 'spec/integration/indexes_spec.rb'
-    - 'spec/integration/references_spec.rb'
-    - 'spec/integration/tables_spec.rb'
-    - 'spec/integration_spec.rb'
-    - 'spec/lhm_integration_spec.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Lint/RedundantCopDisableDirective:
-  Exclude:
-    - 'lib/active_record/connection_adapters/percona_adapter.rb'
-    - 'lib/departure/command.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Lint/SendWithMixinArgument:
-  Exclude:
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/active_record/connection_adapters/for_alter.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/active_record/connection_adapters/percona_adapter.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Security/YAMLLoad:
-  Exclude:
-    - 'configuration.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
-# SupportedStyles: inline, group
-Style/AccessModifierDeclarations:
-  Exclude:
-    - 'lib/departure/migration.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: compact, expanded
-Style/EmptyMethod:
-  Exclude:
-    - 'spec/fixtures/migrate/0029_disable_departure.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/Encoding:
-  Exclude:
-    - 'departure.gemspec'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/ExpandPathArguments:
-  Exclude:
-    - 'departure.gemspec'
-    - 'spec/lhm_integration_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/GlobalStdStream:
-  Exclude:
-    - 'lib/active_record/connection_adapters/for_alter.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/active_record/connection_adapters/percona_adapter.rb'
-    - 'lib/departure/connection_details.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: literals, strict
-Style/MutableConstant:
-  Exclude:
-    - 'lib/departure/alter_argument.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/departure/logger.rb'
-    - 'lib/departure/null_logger.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantConditional:
-  Exclude:
-    - 'lib/lhm/column_with_sql.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/RedundantInterpolation:
-  Exclude:
-    - 'spec/active_record/connection_adapters/percona_adapter_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantRegexpCharacterClass:
-  Exclude:
-    - 'lib/departure/alter_argument.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/StderrPuts:
-  Exclude:
-    - 'lib/active_record/connection_adapters/for_alter.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: Mode.
-Style/StringConcatenation:
-  Exclude:
-    - 'lib/departure/dsn.rb'
-
-# Offense count: 12
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'spec/active_record/connection_adapters/percona_adapter_spec.rb'
-    - 'spec/fixtures/migrate/0030_data_migration_with_upsert_all.rb'
-    - 'spec/integration/data_migrations_spec.rb'
-    - 'spec/integration/foreign_keys_spec.rb'
-    - 'spec/lhm/column_with_sql_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
-  Exclude:
-    - 'spec/departure/runner_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'spec/integration/data_migrations_spec.rb'

data/lib/active_record/connection_adapters/rails_8_1_adapter_behavior.rb

@@ -1,64 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters
-    module Rails81AdapterBehavior
-      class SchemaCreation < ActiveRecord::ConnectionAdapters::MySQL::SchemaCreation
-        def visit_DropForeignKey(name) # rubocop:disable Naming/MethodName
-          fk_name =
-            if name =~ /^__(.+)/
-              Regexp.last_match(1)
-            else
-              "_#{name}"
-            end
-
-          "DROP FOREIGN KEY #{fk_name}"
-        end
-      end
-
-      def self.included(adapter_class)
-        adapter_class.const_set(:SchemaCreation, SchemaCreation)
-        adapter_class.extend(ClassMethods)
-        adapter_class.include ForAlterStatements unless adapter_class.method_defined?(:change_column_for_alter)
-      end
-
-      module ClassMethods
-        def new_client(config)
-          original_client = super
-
-          Departure::DbClient.new(config, original_client)
-        end
-      end
-
-      # add_index is modified from the underlying mysql adapter implementation to ensure we add ALTER TABLE to it
-      def add_index(table_name, column_name, options = {})
-        index_definition, = add_index_options(table_name, column_name, **options)
-        execute <<-SQL.squish
-          ALTER TABLE #{quote_table_name(index_definition.table)}
-            ADD #{schema_creation.accept(index_definition)}
-        SQL
-      end
-
-      # remove_index is modified from the underlying mysql adapter implementation to ensure we add ALTER TABLE to it
-      def remove_index(table_name, column_name = nil, **options)
-        return if options[:if_exists] && !index_exists?(table_name, column_name, **options)
-
-        index_name = index_name_for_remove(table_name, column_name, options)
-
-        execute "ALTER TABLE #{quote_table_name(table_name)} DROP INDEX #{quote_column_name(index_name)}"
-      end
-
-      def schema_creation
-        self.class::SchemaCreation.new(self)
-      end
-
-      private
-
-      # rubocop:disable Metrics/ParameterLists
-      def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false)
-        return raw_connection.send_to_pt_online_schema_change(sql) if raw_connection.alter_statement?(sql)
-
-        super
-      end
-      # rubocop:enable Metrics/ParameterLists
-    end
-  end
-end