percona_migrator 0.1.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54dcba8208db6d98ee85f3124a8b4d725617e80d
+  data.tar.gz: 86b55bab745a0952886b09aa32323f78db9e8d9f
+SHA512:
+  metadata.gz: 695c5ed29fa887f1f8df33b66ab86a8d63c6fde601e17ff91440f237ec05d62c6e4645128fa144a29dd412b1dbcfa9ef56356e5caa04833d2a88a2ff8ce20200
+  data.tar.gz: 36d59e8106ceb679b867e90f2d0b1598f17fa74a4eb79d33f73b0c13311ac82a7dd20c990d9a8a711969cec61e1b1de0bbe393205a6a89860569d3248f0515e7

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install:
+  - gpg --keyserver  hkp://keys.gnupg.net --recv-keys 1C4CBDCDCD2EFD2A && gpg -a --export CD2EFD2A | sudo apt-key add -
+  - 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
+  - bin/setup
+
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 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]
+
+- 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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pau Pérez
+
+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,90 @@
+# PerconaMigrator [![Build Status](https://travis-ci.org/redbooth/percona_migrator.svg?branch=master)](https://travis-ci.org/redbooth/percona_migrator)
+
+Percona Migrator is a tool for running online and non-blocking
+DDL `ActiveRecord::Migrations` using `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 supports foreign key constraints.
+
+It adds a `db:percona_migrate:up` runs your migration using the
+`pt-online-schema-change` command.  It will apply exactly the same changes as
+if you run it with `db:migrate:up` avoiding deadlocks and without the need to
+change how you write regular rails migrations.
+
+It also disables `rake db:migrate:up` for the ddl migrations on envs with
+PERCONA_TOOLKIT var set to ensure all these migrations use Percona in production.
+
+## Installation
+
+Percona Migrator relies on `pt-online-schema-change` from  [Percona
+Toolkit](https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html)
+
+For mac, you can install it with homebrew typing `brew install percona-toolkit`. For
+linux machines 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 'percona_migrator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install percona_migrator
+
+## Usage
+
+Percona Migrator is meant to be used only on production or production-like
+environments. To that end, it will only run if the `PERCONA_TOOLKIT`
+environment variable is present.
+
+From that same environment where you added the variable, execute the following:
+
+1. `bundle exec rake db:migrate:status` to find out your migration's version
+number
+2. `rake db:percona_migrate:up VERSION=<version>`.  This will run the migration
+and mark it as up. Otherwise, if the migration fails, it will still be listed as down
+
+You can also mark the migration as run manually, by executing `bundle exec rake
+db:migrate:mark_as_up VERSION=<version>`. Likewise, there's a `bundle exec rake
+db:migrate:mark_as_down VERSION=<version>` that may be of help.
+
+## 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/redbooth/percona_migrator.
+
+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).
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require './configuration'
+require './test_database'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :db do
+  desc 'Create the test database'
+  task :create do
+    config = Configuration.new
+    TestDatabase.new(config).create_test_database
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+bundle exec rake db:create

data/config.yml

@@ -0,0 +1,3 @@
+username: 'root'
+password: ''
+database: 'percona_migrator_test'

data/configuration.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+
+class Configuration
+  CONFIG_PATH = 'config.yml'
+
+  attr_reader :config
+
+  def initialize
+    @config = YAML.load_file(CONFIG_PATH)
+  end
+
+  def [](key)
+    config[key]
+  end
+end

data/lib/active_record/connection_adapters/percona_adapter.rb

@@ -0,0 +1,153 @@
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+require 'active_record/connection_adapters/statement_pool'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'percona_migrator'
+require 'forwardable'
+
+module ActiveRecord
+  class Base
+    # Establishes a connection to the database that's used by all Active
+    # Record objects.
+    def self.percona_connection(config)
+      connection = mysql2_connection(config)
+      client = connection.raw_connection
+
+      # TODO: use AR's logger. It must pass a logger instance around, at least
+      # the one the migration uses
+      logger = config[:logger] || $stdout
+
+      config.merge!(
+        logger: logger,
+        runner: PerconaMigrator::Runner.new(logger),
+        cli_generator: PerconaMigrator::CliGenerator.new(config)
+      )
+
+      connection_options = { mysql_adapter: connection }
+
+      ConnectionAdapters::PerconaMigratorAdapter.new(
+        client,
+        logger,
+        connection_options,
+        config
+      )
+    end
+  end
+
+  module ConnectionAdapters
+    # It doesn't implement #create_table as this statement is harmless and
+    # pretty fast. No need to do it with Percona
+    class PerconaMigratorAdapter < AbstractMysqlAdapter
+
+      class Column < AbstractMysqlAdapter::Column
+        def adapter
+          PerconaMigratorAdapter
+        end
+      end
+
+      extend Forwardable
+
+      ADAPTER_NAME = 'Percona'.freeze
+
+      def_delegators :mysql_adapter, :tables, :select_values, :exec_delete,
+        :exec_insert, :exec_query, :last_inserted_id, :select
+
+      def initialize(connection, logger, connection_options, config)
+        super
+        @mysql_adapter = connection_options[:mysql_adapter]
+        @logger = logger
+        @runner = config[:runner]
+        @cli_generator = config[:cli_generator]
+      end
+
+      # Returns true, as this adapter supports migrations
+      def supports_migrations?
+        true
+      end
+
+      # Delegates #each_hash to the mysql adapter
+      #
+      # @param result [Mysql2::Result]
+      def each_hash(result)
+        if block_given?
+          mysql_adapter.each_hash(result, &Proc.new)
+        else
+          mysql_adapter.each_hash(result)
+        end
+      end
+
+      def new_column(field, default, type, null, collation)
+        Column.new(field, default, type, null, collation)
+      end
+
+      # Adds a new column to the named table
+      #
+      # @param table_name [String, Symbol]
+      # @param column_name [String, Symbol]
+      # @param type [Symbol]
+      # @param options [Hash] optional
+      def add_column(table_name, column_name, type, options = {})
+        super
+        command = cli_generator.generate(table_name, @sql)
+        runner.execute(command)
+      end
+
+      # Removes the column(s) from the table definition
+      #
+      # @param table_name [String, Symbol]
+      # @param column_names [String, Symbol, Array<String>, Array<Symbol>]
+      def remove_column(table_name, *column_names)
+        super
+        command = cli_generator.generate(table_name, @sql)
+        runner.execute(command)
+      end
+
+      # Adds a new index to the table
+      #
+      # @param table_name [String, Symbol]
+      # @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 "ADD #{index_type} INDEX #{quote_column_name(index_name)} (#{index_columns})#{index_options}"
+
+        command = cli_generator.generate(table_name, @sql)
+        runner.execute(command)
+      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)
+        execute "DROP INDEX #{quote_column_name(index_name)}"
+
+        command = cli_generator.generate(table_name, @sql)
+        runner.execute(command)
+      end
+
+      # Records the SQL statement to be executed. This is used to then delegate
+      # the execution to Percona's pt-online-schema-change.
+      #
+      # @param sql [String]
+      # @param _name [String] optional
+      def execute(sql, _name = nil)
+        @sql = sql
+        true
+      end
+
+      # This abstract method leaves up to the connection adapter freeing the
+      # result, if it needs to. Check out: https://github.com/rails/rails/blob/330c6af05c8b188eb072afa56c07d5fe15767c3c/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb#L247
+      #
+      # @param sql [String]
+      # @param name [String] optional
+      def execute_and_free(sql, name = nil)
+        yield mysql_adapter.execute(sql, name)
+      end
+
+      private
+
+      attr_reader :mysql_adapter, :logger, :runner, :cli_generator
+    end
+  end
+end

data/lib/lhm/adapter.rb

@@ -0,0 +1,109 @@
+require 'lhm/column_with_sql'
+require 'lhm/column_with_type'
+
+module Lhm
+
+  # Translates Lhm DSL to ActiveRecord's one, so Lhm migrations will now go
+  # through Percona as well, without any modification on the migration's
+  # code
+  class Adapter
+
+    # Constructor
+    #
+    # @param migration [ActiveRecord::Migtration]
+    # @param table_name [String, Symbol]
+    def initialize(migration, table_name)
+      @migration = migration
+      @table_name = table_name
+    end
+
+    # Adds the specified column through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    # @param definition [String, Symbol]
+    def add_column(column_name, definition)
+      attributes = column_attributes(column_name, definition)
+      migration.add_column(*attributes)
+    end
+
+    # Removes the specified column through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    def remove_column(column_name)
+      migration.remove_column(table_name, column_name)
+    end
+
+    # Adds an index in the specified columns through ActiveRecord. Note you
+    # can provide a name as well
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def add_index(columns, index_name = nil)
+      options = { name: index_name } if index_name
+      migration.add_index(table_name, columns, options || {})
+    end
+
+    # Removes the index in the given columns or by its name
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def remove_index(columns, index_name = nil)
+      options = if index_name
+                  { name: index_name }
+                else
+                  { column: columns }
+                end
+      migration.remove_index(table_name, options)
+    end
+
+    # Change the column to use the provided definition, through ActiveRecord
+    #
+    # @param column_name [String, Symbol]
+    # @param definition [String, Symbol]
+    def change_column(column_name, definition)
+      attributes = column_attributes(column_name, definition)
+      migration.change_column(*attributes)
+    end
+
+    # Renames the old_name column to new_name by using ActiveRecord
+    #
+    # @param old_name [String, Symbol]
+    # @param new_name [String, Symbol]
+    def rename_column(old_name, new_name)
+      migration.rename_column(table_name, old_name, new_name)
+    end
+
+    # Adds a unique index on the given columns, with the provided name if passed
+    #
+    # @param columns [Array<String>, Array<Symbol>, String, Symbol]
+    # @param index_name [String]
+    def add_unique_index(columns, index_name = nil)
+      options = { unique: true }
+      options.merge!(name: index_name) if index_name
+
+      migration.add_index(table_name, columns, options)
+    end
+
+    private
+
+    attr_reader :migration, :table_name
+
+    # Returns the instance of ActiveRecord column with the given name and
+    # definition
+    #
+    # @param name [String, Symbol]
+    # @param definition [String]
+    def column(name, definition)
+      @column ||= if definition.is_a?(Symbol)
+                    ColumnWithType.new(name, definition)
+                  else
+                    ColumnWithSql.new(name, definition)
+                  end
+    end
+
+    def column_attributes(name, definition)
+      attributes = column(name, definition).attributes
+      [table_name, name].concat(attributes)
+    end
+  end
+end

data/lib/lhm/column_with_sql.rb

@@ -0,0 +1,90 @@
+require 'forwardable'
+
+module Lhm
+
+  # Abstracts the details of a table column definition when specified with a MySQL
+  # column definition string
+  class ColumnWithSql
+    extend Forwardable
+
+    # Returns the column's class to be used
+    #
+    # @return [Constant]
+    def self.column_factory
+      ::ActiveRecord::ConnectionAdapters::PerconaMigratorAdapter::Column
+    end
+
+    # Constructor
+    #
+    # @param name [String, Symbol]
+    # @param definition [String]
+    def initialize(name, definition)
+      @name = name
+      @definition = definition
+    end
+
+    # Returns the column data as an Array to be used with the splat operator.
+    # See Lhm::Adaper#add_column
+    #
+    # @return [Array]
+    def attributes
+      [type, column_options]
+    end
+
+    private
+
+    def_delegators :column, :limit, :type, :default, :null
+
+    attr_reader :name, :definition
+
+    # TODO: investigate
+    #
+    # Rails doesn't take into account lenght argument of INT in the
+    # definition, as an integer it will default it to 4 not an integer
+    #
+    # Returns the columns data as a Hash
+    #
+    # @return [Hash]
+    def column_options
+      { limit: column.limit, default: column.default, null: column.null }
+    end
+
+    # Returns the column instance with the provided data
+    #
+    # @return [column_factory]
+    def column
+      @column ||= self.class.column_factory.new(
+        name,
+        default_value,
+        definition,
+        null_value
+      )
+    end
+
+    # Gets the DEFAULT value the column takes as specified in the
+    # definition, if any
+    #
+    # @return [String, NilClass]
+    def default_value
+      match = if definition =~ /timestamp|datetime/i
+                /default '?(.+[^'])'?/i.match(definition)
+              else
+                /default '?(\w+)'?/i.match(definition)
+              end
+
+      return unless match
+
+      match[1].downcase != 'null' ? match[1] : nil
+    end
+
+    # Checks whether the column accepts NULL as specified in the definition
+    #
+    # @return [Boolean]
+    def null_value
+      match = /((\w*) NULL)/i.match(definition)
+      return true unless match
+
+      match[2].downcase == 'not' ? false : true
+    end
+  end
+end

data/lib/lhm/column_with_type.rb

@@ -0,0 +1,31 @@
+module Lhm
+
+  # Abstracts the details of a table column definition when specified with a type
+  # as a symbol. This is the regular ActiveRecord's #add_column syntax:
+  #
+  #   add_column :tablenames, :field, :string
+  #
+  class ColumnWithType
+
+    # Constructor
+    #
+    # @param name [String, Symbol]
+    # @param definition [Symbol]
+    def initialize(name, definition)
+      @name = name
+      @definition = definition
+    end
+
+    # Returns the column data as an Array to be used with the splat operator.
+    # See Lhm::Adaper#add_column
+    #
+    # @return [Array]
+    def attributes
+      [definition]
+    end
+
+    private
+
+    attr_reader :definition
+  end
+end

data/lib/lhm.rb

@@ -0,0 +1,25 @@
+require 'lhm/adapter'
+
+# Defines the same global namespace as LHM's gem does to mimic its API
+# while providing a different behaviour. We delegate all LHM's methods to
+# ActiveRecord so that you don't need to modify your old LHM migrations
+module Lhm
+
+  # Yields an adapter instance so that Lhm migration Dsl methods get
+  # delegated to ActiveRecord::Migration ones instead
+  #
+  # @param table_name [String]
+  # @param _options [Hash]
+  # @param block [Block]
+  def self.change_table(table_name, _options = {}, &block)
+    yield Adapter.new(@migration, table_name)
+  end
+
+  # Sets the migration to apply the adapter to
+  #
+  # @param migration [ActiveRecord::Migration]
+  def self.migration=(migration)
+    @migration = migration
+  end
+end
+

data/lib/percona_migrator/alter_argument.rb

@@ -0,0 +1,33 @@
+module PerconaMigrator
+
+  # 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
+
+    # Constructor
+    #
+    # @param statement [String]
+    def initialize(statement)
+      @statement = statement
+    end
+
+    # Returns the '--alter' pt-online-schema-change argumment as a string. See
+    # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html
+    def to_s
+      "--alter \"#{parsed_statement}\""
+    end
+
+    private
+
+    attr_reader :statement
+
+    # Removes the 'ALTER TABLE' portion of the SQL statement
+    #
+    # @return [String]
+    def parsed_statement
+      @parsed_statement ||= statement
+        .gsub(/ALTER TABLE `(\w+)` /, '')
+        .gsub('`','\\\`')
+    end
+  end
+end

data/lib/percona_migrator/cli_generator.rb

@@ -0,0 +1,117 @@
+require 'percona_migrator/alter_argument'
+
+module PerconaMigrator
+
+  # Represents the 'DSN' argument of Percona's pt-online-schema-change
+  # See https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
+  class DSN
+
+    # Constructor
+    #
+    # @param database [String, Symbol]
+    # @param table_name [String, Symbol]
+    def initialize(database, table_name)
+      @database = database
+      @table_name = table_name
+    end
+
+    # Returns the pt-online-schema-change DSN string. See
+    # https://www.percona.com/doc/percona-toolkit/2.0/pt-online-schema-change.html#dsn-options
+    def to_s
+      "D=#{database},t=#{table_name}"
+    end
+
+    private
+
+    attr_reader :table_name, :database
+  end
+
+  # Generates the equivalent Percona's pt-online-schema-change command to the
+  # given SQL statement
+  class CliGenerator # Command
+    BASE_COMMAND = 'pt-online-schema-change'
+    BASE_OPTIONS = %w(
+      --execute
+      --statistics
+      --recursion-method=none
+      --alter-foreign-keys-method=auto
+    )
+
+    # Constructor
+    #
+    # @param connection_data [Hash]
+    def initialize(connection_data)
+      @connection_data = connection_data
+      init_base_command
+      add_connection_details
+    end
+
+    # Generates the percona command. Fills all the connection credentials from
+    # the current AR connection, but that can amended via ENV-vars:
+    # PERCONA_DB_HOST, PERCONA_DB_USER, PERCONA_DB_PASSWORD, PERCONA_DB_NAME
+    # Table name can't not be amended, it populates automatically from the
+    # migration data
+    #
+    # @param table_name [String]
+    # @param statement [String] MySQL statement
+    # @return [String]
+    def generate(table_name, statement)
+      dsn = DSN.new(database, table_name)
+      alter_argument = AlterArgument.new(statement)
+
+      "#{to_s} #{dsn} #{alter_argument}"
+    end
+
+    private
+
+    attr_reader :connection_data
+
+    # Sets up the command with its options
+    def init_base_command
+      @command = [BASE_COMMAND, BASE_OPTIONS.join(' ')]
+    end
+
+    # Adds the host, user and password, if present, to the command
+    def add_connection_details
+      @command.push("-h #{host}")
+      @command.push("-u #{user}")
+      @command.push("-p #{password}") if password.present?
+    end
+
+    # Returns the command as a string that can be executed in a shell
+    def to_s
+      @command.join(' ')
+    end
+
+    # Returns the database host name, defaulting to localhost. If PERCONA_DB_HOST
+    # is passed its value will be used instead
+    #
+    # @return [String]
+    def host
+      ENV['PERCONA_DB_HOST'] || connection_data[:host] || 'localhost'
+    end
+
+    # Returns the database user. If PERCONA_DB_USER is passed its value will be
+    # used instead
+    #
+    # @return [String]
+    def user
+      ENV['PERCONA_DB_USER'] || connection_data[:username]
+    end
+
+    # Returns the database user's password. If PERCONA_DB_PASSWORD is passed its
+    # value will be used instead
+    #
+    # @return [String]
+    def password
+      ENV['PERCONA_DB_PASSWORD'] || connection_data[:password]
+    end
+
+    # TODO: Doesn't the abstract adapter already handle this somehow?
+    # Returns the database name. If PERCONA_DB_NAME is passed its value will be
+    # used instead
+    def database
+      ENV['PERCONA_DB_NAME'] || connection_data[:database]
+    end
+  end
+end

data/lib/percona_migrator/railtie.rb

@@ -0,0 +1,44 @@
+require 'percona_migrator'
+require 'lhm' # It's our own Lhm adapter, not the gem
+require 'rails'
+
+module PerconaMigrator
+  class Railtie < Rails::Railtie
+    railtie_name :percona_migrator
+
+    # 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 'percona_migrator.configure_rails_initialization' do
+      ActiveSupport.on_load(:active_record) do
+
+        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
+            ::Lhm.migration = self
+            original_migrate(direction)
+          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
+            ActiveRecord::Base.establish_connection(
+              connection_config.merge(adapter: 'percona')
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/percona_migrator/runner.rb

@@ -0,0 +1,88 @@
+require 'open3'
+
+module PerconaMigrator
+
+  # It executes pt-online-schema-change commands in a new process and gets its
+  # output and status
+  class Runner
+
+    NONE = "\e[0m"
+    CYAN = "\e[38;5;86m"
+    GREEN = "\e[32m"
+    RED = "\e[31m"
+
+    # Executes the given command printing the output to the logger
+    #
+    # @param command [String]
+    # @param logger [IO]
+    def self.execute(command, logger)
+      new(command, logger).execute
+    end
+
+    # Constructor
+    #
+    # @param logger [IO]
+    def initialize(logger)
+      @logger = logger
+      @status = nil
+    end
+
+    # Runs and logs the given command
+    #
+    # @param command [String]
+    # @return [Boolean]
+    def execute(command)
+      @command = command
+
+      log_started
+      run_command
+      log_finished
+
+      status
+    end
+
+    private
+
+    attr_reader :command, :logger, :status
+
+    # TODO: log as a migration logger subitem
+    #
+    # Logs when the execution started
+    def log_started
+      logger.puts "\n#{CYAN}-- #{command}#{NONE}\n\n"
+    end
+
+    # Executes the command outputing any errors
+    #
+    # @raise [Errno::ENOENT] if pt-online-schema-change can't be found
+    def run_command
+      Open3.popen2(command) do |_stdin, stdout, process|
+        @status = process.value
+        logger.puts stdout.read
+      end
+
+      if status.nil?
+        Kernel.warn("Error running '#{command}': status could not be retrieved")
+      end
+
+      if status && status.signaled?
+        Kernel.warn("Error running '#{command}': #{status.to_s}")
+      end
+
+    rescue Errno::ENOENT
+      raise Errno::ENOENT, "Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit"
+    end
+
+    # Logs the status of the execution once it's finished
+    def log_finished
+      return unless status
+
+      value = status.exitstatus
+      return unless value
+
+      message = value.zero? ? "#{GREEN}Done!#{NONE}" : "#{RED}Failed!#{NONE}"
+
+      logger.puts("\n#{message}")
+    end
+  end
+end

data/lib/percona_migrator/version.rb

@@ -0,0 +1,3 @@
+module PerconaMigrator
+  VERSION = '0.1.0.rc.1'.freeze
+end

data/lib/percona_migrator.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'active_support/all'
+
+require 'percona_migrator/version'
+require 'percona_migrator/runner'
+require 'percona_migrator/cli_generator'
+
+require 'percona_migrator/railtie' if defined?(Rails)
+
+module PerconaMigrator
+end

data/percona_migrator.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'percona_migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'percona_migrator'
+  spec.version       = PerconaMigrator::VERSION
+  spec.authors       = ['Ilya Zayats', 'Pau Pérez', 'Fran Casas']
+  spec.email         = ['ilya.zayats@redbooth.com', 'pau.perez@redbooth.com', 'fran.casas@redbooth.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}
+  spec.homepage      = 'http://github.com/redbooth/percona_migrator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  # TODO: Relax me
+  spec.add_runtime_dependency 'rails', '~>3.2.22'
+  spec.add_runtime_dependency 'mysql2', '0.3.20'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  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'
+end

data/test_database.rb

@@ -0,0 +1,25 @@
+class TestDatabase
+  def initialize(config)
+    @config = config
+  end
+
+  # Creates the percona_migrator_test database and comments table in it
+  def create_test_database
+    %x(#{mysql_command} "DROP DATABASE IF EXISTS percona_migrator_test; CREATE DATABASE percona_migrator_test DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci")
+    %x(#{mysql_command} "USE percona_migrator_test; 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;")
+  end
+
+  # Creates the ActiveRecord's schema_migrations table required for
+  # migrations to work
+  def create_schema_migrations_table
+    %x(#{mysql_command} "USE percona_migrator_test; 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")
+  end
+
+  private
+
+  attr_reader :config
+
+  def mysql_command
+    "mysql --user=#{config['username']} --password=#{config['password']} -e"
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: percona_migrator
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc.1
+platform: ruby
+authors:
+- Ilya Zayats
+- Pau Pérez
+- Fran Casas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.2.1
+  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
+description: Execute your ActiveRecord migrations with Percona's pt-online-schema-change
+email:
+- ilya.zayats@redbooth.com
+- pau.perez@redbooth.com
+- fran.casas@redbooth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.yml
+- configuration.rb
+- lib/active_record/connection_adapters/percona_adapter.rb
+- lib/lhm.rb
+- lib/lhm/adapter.rb
+- lib/lhm/column_with_sql.rb
+- lib/lhm/column_with_type.rb
+- lib/percona_migrator.rb
+- lib/percona_migrator/alter_argument.rb
+- lib/percona_migrator/cli_generator.rb
+- lib/percona_migrator/railtie.rb
+- lib/percona_migrator/runner.rb
+- lib/percona_migrator/version.rb
+- percona_migrator.gemspec
+- test_database.rb
+homepage: http://github.com/redbooth/percona_migrator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: pt-online-schema-change runner for ActiveRecord migrations
+test_files: []
+has_rdoc: