strong_migrations 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22e260ec0e3e09954c65535725a3ddc4439b9cf94182a21cf5963e12d8485fe
-  data.tar.gz: 865633da561d77e615df16a9a00f8524a95bf73edc5590e3932855aaf544d4f7
+  metadata.gz: fac153e8505e25b50796c4033952d7e3a0b50db1f0a1fadfd3d3c19e72ac669b
+  data.tar.gz: fc7823c9b58f8598f7a5fee9bc9886e6a7cf444cf853da26fb9b6bc960a09dc9
 SHA512:
-  metadata.gz: f9b4df7a67aae2c8e1f7c58327b0e7e298261a33d9810dff4b5634bee3e000f1b26e64ad7b3997c8fc6c1cfef3a5cbeabe35ecbe508ed902679e3c9a720ecfb8
-  data.tar.gz: f4a7ecb6e64c40d1be1025a978387b94b9c2e47897cc25568c32dc32043292bc8fe14c9e6471108a4d84a1b1704459707f4fcf8a25227b7a86d8bcf2237dc19d
+  metadata.gz: 4cfb16530dce0d416b54ab87b333926299eaccd84a059d270809fb98a576a489f6d250fe7cb008f9471b0f992819cc6bc9efa90c337c78bd7bb53282cc4758e8
+  data.tar.gz: d1aa24bb732b617a4208ac95eafa206c4e3af1782793a7007a89c57894fc2e6a38abccf9e6289f53be1ceda436392bdce08e3cc52be7c70c3b942ea896aaec21

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.0 (2022-06-08)
+
+- Added check for `force` option with `create_join_table`
+- Improved errors for extra arguments
+- Fixed ignoring extra arguments with `safe_by_default`
+- Fixed missing options with `remove_index` and `safe_by_default`
+
 ## 1.0.0 (2022-03-21)
 
 New safe operations with MySQL and MariaDB

data/lib/strong_migrations/checker.rb

@@ -33,29 +33,31 @@ module StrongMigrations
         # see checks.rb for methods
         case method
         when :add_check_constraint
-          check_add_check_constraint(args)
+          check_add_check_constraint(*args)
         when :add_column
-          check_add_column(args)
+          check_add_column(*args)
         when :add_foreign_key
-          check_add_foreign_key(args)
+          check_add_foreign_key(*args)
         when :add_index
-          check_add_index(args)
+          check_add_index(*args)
         when :add_reference, :add_belongs_to
-          check_add_reference(method, args)
+          check_add_reference(method, *args)
         when :change_column
-          check_change_column(args)
+          check_change_column(*args)
         when :change_column_null
-          check_change_column_null(args)
+          check_change_column_null(*args)
         when :change_table
           check_change_table
+        when :create_join_table
+          check_create_join_table(*args)
         when :create_table
-          check_create_table(args)
+          check_create_table(*args)
         when :execute
           check_execute
         when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
-          check_remove_column(method, args)
+          check_remove_column(method, *args)
         when :remove_index
-          check_remove_index(args)
+          check_remove_index(*args)
         when :rename_column
           check_rename_column
         when :rename_table

data/lib/strong_migrations/checks.rb

@@ -3,9 +3,9 @@ module StrongMigrations
   module Checks
     private
 
-    def check_add_check_constraint(args)
-      table, expression, options = args
-      options ||= {}
+    def check_add_check_constraint(*args)
+      options = args.extract_options!
+      table, expression = args
 
       if !new_table?(table)
         if postgresql? && options[:validate] != false
@@ -14,7 +14,7 @@ module StrongMigrations
           validate_options = {name: name}
 
           if StrongMigrations.safe_by_default
-            safe_add_check_constraint(table, expression, add_options, validate_options)
+            safe_add_check_constraint(*args, add_options, validate_options)
             throw :safe
           end
 
@@ -27,9 +27,9 @@ module StrongMigrations
       end
     end
 
-    def check_add_column(args)
-      table, column, type, options = args
-      options ||= {}
+    def check_add_column(*args)
+      options = args.extract_options!
+      table, column, type = args
       default = options[:default]
 
       if !default.nil? && !adapter.add_column_default_safe?
@@ -73,14 +73,14 @@ Then add the NOT NULL constraint in separate migrations."
     #
     # note: adding foreign_keys with create_table is fine
     # since the table is always guaranteed to be empty
-    def check_add_foreign_key(args)
-      from_table, to_table, options = args
-      options ||= {}
+    def check_add_foreign_key(*args)
+      options = args.extract_options!
+      from_table, to_table = args
 
       validate = options.fetch(:validate, true)
       if postgresql? && validate
         if StrongMigrations.safe_by_default
-          safe_add_foreign_key(from_table, to_table, options)
+          safe_add_foreign_key(*args, **options)
           throw :safe
         end
 
@@ -90,9 +90,9 @@ Then add the NOT NULL constraint in separate migrations."
       end
     end
 
-    def check_add_index(args)
-      table, columns, options = args
-      options ||= {}
+    def check_add_index(*args)
+      options = args.extract_options!
+      table, columns = args
 
       if columns.is_a?(Array) && columns.size > 3 && !options[:unique]
         raise_error :add_index_columns, header: "Best practice"
@@ -102,7 +102,7 @@ Then add the NOT NULL constraint in separate migrations."
       # since the table won't be in use by the application
       if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
         if StrongMigrations.safe_by_default
-          safe_add_index(table, columns, options)
+          safe_add_index(*args, **options)
           throw :safe
         end
 
@@ -110,9 +110,9 @@ Then add the NOT NULL constraint in separate migrations."
       end
     end
 
-    def check_add_reference(method, args)
-      table, reference, options = args
-      options ||= {}
+    def check_add_reference(method, *args)
+      options = args.extract_options!
+      table, reference = args
 
       if postgresql?
         index_value = options.fetch(:index, true)
@@ -127,7 +127,7 @@ Then add the NOT NULL constraint in separate migrations."
           end
 
           if StrongMigrations.safe_by_default
-            safe_add_reference(table, reference, options)
+            safe_add_reference(*args, **options)
             throw :safe
           end
 
@@ -148,9 +148,9 @@ Then add the foreign key in separate migrations."
       end
     end
 
-    def check_change_column(args)
-      table, column, type, options = args
-      options ||= {}
+    def check_change_column(*args)
+      options = args.extract_options!
+      table, column, type = args
 
       safe = false
       existing_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
@@ -168,7 +168,7 @@ Then add the foreign key in separate migrations."
       raise_error :change_column, rewrite_blocks: adapter.rewrite_blocks unless safe
     end
 
-    def check_change_column_null(args)
+    def check_change_column_null(*args)
       table, column, null, default = args
       if !null
         if postgresql?
@@ -242,13 +242,21 @@ Then add the foreign key in separate migrations."
       raise_error :change_table, header: "Possibly dangerous operation"
     end
 
-    def check_create_table(args)
-      table, options = args
-      options ||= {}
+    def check_create_join_table(*args)
+      options = args.extract_options!
 
       raise_error :create_table if options[:force]
 
-      # keep track of new tables of add_index check
+      # TODO keep track of new table of add_index check
+    end
+
+    def check_create_table(*args)
+      options = args.extract_options!
+      table, _ = args
+
+      raise_error :create_table if options[:force]
+
+      # keep track of new table of add_index check
       @new_tables << table.to_s
     end
 
@@ -256,7 +264,7 @@ Then add the foreign key in separate migrations."
       raise_error :execute, header: "Possibly dangerous operation"
     end
 
-    def check_remove_column(method, args)
+    def check_remove_column(method, *args)
       columns =
         case method
         when :remove_timestamps
@@ -288,20 +296,26 @@ Then add the foreign key in separate migrations."
         column_suffix: columns.size > 1 ? "s" : ""
     end
 
-    def check_remove_index(args)
-      table, options = args
-      unless options.is_a?(Hash)
-        options = {column: options}
-      end
-      options ||= {}
+    def check_remove_index(*args)
+      options = args.extract_options!
+      table, _ = args
 
       if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
+        # avoid suggesting extra (invalid) args
+        args = args[0..1] unless StrongMigrations.safe_by_default
+
+        # Active Record < 6.1 only supports two arguments (including options)
+        if args.size == 2 && ar_version < 6.1
+          # arg takes precedence over option
+          options[:column] = args.pop
+        end
+
         if StrongMigrations.safe_by_default
-          safe_remove_index(table, options)
+          safe_remove_index(*args, **options)
           throw :safe
         end
 
-        raise_error :remove_index, command: command_str("remove_index", [table, options.merge(algorithm: :concurrently)])
+        raise_error :remove_index, command: command_str("remove_index", args + [options.merge(algorithm: :concurrently)])
       end
     end
 

data/lib/strong_migrations/safe_methods.rb

@@ -5,22 +5,22 @@ module StrongMigrations
     end
 
     # TODO check if invalid index with expected name exists and remove if needed
-    def safe_add_index(table, columns, options)
+    def safe_add_index(*args, **options)
       disable_transaction
-      @migration.add_index(table, columns, **options.merge(algorithm: :concurrently))
+      @migration.add_index(*args, **options.merge(algorithm: :concurrently))
     end
 
-    def safe_remove_index(table, options)
+    def safe_remove_index(*args, **options)
       disable_transaction
-      @migration.remove_index(table, **options.merge(algorithm: :concurrently))
+      @migration.remove_index(*args, **options.merge(algorithm: :concurrently))
     end
 
-    def safe_add_reference(table, reference, options)
+    def safe_add_reference(table, reference, *args, **options)
       @migration.reversible do |dir|
         dir.up do
           disable_transaction
           foreign_key = options.delete(:foreign_key)
-          @migration.add_reference(table, reference, **options)
+          @migration.add_reference(table, reference, *args, **options)
           if foreign_key
             # same as Active Record
             name =
@@ -43,10 +43,10 @@ module StrongMigrations
       end
     end
 
-    def safe_add_foreign_key(from_table, to_table, options)
+    def safe_add_foreign_key(from_table, to_table, *args, **options)
       @migration.reversible do |dir|
         dir.up do
-          @migration.add_foreign_key(from_table, to_table, **options.merge(validate: false))
+          @migration.add_foreign_key(from_table, to_table, *args, **options.merge(validate: false))
           disable_transaction
           @migration.validate_foreign_key(from_table, to_table)
         end
@@ -56,10 +56,10 @@ module StrongMigrations
       end
     end
 
-    def safe_add_check_constraint(table, expression, add_options, validate_options)
+    def safe_add_check_constraint(table, expression, *args, add_options, validate_options)
       @migration.reversible do |dir|
         dir.up do
-          @migration.add_check_constraint(table, expression, **add_options)
+          @migration.add_check_constraint(table, expression, *args, **add_options)
           disable_transaction
           @migration.validate_check_constraint(table, **validate_options)
         end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord