percona_ar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 010f7f273259e09c3015a47dab02ad0d4b6a2011
+  data.tar.gz: a27b2a053febc0cb026370830d890daa3d3ae60a
+SHA512:
+  metadata.gz: 54e9295eb40eae2aa6f9a3d0c78e17f6c12957a215b3feecd3254ea868b8fc02a22458567d7f6639404282589eb4472c323a8ff782cd2d0aeb157571d681d620
+  data.tar.gz: 215e6bd600e0ee695208ac87fa2b4d957277a67bfdb7684c640762b8d20e88e300ab98c981a5ad06143043d80dc5497ead41f5efb8d5209e9a90642f62742675

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6
+
+services:
+  - mysql
+
+before_script:
+  - mysql -e 'create database myapp_test;'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in percona_ar_migration.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Mac William
+
+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,63 @@
+# PerconaAr
+
+[![Build
+Status](https://travis-ci.org/jamesmacwilliam/percona_ar.svg?branch=master)](https://travis-ci.org/jamesmacwilliam/percona_ar)
+
+This gem adds another tool in your belt for rails migrations.  You can
+stil generate migrations, and they will function just as they always
+have, but there is also the option of generating percona_ar migrations,
+which use the percona tool for ALTER statements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'percona_ar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install percona_ar
+
+## Dependencies
+
+this tool relies on `pt-online-schema-change` being available from where
+the migration is run.
+
+https://www.percona.com/doc/percona-toolkit/2.1/pt-online-schema-change.html
+
+## Usage
+
+- to get started, run: `rails generate percona_ar SomeMigrationName`
+
+- open the file in the db/migrate directory and use it just like you would
+  a normal rails migration
+
+- The ALTER commands will get run by pt-online-schema-change, and all
+  other commands get run by ActiveRecord just like they normally would
+
+- All the usual rails migration things still apply, your schema updates
+  still get kept track of wherever you usually have that done,
+  version gets added to schema_migrations, and rails yells at you if you
+  haven't yet migrated.
+
+## 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/[USERNAME]/percona_ar_migration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "percona_ar_migration"
+
+# 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
+
+# Do any other automated setup that you need to do here

data/lib/generators/percona_ar/percona_ar_generator.rb

@@ -0,0 +1,16 @@
+class PerconaArGenerator < Rails::Generators::NamedBase
+  def create_percona_file
+    create_file(filename, <<-EOT)
+class #{name} < PerconaAr::Migration
+  def change
+    # ALTER commands will get run by the Percona tool,
+    # all other commands will get run by ActiveRecord
+  end
+end
+    EOT
+  end
+
+  def filename
+    "db/migrate/#{Time.now.strftime("%Y%m%d%H%M%S")}_#{name.underscore}.rb"
+  end
+end

data/lib/percona_ar/connection.rb

@@ -0,0 +1,26 @@
+class PerconaAr::Connection < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+  def initialize(conn)
+    super(
+      conn.instance_variable_get(:@connection),
+      Logger.new("/dev/null"),
+      conn.instance_variable_get(:@connection_options),
+      conn.instance_variable_get(:@config)
+    )
+  end
+
+  def execute(sql, name = nil)
+    return super unless sql =~ /^ALTER TABLE.*/
+    PerconaAr::PtOnlineSchemaChangeExecutor.new(sql).call
+  end
+
+  def not_implemented(*args)
+    raise NotImplementedError.new(
+      "This is not implemented with the percona tool, please use a standard migration"
+    )
+  end
+
+  alias :create_table          :not_implemented
+  alias :remove_table          :not_implemented
+  alias :change_table          :not_implemented
+  alias :create_join_table     :not_implemented
+end

data/lib/percona_ar/migration.rb

@@ -0,0 +1,6 @@
+class PerconaAr::Migration < ActiveRecord::Migration
+  def connection
+    @percona_connection ||=
+      PerconaAr::Connection.new(ActiveRecord::Base.connection)
+  end
+end

data/lib/percona_ar/pt_online_schema_change_executor.rb

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/file_utils'
+
+class PerconaAr::PtOnlineSchemaChangeExecutor
+  include FileUtils
+
+  attr_accessor :sql
+
+  def initialize(sql)
+    @sql = sql
+  end
+
+  def call
+    if sql =~ /^ALTER TABLE `([^`]*)` (.*)/i
+      sh "#{boilerplate}#{suffix($1, $2)}"
+    end
+  end
+
+  private
+
+  def suffix(table, cmd)
+    "'#{cmd}' --recursion-method processlist --no-check-alter --execute D=#{config[:database]},t=#{table}"
+
+  end
+
+  def boilerplate
+    "pt-online-schema-change -u '#{config[:username]}' -h '#{config[:host]}' -p '#{config[:password]}' --alter "
+  end
+
+  def config
+    ActiveRecord::Base.connection_config
+  end
+end

data/lib/percona_ar/version.rb

@@ -0,0 +1,3 @@
+module PerconaAr
+  VERSION = "0.1.0"
+end

data/lib/percona_ar.rb

@@ -0,0 +1,10 @@
+require "mysql2"
+require "active_record"
+require "active_record/connection_adapters/mysql2_adapter"
+require "percona_ar/version"
+require "percona_ar/pt_online_schema_change_executor"
+require "percona_ar/connection"
+require "percona_ar/migration"
+
+module PerconaAr
+end

data/percona_ar.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'percona_ar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "percona_ar"
+  spec.version       = PerconaAr::VERSION
+  spec.authors       = ["James Mac William"]
+  spec.email         = ["jimmy.macwilliam@gmail.com"]
+
+  spec.summary       = %q{Use Percona (pt-online-schema-change) for migrations generated with this tool, all activerecord helpers are available.}
+  spec.homepage      = "https://github.com/jamesmacwilliam/percona_ar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rails",   ">= 4.0.0"
+  spec.add_development_dependency "mysql2",  ">= 0.3.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: percona_ar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Mac William
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-25 00:00:00.000000000 Z
+dependencies:
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
+- jimmy.macwilliam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/percona_ar/percona_ar_generator.rb
+- lib/percona_ar.rb
+- lib/percona_ar/connection.rb
+- lib/percona_ar/migration.rb
+- lib/percona_ar/pt_online_schema_change_executor.rb
+- lib/percona_ar/version.rb
+- percona_ar.gemspec
+homepage: https://github.com/jamesmacwilliam/percona_ar
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Use Percona (pt-online-schema-change) for migrations generated with this
+  tool, all activerecord helpers are available.
+test_files: []
+has_rdoc: