departure-76c9880 6.2.0

data/RELEASING.md

@@ -0,0 +1,17 @@
+# Releasing Departure
+
+All releases come from the master branch. All other branches won't be maintained
+and will receive bug fix releases only.
+
+In order to give support to a new major Rails version, we'll branch off of
+master, name it following the Rails repo convention, such as `v4.2`, and
+we'll keep it open for bug fixes.
+
+1. Update `lib/departure/version.rb` accordingly
+2. Review the `CHANGELOG.md` and add a new section following the format
+   `[version] - YYYY-MM-DD`. We conform to the guidelines of
+   http://keepachangelog.com/
+3. Commit the changes with the message `Prepare release VERSION`
+4. Execute the release rake task as `bundle exec rake release`. It creates the
+   tag, builds and pushes the gem to Rubygems.
+5. Announce it! :tada:

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).setup_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/rspec

@@ -0,0 +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 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

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.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

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

data/departure.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$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', '< 6.1'])
+
+Gem::Specification.new do |spec|
+  spec.name          = 'departure-76c9880'
+  spec.version       = Departure::VERSION
+  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.)
+  spec.homepage      = 'https://github.com/departurerb/departure'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  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.3'
+
+  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 'climate_control', '~> 0.0.3'
+end

data/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '2'
+services:
+  db:
+    image: mysql/mysql-server
+    ports: 
+      - "3306:3306"
+    environment:
+      MYSQL_DATABASE: departure_test
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+      MYSQL_ROOT_HOST: '%'
+  rails:
+    build: .
+    links:
+      - db
+    depends_on:
+      - db
+    tty: true
+    stdin_open: true
+    environment:
+      PERCONA_DB_USER: root
+      PERCONA_DB_HOST: db
+      PERCONA_DB_PASSWORD:
+      PERCONA_DB_NAME: departure_test

data/lib/active_record/connection_adapters/for_alter.rb

@@ -0,0 +1,91 @@
+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 = {})
+    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
+
+  def remove_index_for_alter(table_name, options = {})
+    index_name = index_name_for_remove(table_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)
+    column_names.map { |column_name| remove_column_for_alter(table_name, column_name) }
+  end
+end

data/lib/active_record/connection_adapters/percona_adapter.rb

@@ -0,0 +1,168 @@
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+require 'active_record/connection_adapters/statement_pool'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'departure'
+require 'forwardable'
+
+module ActiveRecord
+  module ConnectionHandling
+    # 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?
+      mysql2_connection = mysql2_connection(config)
+
+      connection_details = Departure::ConnectionDetails.new(config)
+      verbose = ActiveRecord::Migration.verbose
+      sanitizers = [
+        Departure::LogSanitizers::PasswordSanitizer.new(connection_details)
+      ]
+      percona_logger = Departure::LoggerFactory.build(sanitizers: sanitizers, verbose: verbose)
+      cli_generator = Departure::CliGenerator.new(connection_details)
+
+      runner = Departure::Runner.new(
+        percona_logger,
+        cli_generator,
+        mysql2_connection
+      )
+
+      connection_options = { mysql_adapter: mysql2_connection }
+
+      ConnectionAdapters::DepartureAdapter.new(
+        runner,
+        logger,
+        connection_options,
+        config
+      )
+    end
+  end
+
+  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 initialize(connection, _logger, connection_options, _config)
+        @mysql_adapter = connection_options[:mysql_adapter]
+        super
+        @prepared_statements = false
+      end
+
+      def exec_delete(sql, name, binds)
+        execute(to_sql(sql, binds), name)
+        @connection.affected_rows
+      end
+      alias exec_update exec_delete
+
+      def exec_insert(sql, name, binds, pk = nil, sequence_name = nil) # rubocop:disable Lint/UnusedMethodArgument, Metrics/LineLength
+        execute(to_sql(sql, binds), name)
+      end
+
+      def exec_query(sql, name = 'SQL', _binds = [])
+        result = execute(sql, name)
+        ActiveRecord::Result.new(result.fields, result.to_a)
+      end
+
+      # Executes a SELECT query and returns an array of rows. Each row is an
+      # array of field values.
+
+      def select_rows(arel, name = nil, binds = [])
+        select_all(arel, name, binds).rows
+      end
+
+      # 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)
+      end
+
+      # Returns true, as this adapter supports migrations
+      def supports_migrations?
+        true
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+      def new_column(field, default, type_metadata, null, table_name, default_function, collation, comment)
+        Column.new(field, default, type_metadata, null, table_name, default_function, collation, comment)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      # 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 "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
+
+      # 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 "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
+
+      private
+
+      attr_reader :mysql_adapter
+    end
+  end
+end

data/lib/departure.rb

@@ -0,0 +1,43 @@
+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'
+require 'departure/cli_generator'
+require 'departure/logger'
+require 'departure/null_logger'
+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
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.load
+    # No-op left for compatibility
+  end
+end