ghost_adapter 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba1dbba1a2d2d06fed7d8af232da57bd48cb3f0a4656586c93e54122b555d04
-  data.tar.gz: 6f4b53a62c983f97c5e515084ee1d59025cd03c28ad5d194da36d79ff5d0b803
+  metadata.gz: 74aed2db6347e0839ee599e4cc30d41f8261533d8926aa65a3fb97bdb0518348
+  data.tar.gz: 12e12bfd052ff336e2b2f9088e18554bdc00e7e0647f65254a33f6b32c9a6fd0
 SHA512:
-  metadata.gz: cdf902df84f0196767cd37bbcefe52d4de56d1695a55912a154f3ccb7bcdac7e744d46af91907ed4eb268a0164ccbe90c48d52a80348a27f25a0962444eda0fd
-  data.tar.gz: 5a9a407c9f663fd92f59be8f6d72d727be22018bfab082cd1c44789f11df4c88be6a662f30f1a4c11a3bc796537dad6a96e469acdd1299f44ba2c2f57e84ca64
+  metadata.gz: e0de5d2b1dc0162733d976379a2eaf3f892b1c189fe799619f5c6129bfa7a9e285748ce9076c095d471f8c29d4e194335087ee2becc615781c0e9ac76412b687
+  data.tar.gz: da399185e546d532a8b501b4a00c97dd1ade0611c438e444024cf8ad891ca77a024fab31de7c1feb1af0c9755749b95a556316cf730c50f22a98fda15f3b8bc5

data/.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+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/

data/.rubocop.yml

@@ -9,7 +9,7 @@ Style/RescueModifier:
 
 Metrics/BlockLength:
   Exclude:
-    - test/**/*_test.rb
+    - spec/**/*_spec.rb
 
 Metrics/MethodLength:
   IgnoredMethods:

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+## 0.2.1
+- Fix bug caused by missing `require 'ghost_adapter'` for non-rails apps ([#34](https://github.com/WeTransfer/ghost_adapter/pull/34))
+
+## 0.2.0
+
+- Add templating to configuration values.  See [the docs](./docs/config/templating.md) for more info on how to use this feature.
+
+## 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.1.1)
+    ghost_adapter (0.2.1)
       activerecord (>= 5)
+      mysql2 (>= 0.4.0, < 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    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)
@@ -22,9 +23,11 @@ GEM
     bump (0.10.0)
     byebug (11.1.3)
     concurrent-ruby (1.1.8)
-    i18n (1.8.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       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)
@@ -32,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)
@@ -58,9 +74,9 @@ DEPENDENCIES
   bundler (~> 2)
   byebug (~> 11.1)
   ghost_adapter!
-  minitest (~> 5.14)
   rake (~> 13.0)
+  rspec (~> 3)
   rubocop (~> 1)
 
 BUNDLED WITH
-   2.2.6
+   2.2.7

data/README.md

@@ -3,7 +3,7 @@
 ![ghost](./doc/images/ghost.png)
 
 [![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)
+![GitHub Actions Workflow](https://github.com/WeTransfer/ghost_adapter/actions/workflows/tests.yml/badge.svg)
 [![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)
 
@@ -31,7 +31,7 @@ Configure your ActiveRecord connection to use `mysql2_ghost` as the adapter in w
 
 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))
+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 be either alphanumeric or one of [`-`, `.`, `+`] ([more details](https://tools.ietf.org/html/rfc3986#section-3.1))
 
 ### Configuration
 
@@ -41,7 +41,7 @@ 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.
+Since most database activity isn't a migration, we default to just using 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:
 

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,11 +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 'byebug', '~> 11.1'
-  spec.add_development_dependency 'minitest', '~> 5.14'
   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,7 @@
 require 'active_record/connection_adapters/mysql2_adapter'
+require 'ghost_adapter'
 require 'ghost_adapter/migrator'
 require 'ghost_adapter/version_checker'
-
-gem 'mysql2', '>= 0.4.4', '< 0.6.0'
 require 'mysql2'
 
 module ActiveRecord
@@ -56,6 +55,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

data/lib/ghost_adapter/command.rb

@@ -1,3 +1,5 @@
+require 'English'
+
 module GhostAdapter
   class Command
     def initialize(alter:, table:, database: nil, dry_run: false)
@@ -12,7 +14,7 @@ module GhostAdapter
       [
         EXECUTABLE,
         *base_args,
-        *GhostAdapter.config.as_args,
+        *config_args,
         *execute_arg
       ]
     end
@@ -37,6 +39,18 @@ module GhostAdapter
       ]
     end
 
+    def config_args
+      context = {
+        pid: $PID,
+        table: table,
+        database: database,
+        timestamp: Time.now.utc.to_i,
+        unique_id: SecureRandom.uuid
+      }
+
+      GhostAdapter.config.as_args(context: context)
+    end
+
     def execute_arg
       dry_run ? [] : ['--execute']
     end

data/lib/ghost_adapter/config.rb

@@ -78,32 +78,44 @@ module GhostAdapter
                    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 merge!(other_config)
       other_config.compact.each { |k, v| self[k] = v }
       self
     end
 
+    def with_env
+      env_config = EnvParser.new(ENV).config
+      compact.merge(env_config)
+    end
+
     def compact
       to_h.compact
     end
 
-    def as_args
-      compact.map do |key, value|
-        next unless value  # Skip both false and null values
+    def as_args(context: {})
+      full_context = context.merge(compact)
+      with_env.map { |key, value| arg(key, value, full_context) }.compact
+    end
+
+    private
+
+    def arg(key, value, context)
+      return unless value
+
+      hyphenated_key = key.to_s.gsub('_', '-')
+      if value == true
+        "--#{hyphenated_key}"
+      else
+        substituted_value = substitute_value(value, context)
+        "--#{hyphenated_key}=#{substituted_value}"
+      end
+    end
+
+    def substitute_value(value, context)
+      return value unless value.is_a? String
+      return value unless value =~ /<%=.*%>/
 
-        hyphenated_key = key.to_s.gsub('_', '-')
-        if value == true
-          "--#{hyphenated_key}"
-        else
-          "--#{hyphenated_key}=#{value}"
-        end
-      end.compact
+      ERB.new(value).result_with_hash(context)
     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.1.1'.freeze
+  VERSION = '0.2.1'.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.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-13 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
@@ -67,33 +87,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '11.1'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -118,10 +138,11 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".vscode/settings.json"
+- CHANGELOG.md
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - CONTRIBUTORS.md

data/.travis.yml

@@ -1,25 +0,0 @@
-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