dynamic_migrations 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8f9a1a4cf3316579443b0fed7898a42ab410ba114d194c5ffb874a5ca5027d9
-  data.tar.gz: 03651b7187cef799edee4d64e9c7533f0c6fb9ce0f9193b16e721c13e508373b
+  metadata.gz: d3402241c1537169c438a53ccadd5bc53c048479d75164afe5ec7659bc8f65c3
+  data.tar.gz: 0dd0e31a82d757ee980b12c51f8baff81cc9a698308be775a2112bc89fa75fc3
 SHA512:
-  metadata.gz: cfdbf88d363b8280f18d1aa63cc7ad9d917de7d5c0582ae43a02ac9341af4c00918f6cd5382c935c2a1a1026873afdd98e2aed42397a722b8660fb876133408a
-  data.tar.gz: 35451e4c7cfbcfa0a7dec0133b726d005c32ff4c1d7d2792737f24b4b7c2da98b0ba50250f30876f99743d16b911201243d0a0252f162794ec6a08e1955cc634
+  metadata.gz: 27fd59935f7d85a81fde4ce74899490917396d8598be9f3a23c8fb5b59a49f9049c85a703ec50d3e9b4040db6ce0acb72ecfa579eb2304bf7d8a79a17ebbccda
+  data.tar.gz: 043f54479dfbe7078755a4a258f7ff8a7d0d6fc12208e6849f5a452b473fc28fd0f04c612b9af959f0c69d1b230107a90409b122dcf0e92f33cc32ea1067f716

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [3.3.0](https://github.com/craigulliott/dynamic_migrations/compare/v3.2.2...v3.3.0) (2023-08-18)
+
+
+### Features
+
+* adding parameters to triggers ([0d48466](https://github.com/craigulliott/dynamic_migrations/commit/0d484664dd344c34804580fb939a2807339a0552))
+
+
+### Bug Fixes
+
+* only accepting action_order for loaded triggers, and calculating its value dynamically for configured triggers ([0d48466](https://github.com/craigulliott/dynamic_migrations/commit/0d484664dd344c34804580fb939a2807339a0552))
+* providing full function definition within specs (to conform with updated pg_spec_helper gem) ([0d48466](https://github.com/craigulliott/dynamic_migrations/commit/0d484664dd344c34804580fb939a2807339a0552))
+* removing unused action_statement from triggers ([0d48466](https://github.com/craigulliott/dynamic_migrations/commit/0d484664dd344c34804580fb939a2807339a0552))
+
 ## [3.2.2](https://github.com/craigulliott/dynamic_migrations/compare/v3.2.1...v3.2.2) (2023-08-17)
 
 

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

@@ -18,17 +18,10 @@ module DynamicMigrations
             fn_sql = block.call.strip
           end
 
-          # ensure that the function ends with a semicolon
-          unless fn_sql.end_with? ";"
-            fn_sql << ";"
-          end
-
           # schema_name was not provided to this method, it comes from the migration class
           execute <<~SQL
             CREATE FUNCTION #{schema_name}.#{function_name}() returns trigger language plpgsql AS
-            $$BEGIN #{fn_sql}
-            RETURN NEW;
-            END$$;
+            $$#{fn_sql}$$;
           SQL
 
           if comment.is_a? String
@@ -46,11 +39,6 @@ module DynamicMigrations
             fn_sql = block.call.strip
           end
 
-          # ensure that the function ends with a semicolon
-          unless fn_sql.end_with? ";"
-            fn_sql << ";"
-          end
-
           # schema_name was not provided to this method, it comes from the migration class
           # assert it already exists
           exists_result = execute <<~SQL
@@ -72,9 +60,7 @@ module DynamicMigrations
           # create or replace will update the function
           execute <<~SQL
             CREATE OR REPLACE FUNCTION #{schema_name}.#{function_name}() returns trigger language plpgsql AS
-            $$BEGIN #{fn_sql}
-            RETURN NEW;
-            END$$;
+            $$#{fn_sql}$$;
           SQL
 
           if comment.is_a? String

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

@@ -16,7 +16,7 @@ module DynamicMigrations
         end
 
         # create a postgres trigger
-        def add_trigger table_name, name:, action_timing:, event_manipulation:, action_orientation:, function_schema_name:, function_name:, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, comment: nil
+        def add_trigger table_name, name:, action_timing:, event_manipulation:, action_orientation:, function_schema_name:, function_name:, parameters: nil, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, comment: nil
           unless [:insert, :delete, :update].include? event_manipulation
             raise UnexpectedEventManipulationError, event_manipulation
           end
@@ -53,7 +53,7 @@ module DynamicMigrations
               #{timing_sql} ON #{schema_name}.#{table_name} #{temp_tables_sql}
                 FOR EACH #{action_orientation}
                   #{condition_sql}
-                  EXECUTE FUNCTION #{function_schema_name}.#{function_name}();
+                  EXECUTE FUNCTION #{function_schema_name}.#{function_name}(#{parameters});
           SQL
 
           if comment.is_a? String

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

@@ -20,10 +20,6 @@ module DynamicMigrations
           optional_options_syntax = (options_syntax == "") ? "" : ", #{options_syntax}"
 
           fn_sql = function.definition.strip
-          # ensure that the function ends with a semicolon
-          unless fn_sql.end_with? ";"
-            fn_sql << ";"
-          end
 
           add_fragment schema: function.schema,
             table: function.triggers.first&.table,
@@ -33,7 +29,7 @@ module DynamicMigrations
             migration: comment_sql + <<~RUBY
               create_function :#{function.name}#{optional_options_syntax} do
                 <<~SQL
-                  #{indent fn_sql}
+                  #{indent fn_sql, 2}
                 SQL
               end
             RUBY
@@ -41,10 +37,6 @@ module DynamicMigrations
 
         def update_function function, code_comment = nil
           fn_sql = function.definition.strip
-          # ensure that the function ends with a semicolon
-          unless fn_sql.end_with? ";"
-            fn_sql << ";"
-          end
 
           add_fragment schema: function.schema,
             table: function.triggers.first&.table,
@@ -54,7 +46,7 @@ module DynamicMigrations
             migration: <<~RUBY
               update_function :#{function.name} do
                 <<~SQL
-                  #{indent fn_sql}
+                  #{indent fn_sql, 2}
                 SQL
               end
             RUBY

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

@@ -28,6 +28,10 @@ module DynamicMigrations
             options[:action_condition] = ":#{trigger.action_condition}"
           end
 
+          unless trigger.parameters.nil?
+            options[:parameters] = "\"#{trigger.parameters}\""
+          end
+
           unless trigger.action_reference_old_table.nil?
             options[:action_reference_old_table] = ":#{trigger.action_reference_old_table}"
           end

data/lib/dynamic_migrations/postgres/generator.rb

@@ -216,8 +216,9 @@ module DynamicMigrations
         fragment
       end
 
-      def indent multi_line_string
-        multi_line_string.gsub("\n", "\n  ")
+      def indent multi_line_string, levels = 1
+        spaces = "  " * levels
+        multi_line_string.gsub("\n", "\n#{spaces}")
       end
 
       def strip_empty_lines multi_line_string

data/lib/dynamic_migrations/postgres/server/database/differences.rb

@@ -198,7 +198,7 @@ module DynamicMigrations
                 :event_manipulation,
                 :action_order,
                 :action_condition,
-                :action_statement,
+                :parameters,
                 :action_orientation,
                 :action_reference_old_table,
                 :action_reference_new_table,

data/lib/dynamic_migrations/postgres/server/database/loaded_schemas_builder.rb

@@ -92,7 +92,7 @@ module DynamicMigrations
                   table.add_trigger trigger_name, action_timing: trigger_definition[:action_timing],
                     event_manipulation: trigger_definition[:event_manipulation],
                     action_order: trigger_definition[:action_order],
-                    action_statement: trigger_definition[:action_statement],
+                    parameters: trigger_definition[:parameters],
                     action_orientation: trigger_definition[:action_orientation],
                     function: function,
                     action_condition: trigger_definition[:action_condition],

data/lib/dynamic_migrations/postgres/server/database/schema/function.rb

@@ -31,10 +31,10 @@ module DynamicMigrations
               raise ExpectedSymbolError, name unless name.is_a? Symbol
               @name = name
 
-              unless definition.is_a?(String) && definition.strip != ""
-                raise ExpectedDefinitionError, definition
+              unless definition.is_a?(String) && definition.strip != "" && definition.strip.end_with?("END;")
+                raise ExpectedDefinitionError, "Definition must be a string, and end with `END;`. Definition provided:\n#{definition}"
               end
-              @definition = definition
+              @definition = definition.strip
 
               unless description.nil?
                 raise ExpectedStringError, description unless description.is_a? String

data/lib/dynamic_migrations/postgres/server/database/schema/table/trigger.rb

@@ -14,10 +14,7 @@ module DynamicMigrations
               class UnexpectedEventManipulationError < StandardError
               end
 
-              class UnexpectedActionOrderError < StandardError
-              end
-
-              class UnexpectedActionStatementError < StandardError
+              class UnexpectedParametersError < StandardError
               end
 
               class UnexpectedActionOrientationError < StandardError
@@ -35,13 +32,15 @@ module DynamicMigrations
               class ExpectedFunctionError < StandardError
               end
 
+              class UnexpectedActionOrderError < StandardError
+              end
+
               attr_reader :table
               attr_reader :name
               attr_reader :event_manipulation
               attr_reader :action_timing
-              attr_reader :action_order
               attr_reader :action_condition
-              attr_reader :action_statement
+              attr_reader :parameters
               attr_reader :action_orientation
               attr_reader :function
               attr_reader :action_reference_old_table
@@ -49,7 +48,7 @@ module DynamicMigrations
               attr_reader :description
 
               # initialize a new object to represent a validation in a postgres table
-              def initialize source, table, name, action_timing:, event_manipulation:, action_order:, action_statement:, action_orientation:, function:, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, description: nil
+              def initialize source, table, name, action_timing:, event_manipulation:, parameters:, action_orientation:, function:, action_order: nil, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, description: nil
                 super source
 
                 unless table.is_a? Table
@@ -72,20 +71,27 @@ module DynamicMigrations
                 end
                 @event_manipulation = event_manipulation
 
-                unless action_order.is_a?(Integer) && action_order >= 1
-                  raise UnexpectedActionOrderError, action_order
+                if from_configuration?
+                  unless action_order.nil?
+                    raise UnexpectedActionOrderError, "Unexpected `action_order` argument. Action order is calculated dynamically for configured triggers."
+                  end
+
+                else
+                  unless action_order.is_a?(Integer) && action_order >= 1
+                    raise UnexpectedActionOrderError, "Missing valid `action_order` argument. Action order must be provided for triggers loaded from the database."
+                  end
+                  @action_order = action_order
                 end
-                @action_order = action_order
 
                 unless action_condition.nil? || action_condition.is_a?(String)
                   raise ExpectedStringError, action_condition
                 end
                 @action_condition = action_condition
 
-                unless action_statement.is_a?(String) && action_statement[/\AEXECUTE FUNCTION [a-z]+(_[a-z]+)*\.[a-z]+(_[a-z]+)*\(\)\z/]
-                  raise UnexpectedActionStatementError, "unexpected action statement `#{action_statement}`, currently only `EXECUTE FUNCTION function_name()` statements are supported"
+                unless parameters.nil? || (parameters.is_a?(String) && parameters[/\A'[\w\d_ -]+'(, ?'[\w\d_ -]+')*\z/])
+                  raise UnexpectedParametersError, "unexpected parameters `#{parameters}`, currently only a comma seeparated list of strings is supported"
                 end
-                @action_statement = action_statement
+                @parameters = parameters
 
                 unless [:row, :statement].include? action_orientation
                   raise UnexpectedActionOrientationError, action_orientation
@@ -120,6 +126,42 @@ module DynamicMigrations
                 end
               end
 
+              def action_order
+                # if the source is the database, then return the locally stored
+                # representation of the action order
+                if from_database?
+                  action_order = @action_order
+                  if action_order.nil?
+                    raise "Missing valid action_order. This should be impossible."
+                  end
+                  action_order
+
+                # otherwise return the dynamically calculated action order, this is calculated
+                # by returning this triggers index in the list of alphabetically sorted triggers
+                # for this triggers table
+                else
+                  pos = @table.triggers.sort_by(&:name).index(self)
+                  if pos.nil?
+                    raise "Trigger not found in table triggers list. This should be impossible."
+                  end
+                  pos + 1
+                end
+              end
+
+              def action_condition= new_action_condition
+                unless new_action_condition.nil? || new_action_condition.is_a?(String)
+                  raise ExpectedStringError, new_action_condition
+                end
+                @action_condition = new_action_condition
+              end
+
+              def parameters= new_parameters
+                unless new_parameters.nil? || new_parameters.is_a?(String)
+                  raise ExpectedStringError, new_parameters
+                end
+                @parameters = new_parameters
+              end
+
               # return true if this has a description, otherwise false
               def has_description?
                 !@description.nil?
@@ -131,7 +173,7 @@ module DynamicMigrations
                   :action_timing,
                   :action_order,
                   :action_condition,
-                  :action_statement,
+                  :parameters,
                   :action_orientation,
                   :action_reference_old_table,
                   :action_reference_new_table

data/lib/dynamic_migrations/postgres/server/database/schema/table/triggers.rb

@@ -38,13 +38,13 @@ module DynamicMigrations
               end
 
               # adds a new trigger to this table, and returns it
-              def add_trigger name, action_timing:, event_manipulation:, action_order:, action_statement:, action_orientation:, function:, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, description: nil
+              def add_trigger name, action_timing:, event_manipulation:, parameters:, action_orientation:, function:, action_order: nil, action_condition: nil, action_reference_old_table: nil, action_reference_new_table: nil, description: nil
                 if has_trigger? name
                   raise(TriggerAlreadyExistsError, "Trigger #{name} already exists")
                 end
                 included_target = self
                 if included_target.is_a? Table
-                  new_trigger = @triggers[name] = Trigger.new source, included_target, name, action_timing: action_timing, event_manipulation: event_manipulation, action_order: action_order, action_statement: action_statement, action_orientation: action_orientation, function: function, action_condition: action_condition, action_reference_old_table: action_reference_old_table, action_reference_new_table: action_reference_new_table, description: description
+                  new_trigger = @triggers[name] = Trigger.new source, included_target, name, action_timing: action_timing, event_manipulation: event_manipulation, action_order: action_order, parameters: parameters, action_orientation: action_orientation, function: function, action_condition: action_condition, action_reference_old_table: action_reference_old_table, action_reference_new_table: action_reference_new_table, description: description
                 else
                   raise ModuleIncludedIntoUnexpectedTargetError, included_target
                 end

data/lib/dynamic_migrations/postgres/server/database/triggers_and_functions_loader.rb

@@ -35,22 +35,14 @@ module DynamicMigrations
                     '.{35,} WHEN ((.+)) EXECUTE FUNCTION'
                   )
                 ) [1] ELSE NULL END AS action_condition,
-                p_n.nspname AS function_schema,
-                p.proname AS function_name,
-                p.prosrc AS function_definition,
                 SUBSTRING(
                   pg_get_triggerdef(t.oid)
                   FROM
-                    POSITION(
-                      ('EXECUTE FUNCTION') IN (
-                        SUBSTRING(
-                          pg_get_triggerdef(t.oid)
-                          FROM
-                            48
-                        )
-                      )
-                    ) + 47
-                ) AS action_statement,
+                  '\\(([\d\w_''-]+)\\)$'
+                ) AS parameters,
+                p_n.nspname AS function_schema,
+                p.proname AS function_name,
+                p.prosrc AS function_definition,
                 CASE t.tgtype & 1 WHEN 1 THEN 'row' ELSE 'statement' END AS action_orientation,
                 CASE t.tgtype & 66 WHEN 2 THEN 'before' WHEN 64 THEN 'instead_of' ELSE 'after' END AS action_timing,
                 t.tgoldtable AS action_reference_old_table,
@@ -112,7 +104,7 @@ module DynamicMigrations
                 function_schema: row["function_schema"].to_sym,
                 function_name: row["function_name"].to_sym,
                 function_definition: row["function_definition"],
-                action_statement: row["action_statement"],
+                parameters: row["parameters"],
                 action_orientation: row["action_orientation"].to_sym,
                 action_timing: row["action_timing"].to_sym,
                 # `action_reference_old_table` and `action_reference_new_table` can be null

data/lib/dynamic_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_migrations
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg