departure 6.1.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ec14bb84716b3492846b14acd70c19f2e242748
-  data.tar.gz: 138eb9af8dc4c07d4fc5d7f77203f2cb927b7f5d
+SHA256:
+  metadata.gz: 8e9b07d68819910b4f867268d8680b65677e6c11fe91b7f5c2f3a4b62cee627a
+  data.tar.gz: daf4792210ea603d0732fae6daebe97fcbea253960067d800495b49b6c2aa866
 SHA512:
-  metadata.gz: 3ea0b39fa2cb8ca1766ad374f6a1dc33a3214e742930afc94974faade91468e561ef0b21beac179f6209124559264de9b0dfff1b3014378ebcf87c98e60902b4
-  data.tar.gz: 83b78984ff0ace2b88f0b4fddbe6ccc37daa4f34f49b30f327c9041d5babb82b2d2d4a3d98dd4494f3eb94e8d39590229bd974db9bb1420ca58356c69d803132
+  metadata.gz: 1ba37179c249db07bc0770288ff6103ee4502846488319356bb2aad94738dd5727c42fea899e97aaccb974d5e0bd6f06d475ee0f922d460ec0cc2a2a0ad95f4b
+  data.tar.gz: 9c5acbc1f3b3064341f371e584c3e3da4f326d9f3bfc9a32d844dccdd12bf50c4c6c4519c5742f086fbb4261e252fc31fa6c5cf5777f1d028da4e4798d127aa8

data/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+        rails:
+          - 5.2.0
+          - 6.0.0
+          - 6.1.0
+        include:
+          - ruby: 2.4
+            rails: 5.2.0
+          - ruby: 2.7
+            rails: 7.0.1
+          - ruby: 3.0
+            rails: 6.1.0
+    env:
+      PERCONA_DB_USER: root
+      PERCONA_DB_PASSWORD: root
+      RAILS_VERSION: "~> ${{ matrix.rails }}"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: "Add Percona GPG key"
+        run: sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 9334A25F8507EFA5
+      - name: "Add Percona APT repository"
+        run: echo "deb http://repo.percona.com/apt `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list
+      - run: sudo apt-get update -qq
+      - run: sudo apt-get install percona-toolkit
+      - name: Start MySQL server
+        run: sudo systemctl start mysql.service
+      - run: bin/setup
+      - run: bundle exec rake

data/.gitignore

@@ -10,3 +10,5 @@
 .byebug_history
 tags
 departure_error.log
+.ruby-version
+.idea/

data/.pryrc

@@ -0,0 +1,11 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+  Pry.commands.alias_command 'w', 'pry-backtrace'
+
+  Pry::Commands.command(/^$/, 'repeat last command') do
+    pry_instance.run_command Pry.history.to_a.last
+  end
+end

data/.rubocop.yml

@@ -48,7 +48,7 @@ Style/MultilineBlockChain:
   Exclude:
     - 'spec/integration_spec.rb'
 
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   Enabled: false
 
 Style/SymbolArray:

data/CHANGELOG.md

@@ -6,6 +6,42 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [6.4.0] - 2020-06-23
+
+- Support for ActiveRecord 6.1.4
+- Relax mysql2 requirement to allow mysql2 0.5.4
+- Support Rails 6' #upsert_all
+
+## [6.3.0] - 2020-06-23
+
+- Support for ActiveRecord 6.1
+
+## [6.2.0] - 2020-06-23
+
+### Added
+
+- Support for ActiveRecord 6.0
+- Support for ActiveRecord 5.2
+- Relax mysql2 requirement to allow mysql2 0.5.3
+- Support to batch multiple changes at once with #change_table
+- Support for connection to MySQL server over SSL
+
+### Changed
+
+- Depend only in railties and activerecord instead of rails gem
+
+### Deprecated
+### Removed
+### Fixed
+
+- Fix support for removing foreign keys
+- Fix PERCONA_ARGS syntax for critical-load option
+- Make sure quotes in ALTER TABLE get correctly escaped
+- Fixes for regex handling
+- Fix LHM compatibility
+
+## [6.1.0] - 2018-02-27
+
 ### Added
 ### Changed
 

data/README.md

@@ -1,4 +1,6 @@
-# Departure [![Build Status](https://travis-ci.org/departurerb/departure.svg?branch=master)](https://travis-ci.org/departurerb/departure) [![Code Climate](https://codeclimate.com/github/departurerb/departure/badges/gpa.svg)](https://codeclimate.com/github/departurerb/departure)
+# Departure
+
+![Build Status](https://img.shields.io/travis/departurerb/departure?style=for-the-badge) ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/departurerb/departure?style=for-the-badge) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/departurerb/departure/latest/master?style=for-the-badge)
 
 Departure is an **ActiveRecord connection adapter** that allows running
 **MySQL online and non-blocking DDL** through `ActiveRecord::Migration` without needing
@@ -99,7 +101,7 @@ $ PERCONA_ARGS='--chunk-time=1' bundle exec rake db:migrate:up VERSION=xxx
 or even mulitple arguments
 
 ```ruby
-$ PERCONA_ARGS='--chunk-time=1 --critical-load=55' bundle exec rake db:migrate:up VERSION=xxx
+$ PERCONA_ARGS='--chunk-time=1 --critical-load Threads_running=55' bundle exec rake db:migrate:up VERSION=xxx
 ```
 
 Use caution when using PERCONA_ARGS with `db:migrate`, as your args will be applied
@@ -112,7 +114,7 @@ using `global_percona_args` option.
 
 ```ruby
 Departure.configure do |config|
-  config.global_percona_args = '--chunk-time=1 --critical-load=55'
+  config.global_percona_args = '--chunk-time=1 --critical-load Threads_running=55'
 end
 ```
 
@@ -145,6 +147,39 @@ end
 It's strongly recommended to name it after this gems name, such as
 `config/initializers/departure.rb`
 
+### Disable on per-migration basis
+
+Departure gem is enabled by default. 
+In order to disable it on a particular migration the method `disable_departure!` should be used.
+
+```ruby
+class UseDepartureMigration < ActiveRecord::Migration[5.2]
+  disable_departure!
+
+  def up
+    # ...
+  end
+  # ...
+end
+```
+
+### Enable on per-migration basis
+
+If you wish to only have Departure enabled per-migration, set `config.enabled_by_default = false` in the configure block of your departure initializer.
+
+Then, add a `uses_departure!` statement in migrations where Departure should be used:
+
+```ruby
+class UseDepartureMigration < ActiveRecord::Migration[5.2]
+  uses_departure!
+
+  def up
+    # ...
+  end
+  # ...
+end
+```
+
 ## How it works
 
 When booting your Rails app, Departure extends the
@@ -154,19 +189,19 @@ it using the `DepartureAdapter` instead of the one you defined in your
 
 Then, when any migration DSL methods such as `add_column` or `create_table` are
 executed, they all go to the
-[DepartureAdapter](https://github.com/redbooth/departure/blob/master/lib/active_record/connection_adapters/departure_adapter.rb).
+[DepartureAdapter](https://github.com/departurerb/departure/blob/master/lib/active_record/connection_adapters/departure_adapter.rb).
 There, the methods that require `ALTER TABLE` SQL statements, like `add_column`,
 are overriden to get executed with
-[Departure::Runner](https://github.com/redbooth/departure/blob/master/lib/departure/runner.rb),
+[Departure::Runner](https://github.com/departurerb/departure/blob/master/lib/departure/runner.rb),
 which deals with the `pt-online-schema-change` binary. All the others, like
 `create_table`, are delegated to the ActiveRecord's built in Mysql2Adapter and
 so they follow the regular path.
 
-[Departure::Runner](https://github.com/redbooth/departure/blob/master/lib/departure/runner.rb)
+[Departure::Runner](https://github.com/departurerb/departure/blob/master/lib/departure/runner.rb)
 spawns a new process that runs the `pt-online-schema-change` binary present in
-the system, with the apropriate arguments for the generated SQL.
+the system, with the appropriate arguments for the generated SQL.
 
-When an any error occurs, an `ActiveRecord::StatementInvalid` exception is
+When any errors occur, an `ActiveRecord::StatementInvalid` exception is
 raised and the migration is aborted, as all other ActiveRecord connection
 adapters.
 
@@ -191,7 +226,7 @@ git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/redbooth/departure. They need to be opened against
+https://github.com/departurerb/departure. They need to be opened against
 `master` or `v3.2` only if the changes fix a bug in Rails 3.2 apps.
 
 Please note that this project is released with a Contributor Code of Conduct. By
@@ -208,3 +243,6 @@ You can consult the changelog [here](CHANGELOG.md)
 The gem is available as open source under the terms of the [MIT
 License](http://opensource.org/licenses/MIT).
 
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/departurerb/departure?style=for-the-badge)
+![GitHub issues](https://img.shields.io/github/issues/departurerb/departure?style=for-the-badge)
+

data/RELEASING.md

@@ -1,4 +1,4 @@
-# Releasing Percona Migrator
+# Releasing Departure
 
 All releases come from the master branch. All other branches won't be maintained
 and will receive bug fix releases only.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'percona_migrator'
+require 'departure'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/departure.gemspec

@@ -5,11 +5,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'departure/version'
 
+# This environment variable is set on CI to facilitate testing with multiple
+# versions of Rails.
+RAILS_DEPENDENCY_VERSION = ENV.fetch('RAILS_VERSION', ['>= 5.2.0', '!= 7.0.0', '< 7.1'])
+
 Gem::Specification.new do |spec|
   spec.name          = 'departure'
   spec.version       = Departure::VERSION
-  spec.authors       = ['Ilya Zayats', 'Pau Pérez', 'Fran Casas', 'Jorge Morante', 'Enrico Stano', 'Adrian Serafin', 'Kirk Haines']
-  spec.email         = ['ilya.zayats@redbooth.com', 'pau.perez@redbooth.com', 'fran.casas@redbooth.com', 'jorge.morante@redbooth.com', 'adrian@softmad.pl', 'wyhaines@gmail.com']
+  spec.authors       = ['Ilya Zayats', 'Pau Pérez', 'Fran Casas', 'Jorge Morante', 'Enrico Stano', 'Adrian Serafin', 'Kirk Haines', 'Guillermo Iguaran']
+  spec.email         = ['ilya.zayats@redbooth.com', 'pau.perez@redbooth.com', 'nflamel@gmail.com', 'jorge.morante@redbooth.com', 'adrian@softmad.pl', 'wyhaines@gmail.com', 'guilleiguaran@gmail.com']
 
   spec.summary       = %q(pt-online-schema-change runner for ActiveRecord migrations)
   spec.description   = %q(Execute your ActiveRecord migrations with Percona's pt-online-schema-change. Formerly known as Percona Migrator.)
@@ -19,12 +23,13 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rails', '~> 5.1.0'
-  spec.add_runtime_dependency 'mysql2', '~> 0.4.0'
+  spec.add_runtime_dependency 'railties', *Array(RAILS_DEPENDENCY_VERSION)
+  spec.add_runtime_dependency 'activerecord', *Array(RAILS_DEPENDENCY_VERSION)
+  spec.add_runtime_dependency 'mysql2', '>= 0.4.0', '<= 0.5.4'
 
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'climate_control', '~> 0.0.3'
 end

data/lib/active_record/connection_adapters/for_alter.rb

@@ -0,0 +1,97 @@
+require 'active_record/connection_adapters/mysql/schema_statements'
+
+module ForAlterStatements
+  class << self
+    def included(_)
+      STDERR.puts 'Including for_alter statements'
+    end
+  end
+
+  def bulk_change_table(table_name, operations) #:nodoc:
+    sqls = operations.flat_map do |command, args|
+      table = args.shift
+      arguments = args
+
+      method = :"#{command}_for_alter"
+
+      raise "Unknown method called : #{method}(#{arguments.inspect})" unless respond_to?(method, true)
+      public_send(method, table, *arguments)
+    end.join(', ')
+
+    execute("ALTER TABLE #{quote_table_name(table_name)} #{sqls}")
+  end
+
+  def change_column_for_alter(table_name, column_name, type, options = {})
+    column = column_for(table_name, column_name)
+    type ||= column.sql_type
+
+    options = {
+      default: column.default,
+      null: column.null,
+      comment: column.comment
+    }.merge(options)
+
+    td = create_table_definition(table_name)
+    cd = td.new_column_definition(column.name, type, **options)
+    schema_creation.accept(ActiveRecord::ConnectionAdapters::ChangeColumnDefinition.new(cd, column.name))
+  end
+
+  def rename_column_for_alter(table_name, column_name, new_column_name)
+    column  = column_for(table_name, column_name)
+    options = {
+      default: column.default,
+      null: column.null,
+      auto_increment: column.auto_increment?
+    }
+
+    columns_sql = "SHOW COLUMNS FROM #{quote_table_name(table_name)} LIKE #{quote(column_name)}"
+    current_type = exec_query(columns_sql, 'SCHEMA').first['Type']
+    td = create_table_definition(table_name)
+    cd = td.new_column_definition(new_column_name, current_type, **options)
+    schema_creation.accept(ActiveRecord::ConnectionAdapters::ChangeColumnDefinition.new(cd, column.name))
+  end
+
+  def add_index_for_alter(table_name, column_name, options = {})
+    if ActiveRecord::VERSION::STRING >= '6.1'
+      index_definition, = add_index_options(table_name, column_name, **options)
+
+      "ADD #{schema_creation.accept(index_definition)}"
+    else
+      index_name, index_type, index_columns, _,
+        index_algorithm, index_using = add_index_options(table_name, column_name, **options)
+      index_algorithm[0, 0] = ', ' if index_algorithm.present?
+
+      "ADD #{index_type} INDEX #{quote_column_name(index_name)} #{index_using} (#{index_columns})#{index_algorithm}"
+    end
+  end
+
+  def remove_index_for_alter(table_name, column_name, options = {})
+    index_name = index_name_for_remove(table_name, column_name, options)
+    "DROP INDEX #{quote_column_name(index_name)}"
+  end
+
+  def add_timestamps_for_alter(table_name, options = {})
+    [
+      add_column_for_alter(table_name, :created_at, :datetime, options),
+      add_column_for_alter(table_name, :updated_at, :datetime, options)
+    ]
+  end
+
+  def remove_timestamps_for_alter(table_name, _options = {})
+    [remove_column_for_alter(table_name, :updated_at), remove_column_for_alter(table_name, :created_at)]
+  end
+
+  def add_column_for_alter(table_name, column_name, type, options = {})
+    td = create_table_definition(table_name)
+    cd = td.new_column_definition(column_name, type, **options)
+    schema_creation.accept(ActiveRecord::ConnectionAdapters::AddColumnDefinition.new(cd))
+  end
+
+  def remove_column_for_alter(_table_name, column_name, _type = nil, _options = {})
+    "DROP COLUMN #{quote_column_name(column_name)}"
+  end
+
+  def remove_columns_for_alter(table_name, *column_names, **options)
+    column_names.map { |column_name| remove_column_for_alter(table_name, column_name) }
+  end
+end

data/lib/active_record/connection_adapters/percona_adapter.rb

@@ -1,6 +1,7 @@
 require 'active_record/connection_adapters/abstract_mysql_adapter'
 require 'active_record/connection_adapters/statement_pool'
 require 'active_record/connection_adapters/mysql2_adapter'
+require 'active_support/core_ext/string/filters'
 require 'departure'
 require 'forwardable'
 
@@ -9,7 +10,10 @@ module ActiveRecord
     # Establishes a connection to the database that's used by all Active
     # Record objects.
     def percona_connection(config)
-      config[:username] = 'root' if config[:username].nil?
+      if config[:username].nil?
+        config = config.dup if config.frozen?
+        config[:username] = 'root'
+      end
       mysql2_connection = mysql2_connection(config)
 
       connection_details = Departure::ConnectionDetails.new(config)
@@ -39,18 +43,34 @@ module ActiveRecord
 
   module ConnectionAdapters
     class DepartureAdapter < AbstractMysqlAdapter
-
       class Column < ActiveRecord::ConnectionAdapters::MySQL::Column
         def adapter
           DepartureAdapter
         end
       end
 
+      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
+
       extend Forwardable
 
+      unless method_defined?(:change_column_for_alter)
+        include ForAlterStatements
+      end
+
       ADAPTER_NAME = 'Percona'.freeze
 
-      def_delegators :mysql_adapter, :last_inserted_id, :each_hash, :set_field_encoding
+      def_delegators :mysql_adapter, :each_hash, :set_field_encoding
 
       def initialize(connection, _logger, connection_options, _config)
         @mysql_adapter = connection_options[:mysql_adapter]
@@ -58,6 +78,12 @@ module ActiveRecord
         @prepared_statements = false
       end
 
+      def write_query?(sql) # :nodoc:
+        !ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
+          :desc, :describe, :set, :show, :use
+        ).match?(sql)
+      end
+
       def exec_delete(sql, name, binds)
         execute(to_sql(sql, binds), name)
         @connection.affected_rows
@@ -68,9 +94,10 @@ module ActiveRecord
         execute(to_sql(sql, binds), name)
       end
 
-      def exec_query(sql, name = 'SQL', _binds = [])
+      def exec_query(sql, name = 'SQL', _binds = [], **_kwargs)
         result = execute(sql, name)
-        ActiveRecord::Result.new(result.fields, result.to_a)
+        fields = result.fields if defined?(result.fields)
+        ActiveRecord::Result.new(fields, result.to_a)
       end
 
       # Executes a SELECT query and returns an array of rows. Each row is an
@@ -82,8 +109,8 @@ module ActiveRecord
 
       # Executes a SELECT query and returns an array of record hashes with the
       # column names as keys and column values as values.
-      def select(sql, name = nil, binds = [])
-        exec_query(sql, name, binds)
+      def select(sql, name = nil, binds = [], **kwargs)
+        exec_query(sql, name, binds, **kwargs)
       end
 
       # Returns true, as this adapter supports migrations
@@ -103,27 +130,69 @@ module ActiveRecord
       # @param column_name [String, Symbol]
       # @param options [Hash] optional
       def add_index(table_name, column_name, options = {})
-        index_name, index_type, index_columns, index_options = add_index_options(table_name, column_name, options)
-        execute "ALTER TABLE #{quote_table_name(table_name)} ADD #{index_type} INDEX #{quote_column_name(index_name)} (#{index_columns})#{index_options}" # rubocop:disable Metrics/LineLength
+        if ActiveRecord::VERSION::STRING >= '6.1'
+          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
+        else
+          index_name, index_type, index_columns, index_options = add_index_options(table_name, column_name, **options)
+          execute <<-SQL.squish
+            ALTER TABLE #{quote_table_name(table_name)}
+              ADD #{index_type} INDEX
+              #{quote_column_name(index_name)} (#{index_columns})#{index_options}
+          SQL
+        end
       end
 
       # Remove the given index from the table.
       #
       # @param table_name [String, Symbol]
       # @param options [Hash] optional
-      def remove_index(table_name, options = {})
-        index_name = index_name_for_remove(table_name, options)
+      def remove_index(table_name, column_name = nil, **options)
+        if ActiveRecord::VERSION::STRING >= '6.1'
+          return if options[:if_exists] && !index_exists?(table_name, column_name, **options)
+          index_name = index_name_for_remove(table_name, column_name, options)
+        else
+          index_name = index_name_for_remove(table_name, options)
+        end
+
         execute "ALTER TABLE #{quote_table_name(table_name)} DROP INDEX #{quote_column_name(index_name)}"
       end
 
+      def schema_creation
+        SchemaCreation.new(self)
+      end
+
+      def change_table(table_name, _options = {})
+        recorder = ActiveRecord::Migration::CommandRecorder.new(self)
+        yield update_table_definition(table_name, recorder)
+        bulk_change_table(table_name, recorder.commands)
+      end
+
       # Returns the MySQL error number from the exception. The
       # AbstractMysqlAdapter requires it to be implemented
       def error_number(_exception); end
 
       def full_version
+        if ActiveRecord::VERSION::MAJOR < 6
+          get_full_version
+        else
+          schema_cache.database_version.full_version_string
+        end
+      end
+
+      # This is a method defined in Rails 6.0, and we have no control over the
+      # naming of this method.
+      def get_full_version # rubocop:disable Naming/AccessorMethodName
         mysql_adapter.raw_connection.server_info[:version]
       end
 
+      def last_inserted_id(result)
+        mysql_adapter.send(:last_inserted_id, result)
+      end
+
       private
 
       attr_reader :mysql_adapter

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 `(\w+)` /
+    ALTER_TABLE_REGEX = /\AALTER TABLE [^\s]*[\n]* /
 
     attr_reader :table_name
 
@@ -17,8 +17,12 @@ module Departure
 
       match = statement.match(ALTER_TABLE_REGEX)
       raise InvalidAlterStatement unless match
-
-      @table_name = match.captures[0]
+      # Separates the ALTER TABLE from the table_name
+      #
+      # Removes the grave marks, if they are there, so we can get the table_name
+      @table_name = String(match)
+                      .split(' ')[2]
+                      .delete('`')
     end
 
     # Returns the '--alter' pt-online-schema-change argument as a string. See
@@ -38,6 +42,8 @@ module Departure
       @parsed_statement ||= statement
         .gsub(ALTER_TABLE_REGEX, '')
         .gsub('`', '\\\`')
+        .gsub(/\\n/, '')
+        .gsub('"', '\\\"')
     end
   end
 end

data/lib/departure/command.rb

@@ -8,10 +8,11 @@ module Departure
     # @param command_line [String]
     # @param error_log_path [String]
     # @param logger [#write_no_newline]
-    def initialize(command_line, error_log_path, logger)
+    def initialize(command_line, error_log_path, logger, redirect_stderr)
       @command_line = command_line
       @error_log_path = error_log_path
       @logger = logger
+      @redirect_stderr = redirect_stderr
     end
 
     # Executes the command returning its status. It also prints its stdout to
@@ -35,7 +36,7 @@ module Departure
 
     private
 
-    attr_reader :command_line, :error_log_path, :logger, :status
+    attr_reader :command_line, :error_log_path, :logger, :status, :redirect_stderr
 
     # Runs the command in a separate process, capturing its stdout and
     # execution status
@@ -56,11 +57,15 @@ module Departure
     end
 
     # Builds the actual command including stderr redirection to the specified
-    # log file
+    # log file or stdout
     #
     # @return [String]
     def full_command
-      "#{command_line} 2> #{error_log_path}"
+      if redirect_stderr
+        "#{command_line} 2> #{error_log_path}"
+      else
+        "#{command_line} 2>&1"
+      end
     end
 
     # Validates the status of the execution

data/lib/departure/configuration.rb

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

data/lib/departure/connection_base.rb

@@ -0,0 +1,11 @@
+module Departure
+  class ConnectionBase < ActiveRecord::Base
+    def self.establish_connection(config = nil)
+      super.tap do
+        ActiveRecord::Base.connection_specification_name = connection_specification_name
+      end
+    end
+  end
+
+  class OriginalAdapterConnection < ConnectionBase; end
+end

data/lib/departure/connection_details.rb

@@ -15,7 +15,7 @@ module Departure
     #
     # @return [String]
     def to_s
-      @to_s ||= "-h #{host} -P #{port} -u #{user} #{password_argument}"
+      @to_s ||= "#{host_argument} -P #{port} -u #{user} #{password_argument}"
     end
 
     # TODO: Doesn't the abstract adapter already handle this somehow?
@@ -40,6 +40,17 @@ module Departure
       end
     end
 
+    # Returns the host fragment of the details string, adds ssl options if needed
+    #
+    # @return [String]
+    def host_argument
+      host_string = host
+      if ssl_ca.present?
+        host_string += ";mysql_ssl=1;mysql_ssl_client_ca=#{ssl_ca}"
+      end
+      "-h \"#{host_string}\""
+    end
+
     private
 
     attr_reader :connection_data
@@ -74,5 +85,12 @@ module Departure
     def port
       connection_data.fetch(:port, DEFAULT_PORT)
     end
+
+    # Returns the database' SSL CA certificate.
+    #
+    # @return [String]
+    def ssl_ca
+      connection_data.fetch(:sslca, nil)
+    end
   end
 end

data/lib/departure/migration.rb

@@ -0,0 +1,104 @@
+module Departure
+  # Hooks Departure into Rails migrations by replacing the configured database
+  # adapter.
+  #
+  # It also patches ActiveRecord's #migrate method so that it patches LHM
+  # first. This will make migrations written with LHM to go through the
+  # regular Rails Migration DSL.
+  module Migration
+    extend ActiveSupport::Concern
+
+    included do
+      # Holds the name of the adapter that was configured by the app.
+      mattr_accessor :original_adapter
+
+      # Declare on a per-migration class basis whether or not to use Departure.
+      # The default for this attribute is set based on
+      # Departure.configuration.enabled_by_default (default true).
+      class_attribute :uses_departure
+      self.uses_departure = true
+
+      alias_method :active_record_migrate, :migrate
+      remove_method :migrate
+    end
+
+    module ClassMethods
+      # Declare `uses_departure!` in the class body of your migration to enable
+      # Departure for that migration only when
+      # Departure.configuration.enabled_by_default is false.
+      def uses_departure!
+        self.uses_departure = true
+      end
+
+      # Declare `disable_departure!` in the class body of your migration to
+      # disable Departure for that migration only (when
+      # Departure.configuration.enabled_by_default is true, the default).
+      def disable_departure!
+        self.uses_departure = false
+      end
+    end
+
+    # Replaces the current connection adapter with the PerconaAdapter and
+    # patches LHM, then it continues with the regular migration process.
+    #
+    # @param direction [Symbol] :up or :down
+    def departure_migrate(direction)
+      reconnect_with_percona
+      include_foreigner if defined?(Foreigner)
+
+      ::Lhm.migration = self
+      active_record_migrate(direction)
+    end
+
+    # Migrate with or without Departure based on uses_departure class
+    # attribute.
+    def migrate(direction)
+      if uses_departure?
+        departure_migrate(direction)
+      else
+        reconnect_without_percona
+        active_record_migrate(direction)
+      end
+    end
+
+    # Includes the Foreigner's Mysql2Adapter implemention in
+    # DepartureAdapter to support foreign keys
+    def include_foreigner
+      Foreigner::Adapter.safe_include(
+        :DepartureAdapter,
+        Foreigner::ConnectionAdapters::Mysql2Adapter
+      )
+    end
+
+    # Make all connections in the connection pool to use PerconaAdapter
+    # instead of the current adapter.
+    def reconnect_with_percona
+      return if connection_config[:adapter] == 'percona'
+      Departure::ConnectionBase.establish_connection(connection_config.merge(adapter: 'percona'))
+    end
+
+    # Reconnect without percona adapter when Departure is disabled but was
+    # enabled in a previous migration.
+    def reconnect_without_percona
+      return unless connection_config[:adapter] == 'percona'
+      Departure::OriginalAdapterConnection.establish_connection(connection_config.merge(adapter: original_adapter))
+    end
+
+    private
+
+    # Capture the type of the adapter configured by the app if not already set.
+    def connection_config
+      configuration_hash.tap do |config|
+        self.class.original_adapter ||= config[:adapter]
+      end
+    end
+
+    private def configuration_hash
+      if ActiveRecord::VERSION::STRING >= '6.1'
+        ActiveRecord::Base.connection_db_config.configuration_hash
+      else
+        ActiveRecord::Base.connection_config
+      end
+    end
+  end
+end

data/lib/departure/railtie.rb

@@ -6,23 +6,16 @@ module Departure
   class Railtie < Rails::Railtie
     railtie_name :departure
 
-    # It drops all previous database connections and reconnects using this
-    # PerconaAdapter. By doing this, all later ActiveRecord methods called in
-    # the migration will use this adapter instead of Mysql2Adapter.
-    #
-    # It also patches ActiveRecord's #migrate method so that it patches LHM
-    # first. This will make migrations written with LHM to go through the
-    # regular Rails Migration DSL.
-    initializer 'departure.configure_rails_initialization' do
-      ActiveSupport.on_load(:active_record) do
-        Departure.load
-      end
-    end
-
     initializer 'departure.configure' do |app|
       Departure.configure do |config|
         config.tmp_path = app.paths['tmp'].first
       end
     end
+
+    config.after_initialize do
+      Departure.configure do |dc|
+        ActiveRecord::Migration.uses_departure = dc.enabled_by_default
+      end
+    end
   end
 end

data/lib/departure/runner.rb

@@ -15,6 +15,7 @@ module Departure
       @cli_generator = cli_generator
       @mysql_adapter = mysql_adapter
       @error_log_path = config.error_log_path
+      @redirect_stderr = config.redirect_stderr
     end
 
     # Executes the passed sql statement using pt-online-schema-change for ALTER
@@ -44,12 +45,12 @@ module Departure
     # @param command_line [String]
     # @return [Boolean]
     def execute(command_line)
-      Command.new(command_line, error_log_path, logger).run
+      Command.new(command_line, error_log_path, logger, redirect_stderr).run
     end
 
     private
 
-    attr_reader :logger, :cli_generator, :mysql_adapter, :error_log_path
+    attr_reader :logger, :cli_generator, :mysql_adapter, :error_log_path, :redirect_stderr
 
     # Checks whether the sql statement is an ALTER TABLE
     #

data/lib/departure/version.rb

@@ -1,3 +1,3 @@
 module Departure
-  VERSION = '6.1.0'.freeze
+  VERSION = '6.4.0'.freeze
 end

data/lib/departure.rb

@@ -1,6 +1,8 @@
 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/runner'
@@ -11,12 +13,20 @@ require 'departure/logger_factory'
 require 'departure/configuration'
 require 'departure/errors'
 require 'departure/command'
+require 'departure/connection_base'
+require 'departure/migration'
 
 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
 
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Migration.class_eval do
+    include Departure::Migration
+  end
+end
+
 module Departure
   class << self
     attr_accessor :configuration
@@ -27,40 +37,7 @@ module Departure
     yield(configuration)
   end
 
-  # Hooks Percona Migrator into Rails migrations by replacing the configured
-  # database adapter
   def self.load
-    ActiveRecord::Migration.class_eval do
-      alias_method :original_migrate, :migrate
-
-      # Replaces the current connection adapter with the PerconaAdapter and
-      # patches LHM, then it continues with the regular migration process.
-      #
-      # @param direction [Symbol] :up or :down
-      def migrate(direction)
-        reconnect_with_percona
-        include_foreigner if defined?(Foreigner)
-
-        ::Lhm.migration = self
-        original_migrate(direction)
-      end
-
-      # Includes the Foreigner's Mysql2Adapter implemention in
-      # DepartureAdapter to support foreign keys
-      def include_foreigner
-        Foreigner::Adapter.safe_include(
-          :DepartureAdapter,
-          Foreigner::ConnectionAdapters::Mysql2Adapter
-        )
-      end
-
-      # Make all connections in the connection pool to use PerconaAdapter
-      # instead of the current adapter.
-      def reconnect_with_percona
-        connection_config = ActiveRecord::Base
-          .connection_config.merge(adapter: 'percona')
-        ActiveRecord::Base.establish_connection(connection_config)
-      end
-    end
+    # No-op left for compatibility
   end
 end

data/lib/lhm/column_with_sql.rb

@@ -52,7 +52,7 @@ module Lhm
     #
     # @return [column_factory]
     def column
-      cast_type = ActiveRecord::Base.connection.lookup_cast_type(definition)
+      cast_type = ActiveRecord::Base.connection.send(:lookup_cast_type, definition)
       metadata = ActiveRecord::ConnectionAdapters::SqlTypeMetadata.new(
         type: cast_type.type,
         sql_type: definition,

data/test_database.rb

@@ -6,8 +6,6 @@ require 'active_record/connection_adapters/mysql2_adapter'
 # the tests.
 #
 class TestDatabase
-
-
   # Constructor
   #
   # @param config [Hash]
@@ -33,10 +31,10 @@ class TestDatabase
   # Creates the ActiveRecord's schema_migrations table required for
   # migrations to work. Before, it drops the table if it already exists
   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"
+    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'
     ]
 
     run_commands(sql)
@@ -58,19 +56,17 @@ class TestDatabase
   def drop_and_create_comments_table
     sql = [
       "USE #{@database}",
-      "DROP TABLE IF EXISTS comments",
-      "CREATE TABLE comments ( id int(12) 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")
-    sql.each { |str|
-      conn.execute(str)
-    }
-    conn.execute("COMMIT")
+    conn.execute('START TRANSACTION')
+    sql.each { |str| conn.execute(str) }
+    conn.execute('COMMIT')
   end
 
   def conn
@@ -78,6 +74,7 @@ class TestDatabase
       host: @config['hostname'],
       username: @config['username'],
       password: @config['password'],
-      reconnect: true)
+      reconnect: true
+    )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: departure
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -11,51 +11,96 @@ authors:
 - Enrico Stano
 - Adrian Serafin
 - Kirk Haines
+- Guillermo Iguaran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "!="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -93,25 +138,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.2.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -131,19 +170,21 @@ description: Execute your ActiveRecord migrations with Percona's pt-online-schem
 email:
 - ilya.zayats@redbooth.com
 - pau.perez@redbooth.com
-- fran.casas@redbooth.com
+- nflamel@gmail.com
 - jorge.morante@redbooth.com
 - adrian@softmad.pl
 - wyhaines@gmail.com
+- guilleiguaran@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
@@ -159,18 +200,21 @@ files:
 - configuration.rb
 - departure.gemspec
 - docker-compose.yml
+- lib/active_record/connection_adapters/for_alter.rb
 - lib/active_record/connection_adapters/percona_adapter.rb
 - lib/departure.rb
 - lib/departure/alter_argument.rb
 - lib/departure/cli_generator.rb
 - lib/departure/command.rb
 - lib/departure/configuration.rb
+- lib/departure/connection_base.rb
 - lib/departure/connection_details.rb
 - lib/departure/dsn.rb
 - lib/departure/errors.rb
 - lib/departure/log_sanitizers/password_sanitizer.rb
 - lib/departure/logger.rb
 - lib/departure/logger_factory.rb
+- lib/departure/migration.rb
 - lib/departure/null_logger.rb
 - lib/departure/option.rb
 - lib/departure/railtie.rb
@@ -201,8 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.8
-before_install:
-  - sudo apt-key adv --keyserver keys.gnupg.net --recv-keys 8507EFA5
-  - echo "deb http://repo.percona.com/apt `lsb_release -cs` main" | sudo tee -a /etc/apt/sources.list
-  - sudo apt-get update -qq
-  - sudo apt-get install percona-toolkit
-  - gem update bundler
-
-install: bin/setup
-
-after_success:
-  - codeclimate-test-reporter