departure-76c9880 6.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf36ce3a7bd698221c247f1f71cbcd3a89dbdf06b92f9a2578cf0de97da5645f
+  data.tar.gz: caf6bca450a5c7ac055a15531c05409316aef1ea57f959fc36a88930ca764ec0
+SHA512:
+  metadata.gz: 753c451b099a1670d49506922cd6ed732aa05c016b7380d1812ac0d0ff012107335ea882bb64c794ba6bc6e84a218134966c9cc560a62685eb68e7de35186baf
+  data.tar.gz: 65321b556b5099203333836a989cbe4cf93adb0592a6e30d498d5ba75fea3f0798399b049cb2512f58f2007afece7ad0069eb0cba57c8b25d3363d53334dfc31

data/.codeclimate.yml

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

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+tags
+departure_error.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

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

@@ -0,0 +1,30 @@
+language: ruby
+
+rvm:
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0
+
+env:
+  - 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:
+  - 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
+  - gem update bundler
+
+install: bin/setup
+
+after_success:
+  - codeclimate-test-reporter

data/CHANGELOG.md

@@ -0,0 +1,192 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+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
+
+- Support for all pt-osc command-line options, including short forms and array
+    arguments
+
+### Changed
+### Deprecated
+### Removed
+### Fixed
+
+## [4.0.0] - 2017-06-12
+
+### Added
+### Changed
+
+- Rename the gem from percona_migrator to departure.
+
+### Deprecated
+### Removed
+
+- Percona_migrator's deprecation warnings when installing and running the gem.
+
+### Fixed
+
+## [3.0.0] - 2016-04-07
+
+### Added
+
+- Support for ActiveRecord 4.2.x
+- Support for Mysql2 4.x
+- Allow passing any `pt-online-schema-change`'s arguments through the
+   `PERCONA_ARGS` env var when executing a migration with `rake db:migrate:up`
+   or `db:migrate:down`.
+- Allow setting global percona arguments via gem configuration
+- Filter MySQL's password from logs
+
+### Changed
+
+- Enable default pt-online-schema-change replicas discovering mechanism.
+    So far, this was purposely set to `none`. To keep this same behaviour
+    provide the `PERCONA_ARGS=--recursion-method=none` env var when running the
+    migration.
+
+## [1.0.0] - 2016-11-30
+
+### Added
+
+- Show pt-online-schema-change's stdout while the migration is running instead
+    of at then and all at once.
+- Store pt-online-schema-change's stderr to percona_migrator_error.log in the
+    default Rails tmp folder.
+- Allow configuring the tmp directory where the error log gets written into,
+    with the `tmp_path` configuration setting.
+- Support for ActiveRecord 4.0. Adds the following migration methods:
+  - #rename_index, #change_column_null, #add_reference, #remove_reference,
+    #set_field_encoding, #add_timestamps, #remove_timestamps, #rename_table,
+    #rename_column
+
+## [0.1.0.rc.7] - 2016-09-15
+
+### Added
+
+- Toggle pt-online-schema-change's output as well when toggling the migration's
+    verbose option.
+
+### Changed
+
+- Enabled pt-online-schema-change's output while running the migration, that got
+  broken in v0.1.0.rc.2
+
+## [0.1.0.rc.6] - 2016-04-07
+
+### Added
+
+- Support non-ddl migrations by implementing the methods for the ActiveRecord
+    quering to work.
+
+### Changed
+
+- Refactor the PerconaAdapter to use the Runner as connection client, as all the
+    other adapters.
+
+## [0.1.0.rc.5] - 2016-03-29
+
+### Changed
+
+- Raise a ActiveRecord::StatementInvalid on failed migration. It also provides
+    more detailed error message when possible such as pt-onlin-schema-change
+    being missing.
+
+## [0.1.0.rc.4] - 2016-03-15
+
+### Added
+
+- Support #drop_table
+- Support for foreing keys in db/schema.rb when using [Foreigner
+gem](https://github.com/matthuhiggins/foreigner) in Rails 3 apps. This allows to
+define foreign keys with #execute, but does not provide support for
+add_foreign_key yet.
+
+## [0.1.0.rc.3] - 2016-03-10
+
+### Added
+
+- Support #execute. Allows to execute raw SQL from the migration
+
+## [0.1.0.rc.2] - 2016-03-09
+
+### Added
+
+- VERBOSE env var in tests. Specially useful for integration tests.
+- Fix #create_table migration method. Now it does create the table.
+
+### Changed
+
+- Use ActiveRecord's logger instead of specifying one in the connection data.
+
+## [0.1.0.rc.1] - 2016-03-01
+
+- Initial gem version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at accounts@redbooth.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

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

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'codeclimate-test-reporter', '~> 1.0.3', group: :test, require: nil
+gem 'rubocop', '~> 0.49.1', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,227 @@
+# 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 is an **ActiveRecord connection adapter** that allows running
+**MySQL online and non-blocking DDL** through `ActiveRecord::Migration` without needing
+    to use a different DSL other than Rails' migrations DSL.
+
+It uses `pt-online-schema-change` command-line tool of
+[Percona
+Toolkit](https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html)
+which runs MySQL alter table statements without downtime.
+
+## Rename from "Percona Migrator"
+
+This project was formerly known as "Percona Migrator", but this incurs in an
+infringement of Percona's trade mark policy and thus has to be renamed. Said
+name is likely to cause confusion as to the source of the wrapper.
+
+The next major versions will use "Departure" as gem name.
+
+## Installation
+
+Departure relies on `pt-online-schema-change` from [Percona
+Toolkit](https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html)
+
+### Mac
+
+`brew install percona-toolkit`
+
+If when running a migration you see an error like:
+
+```
+PerconaMigrator::Error: Cannot connect to MySQL: Cannot connect to MySQL because
+the Perl DBI module is not installed or not found.
+```
+
+You also need to install the DBI and DBD::MySQL modules from `cpan`.
+
+```
+$ sudo cpan
+cpan> install DBI
+cpan> install DBD::mysql
+```
+
+### Linux
+
+#### Ubuntu/Debian based
+
+`apt-get install percona-toolkit`
+
+#### Arch Linux
+
+`pacman -S percona-toolkit perl-dbd-mysql`
+
+#### Other distros
+
+For other Linux distributions check out the [Percona Toolkit download
+page](https://www.percona.com/downloads/percona-toolkit/) to find the package
+that fits your distribution.
+
+You can also get it from [Percona's apt repository](https://www.percona.com/doc/percona-xtradb-cluster/5.5/installation/apt_repo.html)
+
+Once installed, add this line to your application's Gemfile:
+
+```ruby
+gem 'departure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install departure
+
+## Usage
+
+Once you added it to your app's Gemfile, you can create and run Rails migrations
+as usual.
+
+All the `ALTER TABLE` statements will be executed with
+`pt-online-schema-change`, which will provide additional output to the
+migration.
+
+### pt-online-schema-change arguments
+
+#### with environment variable
+
+You can specify any `pt-online-schema-change` arguments when running the
+migration. All what you pass in the PERCONA_ARGS env var, will be bypassed to the
+binary, overwriting any default values. Note the format is the same as in
+`pt-online-schema-change`. Check the full list in [Percona Toolkit
+documentation](https://www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html#options)
+
+```ruby
+$ 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 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
+to every call that Departure makes to pt-osc.
+
+#### with global configuration
+
+You can specify any `pt-online-schema-change` arguments in global gem configuration
+using `global_percona_args` option.
+
+```ruby
+Departure.configure do |config|
+  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
+every time sql command is executed via `pt-online-schema-change`.
+
+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.
+
+### LHM support
+
+If you moved to Soundcloud's [Lhm](https://github.com/soundcloud/lhm) already,
+we got you covered. Departure overrides Lhm's DSL so that all the alter
+statements also go through `pt-online-schema-change` as well.
+
+You can keep your Lhm migrations and start using Rails migration's DSL back
+again in your next migration.
+
+## Configuration
+
+You can override any of the default values from an initializer:
+
+```ruby
+Departure.configure do |config|
+  config.tmp_path = '/tmp/'
+end
+```
+
+It's strongly recommended to name it after this gems name, such as
+`config/initializers/departure.rb`
+
+### Only enabled on a 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
+`ActiveRecord::Migration#migrate` method to reset the connection and reestablish
+it using the `DepartureAdapter` instead of the one you defined in your
+`config/database.yml`.
+
+Then, when any migration DSL methods such as `add_column` or `create_table` are
+executed, they all go to the
+[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/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/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 appropriate arguments for the generated SQL.
+
+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
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+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
+participating in this project you agree to abide by its terms.
+
+Check the code of conduct [here](CODE_OF_CONDUCT.md)
+
+## Changelog
+
+You can consult the changelog [here](CHANGELOG.md)
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+