ghost_adapter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16360adbdcaec4bfe137c537c3895a3d7ec75284f43711b17da3985874c337e1
+  data.tar.gz: 6eb5e12eab95103791e86ae42be79a40aed252b86ca802e683942ec0ee5d2396
+SHA512:
+  metadata.gz: 206bede0e5fb5087a16b56fef1787060b072cd234e1101ba14c8d4b41efac55b15dcd43ce3a5d72dbcf0723c9d3d930a1042bbcd540d26b59459bdaa9fb7c585
+  data.tar.gz: 1edd7c6b056e355eabd320cabe30eec22699b1c0a91c8c12aff6ccaf348a5cfd130ab1e978d423e55c7c4f034658af8d9918ee15e4beeb8168d55e9b6d064822

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+## Checklist:
+
+- [ ] My code follows the style guidelines set by rubocop
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have checked my code and corrected any misspellings

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,31 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*_test.rb
+
+Metrics/MethodLength:
+  IgnoredMethods:
+    - build_ghost_command
+    - mysql2_ghost_connection
+
+Metrics/AbcSize:
+  IgnoredMethods:
+    - build_ghost_command
+    - mysql2_ghost_connection
+
+Metrics/PerceivedComplexity:
+  IgnoredMethods:
+    - mysql2_ghost_connection
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5
+  NewCops: enable

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm: 2.7
+
+cache:
+  bundler: true
+
+before_install:
+  - bundle install --jobs=3 --path=${BUNDLE_PATH:-vendor/bundle}
+
+stages:
+  - name: Rubocop
+    if: type = pull_request OR branch = main
+  - name: Tests
+    if: type = pull_request OR branch = main
+
+jobs:
+  include:
+    - stage: Rubocop
+      name: Run rubocop
+      script:
+        - bundle exec rake rubocop
+    - stage: Tests
+      name: Run minitest
+      script:
+        - bundle exec rake test

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "solargraph.autoformat": true,
+  "solargraph.formatting": true
+  
+}

data/CODEOWNERS

@@ -0,0 +1,5 @@
+# https://help.github.com/en/articles/about-code-owners
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, they
+# will be requested for review when someone opens a PR.
+*       @acroos

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at austin.roos@wetransfer.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- @acroos (Austin C. Roos, austin.roos@wetransfer.com)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    ghost_adapter (0.0.2)
+      activerecord (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    bump (0.10.0)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bump (~> 0)
+  bundler (~> 2)
+  ghost_adapter!
+  minitest (~> 5.14)
+  rake (~> 13.0)
+  rubocop (~> 1)
+
+BUNDLED WITH
+   2.2.6

data/LICENSE.md

@@ -0,0 +1,33 @@
+Copyright 2021 WeTransfer
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+- Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+- Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+- Compliance with Human Rights Principles and Human Rights Laws.
+
+  1. Human Rights Principles.
+
+     (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+     (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+     Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+  2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws. “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above). Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+  3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+- Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+- Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+- Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,81 @@
+# Ghost Adapter
+
+![ghost](./doc/images/ghost.png)
+
+![gem version](https://img.shields.io/gem/v/ghost_adapter)
+![travis](https://img.shields.io/travis/com/wetransfer/ghost_adapter)
+![Hippocratic License](https://img.shields.io/badge/license-Hippocratic-green?link=https://github.com/WeTransfer/ghost_adapter/blob/main/LICENSE.md)
+![gh-ost version](https://img.shields.io/badge/gh--ost%20version-1.1.0-blue?link=https://github.com/github/gh-ost/releases/latest)
+![depfu](https://img.shields.io/depfu/wetransfer/ghost_adapter)
+
+A tiny, _very configurable_ ActiveRecord adapter built for running [gh-ost](https://github.com/github/gh-ost) migrations. When not running migrations, it'll stay the heck out of the way.
+
+## Installation
+
+First, you'll need to install `gh-ost`. You can find the latest release [here](https://github.com/github/gh-ost/releases/latest). You can check the allowed version range in [the version checker](./lib/ghost_adapter/version_checker.rb#L13) (current range: [>= 1.1, < 2]). Once you've got that installed, install the gem!
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ghost_adapter'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+### Connect with ActiveRecord
+
+Configure your ActiveRecord connection to use `mysql2_ghost` as the adapter in whichever environments you'd like to use `gh-ost`.
+
+For a standard rails project, in `config/database.yml` set `adapter: mysql2_ghost`.
+
+For usage with `DATABASE_URL`, only a _very tiny_ modification is necessary. The URL should be like: `mysql2-ghost://` (notice the `-` instead of `_`). This is because the scheme of a URI must either alphanumeric or one of [`-`, `.`, `+`] ([more details](https://tools.ietf.org/html/rfc3986#section-3.1))
+
+### Configuration
+
+You can configure `ghost_adapter` with (nearly) all of the arguments allowed `gh-ost` in the command line. The arguments are up to date as of `gh-ost` version 1.1.0.
+
+Read more about configuration methods in [the docs](./doc/configuration.md).
+
+### Running Migrations
+
+Since most database activity isn't a migration, we default to identical behavior to the Mysql2Adapter. No need to be executing a bunch of extra logic per query when you're only getting any value for migrations.
+
+To enable the ghost adapter, you have two options. First (recommended) is to use the provided rails generator:
+
+```shell
+rails g ghost_adapter:install
+```
+
+This does everything you need. All migrations will run through gh-ost and otherwise the adapter will be ignored.
+
+Alternatively, you can enable (or disable) gh-ost migrations with an environment variable.
+
+```shell
+GHOST_MIGRATE=1 rake db:...
+```
+
+If you have used the rails generator, you can set the variable to a falsey value and it will override the behavior not to use gh-ost.
+
+- "truthy" values: `[1, t, true, y, yes]`
+- "falsey" values: `[0, f, false, n, no]`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wetransfer/ghost_adapter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
+Please add your name to the [CONTRIBUTORS.md](./CONTRIBUTORS.md)
+
+## License
+
+The gem is available as open source under the terms of the [Hippocratic License](https://firstdonoharm.dev/version/2/1/license.html).
+
+## Code of Conduct
+
+Everyone interacting in the Ghost Adapter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).
+
+---
+
+Illustration by <a href="undefined">Icons 8</a> from <a href="https://icons8.com/">Icons8</a>

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ghost_adapter'
+
+# 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(__FILE__)

data/ghost_adapter.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/ghost_adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ghost_adapter'
+  spec.version       = GhostAdapter::VERSION
+  spec.authors       = ['Austin C Roos']
+  spec.email         = ['austin.roos@wetransfer.com']
+
+  spec.summary       = 'Run ActiveRecord migrations through gh-ost'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/wetransfer/ghost_adapter'
+  spec.license       = 'Hippocratic'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|doc)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5'
+
+  spec.add_development_dependency 'bump', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1'
+end

data/lib/active_record/connection_adapters/mysql2_ghost_adapter.rb

@@ -0,0 +1,107 @@
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'ghost_adapter/migrator'
+require 'ghost_adapter/version_checker'
+
+gem 'mysql2', '>= 0.4.4', '< 0.6.0'
+require 'mysql2'
+
+module ActiveRecord
+  module ConnectionHandling
+    # Establishes a connection to the database that's used by all Active Record objects.
+    def mysql2_ghost_connection(config)
+      config = config.symbolize_keys
+      config[:flags] ||= 0
+
+      if config[:flags].is_a? Array
+        config[:flags].push 'FOUND_ROWS'.freeze
+      else
+        config[:flags] |= Mysql2::Client::FOUND_ROWS
+      end
+
+      client = Mysql2::Client.new(config)
+      if GhostAdapter::Internal.ghost_migration_enabeld?
+        dry_run = ENV['DRY_RUN'] == '1'
+        GhostAdapter::VersionChecker.validate_executable! unless ENV['SKIP_GHOST_VERSION_CHECK'] == '1'
+        ConnectionAdapters::Mysql2GhostAdapter.new(client, logger, nil, config, dry_run: dry_run)
+      else
+        ConnectionAdapters::Mysql2Adapter.new(client, logger, nil, config)
+      end
+    rescue Mysql2::Error => e
+      raise ActiveRecord::NoDatabaseError if e.message.include?('Unknown database')
+
+      raise
+    end
+  end
+
+  module ConnectionAdapters
+    class Mysql2GhostAdapter < Mysql2Adapter
+      ADAPTER_NAME = 'mysql2_ghost'.freeze
+
+      def initialize(connection, logger, connection_options, config, dry_run: false)
+        super(connection, logger, connection_options, config)
+        @database = config[:database]
+        @dry_run = dry_run
+      end
+
+      def execute(sql, name = nil)
+        # Only ALTER TABLE statements are automatically skipped by gh-ost
+        # We need to manually skip CREATE TABLE, DROP TABLE, and
+        # INSERT/DELETE (to schema migrations) for dry runs
+        return if dry_run && should_skip_for_dry_run?(sql)
+
+        if (table, query = parse_sql(sql))
+          GhostAdapter::Migrator.execute(table, query, database, dry_run)
+        else
+          super(sql, name)
+        end
+      end
+
+      private
+
+      attr_reader :database, :dry_run
+
+      ALTER_TABLE_PATTERN = /\AALTER\s+TABLE\W*(?<table_name>\w+)\W*(?<query>.*)$/i.freeze
+      QUERY_ALLOWABLE_CHARS = /[^0-9a-z_\s():'"{}]/i.freeze
+      CREATE_TABLE_PATTERN = /\Acreate\stable/i.freeze
+      DROP_TABLE_PATTERN = /\Acreate\stable/i.freeze
+      INSERT_SCHEMA_MIGRATION_PATTERN = /\Ainsert\sinto\s`schema_migrations`/i.freeze
+      DROP_SCHEMA_MIGRATION_PATTERN = /\Adelete\sfrom\s`schema_migrations`/i.freeze
+
+      def parse_sql(sql)
+        capture = sql.match(ALTER_TABLE_PATTERN)
+        return if capture.nil?
+
+        captured_names = capture.names
+        return unless captured_names.include? 'table_name'
+        return unless captured_names.include? 'query'
+
+        [capture[:table_name], clean_query(capture[:query])]
+      end
+
+      def clean_query(query)
+        cleaned = query.gsub(QUERY_ALLOWABLE_CHARS, '')
+        cleaned.gsub('"', '\"')
+      end
+
+      def should_skip_for_dry_run?(sql)
+        if create_or_drop_table?(sql)
+          puts 'Skipping CREATE TABLE or DROP TABLE for dry run'
+          puts 'SQL:'
+          puts sql
+        end
+
+        create_or_drop_table?(sql) || schema_migration_update?(sql)
+      end
+
+      def create_or_drop_table?(sql)
+        CREATE_TABLE_PATTERN =~ sql ||
+          DROP_TABLE_PATTERN =~ sql
+      end
+
+      def schema_migration_update?(sql)
+        INSERT_SCHEMA_MIGRATION_PATTERN =~ sql ||
+          DROP_SCHEMA_MIGRATION_PATTERN =~ sql
+      end
+    end
+  end
+end

data/lib/generators/ghost_adapter/install_generator.rb

@@ -0,0 +1,12 @@
+module GhostAdapter
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy ghost_adapter_setup rakefile for automatic ghost migration'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_task
+        template 'ghost_adapter_setup.rake', 'lib/tasks/ghost_adapter_setup.rake'
+      end
+    end
+  end
+end

data/lib/generators/ghost_adapter/templates/ghost_adapter_setup.rake

@@ -0,0 +1,4 @@
+require 'ghost_adapter'
+
+# Enable ghost_adapter for all rake migrations
+GhostAdapter::Internal.load_task

data/lib/ghost_adapter.rb

@@ -0,0 +1,38 @@
+require 'ghost_adapter/config'
+
+require 'ghost_adapter/railtie' if defined? ::Rails::Railtie
+
+module GhostAdapter
+  def self.config
+    @@config ||= GhostAdapter::Config.new # rubocop:disable Style/ClassVars
+  end
+
+  def self.setup(options = {})
+    @@config = GhostAdapter::Config.new(options) # rubocop:disable Style/ClassVars
+
+    yield @@config if block_given?
+  end
+
+  module Internal
+    @@ghost_migration_enabled = false # rubocop:disable Style/ClassVars
+
+    def self.load_task
+      return if @loaded
+
+      load File.join(File.dirname(__FILE__), 'tasks', 'ghost_adapter.rake')
+
+      @loaded = true
+    end
+
+    def self.enable_ghost_migration!
+      @@ghost_migration_enabled = true # rubocop:disable Style/ClassVars
+    end
+
+    def self.ghost_migration_enabeld?
+      env_val = ENV['GHOST_MIGRATE']&.downcase
+      return false if %w[0 n no f false].include?(env_val)
+
+      !!@@ghost_migration_enabled || %w[1 y yes t true].include?(env_val)
+    end
+  end
+end

data/lib/ghost_adapter/command.rb

@@ -0,0 +1,44 @@
+module GhostAdapter
+  class Command
+    def initialize(alter:, table:, database: nil, dry_run: false)
+      @alter = alter
+      @table = table
+      @database = GhostAdapter.config.database || database
+      @dry_run = dry_run
+      validate_args_and_config!
+    end
+
+    def to_a
+      [
+        EXECUTABLE,
+        *base_args,
+        *GhostAdapter.config.as_args,
+        *execute_arg
+      ]
+    end
+
+    private
+
+    EXECUTABLE = 'gh-ost'.freeze
+
+    attr_reader :alter, :database, :table, :dry_run
+
+    def validate_args_and_config!
+      raise ArgumentError, 'alter cannot be nil' if alter.nil?
+      raise ArgumentError, 'table cannot be nil' if table.nil?
+      raise ArgumentError, 'database cannot be nil' if database.nil?
+    end
+
+    def base_args
+      [
+        "--alter=#{alter}",
+        "--table=#{table}",
+        "--database=#{database}"
+      ]
+    end
+
+    def execute_arg
+      dry_run ? [] : ['--execute']
+    end
+  end
+end

data/lib/ghost_adapter/config.rb

@@ -0,0 +1,104 @@
+require 'ghost_adapter/env_parser'
+
+module GhostAdapter
+  CONFIG_KEYS = %i[aliyun_rds
+                   allow_master_master
+                   allow_nullable_unique_key
+                   allow_on_master
+                   approve_renamed_columns
+                   assume_master_host
+                   assume_rbr
+                   check_flag
+                   chunk_size
+                   concurrent_rowcount
+                   conf
+                   critical_load
+                   critical_load_hibernate_seconds
+                   critical_load_interval_millis
+                   cut_over
+                   cut_over_exponential_backoff
+                   cut_over_lock_timeout_seconds
+                   database
+                   debug
+                   default_retries
+                   discard_foreign_keys
+                   dml_batch_size
+                   exact_rowcount
+                   exponential_backoff_max_interval
+                   force_named_cut_over
+                   force_named_panic
+                   force_table_names
+                   gcp
+                   heartbeat_interval_millis
+                   hooks_hint
+                   hooks_hint_owner
+                   hooks_hint_token
+                   hooks_path
+                   host
+                   ignore_http_errors
+                   initially_drop_ghost_table
+                   initially_drop_old_table
+                   initially_drop_socket_file
+                   master_password
+                   master_user
+                   max_lag_millis
+                   max_load
+                   migrate_on_replica
+                   mysql_timeout
+                   nice_ratio
+                   ok_to_drop_table
+                   panic_flag_file
+                   password
+                   port
+                   postpone_cut_over_flag_file
+                   quiet
+                   replica_server_id
+                   replication_lag_query
+                   serve_socket_file
+                   serve_tcp_port
+                   skip_foreign_key_checks
+                   skip_renamed_columns
+                   skip_strict_mode
+                   ssl
+                   ssl_allow_insecure
+                   ssl_ca
+                   ssl_cert
+                   ssl_key
+                   stack
+                   switch_to_rbr
+                   test_on_replica
+                   test_on_replica_skip_replica_stop
+                   throttle_additional_flag_file
+                   throttle_control_replicas
+                   throttle_flag_file
+                   throttle_http
+                   throttle_query
+                   timestamp_old_table
+                   tungsten
+                   user
+                   verbose].freeze
+  Config = Struct.new(*CONFIG_KEYS, keyword_init: true) do
+    def initialize(options = {})
+      env_config = EnvParser.new(ENV).config
+      config_options = options.merge(env_config)
+      super(config_options)
+    end
+
+    def compact
+      to_h.compact
+    end
+
+    def as_args
+      compact.map do |key, value|
+        next unless value  # Skip both false and null values
+
+        hyphenated_key = key.to_s.gsub('_', '-')
+        if value == true
+          "--#{hyphenated_key}"
+        else
+          "--#{hyphenated_key}=#{value}"
+        end
+      end.compact
+    end
+  end
+end

data/lib/ghost_adapter/env_parser.rb

@@ -0,0 +1,57 @@
+module GhostAdapter
+  class EnvParser
+    attr_reader :config
+
+    def initialize(env = {})
+      @config = env.map do |key, value|
+        next unless ghost_key?(key)
+
+        config_key = convert_env_key(key)
+        config_value = convert_env_value(value)
+
+        [config_key, config_value]
+      end.compact.to_h
+    end
+
+    private
+
+    def ghost_key?(key)
+      key.start_with?('GHOST_') && (key != 'GHOST_MIGRATE')
+    end
+
+    def convert_env_key(key)
+      key.gsub('GHOST_', '').downcase
+    end
+
+    def convert_env_value(value)
+      num_val = try_to_i_env(value) || try_to_f_env(value)
+      return num_val unless num_val.nil?
+
+      bool_val = try_to_bool_env(value)
+      return bool_val unless bool_val.nil?
+
+      value
+    end
+
+    def try_to_i_env(value)
+      return unless /\A[0-9]+$/ =~ value
+
+      value.to_i
+    end
+
+    def try_to_f_env(value)
+      return unless /\A[0-9]*\.[0-9]+$/ =~ value
+
+      value.to_f
+    end
+
+    def try_to_bool_env(value)
+      lowered = value.downcase
+      return true if %w[yes y true t].include? lowered
+
+      return false if %w[no n false f].include? lowered
+
+      nil
+    end
+  end
+end

data/lib/ghost_adapter/migrator.rb

@@ -0,0 +1,26 @@
+require 'ghost_adapter/command'
+
+module GhostAdapter
+  class MigrationError < StandardError
+    def initialize(exit_code)
+      super("gh-ost migration failed. exit code: #{exit_code}")
+    end
+  end
+
+  class Migrator
+    def self.execute(table, query, database, dry_run)
+      command = GhostAdapter::Command.new(
+        alter: query, table: table, database: database, dry_run: dry_run
+      )
+      Open3.popen2e(*command.to_a) do |_stdin, stdout_stderr, wait_thread|
+        stdout_stderr.each_line do |line|
+          puts "[gh-ost]:\t\t#{line}"
+        end
+
+        raise MigrationError, wait_thread.value.exitstatus unless wait_thread.value.success?
+      end
+      # A little buffer time in case of consecutive alter table commands
+      sleep 5
+    end
+  end
+end

data/lib/ghost_adapter/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module GhostAdapter
+  class Railtie < Rails::Railtie
+    config.ghost_adapter = ActiveSupport::OrderedOptions.new
+
+    initializer 'ghost_adapter.configure' do |app|
+      GhostAdapter.setup(app.config.ghost_adapter.to_h)
+    end
+  end
+end

data/lib/ghost_adapter/version.rb

@@ -0,0 +1,3 @@
+module GhostAdapter
+  VERSION = '0.0.2'.freeze
+end

data/lib/ghost_adapter/version_checker.rb

@@ -0,0 +1,35 @@
+module GhostAdapter
+  class IncompatibleVersion < StandardError
+    def initialize(version = nil)
+      message = %(
+#{version.nil? ? 'gh-ost not installed' : "gh-ost incompatible version #{version} installed."}
+please install version: [#{VersionChecker::ALLOWED_RANGE}]
+for latest release, visit: https://github.com/github/gh-ost/releases/latest)
+      super(message)
+    end
+  end
+
+  class VersionChecker
+    ALLOWED_RANGE = Gem::Requirement.new('>= 1.1.0', '< 2')
+
+    class << self
+      def validate_executable!
+        found_version = fetch_version
+        raise IncompatibleVersion, found_version unless ALLOWED_RANGE.satisfied_by? found_version
+      end
+
+      private
+
+      def fetch_version
+        stdout, status = Open3.capture2('gh-ost', '--version')
+        raise IncompatibleVersion unless status.success?
+
+        begin
+          Gem::Version.new(stdout)
+        rescue ArgumentError
+          raise IncompatibleVersion
+        end
+      end
+    end
+  end
+end

data/lib/tasks/ghost_adapter.rake

@@ -0,0 +1,21 @@
+migration_tasks = %w[db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback]
+
+# Rails 6 supports multi-database setups
+if defined?(Rails::Application) && Rails.version.split('.').first.to_i >= 6
+  require 'active_record'
+
+  databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
+
+  # the db:migrate tasks each have a separate command for migrating a single database
+  ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |spec_name|
+    migration_tasks.concat(%w[db:migrate db:migrate:up db:migrate:down].map { |task| "#{task}:#{spec_name}" })
+  end
+end
+
+migration_tasks.each do |task|
+  Rake::Task[task].enhance([:ghost_adapter_exec])
+end
+
+task ghost_adapter_exec: :environment do
+  GhostAdapter::Internal.enable_ghost_migration!
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: ghost_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Austin C Roos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Run ActiveRecord migrations through gh-ost
+email:
+- austin.roos@wetransfer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".vscode/settings.json"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- CONTRIBUTORS.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- ghost_adapter.gemspec
+- lib/active_record/connection_adapters/mysql2_ghost_adapter.rb
+- lib/generators/ghost_adapter/install_generator.rb
+- lib/generators/ghost_adapter/templates/ghost_adapter_setup.rake
+- lib/ghost_adapter.rb
+- lib/ghost_adapter/command.rb
+- lib/ghost_adapter/config.rb
+- lib/ghost_adapter/env_parser.rb
+- lib/ghost_adapter/migrator.rb
+- lib/ghost_adapter/railtie.rb
+- lib/ghost_adapter/version.rb
+- lib/ghost_adapter/version_checker.rb
+- lib/tasks/ghost_adapter.rake
+homepage: https://github.com/wetransfer/ghost_adapter
+licenses:
+- Hippocratic
+metadata:
+  homepage_uri: https://github.com/wetransfer/ghost_adapter
+  source_code_uri: https://github.com/wetransfer/ghost_adapter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Run ActiveRecord migrations through gh-ost
+test_files: []