ghost_adapter 0.0.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16360adbdcaec4bfe137c537c3895a3d7ec75284f43711b17da3985874c337e1
-  data.tar.gz: 6eb5e12eab95103791e86ae42be79a40aed252b86ca802e683942ec0ee5d2396
+  metadata.gz: 1cabaf83939ee711ed1679803274084bedf6598c2711d69bfeee19cb404a0add
+  data.tar.gz: e42e338f2c2afc2ea448fc9e14fb5132781b9afedcf1c097131e39a935efcb15
 SHA512:
-  metadata.gz: 206bede0e5fb5087a16b56fef1787060b072cd234e1101ba14c8d4b41efac55b15dcd43ce3a5d72dbcf0723c9d3d930a1042bbcd540d26b59459bdaa9fb7c585
-  data.tar.gz: 1edd7c6b056e355eabd320cabe30eec22699b1c0a91c8c12aff6ccaf348a5cfd130ab1e978d423e55c7c4f034658af8d9918ee15e4beeb8168d55e9b6d064822
+  metadata.gz: 80eb4f5803734e3a599c165df1b22fa6892db6fd685d6aa59fc445a072376fad3e8e4fb8535dce94c44af9aced1ec34594a33270b4c0457b0826a11c8e9f6263
+  data.tar.gz: d2ef0fa71b5a429e1cddbe99c1432f047ac4842636f6cb58551416ff88f05d8a7d6ff3b1303c3a2769fb68aee95850b749f9b9831154f15bb2b4e66e2dba19a9

data/.github/workflows/ruby.yml

@@ -0,0 +1,29 @@
+name: Ruby
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run rubocop
+        run: bundle exec rake rubocop
+      - name: Run tests
+        run: bundle exec rake spec

data/.gitignore

@@ -1,3 +1,5 @@
+.rspec_status
+.DS_Store
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -5,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/.rubocop.yml

@@ -9,13 +9,17 @@ Style/RescueModifier:
 
 Metrics/BlockLength:
   Exclude:
-    - test/**/*_test.rb
+    - spec/**/*_spec.rb
 
 Metrics/MethodLength:
   IgnoredMethods:
     - build_ghost_command
     - mysql2_ghost_connection
 
+Metrics/ModuleLength:
+  Exclude:
+    - lib/ghost_adapter/config.rb
+
 Metrics/AbcSize:
   IgnoredMethods:
     - build_ghost_command

data/.travis.yml

@@ -20,6 +20,6 @@ jobs:
       script:
         - bundle exec rake rubocop
     - stage: Tests
-      name: Run minitest
+      name: Run specs
       script:
-        - bundle exec rake test
+        - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+## 0.1.4
+
+- Fix bug caused by missing `require 'open3'` that occurs for some ruby versions
+
+## 0.1.3
+
+- Fix bug [#26](https://github.com/WeTransfer/ghost_adapter/issues/26) causing environment configuration to be overwritten by some other configuration methods.
+
+## 0.1.2
+
+- Fix bug [#28](https://github.com/WeTransfer/ghost_adapter/issues/28) that resulted in add_index and remove_index calls to not run through `gh-ost`

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    ghost_adapter (0.0.2)
+    ghost_adapter (0.1.4)
       activerecord (>= 5)
+      mysql2 (>= 0.4.0, < 0.6.0)
 
 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)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -20,10 +21,13 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     bump (0.10.0)
+    byebug (11.1.3)
     concurrent-ruby (1.1.8)
-    i18n (1.8.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
+    mysql2 (0.5.3)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -31,6 +35,19 @@ GEM
     rake (13.0.3)
     regexp_parser (2.0.3)
     rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (1.8.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -55,9 +72,10 @@ PLATFORMS
 DEPENDENCIES
   bump (~> 0)
   bundler (~> 2)
+  byebug (~> 11.1)
   ghost_adapter!
-  minitest (~> 5.14)
   rake (~> 13.0)
+  rspec (~> 3)
   rubocop (~> 1)
 
 BUNDLED WITH

data/README.md

@@ -2,11 +2,10 @@
 
 ![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)
+[![Gem](https://img.shields.io/gem/v/ghost_adapter)](https://rubygems.org/gems/ghost_adapter)
+[![Build Status](https://travis-ci.com/WeTransfer/ghost_adapter.svg?branch=main)](https://travis-ci.com/WeTransfer/ghost_adapter)
+[![Hippocratic License](https://img.shields.io/badge/license-Hippocratic-green)](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)](https://github.com/github/gh-ost/releases/latest)
 
 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.
 

data/Rakefile

@@ -1,14 +1,8 @@
 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 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
-task default: %i[test rubocop]
+task default: %i[spec rubocop]

data/ghost_adapter.gemspec

@@ -23,10 +23,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activerecord', '>= 5'
+  spec.add_dependency 'mysql2', '>= 0.4.0', '< 0.6.0'
 
   spec.add_development_dependency 'bump', '~> 0'
   spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'byebug', '~> 11.1'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rubocop', '~> 1'
 end

data/lib/active_record/connection_adapters/mysql2_ghost_adapter.rb

@@ -1,8 +1,6 @@
 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
@@ -56,6 +54,16 @@ module ActiveRecord
         end
       end
 
+      def add_index(table_name, column_name, options = {})
+        index_name, index_type, index_columns, index_options = add_index_options(table_name, column_name, options)
+        execute "ALTER TABLE #{quote_table_name(table_name)} ADD #{index_type} INDEX #{quote_column_name(index_name)} (#{index_columns})#{index_options}" # rubocop:disable Layout/LineLength
+      end
+
+      def remove_index(table_name, options = {})
+        index_name = index_name_for_remove(table_name, options)
+        execute "ALTER TABLE #{quote_table_name(table_name)} DROP INDEX #{quote_column_name(index_name)}"
+      end
+
       private
 
       attr_reader :database, :dry_run

data/lib/ghost_adapter.rb

@@ -1,3 +1,8 @@
+require 'active_record'
+require 'active_support/all'
+
+require 'active_record/connection_adapters/mysql2_ghost_adapter'
+
 require 'ghost_adapter/config'
 
 require 'ghost_adapter/railtie' if defined? ::Rails::Railtie
@@ -8,11 +13,21 @@ module GhostAdapter
   end
 
   def self.setup(options = {})
-    @@config = GhostAdapter::Config.new(options) # rubocop:disable Style/ClassVars
+    new_config = GhostAdapter::Config.new(options)
+
+    if defined? @@config
+      @@config.merge!(new_config)
+    else
+      @@config = new_config # rubocop:disable Style/ClassVars
+    end
 
     yield @@config if block_given?
   end
 
+  def self.clear_config
+    @@config = GhostAdapter::Config.new # rubocop:disable Style/ClassVars
+  end
+
   module Internal
     @@ghost_migration_enabled = false # rubocop:disable Style/ClassVars
 

data/lib/ghost_adapter/config.rb

@@ -78,10 +78,14 @@ module GhostAdapter
                    user
                    verbose].freeze
   Config = Struct.new(*CONFIG_KEYS, keyword_init: true) do
-    def initialize(options = {})
+    def merge!(other_config)
+      other_config.compact.each { |k, v| self[k] = v }
+      self
+    end
+
+    def with_env
       env_config = EnvParser.new(ENV).config
-      config_options = options.merge(env_config)
-      super(config_options)
+      compact.merge(env_config)
     end
 
     def compact
@@ -89,16 +93,20 @@ module GhostAdapter
     end
 
     def as_args
-      compact.map do |key, value|
-        next unless value  # Skip both false and null values
+      with_env.map { |key, value| arg(key, value) }.compact
+    end
+
+    private
+
+    def arg(key, value)
+      return unless value
 
-        hyphenated_key = key.to_s.gsub('_', '-')
-        if value == true
-          "--#{hyphenated_key}"
-        else
-          "--#{hyphenated_key}=#{value}"
-        end
-      end.compact
+      hyphenated_key = key.to_s.gsub('_', '-')
+      if value == true
+        "--#{hyphenated_key}"
+      else
+        "--#{hyphenated_key}=#{value}"
+      end
     end
   end
 end

data/lib/ghost_adapter/env_parser.rb

@@ -7,6 +7,9 @@ module GhostAdapter
         next unless ghost_key?(key)
 
         config_key = convert_env_key(key)
+
+        next unless GhostAdapter::CONFIG_KEYS.include?(config_key)
+
         config_value = convert_env_value(value)
 
         [config_key, config_value]
@@ -20,7 +23,7 @@ module GhostAdapter
     end
 
     def convert_env_key(key)
-      key.gsub('GHOST_', '').downcase
+      key.gsub('GHOST_', '').downcase.to_sym
     end
 
     def convert_env_value(value)

data/lib/ghost_adapter/version.rb

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

data/lib/ghost_adapter/version_checker.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 module GhostAdapter
   class IncompatibleVersion < StandardError
     def initialize(version = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_adapter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -104,10 +138,12 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - ".vscode/settings.json"
+- CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - CONTRIBUTORS.md
@@ -151,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Run ActiveRecord migrations through gh-ost