dynamic_migrations 3.8.6 → 3.8.8

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

@@ -23,6 +23,9 @@ module DynamicMigrations
               class DuplicateColumnError < StandardError
               end
 
+              class InvalidNameError < StandardError
+              end
+
               attr_reader :table
               attr_reader :name
               attr_reader :deferrable
@@ -45,12 +48,13 @@ module DynamicMigrations
                   add_column column
                 end
 
-                raise ExpectedSymbolError, name unless name.is_a? Symbol
+                raise InvalidNameError, "Unexpected name `#{name}`. Name should be a Symbol" unless name.is_a? Symbol
+                raise InvalidNameError, "The name `#{name}` is too long. Names must be less than 64 characters" unless name.length < 64
                 @name = name
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description.strip
+                  @description = description.strip.freeze
                   @description = nil if description == ""
                 end
 

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

@@ -26,25 +26,27 @@ module DynamicMigrations
               class UnnormalizableCheckClauseError < StandardError
               end
 
+              class InvalidNameError < StandardError
+              end
+
               attr_reader :table
               attr_reader :name
               attr_reader :check_clause
-              attr_reader :deferrable
-              attr_reader :initially_deferred
               attr_reader :description
               attr_reader :template
 
               # initialize a new object to represent a validation in a postgres table
-              def initialize source, table, columns, name, check_clause, description: nil, deferrable: false, initially_deferred: false, template: nil
+              def initialize source, table, columns, name, check_clause, description: nil, template: nil
                 super source
                 raise ExpectedTableError, table unless table.is_a? Table
                 @table = table
 
-                raise ExpectedSymbolError, name unless name.is_a? Symbol
+                raise InvalidNameError, "Unexpected name `#{name}`. Name should be a Symbol" unless name.is_a? Symbol
+                raise InvalidNameError, "The name `#{name}` is too long. Names must be less than 64 characters" unless name.length < 64
                 @name = name
 
                 raise ExpectedStringError, check_clause unless check_clause.is_a? String
-                @check_clause = check_clause.strip
+                @check_clause = check_clause.strip.freeze
 
                 # if this validation is created via configuration (apposed to being loaded) then they can be lazy loaded
                 unless from_configuration? && columns.nil?
@@ -61,16 +63,10 @@ module DynamicMigrations
 
                 unless description.nil?
                   raise ExpectedStringError, description unless description.is_a? String
-                  @description = description.strip
+                  @description = description.strip.freeze
                   @description = nil if description == ""
                 end
 
-                raise ExpectedBooleanError, deferrable unless [true, false].include?(deferrable)
-                @deferrable = deferrable
-
-                raise ExpectedBooleanError, initially_deferred unless [true, false].include?(initially_deferred)
-                @initially_deferred = initially_deferred
-
                 unless template.nil?
                   unless Generator::Validation.has_template? template
                     raise UnexpectedTemplateError, "Unrecognised template #{template}"
@@ -96,14 +92,12 @@ module DynamicMigrations
               end
 
               def column_names
-                columns.map(&:name)
+                columns.map(&:name).sort
               end
 
               def differences_descriptions other_validation
                 method_differences_descriptions other_validation, [
-                  :normalized_check_clause,
-                  :deferrable,
-                  :initially_deferred
+                  :normalized_check_clause
                 ]
               end
 
@@ -134,7 +128,7 @@ module DynamicMigrations
 
                   temp_enums = table.create_temp_table(connection, "validation_normalized_check_clause_temp_table")
 
-                  temp_check_clause = check_clause
+                  temp_check_clause = check_clause.dup
                   # string replace any real enum names with their temp enum names
                   temp_enums.each do |temp_enum_name, enum|
                     temp_check_clause.gsub!("::#{enum.name}", "::#{temp_enum_name}")
@@ -182,8 +176,7 @@ module DynamicMigrations
 
                   # string replace any enum names with their real enum names
                   temp_enums.each do |temp_enum_name, enum|
-                    real_enum_name = (enum.schema == table.schema) ? enum.name : enum.full_name
-                    check_clause_result.gsub!("::#{temp_enum_name}", "::#{real_enum_name}")
+                    check_clause_result.gsub!("::#{temp_enum_name}", "::#{enum.full_name}")
                   end
 
                   column_names_result = column_names_string.gsub(/\A\{/, "").gsub(/\}\Z/, "").split(",").map { |column_name| column_name.to_sym }

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

@@ -16,6 +16,9 @@ module DynamicMigrations
             class PrimaryKeyAlreadyExistsError < StandardError
             end
 
+            class MissingExtensionError < StandardError
+            end
+
             include Columns
             include Validations
             include Indexes
@@ -40,7 +43,7 @@ module DynamicMigrations
 
               unless description.nil?
                 raise ExpectedStringError, description unless description.is_a? String
-                @description = description.strip
+                @description = description.strip.freeze
                 @description = nil if description == ""
               end
 
@@ -116,7 +119,64 @@ module DynamicMigrations
               end
 
               # in case any of the columnbs are citext columns
-              connection.exec("CREATE EXTENSION IF NOT EXISTS citext;")
+              # in case any of the columns use the citext data type
+              required_extensions = []
+              if columns.any? { |column| column.data_type.start_with? "citext" }
+                required_extensions << "citext"
+              end
+              if columns.any? { |column| column.data_type.start_with? "postgis" }
+                required_extensions << "postgis"
+              end
+
+              required_extensions.each do |extension_name|
+                extension_result = connection.exec(<<~SQL)
+                  SELECT
+                    (
+                      SELECT 1
+                      FROM pg_available_extensions
+                      WHERE name = '#{extension_name}'
+                    ) as is_available,
+                    (
+                      SELECT 1
+                      FROM pg_extension
+                      WHERE extname = '#{extension_name}'
+                    ) as is_installed
+                SQL
+
+                row = extension_result.first
+                raise MissingExtensionError, "unexpected error" if row.nil?
+
+                unless row["is_installed"]
+                  detail = if row["is_available"]
+                    <<~DETAIL
+                      The `#{extension_name}` extension is available for installation,
+                      but has not been installed for this database.
+                    DETAIL
+                  else
+                    <<~DETAIL
+                      The `#{extension_name}` extension is not installed, and does not
+                      appear to be available for installation.
+                    DETAIL
+                  end
+                  raise MissingExtensionError, <<~ERROR.tr!("\n", " ")
+                    This table uses the `#{extension_name}` data type. #{detail}
+                    Add the extension, then generate and run the migrations which will
+                    enable the extension for your database before defining validations
+                    or triggers which rely on it.
+
+                    Note, the `#{extension_name}` extension is required even for defining
+                    some validations and triggers. This library needs to connect to postgres
+                    and gererate normalized versions of validation check clauses and trigger
+                    action conditions before it can even compare them to validations or triggers
+                    which may or may not already exist in the database.
+                  ERROR
+                end
+              end
+
+              # if any of the columns require postgis
+              if required_extensions.include? "postgis"
+                connection.exec("SET search_path TO public,postgis;")
+              end
 
               # note, this is not actually a TEMP TABLE, it is created within a transaction
               # and rolled back.

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

@@ -86,9 +86,7 @@ module DynamicMigrations
               table[validation_name] = {
                 columns: row["columns"].gsub(/\A\{/, "").gsub(/\}\Z/, "").split(",").map { |column_name| column_name.to_sym },
                 check_clause: check_clause,
-                description: row["description"],
-                deferrable: row["deferrable"] == "TRUE",
-                initially_deferred: row["initially_deferred"] == "TRUE"
+                description: row["description"]
               }
             end
             schemas

data/lib/dynamic_migrations/version.rb

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

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

@@ -5,7 +5,7 @@ module DynamicMigrations
   module ActiveRecord
     module Migrators
       module Validation
-        def add_validation: (Symbol table_name, name: Symbol, ?initially_deferred: bool, ?deferrable: bool, ?comment: String?) -> void
+        def add_validation: (Symbol table_name, name: Symbol, ?comment: String?) -> void
         def remove_validation: (Symbol table_name, Symbol name) -> void
         def set_validation_comment: (Symbol table_name, Symbol validation_name, String comment) -> void
         def remove_validation_comment: (Symbol table_name, Symbol validation_name) -> void

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

@@ -10,6 +10,8 @@ module DynamicMigrations
         def drop_enum: (Server::Database::Schema::Enum enum, ?String? code_comment) -> Fragment
         def set_enum_comment: (Server::Database::Schema::Enum enum, ?String? code_comment) -> Fragment
         def remove_enum_comment: (Server::Database::Schema::Enum enum, ?String? code_comment) -> Fragment
+        def optional_enum_table: (Postgres::Server::Database::Schema::Enum enum) -> Server::Database::Schema::Table?
+
         # these come from the generator object (which this module is included into)
         def add_fragment: (migration_method: Symbol, object: untyped, migration: String, ?schema: Server::Database::Schema?, ?table: Server::Database::Schema::Table?, ?code_comment: String?, ?dependent_table: Server::Database::Schema::Table?, ?dependent_function: Server::Database::Schema::Function?, ?dependent_enum: Server::Database::Schema::Enum?) -> Fragment
         def indent: (String migration, ?Integer levels) -> String

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

@@ -40,6 +40,9 @@ module DynamicMigrations
 
         class InvalidNameError < StandardError
         end
+
+        class ContentRequiredError < StandardError
+        end
       end
     end
   end

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

@@ -10,6 +10,7 @@ module DynamicMigrations
         def drop_function: (Postgres::Server::Database::Schema::Function function, ?String? code_comment) -> Fragment
         def set_function_comment: (Postgres::Server::Database::Schema::Function function, ?String? code_comment) -> Fragment
         def remove_function_comment: (Postgres::Server::Database::Schema::Function function, ?String? code_comment) -> Fragment
+        def optional_function_table: (Postgres::Server::Database::Schema::Function function) -> Server::Database::Schema::Table?
 
         # these come from the generator object (which this module is included into)
         def add_fragment: (migration_method: Symbol, object: untyped, migration: String, ?schema: Server::Database::Schema?, ?table: Server::Database::Schema::Table?, ?code_comment: String?, ?dependent_table: Server::Database::Schema::Table?, ?dependent_function: Server::Database::Schema::Function?, ?dependent_enum: Server::Database::Schema::Enum?) -> Fragment

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

@@ -22,6 +22,7 @@ module DynamicMigrations
         def enum_dependencies: -> Array[{schema_name: Symbol, enum_name: Symbol}]
         def function_dependencies: -> Array[{schema_name: Symbol, function_name: Symbol}]
 
+        def fragments_with_table_dependency_count: (Symbol schema_name, Symbol table_name) -> Integer
         def extract_fragments_with_table_dependency: (Symbol schema_name, Symbol table_name) -> Array[Fragment]
 
         def content: -> String

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

@@ -5,6 +5,8 @@ module DynamicMigrations
   module Postgres
     class Generator
       class SchemaMigration < Migration
+        def schema_name: -> Symbol
+
         def initialize: (Symbol schema_name) -> void
 
       end

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

@@ -5,6 +5,9 @@ module DynamicMigrations
   module Postgres
     class Generator
       class TableMigration < Migration
+        def schema_name: -> Symbol
+        def table_name: -> Symbol
+
         def initialize: (Symbol schema_name, Symbol table_name) -> void
       end
     end

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

@@ -15,7 +15,6 @@ module DynamicMigrations
         def fragment_arguments: -> {schema: Postgres::Server::Database::Schema, table: Postgres::Server::Database::Schema::Table, migration_method: Symbol, object: untyped, code_comment: String?, migration: String, dependent_function: Postgres::Server::Database::Schema::Function?}
 
         private
-        def assert_not_deferred!: -> void
         def assert_column_count!: (?Integer count) -> void
         def first_column: -> Postgres::Server::Database::Schema::Table::Column
         def value_from_check_clause: (Regexp regex) -> untyped

data/sig/dynamic_migrations/postgres/generator.rbs

@@ -7,6 +7,7 @@ module DynamicMigrations
       include TSort
 
       @fragments: Array[Fragment]
+      @logger: Logging::Logger
 
       include Schema
       include Table
@@ -27,13 +28,14 @@ module DynamicMigrations
       }]
 
       private
-      def circular_dependency?: (Symbol schema_name, Symbol table_name, {schema_name: Symbol, table_name: Symbol} dependency, Array[TableMigration] all_table_migrations) -> bool
+      def resolve_circular_dependencies: (TableMigration table_migration, Array[TableMigration] all_table_migrations, Hash[Symbol, untyped] database_migrations, Array[TableMigration] completed_table_migrations, ?Array[String] stack) -> void
       def supported_migration_method?: (Symbol migration_method) -> bool
       def add_fragment: (migration_method: Symbol, object: untyped, migration: String, ?schema: Server::Database::Schema?, ?table: Server::Database::Schema::Table?, ?code_comment: String?, ?dependent_table: Server::Database::Schema::Table?, ?dependent_function: Server::Database::Schema::Function?, ?dependent_enum: Server::Database::Schema::Enum?) -> Fragment
       def indent: (String migration, ?Integer levels) -> String
       def tsort_each_node: -> Enumerator[untyped, untyped]
       def tsort_each_child: (untyped node) -> untyped
       def trim_lines: (String migration) -> String
+      def log: -> Logging::Logger
 
       class ExpectedSymbolError < StandardError
       end

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

@@ -30,6 +30,9 @@ module DynamicMigrations
 
             class ValueMustBeStringError < StandardError
             end
+
+            class EnumValueTooLongError < StandardError
+            end
           end
         end
       end

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

@@ -27,6 +27,9 @@ module DynamicMigrations
 
               class UnexpectedEnumError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -43,6 +43,9 @@ module DynamicMigrations
 
               class UnexpectedReferentialActionError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -53,6 +53,9 @@ module DynamicMigrations
 
               class DuplicateColumnError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -31,6 +31,9 @@ module DynamicMigrations
 
               class DuplicateColumnError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -65,6 +65,9 @@ module DynamicMigrations
 
               class UnnormalizableActionConditionError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -40,6 +40,9 @@ module DynamicMigrations
 
               class DuplicateColumnError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -11,12 +11,10 @@ module DynamicMigrations
               attr_reader table: Table
               attr_reader name: Symbol
               attr_reader check_clause: String
-              attr_reader deferrable: bool
-              attr_reader initially_deferred: bool
               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, ?description: String?, ?template: Symbol?) -> void
               def columns: -> Array[Column]
               def column_names: -> Array[Symbol]
               def has_description?: -> bool
@@ -50,6 +48,9 @@ module DynamicMigrations
 
               class UnnormalizableCheckClauseError < StandardError
               end
+
+              class InvalidNameError < StandardError
+              end
             end
           end
         end

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

@@ -31,6 +31,9 @@ module DynamicMigrations
 
             class PrimaryKeyAlreadyExistsError < StandardError
             end
+
+            class MissingExtensionError < StandardError
+            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_migrations
 version: !ruby/object:Gem::Version
-  version: 3.8.6
+  version: 3.8.8
 platform: ruby
 authors:
 - Craig Ulliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-08 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -96,7 +96,6 @@ files:
 - lib/dynamic_migrations/expected_symbol_error.rb
 - lib/dynamic_migrations/invalid_source_error.rb
 - lib/dynamic_migrations/module_included_into_unexpected_target_error.rb
-- lib/dynamic_migrations/name_helper.rb
 - lib/dynamic_migrations/postgres.rb
 - lib/dynamic_migrations/postgres/connections.rb
 - lib/dynamic_migrations/postgres/generator.rb

data/lib/dynamic_migrations/name_helper.rb

@@ -1,13 +0,0 @@
-module DynamicMigrations
-  module NameHelper
-    # shortens a table name like 'invoice_subscription_prepayments' to 'inv_sub_pre'
-    warn "no unit tests"
-    def abbreviate_table_name table_name
-      table_name_without_schema = table_name.to_s.split(".").last
-      if table_name_without_schema.nil?
-        raise "no table name provided"
-      end
-      table_name_without_schema.split("_").map { |v| v[0..2] }.join("_")
-    end
-  end
-end