safe-pg-migrations 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b01cc2376f8bcfa1908bdc642a51bd444420540eef7aa01dc403f13ea0b19c8
-  data.tar.gz: 0c09d3bc52ce84542fd50b119cef667714a6058d5fcf59f1be83af72318b3862
+  metadata.gz: fdee6e752da3fbdec93e5fd5c72fb370497ddd66f1cc27f33609c2a31e364c53
+  data.tar.gz: 143a5dcbf614abed765fac78b16969d900ded5ec574f11d939d802b94d7e2586
 SHA512:
-  metadata.gz: f7a822bbb6cc2e924c8da76ca1501cec16588b4972e850fd07e7fbc120e159dfef715a8293c3399454aa9072e2cc6c2da8927e6dc84f15c72670bb16182fe53c
-  data.tar.gz: 4821e1fb76ce6e868a2032eb0e53aceea8f745f31fce521333949c20143150bd03950187d7286d63d1d9c7269b6015f8b9be8e38833d3e6df659f2f8e5940902
+  metadata.gz: 41c264aa05c7b8ad5fe90f7ecdc88fa700504562e69695d5fd9f4dc9ac63315fb666818554e1387251b367aed241fccff31154589f70309905e1ed1cfae90c68
+  data.tar.gz: 9386e6a8b0366387543998ec5cec42e719d2a4138d5eb52f13f6580d2a3d31e48bd438760b358beb1ab5eb32bd8598927d69bafd03756108a514e88eeb431022

data/lib/safe-pg-migrations/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'ruby2_keywords'
 require 'safe-pg-migrations/configuration'
 require 'safe-pg-migrations/plugins/verbose_sql_logger'
 require 'safe-pg-migrations/plugins/blocking_activity_logger'
@@ -50,13 +51,13 @@ module SafePgMigrations
       @alternate_connection = nil
     end
 
-    def say(*args)
+    ruby2_keywords def say(*args)
       return unless current_migration
 
       current_migration.say(*args)
     end
 
-    def say_method_call(method, *args)
+    ruby2_keywords def say_method_call(method, *args)
       say "#{method}(#{args.map(&:inspect) * ', '})", true
     end
 
@@ -91,6 +92,7 @@ module SafePgMigrations
 
         safety_assured { super(*args) }
       end
+      ruby2_keywords method
     end
   end
 end

data/lib/safe-pg-migrations/plugins/blocking_activity_logger.rb

@@ -21,6 +21,7 @@ module SafePgMigrations
       define_method method do |*args, &block|
         log_blocking_queries { super(*args, &block) }
       end
+      ruby2_keywords method
     end
 
     private

data/lib/safe-pg-migrations/plugins/idem_potent_statements.rb

@@ -2,7 +2,8 @@
 
 module SafePgMigrations
   module IdemPotentStatements
-    def add_index(table_name, column_name, **options)
+    ruby2_keywords def add_index(table_name, column_name, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       index_name = options.key?(:name) ? options[:name].to_s : index_name(table_name, index_column_names(column_name))
       return super unless index_name_exists?(table_name, index_name)
 
@@ -12,19 +13,20 @@ module SafePgMigrations
       super
     end
 
-    def add_column(table_name, column_name, type, options = {})
+    ruby2_keywords def add_column(table_name, column_name, type, *)
       return super unless column_exists?(table_name, column_name)
 
       SafePgMigrations.say("/!\\ Column '#{column_name}' already exists in '#{table_name}'. Skipping statement.", true)
     end
 
-    def remove_column(table_name, column_name, type = nil, options = {})
+    ruby2_keywords def remove_column(table_name, column_name, type = nil, *)
       return super if column_exists?(table_name, column_name)
 
       SafePgMigrations.say("/!\\ Column '#{column_name}' not found on table '#{table_name}'. Skipping statement.", true)
     end
 
-    def remove_index(table_name, options = {})
+    ruby2_keywords def remove_index(table_name, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       index_name = options.key?(:name) ? options[:name].to_s : index_name(table_name, options)
 
       return super if index_name_exists?(table_name, index_name)
@@ -32,9 +34,10 @@ module SafePgMigrations
       SafePgMigrations.say("/!\\ Index '#{index_name}' not found on table '#{table_name}'. Skipping statement.", true)
     end
 
-    def add_foreign_key(from_table, to_table, **options)
-      options_or_to_table = options.slice(:name, :column).presence || to_table
-      return super unless foreign_key_exists?(from_table, options_or_to_table)
+    ruby2_keywords def add_foreign_key(from_table, to_table, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      suboptions = options.slice(:name, :column)
+      return super unless foreign_key_exists?(from_table, suboptions.present? ? nil : to_table, **suboptions)
 
       SafePgMigrations.say(
         "/!\\ Foreign key '#{from_table}' -> '#{to_table}' already exists. Skipping statement.",
@@ -42,19 +45,20 @@ module SafePgMigrations
       )
     end
 
-    def create_table(table_name, comment: nil, **options)
+    ruby2_keywords def create_table(table_name, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       return super if options[:force] || !table_exists?(table_name)
 
       SafePgMigrations.say "/!\\ Table '#{table_name}' already exists.", true
 
-      td = create_table_definition(table_name, **options)
+      td = create_table_definition(table_name, *args)
 
       yield td if block_given?
 
       SafePgMigrations.say(td.indexes.empty? ? '-- Skipping statement' : '-- Creating indexes', true)
 
       td.indexes.each do |column_name, index_options|
-        add_index(table_name, column_name, index_options)
+        add_index(table_name, column_name, **index_options)
       end
     end
 

data/lib/safe-pg-migrations/plugins/statement_insurer.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 module SafePgMigrations
-  module StatementInsurer
+  module StatementInsurer # rubocop:disable Metrics/ModuleLength
     PG_11_VERSION_NUM = 110_000
 
     %i[change_column_null change_column].each do |method|
       define_method method do |*args, &block|
         with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) { super(*args, &block) }
       end
+      ruby2_keywords method
     end
 
-    def add_column(table_name, column_name, type, **options)
+    ruby2_keywords def add_column(table_name, column_name, type, *args) # rubocop:disable Metrics/CyclomaticComplexity
+      options = args.last.is_a?(Hash) ? args.last : {}
       return super if SafePgMigrations.pg_version_num >= PG_11_VERSION_NUM
 
       default = options.delete(:default)
@@ -36,17 +38,21 @@ module SafePgMigrations
       end
     end
 
-    def add_foreign_key(from_table, to_table, **options)
+    ruby2_keywords def add_foreign_key(from_table, to_table, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       validate_present = options.key? :validate
       options[:validate] = false unless validate_present
+      with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) do
+        super(from_table, to_table, **options)
+      end
 
-      with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) { super }
+      return if validate_present
 
-      options_or_to_table = options.slice(:name, :column).presence || to_table
-      without_statement_timeout { validate_foreign_key from_table, options_or_to_table } unless validate_present
+      suboptions = options.slice(:name, :column)
+      without_statement_timeout { validate_foreign_key from_table, suboptions.present? ? nil : to_table, **suboptions }
     end
 
-    def create_table(*)
+    ruby2_keywords def create_table(*)
       with_setting(:statement_timeout, SafePgMigrations.config.pg_safe_timeout) do
         super do |td|
           yield td if block_given?
@@ -65,17 +71,17 @@ module SafePgMigrations
         options[:algorithm] = :concurrently
       end
 
-      SafePgMigrations.say_method_call(:add_index, table_name, column_name, options)
+      SafePgMigrations.say_method_call(:add_index, table_name, column_name, **options)
 
-      without_timeout { super }
+      without_timeout { super(table_name, column_name, **options) }
     end
 
-    def remove_index(table_name, options = {})
-      options = { column: options } unless options.is_a?(Hash)
-      options[:algorithm] = :concurrently
-      SafePgMigrations.say_method_call(:remove_index, table_name, options)
+    ruby2_keywords def remove_index(table_name, *args)
+      options = args.last.is_a?(Hash) ? args.last : { column: args.last }
+      options[:algorithm] = :concurrently unless options.key?(:algorithm)
+      SafePgMigrations.say_method_call(:remove_index, table_name, **options)
 
-      without_timeout { super }
+      without_timeout { super(table_name, **options) }
     end
 
     def backfill_column_default(table_name, column_name)

data/lib/safe-pg-migrations/plugins/statement_retrier.rb

@@ -10,6 +10,7 @@ module SafePgMigrations
       define_method method do |*args, &block|
         retry_if_lock_timeout { super(*args, &block) }
       end
+      ruby2_keywords method
     end
 
     private

data/lib/safe-pg-migrations/plugins/useless_statements_logger.rb

@@ -2,22 +2,27 @@
 
 module SafePgMigrations
   module UselessStatementsLogger
-    def self.warn_useless(action, link = nil, *args)
-      SafePgMigrations.say "/!\\ No need to explicitly use #{action}, safe-pg-migrations does it for you", *args
-      SafePgMigrations.say "\t see #{link} for more details", *args if link
+    class << self
+      ruby2_keywords def warn_useless(action, link = nil, *args)
+        SafePgMigrations.say "/!\\ No need to explicitly use #{action}, safe-pg-migrations does it for you", *args
+        SafePgMigrations.say "\t see #{link} for more details", *args if link
+      end
     end
 
-    def add_index(*, **options)
+    ruby2_keywords def add_index(*args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       warn_for_index(**options)
       super
     end
 
-    def remove_index(table_name, options = {})
-      warn_for_index(options) if options.is_a? Hash
+    ruby2_keywords def remove_index(table_name, *args)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      warn_for_index(**options) unless options.empty?
       super
     end
 
-    def add_foreign_key(*, **options)
+    ruby2_keywords def add_foreign_key(*args)
+      options = args.last.is_a?(Hash) ? args.last : {}
       if options[:validate] == false
         UselessStatementsLogger.warn_useless '`validate: :false`', 'https://github.com/doctolib/safe-pg-migrations#safe_add_foreign_key'
       end

data/lib/safe-pg-migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafePgMigrations
-  VERSION = '1.2.3'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Matthieu Prat
 - Romain Choquet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +188,7 @@ homepage: https://github.com/doctolib/safe-pg-migrations
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,15 +197,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Make your PG migrations safe.
 test_files: []