departure 4.0.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89a3f4d1cb84878f4a556da1439057a2dc8a402e
-  data.tar.gz: c6b8f26150c220f793ef021b7dc1d7ceb0a7ebe7
+SHA256:
+  metadata.gz: d491f83699ed0a2a2932822f624162223ba8a3b74c018a56fd352a00378f3368
+  data.tar.gz: 6b6b6f192dab28cc61431e20bc7b0a35ecd76ab36a56edf5a0a59c42ae893e37
 SHA512:
-  metadata.gz: 66727be4d155815b20da61075f06ddf5e94665e165a3cc9f5ebada94f96e63ac8940efc555a812a127fa013533feb2f3bc0e9342aa5ca0ca699ff8044f000efb
-  data.tar.gz: 89ae513dd2268fddea60c3e11325fcdc309ae02283b74d07a719b77ecf8df968d041d7d92af8d6a35f36d8b341e826a2ce6c42ac9154dec5606cf0da18462daa
+  metadata.gz: 106fa1f8b21f7ab468d6774147352bb2b631398c04df2eb60b664ae520ea44dd91f76fc084ec0215ab722369ad59b3047d9ff6009767329bf26da708f50e60af
+  data.tar.gz: 66396ee515d0a69e65eb8e39dce53d4eec89a5419886b3482f1b4276be1480cb08adf452585f09f7da48b4683e9f87a1d0b4311c6f9ab05a5801577052feb5cf

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+---
+engines:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-49
+ratings:
+  paths:
+  - "**.rb"

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

@@ -0,0 +1,60 @@
+---
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 20
+  Exclude:
+    - 'spec/*'
+    - 'spec/**/*'
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/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/BracesAroundHashParameters:
+  Exclude:
+    - 'spec/fixtures/migrate/**.rb'
+    - 'spec/integration/**.rb'
+
+Style/CommandLiteral:
+  Exclude:
+    - 'test_database.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/integration_spec.rb'
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Exclude:
+    - 'departure.gemspec'
+

data/.travis.yml

@@ -1,8 +1,25 @@
 language: ruby
+
 rvm:
-  - 2.1.2
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0
+
+env:
+  - RAILS_VERSION="~> 6.1.0"
+  - RAILS_VERSION="~> 6.0.0"
+  - RAILS_VERSION="~> 5.2.0"
+
+jobs:
+  include:
+    - rvm: 2.4.6
+      env: RAILS_VERSION="~> 5.2.0"
+
+services:
+  - mysql
+
 before_install:
-  - sudo apt-key adv --keyserver keys.gnupg.net --recv-keys 8507EFA5
+  - travis_retry 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

data/CHANGELOG.md

@@ -6,12 +6,68 @@ 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
+
+### 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
+
+- Permit PERCONA_ARGS to be applied to db:migrate tasks
+
 ### Deprecated
 ### Removed
 ### Fixed
 
+- Output lines are no longer wrapped at 8 chars
+
+## [6.0.0] - 2017-09-25
+
+### Added
+
+- Support for ActiveRecord 5.1
+
+### Changed
+### Deprecated
+### Removed
+### Fixed
+
+## [5.0.0] - 2017-09-19
+
+### Added
+
+- Support for ActiveRecord 5.0
+- Docker setup to run the spec suite
+
+### Changed
+### Deprecated
+### Removed
+### Fixed
+
+- Allow using bash special characters in passwords
+
 ## [4.0.1] - 2017-08-01
 
 ### Added

data/Dockerfile

@@ -0,0 +1,32 @@
+FROM ruby:2.3.4
+MAINTAINER muffinista@gmail.com
+
+# Install apt based dependencies required to run Rails as
+# well as RubyGems. As the Ruby image itself is based on a
+# Debian image, we use apt-get to install those.
+RUN apt-get update && apt-get install -y \
+  build-essential \
+  percona-toolkit
+
+# Configure the main working directory. This is the base
+# directory used in any further RUN, COPY, and ENTRYPOINT
+# commands.
+RUN mkdir -p /app /app/lib/departure
+WORKDIR /app
+
+# Copy the Gemfile as well as the Gemfile.lock and install 
+# the RubyGems. This is a separate step so the dependencies 
+# will be cached unless changes to one of those two files 
+# are made.
+COPY departure.gemspec Gemfile ./ 
+COPY lib/departure/version.rb ./lib/departure/
+
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+
+# Copy the main application.
+COPY . ./
+
+# The main command to run when the container starts. Also
+# tell the Rails dev server to bind to all interfaces by
+# default.
+#CMD ["bundle", "exec", "rails", "server", "-b", "0.0.0.0"]

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem "codeclimate-test-reporter", '~> 1.0.3', group: :test, require: nil
+gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
+gem 'rubocop', '~> 0.49.1', require: false

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Pau Pérez
+Copyright for portions of Departure are held by Redbooth, Inc., 2015-2017. All
+other copyright for Departure are held by Pau Pérez, 2017.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-# Departure [![Build Status](https://travis-ci.org/redbooth/departure.svg?branch=master)](https://travis-ci.org/redbooth/departure) [![Code Climate](https://codeclimate.com/github/redbooth/departure/badges/gpa.svg)](https://codeclimate.com/github/redbooth/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
@@ -99,12 +99,11 @@ $ 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
 ```
 
-This however, only works for `db:migrate:up` or `db:migrate:down` rake tasks and
-not with `db:migrate`. The settings you provide can't be generalized as these
-vary depending on the database table and the kind of changes you apply.
+Use caution when using PERCONA_ARGS with `db:migrate`, as your args will be applied
+to every call that Departure makes to pt-osc.
 
 #### with global configuration
 
@@ -113,14 +112,14 @@ 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
 ```
 
-Unlike using `PERCONA_ARGS`, options provided with global configuration will be applied 
+Unlike using `PERCONA_ARGS`, options provided with global configuration will be applied
 every time sql command is executed via `pt-online-schema-change`.
- 
-Arguments provided in global configuration can be overwritten with `PERCONA_ARGS` env variable. 
+
+Arguments provided in global configuration can be overwritten with `PERCONA_ARGS` env variable.
 
 We recommend using this option with caution and only when you understand the consequences.
 
@@ -146,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
@@ -155,22 +187,28 @@ 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.
 
+## Trouleshooting
+
+### Error creating new table: DBD::mysql::db do failed: Can't write; duplicate key in table (TABLE_NAME)
+There is a [known bug](https://bugs.launchpad.net/percona-toolkit/+bug/1498128) in percona-toolkit version 2.2.15
+that prevents schema changes when a table has constraints. You should upgrade to a version later than 2.2.17 to fix the issue.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -186,7 +224,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
@@ -203,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/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 'bundler/setup'
+require 'percona_migrator'
 
 # 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.
@@ -10,5 +10,5 @@ require "percona_migrator"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/rspec

@@ -1,17 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-#
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rspec-core", "rspec")
+load Gem.bin_path('rspec-core', 'rspec')

data/config.yml.erb

@@ -0,0 +1,4 @@
+username: <%= ENV['PERCONA_DB_USER'] || 'root' %>
+password: <%= ENV['PERCONA_DB_PASSWORD'] || '' %> 
+database: <%= ENV['PERCONA_DB_NAME'] || 'departure_test' %> 
+hostname: <%= ENV['PERCONA_DB_HOST'] || 'localhost' %>

data/configuration.rb

@@ -1,12 +1,13 @@
 require 'yaml'
+require 'erb'
 
 class Configuration
-  CONFIG_PATH = 'config.yml'
+  CONFIG_PATH = 'config.yml.erb'.freeze
 
   attr_reader :config
 
   def initialize
-    @config = YAML.load_file(CONFIG_PATH)
+    @config = YAML.load(ERB.new(File.read(CONFIG_PATH)).result).freeze
   end
 
   def [](key)