safe-pg-migrations 2.3.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da23106f1db5b2a4f626e37170f2d26f8642f52ffda4775d972822b12156b301
-  data.tar.gz: 49ede8d6b233b0d0c9b26efc5d62be4be99e08111b39beec9c4904928ae31e72
+  metadata.gz: 2e58bfc8a79c0b54a368c49a1fc720e33582220b472c81c3556158aa4d3e8f05
+  data.tar.gz: a112e1ade2a57568cdebee942d0a4f4f5eef1fcfb19db576d30c25eacf7fc04d
 SHA512:
-  metadata.gz: 79502033f2e447bea822504895d62ad31e3aa78957c164cfa63a4b857f0282f0e19e0e2a848eba25c8f02cb447fed06316c7c5a1cd2e9f5a021cb9b5a9e178f7
-  data.tar.gz: cd0fb8724abf3ddc17d818fc664e4445cb2b27e87b5644ccb22be5cbe106383792b23ae2ce32c4ad7a6641ad965a8412afe52758b87a9086d2f8cdd979c698cd
+  metadata.gz: 7b28dcf7b252ebe311258b1c3ba4badfa0f365d40b53209e66b51c459a8fd960c3ceb452a378d0feb5785ec8f7632f575d53b9ec543e1de016729066d5e9ed42
+  data.tar.gz: 3338baf96b5d82f6055f6b59691fb42f0560e1d18c4a372685e9bc9ae40f55b58b1382bc8347e13b0d8628b754abae85f4d6c9d57437888efa334f9f82029e7b

data/README.md

@@ -6,8 +6,8 @@ ActiveRecord migrations for Postgres made safe.
 
 ## Requirements
 
-- Ruby 2.7+
-- Rails 6.0+
+- Ruby 3.0+
+- Rails 6.1+
 - PostgreSQL 11.7+
 
 ## Usage

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

@@ -10,22 +10,19 @@ module SafePgMigrations
     include Helpers::StatementsHelper
 
     RETRIABLE_SCHEMA_STATEMENTS.each do |method|
-      define_method method do |*args, &block|
+      define_method method do |*args, **options, &block|
         log_context = lambda do
           break unless SafePgMigrations.config.sensitive_logger
 
-          options = args.last.is_a?(Hash) ? args.last : {}
-
           Helpers::Logger.say "Executing #{SafePgMigrations.current_migration.name}",
                               sensitive: true, warn_sensitive_logs: false
           Helpers::Logger.say_method_call method, *args, **options, sensitive: true, warn_sensitive_logs: false
         end
 
         log_blocking_queries_after_lock(log_context) do
-          super(*args, &block)
+          super(*args, **options, &block)
         end
       end
-      ruby2_keywords method
     end
 
     %i[add_index remove_index].each do |method|

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

@@ -4,8 +4,7 @@ module SafePgMigrations
   module IdempotentStatements
     include Helpers::IndexHelper
 
-    ruby2_keywords def add_index(table_name, column_name, *args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_index(table_name, column_name, **options)
       index_definition = index_definition(table_name, column_name, **options)
 
       return super unless index_name_exists?(index_definition.table, index_definition.name)
@@ -15,42 +14,44 @@ module SafePgMigrations
         return
       end
 
-      remove_index(table_name, name: index_definition.name)
+      remove_index(table_name, column_name, **options)
       super
     end
 
-    ruby2_keywords def add_column(table_name, column_name, type, *)
+    def add_column(table_name, column_name, type, **options)
       if column_exists?(table_name, column_name) && !column_exists?(table_name, column_name, type)
         error_message = "/!\\ Column '#{column_name}' already exists in '#{table_name}' with a different type"
         raise error_message
       end
 
-      return super unless column_exists?(table_name, column_name, type)
+      options_without_default_value_backfill = options.except(:default_value_backfill)
 
-      log_message(<<~MESSAGE.squish
-        /!\\ Column '#{column_name}' already exists in '#{table_name}' with the same type (#{type}).
-        Skipping statement.
-      MESSAGE
-                 )
+      if column_exists?(table_name, column_name, type)
+        log_message(<<~MESSAGE.squish
+          /!\\ Column '#{column_name}' already exists in '#{table_name}' with the same type (#{type}).
+          Skipping statement.
+        MESSAGE
+                   )
+      else
+        super(table_name, column_name, type, **options_without_default_value_backfill)
+      end
     end
 
-    ruby2_keywords def remove_column(table_name, column_name, type = nil, *)
+    def remove_column(table_name, column_name, type = nil, **options)
       return super if column_exists?(table_name, column_name)
 
       log_message("/!\\ Column '#{column_name}' not found on table '#{table_name}'. Skipping statement.")
     end
 
-    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)
+    def remove_index(table_name, column_name = nil, **options)
+      index_name = options.key?(:name) ? options[:name].to_s : index_name(table_name, column: column_name)
 
       return super if index_name_exists?(table_name, index_name)
 
       log_message("/!\\ Index '#{index_name}' not found on table '#{table_name}'. Skipping statement.")
     end
 
-    ruby2_keywords def add_foreign_key(from_table, to_table, *args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_foreign_key(from_table, to_table, **options)
       sub_options = options.slice(:name, :column)
       return super unless foreign_key_exists?(from_table, sub_options.present? ? nil : to_table, **sub_options)
 
@@ -64,13 +65,12 @@ module SafePgMigrations
       log_message("/!\\ Foreign key '#{from_table}' -> '#{reference_name}' does not exist. Skipping statement.")
     end
 
-    ruby2_keywords def create_table(table_name, *args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def create_table(table_name, **options)
       return super if options[:force] || !table_exists?(table_name)
 
       Helpers::Logger.say "/!\\ Table '#{table_name}' already exists.", sub_item: true
 
-      td = create_table_definition(table_name, *args)
+      td = create_table_definition(table_name, **options)
 
       yield td if block_given?
 
@@ -82,8 +82,10 @@ module SafePgMigrations
     end
 
     def add_check_constraint(table_name, expression, **options)
+      options_without_validate = options.except(:validate)
       constraint_definition = check_constraint_for table_name,
-                                                   **check_constraint_options(table_name, expression, options)
+                                                   **check_constraint_options(table_name, expression,
+                                                                              options_without_validate)
 
       return super if constraint_definition.nil?
 
@@ -123,7 +125,7 @@ module SafePgMigrations
                  )
     end
 
-    ruby2_keywords def drop_table(table_name, *)
+    def drop_table(table_name, **options)
       return super if table_exists?(table_name)
 
       log_message("/!\\ Table '#{table_name} does not exist. Skipping statement.")

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

@@ -3,12 +3,11 @@
 module SafePgMigrations
   module StatementInsurer
     module AddColumn
-      ruby2_keywords def add_column(table_name, column_name, type, *args)
-        options = args.last.is_a?(Hash) && args.last
-        options ||= {}
-
+      def add_column(table_name, column_name, type, **options)
         return super if should_keep_default_implementation?(**options)
 
+        options.delete(:default_value_backfill)
+
         raise <<~ERROR unless backfill_column_default_safe?(table_name)
           Table #{table_name} has more than #{SafePgMigrations.config.default_value_backfill_threshold} rows.
           Backfilling the default value for column #{column_name} on table #{table_name} would take too long.

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

@@ -30,8 +30,7 @@ module SafePgMigrations
       without_statement_timeout { super }
     end
 
-    ruby2_keywords def add_foreign_key(from_table, to_table, *args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_foreign_key(from_table, to_table, **options)
       validate_present = options.key?(:validate)
       options[:validate] = false unless validate_present
 
@@ -43,7 +42,7 @@ module SafePgMigrations
       validate_foreign_key from_table, sub_options.present? ? nil : to_table, **sub_options
     end
 
-    ruby2_keywords def create_table(*)
+    def create_table(*)
       super do |td|
         yield td if block_given?
         td.indexes.map! do |key, index_options|
@@ -53,9 +52,7 @@ module SafePgMigrations
       end
     end
 
-    ruby2_keywords def add_index(table_name, column_name, *args_options)
-      options = args_options.last.is_a?(Hash) ? args_options.last : {}
-
+    def add_index(table_name, column_name, **options)
       if options[:algorithm] == :default
         options.delete :algorithm
       else
@@ -66,29 +63,28 @@ module SafePgMigrations
       without_timeout { super(table_name, column_name, **options) }
     end
 
-    ruby2_keywords def remove_index(table_name, *args)
-      options = args.last.is_a?(Hash) ? args.last : { column: args.last }
+    def remove_index(table_name, column_name = nil, **options)
       options[:algorithm] = :concurrently unless options.key?(:algorithm)
 
-      Helpers::Logger.say_method_call(:remove_index, table_name, **options)
-      without_timeout { super(table_name, **options) }
+      Helpers::Logger.say_method_call(:remove_index, table_name, column_name, **options)
+      without_timeout { super(table_name, column_name, **options) }
     end
 
-    def remove_column(table_name, column_name, *)
+    def remove_column(table_name, column_name, type = nil, **options)
       foreign_key = foreign_key_for(table_name, column: column_name)
 
       remove_foreign_key(table_name, name: foreign_key.name) if foreign_key
       super
     end
 
-    ruby2_keywords def drop_table(table_name, *args)
+    def drop_table(table_name, **options)
       foreign_keys(table_name).each do |foreign_key|
         remove_foreign_key(table_name, name: foreign_key.name)
       end
 
-      Helpers::Logger.say_method_call :drop_table, table_name, *args
+      Helpers::Logger.say_method_call :drop_table, table_name, **options
 
-      super(table_name, *args)
+      super
     end
   end
 end

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

@@ -5,10 +5,9 @@ module SafePgMigrations
     include Helpers::StatementsHelper
 
     RETRIABLE_SCHEMA_STATEMENTS.each do |method|
-      define_method method do |*args, &block|
-        retry_if_lock_timeout { super(*args, &block) }
+      define_method method do |*args, **options, &block|
+        retry_if_lock_timeout { super(*args, **options, &block) }
       end
-      ruby2_keywords method
     end
 
     private

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

@@ -54,22 +54,19 @@ module SafePgMigrations
     ].freeze
 
     SAFE_METHODS.each do |method|
-      define_method method do |*args|
-        return super(*args) unless respond_to?(:safety_assured)
+      define_method method do |*args, **options|
+        return super(*args, **options) unless respond_to?(:safety_assured)
 
-        safety_assured { super(*args) }
+        safety_assured { super(*args, **options) }
       end
-      ruby2_keywords method
     end
 
-    ruby2_keywords def add_column(table_name, *args)
-      return super(table_name, *args) unless respond_to?(:safety_assured)
+    def add_column(table_name, *args, **options)
+      return super unless respond_to?(:safety_assured)
 
-      options = args.last.is_a?(Hash) ? args.last : {}
+      return safety_assured { super } if options.fetch(:default_value_backfill, :auto) == :auto
 
-      return safety_assured { super(table_name, *args) } if options.fetch(:default_value_backfill, :auto) == :auto
-
-      super(table_name, *args)
+      super
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module SafePgMigrations
   module UselessStatementsLogger
     class << self
-      ruby2_keywords def warn_useless(action, link = nil, *args)
+      def warn_useless(action, link = nil, *args)
         Helpers::Logger.say(
           "/!\\ No need to explicitly use #{action}, safe-pg-migrations does it for you", *args
         )
@@ -11,28 +11,24 @@ module SafePgMigrations
       end
     end
 
-    ruby2_keywords def add_index(*args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_index(table_name, column_name, **options)
       warn_for_index(**options)
       super
     end
 
-    ruby2_keywords def remove_index(table_name, *args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def remove_index(table_name, column_name = nil, **options)
       warn_for_index(**options) unless options.empty?
       super
     end
 
-    ruby2_keywords def add_foreign_key(*args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_foreign_key(from_table, to_table, **options)
       if options[:validate] == false
         UselessStatementsLogger.warn_useless '`validate: :false`', 'https://github.com/doctolib/safe-pg-migrations#safe_add_foreign_key'
       end
       super
     end
 
-    ruby2_keywords def add_check_constraint(*args)
-      options = args.last.is_a?(Hash) ? args.last : {}
+    def add_check_constraint(table_name, expression, **options)
       if options[:validate] == false
         UselessStatementsLogger.warn_useless '`validate: :false`', 'https://github.com/doctolib/safe-pg-migrations#safe_add_check_constraint'
       end

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

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

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Matthieu Prat
 - Romain Choquet
 - Thomas Hareau
+- Charles Delannoy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,40 +19,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.1.x
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.1.x
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.1.x
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 7.1.x
+        version: '6.1'
 description: Make your PG migrations safe.
 email:
 executables: []
@@ -102,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="