ghost_adapter 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cabaf83939ee711ed1679803274084bedf6598c2711d69bfeee19cb404a0add
-  data.tar.gz: e42e338f2c2afc2ea448fc9e14fb5132781b9afedcf1c097131e39a935efcb15
+  metadata.gz: 70c1ceb8f7c2ca8a3cdf0bd71a2bc0d3c8b7701acf8dd4ee5f1d5c80adef5b7c
+  data.tar.gz: 802ccf5c7a692c6647fdf313fd70e8f0f67d889ecaef8dab4c39f721557057be
 SHA512:
-  metadata.gz: 80eb4f5803734e3a599c165df1b22fa6892db6fd685d6aa59fc445a072376fad3e8e4fb8535dce94c44af9aced1ec34594a33270b4c0457b0826a11c8e9f6263
-  data.tar.gz: d2ef0fa71b5a429e1cddbe99c1432f047ac4842636f6cb58551416ff88f05d8a7d6ff3b1303c3a2769fb68aee95850b749f9b9831154f15bb2b4e66e2dba19a9
+  metadata.gz: 5bdf26f1667220ff862464a362b62af21dafc065f254adf9a9d41be1cd81a98ddb6b1639af7bfd61cbd05a9a2fb47673bf15f7025e3a13209a530d9b449ed7d5
+  data.tar.gz: 6f1e6a8d0ea9d5b654ae6eec9ea8cdb176a87ff1d668f4ff26f08b27a7af29c97ba2052882f10a8df62de91623962e1bc7b4dcfe300ab05aeb491365e36c27e1

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

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ghost_adapter (0.1.4)
+    ghost_adapter (0.2.0)
       activerecord (>= 5)
       mysql2 (>= 0.4.0, < 0.6.0)
 

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/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

@@ -92,21 +92,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.0'.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.0
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-02 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

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