dynamic_migrations 3.1.0 → 3.2.0

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

@@ -3,15 +3,23 @@ module DynamicMigrations
     class Generator
       module Schema
         def create_schema schema, code_comment = nil
-          add_migration schema.name, nil, :create_schema, schema.name, code_comment, <<~RUBY
-            create_schema :#{schema.name}
-          RUBY
+          add_fragment schema: schema,
+            migration_method: :create_schema,
+            object: schema,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              create_schema :#{schema.name}
+            RUBY
         end
 
         def drop_schema schema, code_comment = nil
-          add_migration schema.name, nil, :drop_schema, schema.name, code_comment, <<~RUBY
-            drop_schema :#{schema.name}
-          RUBY
+          add_fragment schema: schema,
+            migration_method: :drop_schema,
+            object: schema,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              drop_schema :#{schema.name}
+            RUBY
         end
       end
     end

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

@@ -0,0 +1,17 @@
+module DynamicMigrations
+  module Postgres
+    class Generator
+      class SchemaMigration < Migration
+        # these sections are in order for which they will appear in a migration,
+        # note that removals come before additions, and that the order here optomizes
+        # for dependencies (i.e. columns have to be created before indexes are added and
+        # triggers are removed before functions are dropped)
+        add_structure_template [:remove_function_comment, :drop_function], "Remove Functions"
+        add_structure_template [:drop_schema], "Drop this schema"
+        add_structure_template [:create_schema], "Create this schema"
+        add_structure_template [:create_function], "Functions"
+        add_structure_template [:update_function, :set_function_comment], "Update Functions"
+      end
+    end
+  end
+end

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

@@ -13,20 +13,30 @@ module DynamicMigrations
             raise NoTableCommentError, "Refusing to generate create_table migration, no description was provided for `#{table.schema.name}`.`#{table.name}`"
           end
 
-          add_migration table.schema.name, table.name, :create_table, table.name, code_comment, <<~RUBY
-            table_comment = <<~COMMENT
-              #{indent table.description}
-            COMMENT
-            create_table :#{table.name}, #{table_options table} do |t|
-              #{indent table_columns(table.columns)}
-            end
-          RUBY
+          add_fragment schema: table.schema,
+            table: table,
+            migration_method: :create_table,
+            object: table,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              table_comment = <<~COMMENT
+                #{indent table.description}
+              COMMENT
+              create_table :#{table.name}, #{table_options table} do |t|
+                #{indent table_columns(table.columns)}
+              end
+            RUBY
         end
 
         def drop_table table, code_comment = nil
-          add_migration table.schema.name, table.name, :drop_table, table.name, code_comment, <<~RUBY
-            drop_table :#{table.name}, force: true
-          RUBY
+          add_fragment schema: table.schema,
+            table: table,
+            migration_method: :drop_table,
+            object: table,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              drop_table :#{table.name}, force: true
+            RUBY
         end
 
         # add a comment to a table
@@ -37,18 +47,28 @@ module DynamicMigrations
             raise MissingDescriptionError
           end
 
-          add_migration table.schema.name, table.name, :set_table_comment, table.name, code_comment, <<~RUBY
-            set_table_comment :#{table.name}, <<~COMMENT
-              #{indent description}
-            COMMENT
-          RUBY
+          add_fragment schema: table.schema,
+            table: table,
+            migration_method: :set_table_comment,
+            object: table,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              set_table_comment :#{table.name}, <<~COMMENT
+                #{indent description}
+              COMMENT
+            RUBY
         end
 
         # remove the comment from a table
         def remove_table_comment table, code_comment = nil
-          add_migration table.schema.name, table.name, :remove_table_comment, table.name, code_comment, <<~RUBY
-            remove_table_comment :#{table.name}
-          RUBY
+          add_fragment schema: table.schema,
+            table: table,
+            migration_method: :remove_table_comment,
+            object: table,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_table_comment :#{table.name}
+            RUBY
         end
 
         private

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

@@ -0,0 +1,51 @@
+module DynamicMigrations
+  module Postgres
+    class Generator
+      class TableMigration < Migration
+        class UnexpectedTableError < StandardError
+        end
+
+        class MissingRequiredTableName < StandardError
+        end
+
+        # these sections are in order for which they will appear in a migration,
+        # note that removals come before additions, and that the order here optomizes
+        # for dependencies (i.e. columns have to be created before indexes are added and
+        # triggers are removed before functions are dropped)
+        add_structure_template [:remove_trigger_comment, :remove_trigger], "Remove Triggers"
+        add_structure_template [:remove_validation, :remove_unique_constraint], "Remove Validations"
+        add_structure_template [:remove_foreign_key], "Remove Foreign Keys"
+        add_structure_template [:remove_primary_key], "Remove Primary Keys"
+        add_structure_template [:remove_index, :remove_index_comment], "Remove Indexes"
+        add_structure_template [:remove_column], "Remove Columns"
+        add_structure_template [:drop_table], "Remove Tables"
+        add_structure_template [:create_table], "Create Table"
+        add_structure_template [:remove_table_comment, :set_table_comment], "Tables"
+        add_structure_template [:add_column], "Additional Columns"
+        add_structure_template [:change_column, :remove_column_comment, :set_column_comment], "Update Columns"
+        add_structure_template [:add_primary_key], "Primary Key"
+        add_structure_template [:add_index, :set_index_comment], "Indexes"
+        add_structure_template [:add_foreign_key, :set_foreign_key_constraint_comment, :remove_foreign_key_constraint_comment], "Foreign Keys"
+        add_structure_template [:add_validation, :add_unique_constraint, :set_validation_comment, :remove_validation_comment, :set_unique_constraint_comment, :remove_unique_constraint_comment], "Validations"
+        add_structure_template [:create_function], "Functions"
+        add_structure_template [:add_trigger, :set_trigger_comment], "Triggers"
+        add_structure_template [:update_function, :set_function_comment], "Update Functions"
+
+        attr_accessor :table_name
+
+        def initialize schema_name, table_name
+          raise MissingRequiredTableName unless table_name
+          super schema_name
+          @table_name = table_name
+        end
+
+        def add_fragment fragment
+          unless @table_name == fragment.table_name
+            raise UnexpectedTableError, "Frgment is for table `#{fragment.table_name}` but migration is for table `#{@table_name}`"
+          end
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -46,15 +46,25 @@ module DynamicMigrations
 
           options_syntax = options.map { |k, v| "#{k}: #{v}" }.join(", ")
 
-          add_migration trigger.table.schema.name, trigger.table.name, :add_trigger, trigger.name, code_comment, <<~RUBY
-            #{method_name} :#{trigger.table.name}, #{options_syntax}
-          RUBY
+          add_fragment schema: trigger.table.schema,
+            table: trigger.table,
+            migration_method: :add_trigger,
+            object: trigger,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              #{method_name} :#{trigger.table.name}, #{options_syntax}
+            RUBY
         end
 
         def remove_trigger trigger, code_comment = nil
-          add_migration trigger.table.schema.name, trigger.table.name, :remove_trigger, trigger.name, code_comment, <<~RUBY
-            remove_trigger :#{trigger.table.name}, :#{trigger.name}
-          RUBY
+          add_fragment schema: trigger.table.schema,
+            table: trigger.table,
+            migration_method: :remove_trigger,
+            object: trigger,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_trigger :#{trigger.table.name}, :#{trigger.name}
+            RUBY
         end
 
         def recreate_trigger original_trigger, updated_trigger
@@ -82,18 +92,28 @@ module DynamicMigrations
             raise MissingDescriptionError
           end
 
-          add_migration trigger.table.schema.name, trigger.table.name, :set_trigger_comment, trigger.name, code_comment, <<~RUBY
-            set_trigger_comment :#{trigger.table.name}, :#{trigger.name}, <<~COMMENT
-              #{indent description}
-            COMMENT
-          RUBY
+          add_fragment schema: trigger.table.schema,
+            table: trigger.table,
+            migration_method: :set_trigger_comment,
+            object: trigger,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              set_trigger_comment :#{trigger.table.name}, :#{trigger.name}, <<~COMMENT
+                #{indent description}
+              COMMENT
+            RUBY
         end
 
         # remove the comment from a trigger
         def remove_trigger_comment trigger, code_comment = nil
-          add_migration trigger.table.schema.name, trigger.table.name, :remove_trigger_comment, trigger.name, code_comment, <<~RUBY
-            remove_trigger_comment :#{trigger.table.name}, :#{trigger.name}
-          RUBY
+          add_fragment schema: trigger.table.schema,
+            table: trigger.table,
+            migration_method: :remove_trigger_comment,
+            object: trigger,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_trigger_comment :#{trigger.table.name}, :#{trigger.name}
+            RUBY
         end
       end
     end

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

@@ -24,15 +24,25 @@ module DynamicMigrations
 
           options_syntax = options.map { |k, v| "#{k}: #{v}" }.join(", ")
 
-          add_migration unique_constraint.table.schema.name, unique_constraint.table.name, :add_unique_constraint, unique_constraint.name, code_comment, <<~RUBY
-            add_unique_constraint :#{unique_constraint.table.name}, #{column_names}, #{options_syntax}
-          RUBY
+          add_fragment schema: unique_constraint.table.schema,
+            table: unique_constraint.table,
+            migration_method: :add_unique_constraint,
+            object: unique_constraint,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              add_unique_constraint :#{unique_constraint.table.name}, #{column_names}, #{options_syntax}
+            RUBY
         end
 
         def remove_unique_constraint unique_constraint, code_comment = nil
-          add_migration unique_constraint.table.schema.name, unique_constraint.table.name, :remove_unique_constraint, unique_constraint.name, code_comment, <<~RUBY
-            remove_unique_constraint :#{unique_constraint.table.name}, :#{unique_constraint.name}
-          RUBY
+          add_fragment schema: unique_constraint.table.schema,
+            table: unique_constraint.table,
+            migration_method: :remove_unique_constraint,
+            object: unique_constraint,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_unique_constraint :#{unique_constraint.table.name}, :#{unique_constraint.name}
+            RUBY
         end
 
         def recreate_unique_constraint original_unique_constraint, updated_unique_constraint
@@ -60,18 +70,28 @@ module DynamicMigrations
             raise MissingDescriptionError
           end
 
-          add_migration unique_constraint.table.schema.name, unique_constraint.table.name, :set_unique_constraint_comment, unique_constraint.name, code_comment, <<~RUBY
-            set_unique_constraint_comment :#{unique_constraint.table.name}, :#{unique_constraint.name}, <<~COMMENT
-              #{indent description}
-            COMMENT
-          RUBY
+          add_fragment schema: unique_constraint.table.schema,
+            table: unique_constraint.table,
+            migration_method: :set_unique_constraint_comment,
+            object: unique_constraint,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              set_unique_constraint_comment :#{unique_constraint.table.name}, :#{unique_constraint.name}, <<~COMMENT
+                #{indent description}
+              COMMENT
+            RUBY
         end
 
         # remove the comment from a unique_constraint
         def remove_unique_constraint_comment unique_constraint, code_comment = nil
-          add_migration unique_constraint.table.schema.name, unique_constraint.table.name, :remove_unique_constraint_comment, unique_constraint.name, code_comment, <<~RUBY
-            remove_unique_constraint_comment :#{unique_constraint.table.name}, :#{unique_constraint.name}
-          RUBY
+          add_fragment schema: unique_constraint.table.schema,
+            table: unique_constraint.table,
+            migration_method: :remove_unique_constraint_comment,
+            object: unique_constraint,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_unique_constraint_comment :#{unique_constraint.table.name}, :#{unique_constraint.name}
+            RUBY
         end
       end
     end

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

@@ -28,19 +28,29 @@ module DynamicMigrations
             validation_sql << ";"
           end
 
-          add_migration validation.table.schema.name, validation.table.name, :add_validation, validation.name, code_comment, (comment_sql + <<~RUBY)
-            add_validation :#{validation.table.name}, #{options_syntax} do
-              <<~SQL
-                #{indent validation_sql}
-              SQL
-            end
-          RUBY
+          add_fragment schema: validation.table.schema,
+            table: validation.table,
+            migration_method: :add_validation,
+            object: validation,
+            code_comment: code_comment,
+            migration: comment_sql + <<~RUBY
+              add_validation :#{validation.table.name}, #{options_syntax} do
+                <<~SQL
+                  #{indent validation_sql}
+                SQL
+              end
+            RUBY
         end
 
         def remove_validation validation, code_comment = nil
-          add_migration validation.table.schema.name, validation.table.name, :remove_validation, validation.name, code_comment, <<~RUBY
-            remove_validation :#{validation.table.name}, :#{validation.name}
-          RUBY
+          add_fragment schema: validation.table.schema,
+            table: validation.table,
+            migration_method: :remove_validation,
+            object: validation,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_validation :#{validation.table.name}, :#{validation.name}
+            RUBY
         end
 
         def recreate_validation original_validation, updated_validation
@@ -68,18 +78,28 @@ module DynamicMigrations
             raise MissingDescriptionError
           end
 
-          add_migration validation.table.schema.name, validation.table.name, :set_validation_comment, validation.name, code_comment, <<~RUBY
-            set_validation_comment :#{validation.table.name}, :#{validation.name}, <<~COMMENT
-              #{indent description}
-            COMMENT
-          RUBY
+          add_fragment schema: validation.table.schema,
+            table: validation.table,
+            migration_method: :set_validation_comment,
+            object: validation,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              set_validation_comment :#{validation.table.name}, :#{validation.name}, <<~COMMENT
+                #{indent description}
+              COMMENT
+            RUBY
         end
 
         # remove the comment from a validation
         def remove_validation_comment validation, code_comment = nil
-          add_migration validation.table.schema.name, validation.table.name, :remove_validation_comment, validation.name, code_comment, <<~RUBY
-            remove_validation_comment :#{validation.table.name}, :#{validation.name}
-          RUBY
+          add_fragment schema: validation.table.schema,
+            table: validation.table,
+            migration_method: :remove_validation_comment,
+            object: validation,
+            code_comment: code_comment,
+            migration: <<~RUBY
+              remove_validation_comment :#{validation.table.name}, :#{validation.name}
+            RUBY
         end
       end
     end