departure 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7379ce58f2dd5726c2844bb8ad94f24f427d5567bf4b96d6252faba6ac9371c3
-  data.tar.gz: 607e8a0fb255e7630e2379f7c3f7907723bad228742905fbefc38a053a22f2f5
+  metadata.gz: d491f83699ed0a2a2932822f624162223ba8a3b74c018a56fd352a00378f3368
+  data.tar.gz: 6b6b6f192dab28cc61431e20bc7b0a35ecd76ab36a56edf5a0a59c42ae893e37
 SHA512:
-  metadata.gz: a16e8fa492148d38370dc86bfc2cc3c46696ba7369c0f07bfe6981c01cdfa93e37286a7394507abbb4cb7e7ed2eed7adb6aa43ea92b193c15743d0469cc09e45
-  data.tar.gz: c01c6cc976f7893c99e3257a3de7075afc004878dc2d04cff15bfd0d344f177669de2be808a67527c39c9ede79b5c8978e85ca797bfecc3258f302f474859995
+  metadata.gz: 106fa1f8b21f7ab468d6774147352bb2b631398c04df2eb60b664ae520ea44dd91f76fc084ec0215ab722369ad59b3047d9ff6009767329bf26da708f50e60af
+  data.tar.gz: 66396ee515d0a69e65eb8e39dce53d4eec89a5419886b3482f1b4276be1480cb08adf452585f09f7da48b4683e9f87a1d0b4311c6f9ab05a5801577052feb5cf

data/.gitignore

@@ -10,3 +10,4 @@
 .byebug_history
 tags
 departure_error.log
+.ruby-version

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/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.7.0
 
 env:
+  - RAILS_VERSION="~> 6.1.0"
   - RAILS_VERSION="~> 6.0.0"
   - RAILS_VERSION="~> 5.2.0"
 

data/CHANGELOG.md

@@ -6,9 +6,13 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [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
 
@@ -21,6 +25,10 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 ### 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
 

data/README.md

@@ -1,4 +1,4 @@
-# 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://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) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/departurerb/departure/latest/master?style=plastic)
 
 Departure is an **ActiveRecord connection adapter** that allows running
 **MySQL online and non-blocking DDL** through `ActiveRecord::Migration` without needing
@@ -145,6 +145,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
@@ -208,3 +241,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/departure.gemspec

@@ -7,7 +7,7 @@ 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', '< 6.1'])
+RAILS_DEPENDENCY_VERSION = ENV.fetch('RAILS_VERSION', ['>= 5.2.0', '<= 6.1'])
 
 Gem::Specification.new do |spec|
   spec.name          = 'departure'
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   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/percona_adapter.rb

@@ -9,7 +9,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)
@@ -74,6 +77,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
@@ -119,16 +128,28 @@ 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, algorithm, if_not_exists = add_index_options(table_name, column_name, options)
+          create_index = CreateIndexDefinition.new(index, algorithm, if_not_exists)
+          execute schema_creation.accept(create_index)
+        else
+          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
+        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, *args, **options)
+        column_name = args.first
+        if column_name
+          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
 

data/lib/departure.rb

@@ -14,12 +14,19 @@ 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
@@ -30,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')
-        Departure::ConnectionBase.establish_connection(connection_config)
-      end
-    end
+    # No-op left for compatibility
   end
 end

data/lib/departure/configuration.rb

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

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::ConnectionBase.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/version.rb

@@ -1,3 +1,3 @@
 module Departure
-  VERSION = '6.2.0'.freeze
+  VERSION = '6.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: departure
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Ilya Zayats
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
   type: :runtime
@@ -34,7 +34,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
 - !ruby/object:Gem::Dependency
@@ -44,7 +44,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
   type: :runtime
@@ -54,7 +54,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
 - !ruby/object:Gem::Dependency
@@ -126,25 +126,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
@@ -175,6 +169,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -207,6 +202,7 @@ files:
 - 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
@@ -237,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations