ghost_adapter 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74aed2db6347e0839ee599e4cc30d41f8261533d8926aa65a3fb97bdb0518348
-  data.tar.gz: 12e12bfd052ff336e2b2f9088e18554bdc00e7e0647f65254a33f6b32c9a6fd0
+  metadata.gz: 7a5270ce864f3b341d77d8185acd6ffe0f69b5c74d6334c86e9be29bce4bee02
+  data.tar.gz: 7647406246ef3276dc83a6f296b9c9a72e2b769ea3ad8f8b17063394540975c1
 SHA512:
-  metadata.gz: e0de5d2b1dc0162733d976379a2eaf3f892b1c189fe799619f5c6129bfa7a9e285748ce9076c095d471f8c29d4e194335087ee2becc615781c0e9ac76412b687
-  data.tar.gz: da399185e546d532a8b501b4a00c97dd1ade0611c438e444024cf8ad891ca77a024fab31de7c1feb1af0c9755749b95a556316cf730c50f22a98fda15f3b8bc5
+  metadata.gz: 16fb9da864e52fe07ecab35359ac06d1cd626acbe2640b70793aea63bbc55472cc9b7b3490b5416a5388248232eed282a60db356e900be1c75882ff5181efffe
+  data.tar.gz: a7b1f75edd691223e582bda09b10679b819644fdb42e673b0b61d8621250786597810d33f27edce9fa1f21257697dfcf8d5414813c537b3f562d43490c14adb8

data/.github/workflows/tests.yml

@@ -5,25 +5,50 @@ on:
     branches: [main]
   pull_request:
     branches: [main]
+  schedule:
+    - cron:  '45 */6 * * *'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
-
+        ruby-version:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+        gemfile:
+          - "gemfiles/activerecord-5.0.Gemfile"
+          - "gemfiles/activerecord-5.1.Gemfile"
+          - "gemfiles/activerecord-5.2.Gemfile"
+          - "gemfiles/activerecord-6.0.Gemfile"
+          - "gemfiles/activerecord-6.1.Gemfile"
+          - "gemfiles/activerecord-7.0.Gemfile"
+        exclude:
+          # Ruby 3 is not supported for ActiveRecord < 6.1
+          - ruby-version: "3.0"
+            gemfile: "gemfiles/activerecord-5.0.Gemfile"
+          - ruby-version: "3.0"
+            gemfile: "gemfiles/activerecord-5.1.Gemfile"
+          - ruby-version: "3.0"
+            gemfile: "gemfiles/activerecord-5.2.Gemfile"
+          - ruby-version: "3.0"
+            gemfile: "gemfiles/activerecord-6.0.Gemfile"
+          # Ruby >= 2.7 is required for ActiveRecord >= 7
+          - ruby-version: "2.5"
+            gemfile: "gemfiles/activerecord-7.0.Gemfile"
+          - ruby-version: "2.6"
+            gemfile: "gemfiles/activerecord-7.0.Gemfile"
     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
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Install gems
+        run: bundle install --gemfile ${{ matrix.gemfile }}
       - name: Run rubocop
         run: bundle exec rake rubocop
       - name: Run tests
-        run: bundle exec rake spec
+        run: bundle exec --gemfile ${{ matrix.gemfile }} rspec

data/.gitignore

@@ -8,3 +8,9 @@
 /spec/reports/
 /tmp/
 .byebug_history
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+**/*Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rubocop.yml

@@ -7,16 +7,36 @@ Style/Documentation:
 Style/RescueModifier:
   Enabled: false
 
+Layout/LineLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
 
+Metrics/ClassLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
+  Max: 150
+
 Metrics/MethodLength:
+  Max: 15
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
   IgnoredMethods:
     - build_ghost_command
     - mysql2_ghost_connection
 
 Metrics/ModuleLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
   Exclude:
     - lib/ghost_adapter/config.rb
 

data/CHANGELOG.md

@@ -1,11 +1,26 @@
 # CHANGELOG
 
+## 0.4.0
+- Add support for ActiveRecord 7 ([#67](https://github.com/WeTransfer/ghost_adapter/pull/67))
+
+## 0.3.0
+- Fix compatibility for ActiveRecord 6.1 ([#61](https://github.com/WeTransfer/ghost_adapter/pull/61))
+
+## 0.2.3
+- Add comma to allowed characters when cleaning SQL queries ([#52](https://github.com/WeTransfer/ghost_adapter/pull/52))
+
+## 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.
+- Add templating to configuration values. See [the docs](./docs/config/templating.md) for more info on how to use this feature.
 
 ## 0.1.4
 

data/CONTRIBUTORS.md

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

data/README.md

@@ -5,13 +5,13 @@
 [![Gem](https://img.shields.io/gem/v/ghost_adapter)](https://rubygems.org/gems/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:
 

data/gemfiles/activerecord-5.0.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 5.0.0'
+
+gemspec path: '../'

data/gemfiles/activerecord-5.1.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 5.1.0'
+
+gemspec path: '../'

data/gemfiles/activerecord-5.2.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 5.2.0'
+
+gemspec path: '../'

data/gemfiles/activerecord-6.0.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 6.0.0'
+
+gemspec path: '../'

data/gemfiles/activerecord-6.1.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 6.1.0'
+
+gemspec path: '../'

data/gemfiles/activerecord-7.0.Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 7.0'
+
+gemspec path: '../'

data/ghost_adapter.gemspec

@@ -14,15 +14,16 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # 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)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|doc|bin)/}) }
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 5'
+  spec.add_dependency 'activerecord', '>= 5', '<= 7.0'
   spec.add_dependency 'mysql2', '>= 0.4.0', '< 0.6.0'
 
   spec.add_development_dependency 'bump', '~> 0'

data/lib/active_record/connection_adapters/mysql2_ghost_adapter.rb

@@ -55,14 +55,47 @@ 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
+      if Gem.loaded_specs['activerecord'].version >= Gem::Version.new('6.1')
+        def add_index(table_name, column_name, **options)
+          index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)
+          return if if_not_exists && index_exists?(table_name, column_name, name: index.name)
+
+          index_type = index.type&.to_s&.upcase || (index.unique ? 'UNIQUE' : nil)
+
+          sql = build_add_index_sql(
+            table_name, quoted_columns(index), index.name,
+            index_type: index_type,
+            using: index.using,
+            algorithm: algorithm
+          )
+
+          execute sql
+        end
+
+        def remove_index(table_name, column_name = nil, **options)
+          return if options[:if_exists] && !index_exists?(table_name, column_name, **options)
+
+          index_name = index_name_for_remove(table_name, column_name, options)
+          execute "ALTER TABLE #{quote_table_name(table_name)} DROP INDEX #{quote_column_name(index_name)}"
+        end
+      else
+        def add_index(table_name, column_name, options = {})
+          index_name, index_type, index_columns, _index_options = add_index_options(table_name, column_name, options)
 
-      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)}"
+          sql = build_add_index_sql(
+            table_name, index_columns, index_name,
+            index_type: index_type&.upcase,
+            using: options[:using]
+          )
+
+          execute sql
+        end
+
+        def remove_index(table_name, options = {})
+          options = { column: options } unless options.is_a?(Hash)
+          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
       end
 
       private
@@ -70,7 +103,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
@@ -111,6 +144,25 @@ module ActiveRecord
         INSERT_SCHEMA_MIGRATION_PATTERN =~ sql ||
           DROP_SCHEMA_MIGRATION_PATTERN =~ sql
       end
+
+      def build_add_index_sql(table_name, column_names, index_name, # rubocop:disable Metrics/ParameterLists
+                              index_type: nil, using: nil, algorithm: nil)
+        sql = %w[ALTER TABLE]
+        sql << quote_table_name(table_name)
+        sql << 'ADD'
+        sql << index_type
+        sql << 'INDEX'
+        sql << quote_column_name(index_name)
+        sql << "USING #{using}" if using
+        sql << "(#{column_names})"
+        sql << algorithm
+
+        sql.compact.join(' ').gsub(/\s+/, ' ')
+      end
+
+      def quoted_columns(index)
+        index.columns.is_a?(String) ? index.columns : quoted_columns_for_index(index.columns, index.column_options)
+      end
     end
   end
 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

data/lib/ghost_adapter/version.rb

@@ -1,3 +1,3 @@
 module GhostAdapter
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_adapter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -147,11 +153,15 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTORS.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- bin/console
+- gemfiles/activerecord-5.0.Gemfile
+- gemfiles/activerecord-5.1.Gemfile
+- gemfiles/activerecord-5.2.Gemfile
+- gemfiles/activerecord-6.0.Gemfile
+- gemfiles/activerecord-6.1.Gemfile
+- gemfiles/activerecord-7.0.Gemfile
 - ghost_adapter.gemspec
 - lib/active_record/connection_adapters/mysql2_ghost_adapter.rb
 - lib/generators/ghost_adapter/install_generator.rb
@@ -171,6 +181,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/wetransfer/ghost_adapter
   source_code_uri: https://github.com/wetransfer/ghost_adapter
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -186,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Run ActiveRecord migrations through gh-ost

data/Gemfile.lock

@@ -1,82 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ghost_adapter (0.2.1)
-      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)
-      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)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    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)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    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)
-      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)
-  byebug (~> 11.1)
-  ghost_adapter!
-  rake (~> 13.0)
-  rspec (~> 3)
-  rubocop (~> 1)
-
-BUNDLED WITH
-   2.2.7

data/bin/console

@@ -1,14 +0,0 @@
-#!/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__)