ghost_adapter 0.1.4 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cabaf83939ee711ed1679803274084bedf6598c2711d69bfeee19cb404a0add
-  data.tar.gz: e42e338f2c2afc2ea448fc9e14fb5132781b9afedcf1c097131e39a935efcb15
+  metadata.gz: 2a5f29780a337090d7ba06e77f8e1ce6c6976f5869ec0065e8ab0dfb0f1cc04a
+  data.tar.gz: 2e7bcdb40edcd0cd958c7be99fcc5c31e4a121a8c5c05c70549e6cee3ac63389
 SHA512:
-  metadata.gz: 80eb4f5803734e3a599c165df1b22fa6892db6fd685d6aa59fc445a072376fad3e8e4fb8535dce94c44af9aced1ec34594a33270b4c0457b0826a11c8e9f6263
-  data.tar.gz: d2ef0fa71b5a429e1cddbe99c1432f047ac4842636f6cb58551416ff88f05d8a7d6ff3b1303c3a2769fb68aee95850b749f9b9831154f15bb2b4e66e2dba19a9
+  metadata.gz: 9dedd0ba573c4abed8d55744cb7f87c6154969d7daa7cc283077c6077d6b690a1ade38e30a8e208fc4584f8b9622d9cf866fbef67bfb1ac8f3f8c3872e8e27f0
+  data.tar.gz: 0b352f02462f55a3cb362a87526b0cca3b47985eb7659e85ce60d40ba2d93766d3be589afe90f17091ee3e82818c76528738b4223c0c25598e48bae6e5791f09

data/.github/workflows/{ruby.yml → tests.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Tests
 
 on:
   push:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 0.2.2
+
+- Bump rexml from 3.2.4 to 3.2.5 (security fix) ([#35](https://github.com/WeTransfer/ghost_adapter/pull/35))
+- Add azure configuration option now available with gh-ost v1.1.1 ([#36](https://github.com/WeTransfer/ghost_adapter/pull/36))
+
+## 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

data/CONTRIBUTORS.md

@@ -1 +1,2 @@
 - @acroos (Austin C. Roos, austin.roos@wetransfer.com)
+- @grdw (Gerard Westerhof, gerard@wetransfer.com)

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    ghost_adapter (0.1.4)
+    ghost_adapter (0.2.3)
       activerecord (>= 5)
       mysql2 (>= 0.4.0, < 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    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)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -22,19 +22,19 @@ GEM
     ast (2.4.2)
     bump (0.10.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     mysql2 (0.5.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -48,17 +48,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.8.1)
+    rubocop (1.21.0)
       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)
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -79,4 +79,4 @@ DEPENDENCIES
   rubocop (~> 1)
 
 BUNDLED WITH
-   2.2.6
+   2.2.7

data/README.md

@@ -3,15 +3,15 @@
 ![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)
+[![gh-ost version](https://img.shields.io/badge/gh--ost%20version-1.1.1-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.
 
 ## 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!
+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.0, < 2]). Once you've got that installed, install the gem!
 
 Add this line to your application's Gemfile:
 
@@ -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/lib/active_record/connection_adapters/mysql2_ghost_adapter.rb

@@ -1,4 +1,5 @@
 require 'active_record/connection_adapters/mysql2_adapter'
+require 'ghost_adapter'
 require 'ghost_adapter/migrator'
 require 'ghost_adapter/version_checker'
 require 'mysql2'
@@ -69,7 +70,7 @@ module ActiveRecord
       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
+      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

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

@@ -8,6 +8,7 @@ module GhostAdapter
                    approve_renamed_columns
                    assume_master_host
                    assume_rbr
+                   azure
                    check_flag
                    chunk_size
                    concurrent_rowcount
@@ -92,21 +93,30 @@ module GhostAdapter
       to_h.compact
     end
 
-    def as_args
-      with_env.map { |key, value| arg(key, value) }.compact
+    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)
+    def arg(key, value, context)
       return unless value
 
       hyphenated_key = key.to_s.gsub('_', '-')
       if value == true
         "--#{hyphenated_key}"
       else
-        "--#{hyphenated_key}=#{value}"
+        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 =~ /<%=.*%>/
+
+      ERB.new(value).result_with_hash(context)
+    end
   end
 end

data/lib/ghost_adapter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.3
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -138,10 +138,9 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".vscode/settings.json"
 - CHANGELOG.md
 - CODEOWNERS
@@ -187,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Run ActiveRecord migrations through gh-ost

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 specs
-      script:
-        - bundle exec rake spec