percona_migrator 0.1.0.rc.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bda957042f0b8003133ed8fddcc2b0e1dd227f75
-  data.tar.gz: 733e11a6c52f6354b353f9866796a431e2045188
+  metadata.gz: 59ecf09f58f8aa46d64cf996a2a91a8acfa6dc8b
+  data.tar.gz: 24daf3f8ba0bd51f1804b23857a0a94d4d345bfc
 SHA512:
-  metadata.gz: 76f26f49d302c27433b1ff95f3ea277e431b1da805f139f2ed1ec57839978d907e6f8d719c5897183a71c7049fe9b81e354ceebd511fe52613f7fd2cab3fbc8e
-  data.tar.gz: 01233203b600ee1f851a4bc2d0820ebd618f4018286fdda856db53fad1ae7e83673edb81126759a62d796f290d76359eb3797f995d6cf2db924c17fc1681700a
+  metadata.gz: 1b1e0e1b42bcf64cd145a34882de830b572e9aabfcd3616a03bf7f81d1545864ca91951b1217f0bbf78191d41aeaa1b29761e3542fa7c110abff1823e4c845ff
+  data.tar.gz: 02eae12611279a35d0cfaf243c1cda0a883c8ad91c792fea9ae11826b1b49e208eb6fa0da434f68706560fcc5ecf7535c5e9b3e366c406d010b53766aded8e27

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .byebug_history
 tags
+percona_migrator_error.log

data/.travis.yml

@@ -2,12 +2,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 -
+  - 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
   - bin/setup
+after_success:
+  - codeclimate-test-reporter
 
 branches:
   only:

data/CHANGELOG.md

@@ -6,6 +6,31 @@ Please follow the format in [Keep a Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+### Added
+### Changed
+### Removed
+### Fixed
+
+## [0.1.1] - 2017-03-10
+
+### Added
+
+- 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.
+- Output a deprecation warning when installing and running the gem. It will be
+    replaced by Departure soon.
+
+### Changed
+
+- No longer a hard dependency on mysql2 0.3.20. Will accept 0.3.20 or any
+    higher patch revisions.
+
+### Fixed
+
+- Output pt-online-schema-change's stdout while the migration is running instead
+    of all of it at the end.
+
 ## [0.1.0.rc.7] - 2016-09-15
 
 ### Added

data/Gemfile

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

data/README.md

@@ -1,6 +1,6 @@
-# Percona Migrator [![Build Status](https://travis-ci.org/redbooth/percona_migrator.svg?branch=master)](https://travis-ci.org/redbooth/percona_migrator) [![Code Climate](https://codeclimate.com/github/redbooth/percona_migrator/badges/gpa.svg)](https://codeclimate.com/github/redbooth/percona_migrator)
+# Departure [![Build Status](https://travis-ci.org/redbooth/departure.svg?branch=master)](https://travis-ci.org/redbooth/percona_migrator) [![Code Climate](https://codeclimate.com/github/redbooth/percona_migrator/badges/gpa.svg)](https://codeclimate.com/github/redbooth/percona_migrator)
 
-Percona Migrator is an **ActiveRecord connection adapter** that allows running
+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.
 
@@ -9,9 +9,17 @@ It uses `pt-online-schema-change` command-line tool of
 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
 
-Percona Migrator relies on `pt-online-schema-change` from [Percona
+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
@@ -62,15 +70,28 @@ migration.
 ### LHM support
 
 If you moved to Soundcloud's [Lhm](https://github.com/soundcloud/lhm) already,
-we got you covered. Percona Migrator overrides Lhm's DSL so that all the alter
+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
+PerconaMigrator.configure do |config|
+  config.tmp_path = '/tmp/'
+end
+```
+
+It's strongly recommended to name it after this gems name, such as
+`config/initializers/percona_migrator.rb`
+
 ## How it works
 
-When booting your Rails app, Percona Migrator extends the
+When booting your Rails app, Departure extends the
 `ActiveRecord::Migration#migrate` method to reset the connection and reestablish
 it using the `PerconaAdapter` instead of the one you defined in your
 `config/database.yml`.

data/lib/percona_migrator/configuration.rb

@@ -0,0 +1,18 @@
+module PerconaMigrator
+  class Configuration
+    attr_accessor :tmp_path
+
+    def initialize
+      @tmp_path = '.'.freeze
+      @error_log_filename = 'percona_migrator_error.log'.freeze
+    end
+
+    def error_log_path
+      File.join(tmp_path, error_log_filename)
+    end
+
+    private
+
+    attr_reader :error_log_filename
+  end
+end

data/lib/percona_migrator/errors.rb

@@ -0,0 +1,35 @@
+module PerconaMigrator
+  class Error < StandardError; end
+
+  # Used when for whatever reason we couldn't get the spawned process'
+  # status.
+  class NoStatusError < Error
+    def message
+      'Status could not be retrieved'.freeze
+    end
+  end
+
+  # Used when the spawned process failed by receiving a signal.
+  # pt-online-schema-change returns "SIGSEGV (signal 11)" on failures.
+  class SignalError < Error
+    attr_reader :status
+
+    # Constructor
+    #
+    # @param status [Process::Status]
+    def initialize(status)
+      super
+      @status = status
+    end
+
+    def message
+      status.to_s
+    end
+  end
+
+  class CommandNotFoundError < Error
+    def message
+      'Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details'
+    end
+  end
+end

data/lib/percona_migrator/logger.rb

@@ -1,7 +1,8 @@
 module PerconaMigrator
-  # Copies the ActiveRecord::Migration #say and #write to log the migration's
-  # status. It's not possible to reuse the from ActiveRecord::Migration because
-  # the migration's instance can't be seen from the connection adapter.
+  # Copies the ActiveRecord::Migration #say and #write plus a new
+  # #write_no_newline to log the migration's status. It's not possible to reuse
+  # the from ActiveRecord::Migration because the migration's instance can't be
+  # seen from the connection adapter.
   class Logger
 
     # Outputs the message through the stdout, following the
@@ -13,11 +14,18 @@ module PerconaMigrator
       write "#{subitem ? "   ->" : "--"} #{message}"
     end
 
-    # Outputs the text through the stdout
+    # Outputs the text through the stdout adding a new line at the end
     #
     # @param text [String]
     def write(text = '')
       puts(text)
     end
+
+    # Outputs the text through the stdout without adding a new line at the end
+    #
+    # @param text [String]
+    def write_no_newline(text)
+      print(text)
+    end
   end
 end

data/lib/percona_migrator/null_logger.rb

@@ -7,5 +7,9 @@ module PerconaMigrator
     def write(_text)
       # noop
     end
+
+    def write_no_newline(_text)
+      # noop
+    end
   end
 end

data/lib/percona_migrator/railtie.rb

@@ -15,40 +15,13 @@ module PerconaMigrator
     # regular Rails Migration DSL.
     initializer 'percona_migrator.configure_rails_initialization' do
       ActiveSupport.on_load(:active_record) do
+        PerconaMigrator.load
+      end
+    end
 
-        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
-          # PerconaMigratorAdapter to support foreign keys
-          def include_foreigner
-            Foreigner::Adapter.safe_include(
-              :PerconaMigratorAdapter,
-              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
-            ActiveRecord::Base.establish_connection(
-              connection_config.merge(adapter: 'percona')
-            )
-          end
-        end
+    initializer 'percona_migrator.configure' do |app|
+      PerconaMigrator.configure do |config|
+        config.tmp_path = app.paths['tmp'].first
       end
     end
   end

data/lib/percona_migrator/runner.rb

@@ -1,39 +1,6 @@
 require 'open3'
 
 module PerconaMigrator
-  class Error < StandardError; end
-
-  # Used when for whatever reason we couldn't get the spawned process'
-  # status.
-  class NoStatusError < Error
-    def message
-      'Status could not be retrieved'.freeze
-    end
-  end
-
-  # Used when the spawned process failed by receiving a signal.
-  # pt-online-schema-change returns "SIGSEGV (signal 11)" on failures.
-  class SignalError < Error
-    attr_reader :status
-
-    # Constructor
-    #
-    # @param status [Process::Status]
-    def initialize(status)
-      super
-      @status = status
-    end
-
-    def message
-      status.to_s
-    end
-  end
-
-  class CommandNotFoundError < Error
-    def message
-      'Please install pt-online-schema-change. Check: https://www.percona.com/doc/percona-toolkit for further details'
-    end
-  end
 
   # It executes pt-online-schema-change commands in a new process and gets its
   # output and status
@@ -46,11 +13,12 @@ module PerconaMigrator
     # @param cli_generator [CliGenerator]
     # @param mysql_adapter [ActiveRecord::ConnectionAdapter] it must implement
     #   #execute and #raw_connection
-    def initialize(logger, cli_generator, mysql_adapter)
+    def initialize(logger, cli_generator, mysql_adapter, config = PerconaMigrator.configuration)
       @logger = logger
       @cli_generator = cli_generator
       @mysql_adapter = mysql_adapter
       @status = nil
+      @config = config
     end
 
     # Executes the passed sql statement using pt-online-schema-change for ALTER
@@ -88,8 +56,7 @@ module PerconaMigrator
 
     private
 
-    attr_reader :command, :logger, :status, :error_message, :cli_generator,
-      :mysql_adapter
+    attr_reader :command, :logger, :status, :cli_generator, :mysql_adapter, :config
 
     # Checks whether the sql statement is an ALTER TABLE
     #
@@ -103,11 +70,17 @@ module PerconaMigrator
     #
     # @yield
     def logging
+      log_deprecations
       log_started
       yield
       log_finished
     end
 
+    def log_deprecations
+      logger.write("\n")
+      logger.write("[DEPRECATION] This gem has been renamed to Departure and will no longer be supported. Please switch to Departure as soon as possible.")
+    end
+
     # Logs when the execution started
     def log_started
       logger.write("\n")
@@ -116,10 +89,18 @@ module PerconaMigrator
 
     # Executes the command and prints its output to the stdout
     def run_command
-      Open3.popen3(command) do |_stdin, stdout, stderr, waith_thr|
-        @status = waith_thr.value
-        @error_message = stderr.read
-        logger.write(stdout.read)
+      Open3.popen3("#{command} 2> #{error_log_path}") do |_stdin, stdout, _stderr, waith_thr|
+        begin
+          loop do
+            IO.select([stdout])
+            data = stdout.read_nonblock(8)
+            logger.write_no_newline(data)
+          end
+        rescue EOFError
+          # noop
+        ensure
+          @status = waith_thr.value
+        end
       end
     end
 
@@ -129,7 +110,6 @@ module PerconaMigrator
     # @raise [SignalError] if the spawned process received a signal
     # @raise [CommandNotFoundError] if pt-online-schema-change can't be found
     def validate_status
-      raise NoStatusError if status.nil?
       raise SignalError.new(status) if status.signaled?
       raise CommandNotFoundError if status.exitstatus == COMMAND_NOT_FOUND
       raise Error, error_message unless status.success?
@@ -140,5 +120,17 @@ module PerconaMigrator
     def log_finished
       logger.write("\n")
     end
+
+    # The path where the percona toolkit stderr will be written
+    #
+    # @return [String]
+    def error_log_path
+      config.error_log_path
+    end
+
+    # @return [String]
+    def error_message
+      File.read(error_log_path)
+    end
   end
 end

data/lib/percona_migrator/version.rb

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

data/lib/percona_migrator.rb

@@ -7,8 +7,59 @@ require 'percona_migrator/cli_generator'
 require 'percona_migrator/logger'
 require 'percona_migrator/null_logger'
 require 'percona_migrator/logger_factory'
+require 'percona_migrator/configuration'
+require 'percona_migrator/errors'
 
 require 'percona_migrator/railtie' if defined?(Rails)
 
+# We need the OS not to buffer the IO to see pt-osc's output while migrating
+$stdout.sync = true
+
 module PerconaMigrator
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    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
+      # PerconaMigratorAdapter to support foreign keys
+      def include_foreigner
+        Foreigner::Adapter.safe_include(
+          :PerconaMigratorAdapter,
+          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
+        ActiveRecord::Base.establish_connection(
+          connection_config.merge(adapter: 'percona')
+        )
+      end
+    end
+  end
 end

data/percona_migrator.gemspec

@@ -15,12 +15,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://github.com/redbooth/percona_migrator'
   spec.license       = 'MIT'
 
+  spec.post_install_message = <<-MESSAGE
+  !    The Percona_migrator gem has been deprecated and has been replaced by Departure.
+  !    See: https://rubygems.org/gems/departure
+  !    And: https://github.com/redbooth/departure
+  MESSAGE
+
   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_runtime_dependency 'mysql2', '~>0.3.20'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percona_migrator
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Ilya Zayats
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,14 +31,14 @@ dependencies:
   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
@@ -154,6 +154,8 @@ files:
 - lib/percona_migrator.rb
 - lib/percona_migrator/alter_argument.rb
 - lib/percona_migrator/cli_generator.rb
+- lib/percona_migrator/configuration.rb
+- lib/percona_migrator/errors.rb
 - lib/percona_migrator/logger.rb
 - lib/percona_migrator/logger_factory.rb
 - lib/percona_migrator/null_logger.rb
@@ -166,7 +168,10 @@ homepage: http://github.com/redbooth/percona_migrator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+    !    The Percona_migrator gem has been deprecated and has been replaced by Departure.
+    !    See: https://rubygems.org/gems/departure
+    !    And: https://github.com/redbooth/departure
 rdoc_options: []
 require_paths:
 - lib
@@ -177,12 +182,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: pt-online-schema-change runner for ActiveRecord migrations