dynamic_migrations 3.6.16 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166ee1f91202640e9ad50fd80c0cb4fade2993ba6ca873ff4bdbf207d939ce81
-  data.tar.gz: e23bc180aa98886aecd575a4b869d595d08f4d90136a59e7de46b7f42b6cbe11
+  metadata.gz: 22fd29f59924e820da26858d1cf6caf04b03985ecc2fafd5f49205f5a0c2b34e
+  data.tar.gz: a8164cec22385ede8954df04e86c866bdb9d1ae4d420ba9107353f96e1a525e8
 SHA512:
-  metadata.gz: e3b9df7db4f4eed952f7144c52eda7a46447d66cdb83e44fff32f97f335cfb78e03ebd87d0e000f781b8c596a21615ccff085933032c8e2534d900864b242f36
-  data.tar.gz: e0ce6d30f2d346dbbb69ae506674aef00dc49eefe04c48d7cf7c8e81e06fea11fe5afb33e7822e87302c1d514d8be5da16070ecbc622829e51bfecc87f650885
+  metadata.gz: ec4eb2339d1ce110393eae8747c9e2aabee426d58a4e3caca8e01b7dd48ddfe99291ab903c9c7ba2e474a8b509a7185850132c1934f512c8ebe710e763243ba9
+  data.tar.gz: 50076bbed1405f301476ac49f0886207f9fde401c47af062fafa4095139cd3287699b8054cac4583b97422180f8fb3be935d94ac87b1ccd071a293972811eec7

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [3.7.0](https://github.com/craigulliott/dynamic_migrations/compare/v3.6.16...v3.7.0) (2023-09-27)
+
+
+### Features
+
+* providing access to foreign key constraints from both sides of the association ([48dcf1c](https://github.com/craigulliott/dynamic_migrations/commit/48dcf1cd4cdb23bc37da3e47b00f8007b8bc0f8a))
+
+
+### Bug Fixes
+
+* allowing foreign keys to the same table because they are valid and sometimes useful ([0566384](https://github.com/craigulliott/dynamic_migrations/commit/0566384a4cfeade757d9806059035477f7c41ee2))
+* lazy loading column names for validations when they were configured with a nil value for columns ([439200e](https://github.com/craigulliott/dynamic_migrations/commit/439200efdedf74dddc852bf9bd35e81c1f6b4336))
+* providing convenience method to retrieve columns base data type from array columns ([cd3d9bf](https://github.com/craigulliott/dynamic_migrations/commit/cd3d9bf06682335a890d9b11133d397d7bcd50af))
+* semi colon at the end of function definitions is now optional ([ca9b3aa](https://github.com/craigulliott/dynamic_migrations/commit/ca9b3aa04da23605ff61b2ec14baed927145d2c3))
+* structure loader was not identifying enums properly ([95276d3](https://github.com/craigulliott/dynamic_migrations/commit/95276d33f98f41eca9a9467bb6abeb458a37f16b))
+
 ## [3.6.16](https://github.com/craigulliott/dynamic_migrations/compare/v3.6.15...v3.6.16) (2023-09-16)
 
 

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

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

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

@@ -77,6 +77,12 @@ module DynamicMigrations
                 !@enum.nil?
               end
 
+              # for arrays returns the column type without the array brackets, for non arrays
+              # jsut returnms the column type
+              def base_data_type
+                array? ? @data_type[0..-3]&.to_sym : @data_type
+              end
+
               # sometimes this system makes temporary tables in order to fetch the normalized
               # version of constraint check clauses, function definitions or trigger action conditions
               # because certain data types might not yet exist, we need to use alternative types

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

@@ -14,9 +14,6 @@ module DynamicMigrations
               class ExpectedArrayOfColumnsError < StandardError
               end
 
-              class ExpectedDifferentTablesError < StandardError
-              end
-
               class DuplicateColumnError < StandardError
               end
 
@@ -49,14 +46,14 @@ module DynamicMigrations
                   raise ExpectedArrayOfColumnsError
                 end
 
-                if table.name == foreign_table.name && table.schema.name == foreign_table.schema.name
-                  raise ExpectedDifferentTablesError
-                end
-
                 # tables must be set before the columns are added
                 @table = table
                 @foreign_table = foreign_table
 
+                # add this foreign_key_constraint to the remote table (so we can always find
+                # these from both sides of the association)
+                @foreign_table.add_remote_foreign_key_constraint self
+
                 @columns = {}
                 columns.each do |column|
                   add_column column

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

@@ -61,6 +61,11 @@ module DynamicMigrations
                 # return the new foreign_key_constraint
                 new_foreign_key_constraint
               end
+
+              # called automatically from the other side of the foreign key constraint to keep track of the foreign key from both sides
+              def add_remote_foreign_key_constraint foreign_key_constraint
+                @remote_foreign_key_constraints << foreign_key_constraint
+              end
             end
           end
         end

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

@@ -54,7 +54,7 @@ module DynamicMigrations
               attr_reader :description
               attr_reader :template
 
-              # initialize a new object to represent a validation in a postgres table
+              # initialize a new object to represent a trigger in a postgres table
               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, template: nil
                 super source
 
@@ -201,7 +201,7 @@ module DynamicMigrations
                 descriptions
               end
 
-              # create a temporary table in postgres to represent this validation and fetch
+              # create a temporary table in postgres to represent this trigger and fetch
               # the actual normalized check constraint directly from the database
               def normalized_action_condition
                 if action_condition.nil?

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

@@ -37,22 +37,25 @@ module DynamicMigrations
                 raise ExpectedTableError, table unless table.is_a? Table
                 @table = table
 
-                # assert that the provided columns is an array
-                unless columns.is_a?(Array) && columns.count > 0
-                  raise ExpectedArrayOfColumnsError
-                end
-
-                @columns = {}
-                columns.each do |column|
-                  add_column column
-                end
-
                 raise ExpectedSymbolError, name unless name.is_a? Symbol
                 @name = name
 
                 raise ExpectedStringError, check_clause unless check_clause.is_a? String
                 @check_clause = check_clause.strip
 
+                # if this validation is created via configuration (apposed to being loaded) then they can be lazy loaded
+                unless from_configuration? && columns.nil?
+                  # assert that the provided columns is an array
+                  unless columns.is_a?(Array) && columns.count > 0
+                    raise ExpectedArrayOfColumnsError
+                  end
+
+                  @columns = {}
+                  columns.each do |column|
+                    add_column column
+                  end
+                end
+
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
                   @description = description.strip
@@ -80,11 +83,17 @@ module DynamicMigrations
 
               # return an array of this validations columns
               def columns
+                if @columns.nil?
+                  @columns = {}
+                  normalized_check_clause_and_column_names[:column_names].each do |column_name|
+                    add_column table.column(column_name)
+                  end
+                end
                 @columns.values
               end
 
               def column_names
-                @columns.keys.sort
+                columns.map(&:name)
               end
 
               def differences_descriptions other_validation
@@ -102,15 +111,19 @@ module DynamicMigrations
                 if from_database?
                   check_clause
                 else
-                  @normalized_check_clause ||= fetch_normalized_check_clause
+                  normalized_check_clause_and_column_names[:check_clause]
                 end
               end
 
               private
 
-              def fetch_normalized_check_clause
-                ncc = table.schema.database.with_connection do |connection|
-                  # wrapped in a transaction jsut in case something here fails, because
+              def normalized_check_clause_and_column_names
+                @normalized_check_clause_and_column_names ||= fetch_normalized_check_clause_and_column_names
+              end
+
+              def fetch_normalized_check_clause_and_column_names
+                result = table.schema.database.with_connection do |connection|
+                  # wrapped in a transaction just in case something here fails, because
                   # we don't want the temporary table to be persisted
                   connection.exec("BEGIN")
 
@@ -122,31 +135,46 @@ module DynamicMigrations
                     );
                   SQL
 
-                  # get the normalzed version of the constraint
+                  # get the normalized version of the constraint
                   rows = connection.exec(<<~SQL)
-                    SELECT pg_get_constraintdef(pg_constraint.oid) AS check_clause
+                    SELECT
+                      pg_get_constraintdef(pg_constraint.oid) AS check_clause,
+                      ARRAY_AGG(col.attname ORDER BY u.attposition) AS column_names
                     FROM pg_constraint
-                    WHERE conrelid = 'validation_normalized_check_clause_temp_table'::regclass;
+                    LEFT JOIN LATERAL UNNEST(pg_constraint.conkey)
+                      WITH ORDINALITY AS u(attnum, attposition)
+                      ON TRUE
+                    LEFT JOIN pg_attribute col
+                      ON
+                        (col.attrelid = pg_constraint.conrelid
+                        AND col.attnum = u.attnum)
+                    WHERE conrelid = 'validation_normalized_check_clause_temp_table'::regclass
+                    GROUP BY pg_constraint.oid;
                   SQL
 
                   # delete the temp table and close the transaction
                   connection.exec("ROLLBACK")
 
-                  # return the normalized check clause
-                  rows.first["check_clause"]
+                  rows.first
                 end
 
-                if ncc.nil?
+                if result["check_clause"].nil?
                   raise UnnormalizableCheckClauseError, "Failed to nomalize check clause `#{check_clause}`"
                 end
 
                 # extract the check clause from the result "CHECK(%check_clause%)"
-                matches = ncc.match(/\ACHECK \((?<inner_clause>.*)\)\z/)
+                matches = result["check_clause"].match(/\ACHECK \((?<inner_clause>.*)\)\z/)
                 if matches.nil?
-                  raise UnnormalizableCheckClauseError, "Unparsable normalized check_clause #{ncc}"
+                  raise UnnormalizableCheckClauseError, "Unparsable normalized check_clause #{result["check_clause"]}"
                 end
 
-                matches[:inner_clause]
+                normalized_column_names = result["column_names"].gsub(/\A\{/, "").gsub(/\}\Z/, "").split(",").map { |column_name| column_name.to_sym }
+
+                # return the normalized check clause
+                {
+                  check_clause: matches[:inner_clause],
+                  column_names: normalized_column_names
+                }
               end
 
               # used internally to set the columns from this objects initialize method

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

@@ -42,7 +42,7 @@ module DynamicMigrations
                 if has_validation? name
                   raise(ValidationAlreadyExistsError, "Validation #{name} already exists")
                 end
-                columns = column_names.map { |column_name| column column_name }
+                columns = column_names&.map { |column_name| column column_name }
                 included_target = self
                 if included_target.is_a? Table
                   new_validation = @validations[name] = Validation.new source, included_target, columns, name, check_clause, **validation_options

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

@@ -26,6 +26,7 @@ module DynamicMigrations
             attr_reader :schema
             attr_reader :name
             attr_reader :description
+            attr_reader :remote_foreign_key_constraints
 
             # initialize a new object to represent a postgres table
             def initialize source, schema, name, description: nil
@@ -47,6 +48,7 @@ module DynamicMigrations
               @validations = {}
               @indexes = {}
               @foreign_key_constraints = {}
+              @remote_foreign_key_constraints = []
               @triggers = {}
               @unique_constraints = {}
             end

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

@@ -108,7 +108,7 @@ module DynamicMigrations
 
                   column[:data_type] = row["data_type"].to_sym
                   column[:null] = row["is_nullable"] == "YES"
-                  column[:is_enum] = row["is_enum"] == "TRUE"
+                  column[:is_enum] = row["is_enum"] == "t"
                   column[:default] = row["column_default"]
                   column[:description] = row["column_description"]
                   column[:interval_type] = row["interval_type"].nil? ? nil : row["interval_type"].to_sym

data/lib/dynamic_migrations/version.rb

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

data/sig/dynamic_migrations/postgres/server/database/schema/table/column.rbs

@@ -20,6 +20,8 @@ module DynamicMigrations
               def array?: -> bool
               def enum?: -> bool
               def temp_table_data_type: -> Symbol
+              # untyped because we cant specify this logic in rbs yet (compiler is concerned this might be nil)
+              def base_data_type: -> untyped
 
               class ExpectedTableError < StandardError
               end

data/sig/dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraint.rbs

@@ -38,9 +38,6 @@ module DynamicMigrations
               class ExpectedArrayOfColumnsError < StandardError
               end
 
-              class ExpectedDifferentTablesError < StandardError
-              end
-
               class DuplicateColumnError < StandardError
               end
 

data/sig/dynamic_migrations/postgres/server/database/schema/table/foreign_key_constraints.rbs

@@ -12,6 +12,7 @@ module DynamicMigrations
               def foreign_key_constraints: -> Array[ForeignKeyConstraint]
               def foreign_key_constraints_hash: -> Hash[Symbol, ForeignKeyConstraint]
               def add_foreign_key_constraint: (Symbol name, Array[Symbol] column_names, Symbol foreign_schema_name, Symbol foreign_table_name, Array[Symbol] foreign_column_names, **untyped) -> untyped
+              def add_remote_foreign_key_constraint: (ForeignKeyConstraint foreign_key_constraint) -> untyped
 
               # these come from the table object (which this module is included into)
               def source: -> database_or_configuration

data/sig/dynamic_migrations/postgres/server/database/schema/table/validation.rbs

@@ -6,7 +6,7 @@ module DynamicMigrations
           class Table
             class Validation < Source
               @columns: Hash[Symbol, Column]
-              @normalized_check_clause: String?
+              @normalized_check_clause_and_column_names: {check_clause: String, column_names: Array[Symbol]}?
 
               attr_reader table: Table
               attr_reader name: Symbol
@@ -16,7 +16,7 @@ module DynamicMigrations
               attr_reader description: String?
               attr_reader template: Symbol?
 
-              def initialize: (database_or_configuration source, Table table, Array[Column] columns, Symbol name, String check_clause, ?deferrable: bool, ?initially_deferred: bool, ?description: String?, ?template: Symbol?) -> void
+              def initialize: (database_or_configuration source, Table table, Array[Column]? columns, Symbol name, String check_clause, ?deferrable: bool, ?initially_deferred: bool, ?description: String?, ?template: Symbol?) -> void
               def columns: -> Array[Column]
               def column_names: -> Array[Symbol]
               def has_description?: -> bool
@@ -24,7 +24,9 @@ module DynamicMigrations
               def normalized_check_clause: -> String
 
               private
-              def fetch_normalized_check_clause: -> String
+
+              def normalized_check_clause_and_column_names: -> {check_clause: String, column_names: Array[Symbol]}
+              def fetch_normalized_check_clause_and_column_names: -> {check_clause: String, column_names: Array[Symbol]}
 
               def add_column: (Column column) -> void
 

data/sig/dynamic_migrations/postgres/server/database/schema/table/validations.rbs

@@ -11,7 +11,7 @@ module DynamicMigrations
               def has_validation?: (Symbol name) -> bool
               def validations: -> Array[Validation]
               def validations_hash: -> Hash[Symbol, Validation]
-              def add_validation: (Symbol name, Array[Symbol] column_names, String check_clause, **untyped) -> untyped
+              def add_validation: (Symbol name, Array[Symbol]? column_names, String check_clause, **untyped) -> untyped
 
               # these come from the table object (which this module is included into)
               def source: -> database_or_configuration

data/sig/dynamic_migrations/postgres/server/database/schema/table.rbs

@@ -16,6 +16,7 @@ module DynamicMigrations
             attr_reader schema: Schema
             attr_reader name: Symbol
             attr_reader description: String?
+            attr_reader remote_foreign_key_constraints: Array[ForeignKeyConstraint]
             def initialize: (database_or_configuration source, Schema schema, Symbol name, ?description: String?) -> void
             def has_description?: -> bool
             def add_primary_key: (Symbol name, Array[Symbol] column_names, **untyped) -> untyped

metadata

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