safe-pg-migrations 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624821b7134dee05186350edada6f27faaf8c820976837d32403dc5fffa4880a
-  data.tar.gz: bf41324b8d563de7bc893a302d45d8f175e890bb888a2f52e0b14be7676f942c
+  metadata.gz: da23106f1db5b2a4f626e37170f2d26f8642f52ffda4775d972822b12156b301
+  data.tar.gz: 49ede8d6b233b0d0c9b26efc5d62be4be99e08111b39beec9c4904928ae31e72
 SHA512:
-  metadata.gz: 76601dcf0b97013edc36de6ac351beb8e4f6c532a0e223cba95d1a29e4eb7f18b8a4e7b3e3f28e4e7bde02144a4de8c512c19e2725396578dcb322e040963168
-  data.tar.gz: 767876e75af3292f9c4d3fc82810ab37bb3d38dad7b8b87ee6ba7068ec5e4aa9967ac0e53170be77bda07dd3424f2d3b3b3a03d9b8dc6ebcda94cee21e61fcfc
+  metadata.gz: 79502033f2e447bea822504895d62ad31e3aa78957c164cfa63a4b857f0282f0e19e0e2a848eba25c8f02cb447fed06316c7c5a1cd2e9f5a021cb9b5a9e178f7
+  data.tar.gz: cd0fb8724abf3ddc17d818fc664e4445cb2b27e87b5644ccb22be5cbe106383792b23ae2ce32c4ad7a6641ad965a8412afe52758b87a9086d2f8cdd979c698cd

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

@@ -6,6 +6,7 @@ require 'safe-pg-migrations/helpers/satisfied_helper'
 require 'safe-pg-migrations/helpers/index_helper'
 require 'safe-pg-migrations/helpers/batch_over'
 require 'safe-pg-migrations/helpers/session_setting_management'
+require 'safe-pg-migrations/helpers/statements_helper'
 require 'safe-pg-migrations/plugins/verbose_sql_logger'
 require 'safe-pg-migrations/plugins/blocking_activity_logger'
 require 'safe-pg-migrations/plugins/statement_insurer/add_column'

data/lib/safe-pg-migrations/helpers/statements_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SafePgMigrations
+  module Helpers
+    module StatementsHelper
+      RETRIABLE_SCHEMA_STATEMENTS = %i[
+        add_check_constraint
+        add_column
+        add_foreign_key
+        change_column_default
+        change_column_null
+        create_table
+        remove_column
+        remove_foreign_key
+        drop_table
+      ].freeze
+    end
+  end
+end

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

@@ -7,16 +7,9 @@ module SafePgMigrations
   module BlockingActivityLogger
     include Helpers::BlockingActivityFormatter
     include Helpers::BlockingActivitySelector
+    include Helpers::StatementsHelper
 
-    %i[
-      add_column
-      remove_column
-      add_foreign_key
-      remove_foreign_key
-      change_column_default
-      change_column_null
-      create_table
-    ].each do |method|
+    RETRIABLE_SCHEMA_STATEMENTS.each do |method|
       define_method method do |*args, &block|
         log_context = lambda do
           break unless SafePgMigrations.config.sensitive_logger

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

@@ -6,15 +6,12 @@ module SafePgMigrations
 
     ruby2_keywords def add_index(table_name, column_name, *args)
       options = args.last.is_a?(Hash) ? args.last : {}
-
       index_definition = index_definition(table_name, column_name, **options)
 
       return super unless index_name_exists?(index_definition.table, index_definition.name)
 
       if index_valid?(index_definition.name)
-        Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-          /!\\ Index '#{index_definition.name}' already exists in '#{table_name}'. Skipping statement.
-        MESSAGE
+        log_message("/!\\ Index '#{index_definition.name}' already exists in '#{table_name}'. Skipping statement.")
         return
       end
 
@@ -23,19 +20,24 @@ module SafePgMigrations
     end
 
     ruby2_keywords def add_column(table_name, column_name, type, *)
-      return super unless column_exists?(table_name, column_name)
+      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
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Column '#{column_name}' already exists in '#{table_name}'. Skipping statement.
+      return super unless 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
+                 )
     end
 
     ruby2_keywords def remove_column(table_name, column_name, type = nil, *)
       return super if column_exists?(table_name, column_name)
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Column '#{column_name}' not found on table '#{table_name}'. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Column '#{column_name}' not found on table '#{table_name}'. Skipping statement.")
     end
 
     ruby2_keywords def remove_index(table_name, *args)
@@ -44,9 +46,7 @@ module SafePgMigrations
 
       return super if index_name_exists?(table_name, index_name)
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Index '#{index_name}' not found on table '#{table_name}'. Skipping statement.
-      MESSAGE
+      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)
@@ -54,18 +54,14 @@ module SafePgMigrations
       sub_options = options.slice(:name, :column)
       return super unless foreign_key_exists?(from_table, sub_options.present? ? nil : to_table, **sub_options)
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Foreign key '#{from_table}' -> '#{to_table}' already exists. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Foreign key '#{from_table}' -> '#{to_table}' already exists. Skipping statement.")
     end
 
     def remove_foreign_key(from_table, to_table = nil, **options)
       return super if foreign_key_exists?(from_table, to_table, **options)
 
       reference_name = to_table || options[:to_table] || options[:column] || options[:name]
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Foreign key '#{from_table}' -> '#{reference_name}' does not exist. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Foreign key '#{from_table}' -> '#{reference_name}' does not exist. Skipping statement.")
     end
 
     ruby2_keywords def create_table(table_name, *args)
@@ -91,9 +87,7 @@ module SafePgMigrations
 
       return super if constraint_definition.nil?
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Constraint '#{constraint_definition.name}' already exists. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Constraint '#{constraint_definition.name}' already exists. Skipping statement.")
     end
 
     def change_column_null(table_name, column_name, null, *)
@@ -101,9 +95,7 @@ module SafePgMigrations
 
       return super if column.null != null
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Column '#{table_name}.#{column.name}' is already set to 'null: #{null}'. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Column '#{table_name}.#{column.name}' is already set to 'null: #{null}'. Skipping statement.")
     end
 
     def validate_check_constraint(table_name, **options)
@@ -111,14 +103,11 @@ module SafePgMigrations
 
       return super unless constraint_definition.validated?
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Constraint '#{constraint_definition.name}' already validated. Skipping statement.
-      MESSAGE
+      log_message("/!\\ Constraint '#{constraint_definition.name}' already validated. Skipping statement.")
     end
 
     def change_column_default(table_name, column_name, default_or_changes)
       column = column_for(table_name, column_name)
-
       previous_alter_statement = change_column_default_for_alter(table_name, column_name, column.default)
       new_alter_statement = change_column_default_for_alter(table_name, column_name, default_or_changes)
 
@@ -127,16 +116,24 @@ module SafePgMigrations
 
       return super if new_alter_statement != previous_alter_statement
 
-      Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Column '#{table_name}.#{column.name}' is already set to 'default: #{column.default}'. Skipping statement.
+      log_message(<<~MESSAGE.squish
+        /!\\ Column '#{table_name}.#{column.name}' is already set to 'default: #{column.default}'.
+        Skipping statement.
       MESSAGE
+                 )
     end
 
     ruby2_keywords def drop_table(table_name, *)
       return super if table_exists?(table_name)
 
+      log_message("/!\\ Table '#{table_name} does not exist. Skipping statement.")
+    end
+
+    private
+
+    def log_message(message)
       Helpers::Logger.say <<~MESSAGE.squish, sub_item: true
-        /!\\ Table '#{table_name} does not exist. Skipping statement.
+        #{message}
       MESSAGE
     end
   end

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

@@ -2,9 +2,7 @@
 
 module SafePgMigrations
   module StatementRetrier
-    RETRIABLE_SCHEMA_STATEMENTS = %i[
-      add_column add_foreign_key remove_foreign_key change_column_default change_column_null remove_column drop_table
-    ].freeze
+    include Helpers::StatementsHelper
 
     RETRIABLE_SCHEMA_STATEMENTS.each do |method|
       define_method method do |*args, &block|

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Matthieu Prat
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,6 +19,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,6 +29,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.x
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -33,6 +39,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -40,6 +49,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.x
 description: Make your PG migrations safe.
 email:
 executables: []
@@ -58,6 +70,7 @@ files:
 - lib/safe-pg-migrations/helpers/logger.rb
 - lib/safe-pg-migrations/helpers/satisfied_helper.rb
 - lib/safe-pg-migrations/helpers/session_setting_management.rb
+- lib/safe-pg-migrations/helpers/statements_helper.rb
 - lib/safe-pg-migrations/plugins/blocking_activity_logger.rb
 - lib/safe-pg-migrations/plugins/idempotent_statements.rb
 - lib/safe-pg-migrations/plugins/statement_insurer.rb