Add migration helpers

Author: Taucher2003

lib/code0/zero_track/database/migration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      class Migration
+        # rubocop:disable Naming/ClassAndModuleCamelCase
+        class V1_0 < ::ActiveRecord::Migration[7.1]
+          include Database::MigrationHelpers::AddColumnEnhancements
+          include Database::MigrationHelpers::ConstraintHelpers
+          include Database::MigrationHelpers::IndexHelpers
+          include Database::MigrationHelpers::TableEnhancements
+        end
+        # rubocop:enable Naming/ClassAndModuleCamelCase
+
+        def self.[](version)
+          version = version.to_s
+          name = "V#{version.tr('.', '_')}"
+          raise ArgumentError, "Invalid migration version: #{version}" unless const_defined?(name, false)
+
+          const_get(name, false)
+        end
+      end
+    end
+  end
+end

lib/code0/zero_track/database/migration_helpers/add_column_enhancements.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      module MigrationHelpers
+        module AddColumnEnhancements
+          def add_column(table_name, column_name, type, *args, **kwargs, &block)
+            helper_context = self
+
+            limit = kwargs.delete(:limit)
+            unique = kwargs.delete(:unique)
+
+            super
+
+            return unless type == :text
+
+            quoted_column_name = helper_context.quote_column_name(column_name)
+
+            if limit
+              name = helper_context.send(:text_limit_name, table_name, column_name)
+
+              definition = "char_length(#{quoted_column_name}) <= #{limit}"
+
+              add_check_constraint(table_name, definition, name: name)
+            end
+
+            if unique.is_a?(Hash)
+              unique[:where] = "#{column_name} IS NOT NULL" if unique.delete(:allow_nil_duplicate)
+              column_name = "LOWER(#{quoted_column_name})" if unique.delete(:case_insensitive)
+
+              add_index table_name, column_name, unique: true, **unique
+            elsif unique
+              add_index table_name, column_name, unique: unique
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/code0/zero_track/database/migration_helpers/constraint_helpers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      module MigrationHelpers
+        module ConstraintHelpers
+          def text_limit_name(table, column, name: nil)
+            name.presence || check_constraint_name(table, column, 'max_length')
+          end
+
+          def check_constraint_name(table, column, type)
+            identifier = "#{table}_#{column}_check_#{type}"
+            hashed_identifier = Digest::SHA256.hexdigest(identifier).first(10)
+
+            "check_#{hashed_identifier}"
+          end
+        end
+      end
+    end
+  end
+end

lib/code0/zero_track/database/migration_helpers/index_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      module MigrationHelpers
+        module IndexHelpers
+          def index_name(table, column, type)
+            identifier = "#{table}_#{column}_index_#{type}"
+            hashed_identifier = Digest::SHA256.hexdigest(identifier).first(10)
+
+            "index_#{hashed_identifier}"
+          end
+        end
+      end
+    end
+  end
+end

lib/code0/zero_track/database/migration_helpers/table_enhancements.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Code0
+  module ZeroTrack
+    module Database
+      module MigrationHelpers
+        module TableEnhancements
+          def create_table(table_name, *args, **kwargs, &block)
+            helper_context = self
+
+            super do |t|
+              enhance(t, table_name, helper_context, &block)
+            end
+          end
+
+          def change_table(table_name, *args, **kwargs, &block)
+            helper_context = self
+
+            super do |t|
+              enhance(t, table_name, helper_context, &block)
+            end
+          end
+
+          private
+
+          def enhance(t, table_name, helper_context, &block)
+            t.define_singleton_method(:text) do |column_name, **inner_kwargs|
+              limit = inner_kwargs.delete(:limit)
+              unique = inner_kwargs.delete(:unique)
+
+              super(column_name, **inner_kwargs)
+
+              quoted_column_name = helper_context.quote_column_name(column_name)
+
+              if limit
+                name = helper_context.send(:text_limit_name, table_name, column_name)
+
+                definition = "char_length(#{quoted_column_name}) <= #{limit}"
+
+                t.check_constraint(definition, name: name)
+              end
+
+              if unique.is_a?(Hash)
+                index_definition = column_name
+                unique[:where] = "#{column_name} IS NOT NULL" if unique.delete(:allow_nil_duplicate)
+                index_definition = "LOWER(#{quoted_column_name})" if unique.delete(:case_insensitive)
+
+                t.index index_definition, unique: true, **unique
+              elsif unique
+                t.index column_name, unique: unique
+              end
+            end
+
+            t.define_singleton_method(:integer) do |column_name, **inner_kwargs|
+              unique = inner_kwargs.delete(:unique)
+
+              super(column_name, **inner_kwargs)
+
+              t.index column_name, unique: unique unless unique.nil?
+            end
+
+            return if block.nil?
+
+            t.instance_eval do |obj|
+              if block.arity == 1
+                block.call(obj)
+              elsif block.arity == 2
+                block.call(obj, helper_context)
+              else
+                raise ArgumentError, "Unsupported arity of #{block.arity}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end