percona-migrations 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 645a62ffc2dbbb400aab2434e5fa5662050a5976
+  data.tar.gz: 814f6e3fb1188855998cc3b71a48e7ef20afcd50
+SHA512:
+  metadata.gz: e12d2fa7700ae6ba3ccd05445a00977ba9589cb91c59f29eef4c8a15718b8d0b1c0dc24260c18699a5fd6f18060cbd8a6a2f1daeac08914de8e8e54f44251e84
+  data.tar.gz: f1b48e3ca541afe4273718cf314938a49f0a7b960d03281312643d6b4d65c10f115ff5770180dff3c54b726a6b6d84bfc7c81075f8107972cdcc24e06971c721

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sergey Varaksin
+
+MIT License
+
+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,55 @@
+# Percona Migrations
+
+Allows to use `pt-online-schema-change` for table changes in MySQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'percona-migrations'
+```
+
+Create `config/initializers/percona_migrations.rb` with:
+
+```ruby
+PerconaMigrations.database_config = ActiveRecord::Base.configurations[Rails.env]
+PerconaMigrations.allow_sql = !Rails.env.production?
+
+ActiveRecord::Migration.send :include, PerconaMigrations::HelperMethods
+```
+
+## Usage
+
+```ruby
+class AddAddressToUsers < ActiveRecord::Migration
+  def up
+    commands = columns.map { |name, type| "ADD COLUMN #{name} #{type}" }
+
+    percona_alter_table :users, commands
+  end
+
+  def down
+    commands = columns.map { |name, _| "DROP COLUMN #{name}" }
+
+    percona_alter_table :users, commands
+  end
+
+  private
+
+  def columns
+    { street: 'STRING(255)' },
+    { city:   'STRING(255)' },
+    { state:  'STRING(2)' },
+    { zip:    'STRING(10)' }
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/percona-migrations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/percona-migrations.rb

@@ -0,0 +1 @@
+require 'percona_migrations'

data/lib/percona_migrations.rb

@@ -0,0 +1,33 @@
+require 'percona_migrations/version'
+require 'percona_migrations/runners'
+require 'percona_migrations/helper_methods'
+
+require 'active_record'
+require 'logger'
+
+module PerconaMigrations
+  extend self
+
+  @allow_sql = true
+
+  attr_writer :database_config, :allow_sql, :logger
+
+  def database_config
+    @database_config || raise('PerconaMigrations.database_config is not set.')
+  end
+
+  def allow_sql?
+    !!@allow_sql
+  end
+
+  def logger
+    unless defined? @logger
+      @logger = Logger.new($stdout)
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "[percona-migrations] #{msg}\n"
+      end
+    end
+
+    @logger
+  end
+end

data/lib/percona_migrations/helper_methods.rb

@@ -0,0 +1,7 @@
+module PerconaMigrations
+  module HelperMethods
+    def percona_alter_table(*args)
+      PerconaMigrations::Runners.run(*args)
+    end
+  end
+end

data/lib/percona_migrations/runners.rb

@@ -0,0 +1,43 @@
+require 'percona_migrations/runners/base'
+require 'percona_migrations/runners/percona'
+require 'percona_migrations/runners/sql'
+
+module PerconaMigrations
+  module Runners
+    def self.run(*args)
+      runner_class = find_runner
+
+      unless runner_class
+        raise "No available migration runners found."
+      end
+
+      runner = runner_class.new(*args)
+      runner.run
+    end
+
+    def self.find_runner
+      if Runners::Percona.available?
+        Runners::Percona
+      else
+        log_percona_install_command
+        Runners::Sql if PerconaMigrations.allow_sql?
+      end
+    end
+
+    private
+
+    def self.log_percona_install_command
+      logger = PerconaMigrations.logger
+      return unless logger
+
+      logger.warn ""
+      logger.warn "*" * 80
+      logger.warn ""
+      logger.warn "`#{Runners::Percona::COMMAND}` command not found, please install percona tools:"
+      logger.warn "$ brew install percona-toolkit"
+      logger.warn ""
+      logger.warn "*" * 80
+      logger.warn ""
+    end
+  end
+end

data/lib/percona_migrations/runners/base.rb

@@ -0,0 +1,26 @@
+module PerconaMigrations
+  module Runners
+    class Base
+      def self.available?
+        true
+      end
+
+      def initialize(table_name, commands)
+        @table_name = table_name
+        @commands = commands
+      end
+
+      def run
+        raise NotImplementerError
+      end
+
+      def log(msg)
+        logger.info(msg) if logger
+      end
+
+      def logger
+        PerconaMigrations.logger
+      end
+    end
+  end
+end

data/lib/percona_migrations/runners/percona.rb

@@ -0,0 +1,50 @@
+module PerconaMigrations
+  module Runners
+    class Percona < Base
+      COMMAND = 'pt-online-schema-change'
+
+      def self.available?
+        !percona_command.empty?
+      end
+
+      def self.percona_command
+        @percona_command ||= %x(which #{COMMAND}).chop
+      end
+
+      def run
+        options = [
+          "--alter '#{@commands.join(', ')}'",
+          "-h #{database_config['host']}",
+          "-P #{database_config['port']}",
+          "-u #{database_config['username']}",
+          "D=#{database_config['database']},t=#{@table_name}"
+        ]
+
+        password = database_config['password']
+        if password && !password.empty?
+          options << "-p $PASSWORD"
+        end
+
+        run_command(options.join(' '), { 'PASSWORD' => password })
+      end
+
+      private
+
+      def database_config
+        PerconaMigrations.database_config
+      end
+
+      def run_command(options, env_vars = {})
+        %w(dry-run execute).each do |mode|
+          cmd = "#{self.class.percona_command} #{options} --#{mode}"
+
+          log "Running percona command: \"#{cmd}\""
+
+          unless system(env_vars, cmd)
+            raise "Percona command failed: #{$?}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/percona_migrations/runners/sql.rb

@@ -0,0 +1,25 @@
+module PerconaMigrations
+  module Runners
+    class Sql < Base
+      def run
+        @commands.each do |command|
+          run_command command
+        end
+      end
+
+      private
+
+      def run_command(command)
+        sql = "ALTER TABLE #{@table_name} #{command}"
+
+        log "Running SQL: \"#{sql}\""
+
+        conn.execute sql
+      end
+
+      def conn
+        @conn ||= ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/percona_migrations/version.rb

@@ -0,0 +1,3 @@
+module PerconaMigrations
+  VERSION = "0.0.2"
+end

data/percona-migrations.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'percona_migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "percona-migrations"
+  spec.version       = PerconaMigrations::VERSION
+  spec.authors       = ["Sergey Varaksin"]
+  spec.email         = ["varaksin86@gmail.com"]
+  spec.summary       = %q{Allows to use percona in rails migrations.}
+  spec.homepage      = "https://github.com/svarks/percona-migrations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 3.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'pry'
+end

data/spec/lib/percona_migrations/helper_methods_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe PerconaMigrations::HelperMethods do
+  subject do
+    klass = Class.new do
+      include PerconaMigrations::HelperMethods
+    end
+    klass.new
+  end
+
+  describe '#alter_table' do
+    it 'calls a method on PerconaMigrations' do
+      expect(PerconaMigrations::Runners).to receive(:run).with('users', ['add column name string(255)'])
+
+      subject.percona_alter_table('users', ['add column name string(255)'])
+    end
+  end
+end

data/spec/lib/percona_migrations/runner_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+RSpec.describe PerconaMigrations::Runners do
+  describe '::run' do
+    before do
+      expect(subject).to receive(:find_runner).and_return(runner_class)
+    end
+
+    context 'when runner is found' do
+      let(:runner_class) { PerconaMigrations::Runners::Percona }
+      let(:arguments) { [:arg1, :arg2, :arg3] }
+
+      it 'runs the runner' do
+        runner = double()
+        expect(runner_class).to receive(:new).with(*arguments).and_return(runner)
+        expect(runner).to receive(:run)
+
+        subject.run(*arguments)
+      end
+    end
+
+    context 'when runner is not found' do
+      let(:runner_class) { nil }
+
+      it 'throws an exception' do
+        expect { subject.run }.to raise_exception
+      end
+    end
+  end
+
+  describe '::find_runner' do
+    before do
+      expect(PerconaMigrations::Runners::Percona).to receive(:available?).and_return(percona_available)
+    end
+
+    context 'when percona is available' do
+      let(:percona_available) { true }
+
+      it 'returns percona runner if enabled' do
+        expect(subject.find_runner).to eq(PerconaMigrations::Runners::Percona)
+      end
+    end
+
+    context 'when percona is not available' do
+      let(:percona_available) { false }
+
+      context 'and sql is enabled' do
+        it 'returns sql runner' do
+          expect(subject.find_runner).to eq(PerconaMigrations::Runners::Sql)
+        end
+      end
+
+      context 'and sql is disabled' do
+        before do
+          allow(PerconaMigrations).to receive(:allow_sql?).and_return(false)
+        end
+        it 'returns nil' do
+          expect(subject.find_runner).to eq(nil)
+        end
+      end
+    end
+  end
+end

data/spec/lib/percona_migrations/runners/percona_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+RSpec.describe PerconaMigrations::Runners::Percona do
+  subject { described_class }
+
+  let(:percona_command) { '/bin/pt-online-schema-change' }
+
+  describe '::percona_command' do
+    it 'is looking for pt-online-schema-change in $PATH' do
+      expect(subject).to receive(:`).with('which pt-online-schema-change').and_return(percona_command + "\n")
+      expect(subject.percona_command).to eq(percona_command)
+    end
+  end
+
+  describe '::available?' do
+    it 'returns true when percona_command is present' do
+      expect(subject).to receive(:percona_command).and_return('/bin/percona')
+      expect(subject.available?).to eq(true)
+    end
+  end
+
+  describe '#run' do
+    let(:db_config) do
+      {
+        'host'     => 'localhost',
+        'port'     => '3306',
+        'username' => 'root',
+        'password' => 'test',
+        'database' => 'test-db'
+      }
+    end
+    let(:runner) { described_class.new('users', ['add column name string(255)']) }
+    let(:arguments) do
+      [
+        "--alter 'add column name string(255)'",
+        "-h localhost",
+        "-P 3306",
+        "-u root",
+        "D=test-db,t=users",
+        "-p $PASSWORD"
+      ]
+    end
+
+    before do
+      allow(PerconaMigrations).to receive(:database_config).and_return(db_config)
+      allow(subject).to receive(:percona_command).and_return(percona_command)
+    end
+
+    it 'runs percona command 2 times (dry-run and execute)' do
+      command = "#{percona_command} #{arguments.join(' ')}"
+
+      expect(runner).to receive(:system).
+        with({ 'PASSWORD' => 'test' }, "#{command} --dry-run").
+        and_return(true)
+
+      expect(runner).to receive(:system).
+        with({ 'PASSWORD' => 'test' }, "#{command} --execute").
+        and_return(true)
+
+      runner.run
+    end
+
+    it 'throws an exception if dry-run fails' do
+      expect(runner).to receive(:system).
+        with({ 'PASSWORD' => 'test' }, "#{percona_command} #{arguments.join(' ')} --dry-run").
+        and_return(false)
+
+      expect { runner.run }.to raise_exception
+    end
+  end
+end

data/spec/lib/percona_migrations/runners/sql_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe PerconaMigrations::Runners::Sql do
+  let(:conn) { double() }
+  let(:runner) do
+    described_class.new('users', [
+      'add column first_name string(255)',
+      'add column last_name string(255)',
+    ])
+  end
+
+  before do
+    allow(ActiveRecord::Base).to receive(:connection).and_return(conn)
+  end
+
+  describe '#run' do
+    it 'runs sql commands throuth ActiveRecord' do
+      expect(conn).to receive(:execute).with('ALTER TABLE users add column first_name string(255)')
+      expect(conn).to receive(:execute).with('ALTER TABLE users add column last_name string(255)')
+
+      runner.run
+    end
+  end
+end

data/spec/lib/percona_migrations_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe PerconaMigrations do
+  describe '::allow_sql?' do
+    it 'is true by default' do
+      expect(subject.allow_sql?).to eq(true)
+    end
+
+    it 'can be set to false' do
+      subject.allow_sql = false
+
+      expect(subject.allow_sql?).to eq(false)
+
+      subject.allow_sql = true
+    end
+  end
+
+  describe '::database_config' do
+    it 'throws an exception if not set' do
+      expect { subject.database_config }.to raise_exception
+    end
+
+    it 'returns config' do
+      config = { 'username' => 'test' }
+      subject.database_config = config
+
+      expect(subject.database_config).to eq(config)
+
+      subject.database_config = nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'percona_migrations'
+
+PerconaMigrations.logger = nil
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.order = :random
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: percona-migrations
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sergey Varaksin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- varaksin86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/percona-migrations.rb
+- lib/percona_migrations.rb
+- lib/percona_migrations/helper_methods.rb
+- lib/percona_migrations/runners.rb
+- lib/percona_migrations/runners/base.rb
+- lib/percona_migrations/runners/percona.rb
+- lib/percona_migrations/runners/sql.rb
+- lib/percona_migrations/version.rb
+- percona-migrations.gemspec
+- spec/lib/percona_migrations/helper_methods_spec.rb
+- spec/lib/percona_migrations/runner_spec.rb
+- spec/lib/percona_migrations/runners/percona_spec.rb
+- spec/lib/percona_migrations/runners/sql_spec.rb
+- spec/lib/percona_migrations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/svarks/percona-migrations
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows to use percona in rails migrations.
+test_files:
+- spec/lib/percona_migrations/helper_methods_spec.rb
+- spec/lib/percona_migrations/runner_spec.rb
+- spec/lib/percona_migrations/runners/percona_spec.rb
+- spec/lib/percona_migrations/runners/sql_spec.rb
+- spec/lib/percona_migrations_spec.rb
+- spec/spec_helper.rb