dynamic_migrations 3.6.12 → 3.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b80c950a523a7f70c930e8c86774fa64009ae689f5164de3320dc8d55e4238
-  data.tar.gz: 649f3e0f23d676e97b8cf3c8389875ae2127701eb405c7c8947bf19de076b7f2
+  metadata.gz: 2a53664f8e85f6f7570b65b756687db445a71c5e48cdc7f52ab4a394570e9be5
+  data.tar.gz: 49cad85aaff8c311714a5e9c47c16708e8f6c3d7b6f276ce94d5b0dc8703eae6
 SHA512:
-  metadata.gz: 94c1280b7c62a39f8337d1093731625b22049eab02b642f17a9c8d1e7f067ef90cabb1dcabda980acde0eb38639ddbd1d30c9b740d85535d0250295e032b2983
-  data.tar.gz: '0478e668cf87739da754981dd2be1acd6a21cdfb3ef41609043c12915a455a04ccf99f31e46b3d0a5630002a59ba6b085f65381a86ed1e4d17eeaa796e70b418'
+  metadata.gz: 03230e628a4b6b0719d12ffeecc68ba0395c405ae828232331195a319f2bfc394a00ba80f999ba68660392dede3a76d4656b749c991ba940332901c0a93cb771
+  data.tar.gz: 7b169d5836f5c6a53cfab698c3f8af30c397334bea5efb1087de0f9c33c481218955b90311715a75f96c124c9bd6306887713eddd5a218cbe375bedbd6dd5f31

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [3.6.14](https://github.com/craigulliott/dynamic_migrations/compare/v3.6.13...v3.6.14) (2023-09-14)
+
+
+### Bug Fixes
+
+* allowing templates to return nil and skip adding to migrations ([3d90829](https://github.com/craigulliott/dynamic_migrations/commit/3d9082960403899b4243fde60629d9c83ce1e263))
+
+## [3.6.13](https://github.com/craigulliott/dynamic_migrations/compare/v3.6.12...v3.6.13) (2023-09-14)
+
+
+### Bug Fixes
+
+* providing foreign_schema_name to create foreign key constraint, and only providing non default arguments ([e45d499](https://github.com/craigulliott/dynamic_migrations/commit/e45d4994a9b947f0d626bdd4b0e2a36136412370))
+
 ## [3.6.12](https://github.com/craigulliott/dynamic_migrations/compare/v3.6.11...v3.6.12) (2023-09-13)
 
 

data/lib/dynamic_migrations/active_record/migrators/foreign_key_constraint.rb

@@ -11,7 +11,7 @@ module DynamicMigrations
         # because rails migrations don't support composite (multiple column) foreign keys
         # column_names and foreign_column_names can be a single column name or
         # an array of column names
-        def add_foreign_key table_name, column_names, foreign_schema_name, foreign_table_name, foreign_column_names, name:, initially_deferred: false, deferrable: false, on_delete: :no_action, on_update: :no_action, comment: nil
+        def add_foreign_key table_name, column_names, foreign_table_name, foreign_column_names, name:, foreign_schema: nil, initially_deferred: false, deferrable: false, on_delete: :no_action, on_update: :no_action, comment: nil
           if initially_deferred == true && deferrable == false
             raise DeferrableOptionsError, "A constraint can only be initially deferred if it is also deferrable"
           end
@@ -19,6 +19,8 @@ module DynamicMigrations
           # convert single column names into arrays, this simplifies the logic below
           column_names = column_names.is_a?(Array) ? column_names : [column_names]
           foreign_column_names = foreign_column_names.is_a?(Array) ? foreign_column_names : [foreign_column_names]
+          # default to the current schema
+          foreign_schema_name = foreign_schema.nil? ? schema_name : foreign_schema
 
           # allow it to be deferred, and defer it by default
           deferrable_sql = if initially_deferred

data/lib/dynamic_migrations/postgres/generator/foreign_key_constraint.rb

@@ -12,13 +12,26 @@ module DynamicMigrations
           f_c_names = foreign_key_constraint.foreign_column_names
           foreign_column_names = (f_c_names.count == 1) ? ":#{f_c_names.first}" : "[:#{f_c_names.join(", :")}]"
 
-          options = {
-            name: ":#{foreign_key_constraint.name}",
-            initially_deferred: foreign_key_constraint.initially_deferred,
-            deferrable: foreign_key_constraint.deferrable,
-            on_delete: ":#{foreign_key_constraint.on_delete}",
-            on_update: ":#{foreign_key_constraint.on_update}"
-          }
+          options = {}
+          options[:name] = ":#{foreign_key_constraint.name}"
+
+          # only provide values if they are different from the defaults
+          unless foreign_key_constraint.initially_deferred == false
+            options[:initially_deferred] = foreign_key_constraint.initially_deferred
+          end
+          unless foreign_key_constraint.deferrable == false
+            options[:deferrable] = foreign_key_constraint.deferrable
+          end
+          unless foreign_key_constraint.on_delete == :no_action
+            options[:on_delete] = ":#{foreign_key_constraint.on_delete}"
+          end
+          unless foreign_key_constraint.on_update == :no_action
+            options[:on_update] = ":#{foreign_key_constraint.on_update}"
+          end
+          unless foreign_key_constraint.table.schema.name == foreign_key_constraint.foreign_schema_name
+            options[:foreign_schema] = ":#{foreign_key_constraint.foreign_schema_name}"
+          end
+
           unless foreign_key_constraint.description.nil?
             options[:comment] = <<~RUBY
               <<~COMMENT
@@ -27,6 +40,10 @@ module DynamicMigrations
             RUBY
           end
 
+          if foreign_key_constraint.table.schema != foreign_key_constraint.foreign_table.schema
+            options[:foreign_schema] = foreign_key_constraint.foreign_table.schema.name.to_s
+          end
+
           options_syntax = options.map { |k, v| "#{k}: #{v}" }.join(", ")
 
           add_fragment schema: foreign_key_constraint.table.schema,

data/lib/dynamic_migrations/postgres/generator/trigger.rb

@@ -33,13 +33,18 @@ module DynamicMigrations
 
             arguments = template_class.new(trigger, code_comment).fragment_arguments
 
-            # we only provide a dependent function if the function has more than one trigger
-            # or is in a different schema, otherwise it is added to the same migration as this
-            # trigger and we don't need to worry about dependencies
-            if trigger.function && (trigger.function.triggers.count > 1 || trigger.table.schema != trigger.function.schema)
-              add_fragment(dependent_function: trigger.function, **arguments)
-            else
-              add_fragment(**arguments)
+            # if the template class returns nil, then we skip the creation of this migration
+            # this is common for triggers where the template is respinsible for setting up
+            # multiple triggers (a mix of on update/insert and before/after etc.)
+            unless arguments.nil?
+              # we only provide a dependent function if the function has more than one trigger
+              # or is in a different schema, otherwise it is added to the same migration as this
+              # trigger and we don't need to worry about dependencies
+              if trigger.function && (trigger.function.triggers.count > 1 || trigger.table.schema != trigger.function.schema)
+                add_fragment(dependent_function: trigger.function, **arguments)
+              else
+                add_fragment(**arguments)
+              end
             end
 
           # no template, process this as a default trigger (takes all options)
@@ -124,8 +129,9 @@ module DynamicMigrations
         end
 
         def recreate_trigger original_trigger, updated_trigger
+          fragments = []
           # remove the original trigger
-          removal_fragment = remove_trigger original_trigger, <<~CODE_COMMENT
+          fragments << remove_trigger(original_trigger, <<~CODE_COMMENT)
             Removing original trigger because it has changed (it is recreated below)
             Changes:
               #{indent original_trigger.differences_descriptions(updated_trigger).join("\n")}
@@ -135,9 +141,10 @@ module DynamicMigrations
           recreation_fragment = add_trigger updated_trigger, <<~CODE_COMMENT
             Recreating this trigger
           CODE_COMMENT
+          fragments << recreation_fragment unless recreation_fragment.nil?
 
           # return the new fragments (the main reason to return them here is for the specs)
-          [removal_fragment, recreation_fragment]
+          fragments
         end
 
         # add a comment to a trigger

data/lib/dynamic_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DynamicMigrations
-  VERSION = "3.6.12"
+  VERSION = "3.6.14"
 end

data/sig/dynamic_migrations/active_record/migrators/foreign_key_constraint.rbs

@@ -5,7 +5,7 @@ module DynamicMigrations
   module ActiveRecord
     module Migrators
       module ForeignKeyConstraint
-        def add_foreign_key: (Symbol table_name, Array[Symbol] column_names, Symbol foreign_schema_name, Symbol foreign_table_name, Array[Symbol] foreign_column_names, name: Symbol, ?initially_deferred: bool, ?deferrable: bool, ?on_delete: Symbol, ?on_update: Symbol, ?comment: String?) -> void
+        def add_foreign_key: (Symbol table_name, Array[Symbol] column_names, Symbol foreign_table_name, Array[Symbol] foreign_column_names, name: Symbol, ?foreign_schema: Symbol?, ?initially_deferred: bool, ?deferrable: bool, ?on_delete: Symbol, ?on_update: Symbol, ?comment: String?) -> void
         def remove_foreign_key: (Symbol table_name, Symbol name) -> void
         def set_foreign_key_comment: (Symbol table_name, Symbol foreign_key_name, String comment) -> void
         def remove_foreign_key_comment: (Symbol table_name, Symbol foreign_key_name) -> void

data/sig/dynamic_migrations/postgres/generator/trigger.rbs

@@ -9,7 +9,7 @@ module DynamicMigrations
         def self.has_template?: (Symbol template_name) -> bool
         def self.add_template: (Symbol template_name, singleton(TriggerTemplateBase) template_class) -> void
 
-        def add_trigger: (Server::Database::Schema::Table::Trigger trigger, ?String? code_comment) -> Fragment
+        def add_trigger: (Server::Database::Schema::Table::Trigger trigger, ?String? code_comment) -> Fragment?
         def remove_trigger: (Server::Database::Schema::Table::Trigger trigger, ?String? code_comment) -> Fragment
         def recreate_trigger: (Server::Database::Schema::Table::Trigger original_trigger, Server::Database::Schema::Table::Trigger updated_trigger) -> Array[Fragment]
         def set_trigger_comment: (Postgres::Server::Database::Schema::Table::Trigger trigger, ?String? code_comment) -> Fragment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_migrations
 version: !ruby/object:Gem::Version
-  version: 3.6.12
+  version: 3.6.14
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg