ghost_adapter 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a5f29780a337090d7ba06e77f8e1ce6c6976f5869ec0065e8ab0dfb0f1cc04a
-  data.tar.gz: 2e7bcdb40edcd0cd958c7be99fcc5c31e4a121a8c5c05c70549e6cee3ac63389
+  metadata.gz: b3ea686449861456ca4af2d1131a05a2a3b93d902204735d7e4d9b08db5558ce
+  data.tar.gz: dd72fcde19d24978fbdc164de6b8484b1ed5af236cb518276328134e116468df
 SHA512:
-  metadata.gz: 9dedd0ba573c4abed8d55744cb7f87c6154969d7daa7cc283077c6077d6b690a1ade38e30a8e208fc4584f8b9622d9cf866fbef67bfb1ac8f3f8c3872e8e27f0
-  data.tar.gz: 0b352f02462f55a3cb362a87526b0cca3b47985eb7659e85ce60d40ba2d93766d3be589afe90f17091ee3e82818c76528738b4223c0c25598e48bae6e5791f09
+  metadata.gz: 2e7ee85dcaa85e110c74f375b2ac84722cd14e873e78e4e36ea76308dac4382999e7bbbc0a625840e3aa5859e4b1a88a1536f7842429059469570192b96bfbd5
+  data.tar.gz: 465882ed84263542c08736980d20fe01e8442019c85171cc587ae8283bc74b7c56c6750d8d3485dabc4bcc8c6b616b7a6e5b551ca09eb0a0cef77d8e474a273b

data/.github/workflows/tests.yml

@@ -5,25 +5,44 @@ 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"
+        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"
     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,5 +1,11 @@
 # CHANGELOG
 
+## 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))

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/ghost_adapter.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   # 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', '< 6.2'
   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
@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_adapter
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Austin C Roos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-11-04 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: '6.2'
   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: '6.2'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -147,11 +153,14 @@ 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
 - ghost_adapter.gemspec
 - lib/active_record/connection_adapters/mysql2_ghost_adapter.rb
 - lib/generators/ghost_adapter/install_generator.rb
@@ -186,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+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.3)
-      activerecord (>= 5)
-      mysql2 (>= 0.4.0, < 0.6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    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)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    bump (0.10.0)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    mysql2 (0.5.3)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    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)
-      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.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.9.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    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__)