activerecord-pg-format-db-structure 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eadcc90f7e5d8ec76f9f9494e7049646bf68ed37df502df31a1dc9fae87d2b6
-  data.tar.gz: bee026074f768393231546155fc52e0d00098cbdec981729a63c5a8d1efeb1c4
+  metadata.gz: 231e1ce74a64d5b68e27b122465855bf382cb24c5f573da3983b2ab1e11b3c23
+  data.tar.gz: 3341fb271ea14d6762cb879f28b6b526d51a76c37c83163fe26ce2955d9b1b83
 SHA512:
-  metadata.gz: efe9804695f586ea988faa923d5db83483b0a0e1395bdaaaabd3dcdbd93358d96a7c5a0f7688b5bf1512d4e14d49bf68f46c65000c9700cb3ad8ef7d63094908
-  data.tar.gz: dbdfa7873bd2551f2c1284befbd039c194cc87aaafea7690df8daabc84724c78a06ff3f021940204aa80cdef569566b9c81bfe4cc0aa3aa6180cb7a660e0bb21
+  metadata.gz: 2f06ac5c8140c6766f4dd77909ba62f60fb2b86b2453d4fad3eb190221de590025eb079e6c2e74999ff3e39fcf90dcac8b1751d52fa33bf9a33ec26ea9c05b91
+  data.tar.gz: 790f40bbc56b3b0062e72b7793a9c1645ea286f9a3f557f180aea1fc261dc52401ef721ee2320901cf2ec30d1dc6b763eb0662d30906ab6e351e0b4ab33b1377

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.5] - 2025-02-08
+
+- Sort table columns
+
+## [0.1.4] - 2025-02-08
+
+- Sort schema migrations inserts
+
 ## [0.1.3] - 2025-02-02
 
 - Rework SQL formatting by only adding indentation to deparsed statements

data/README.md

@@ -1,4 +1,7 @@
 # activerecord-pg-format-db-structure
+[![Gem Version](https://img.shields.io/gem/v/activerecord-pg-format-db-structure)](https://rubygems.org/gems/activerecord-pg-format-db-structure)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ReifyAB/activerecord-pg-format-db-structure/main.yml)
+
 
 Automatically cleans up your `structure.sql` file after each rails migration.
 
@@ -9,6 +12,8 @@ By default, it will:
 * Inline table constraints
 * Move index creation below their corresponding tables
 * Group `ALTER TABLE` statements into a single statement per table
+* Sorts table column declarations (primary key / foreign keys / data / timestamp / constraints)
+* Sorts `schema_migrations` inserts
 * Removes unnecessary whitespace
 
 The task will transform this raw `structure.sql`:
@@ -259,12 +264,14 @@ Rails.application.configure do
 
   config.activerecord_pg_format_db_structure.transforms = [
     ActiveRecordPgFormatDbStructure::Transforms::RemoveCommentsOnExtensions,
+    ActiveRecordPgFormatDbStructure::Transforms::SortSchemaMigrations,
     ActiveRecordPgFormatDbStructure::Transforms::InlinePrimaryKeys,
     # ActiveRecordPgFormatDbStructure::Transforms::InlineForeignKeys,
     ActiveRecordPgFormatDbStructure::Transforms::InlineSerials,
     ActiveRecordPgFormatDbStructure::Transforms::InlineConstraints,
     ActiveRecordPgFormatDbStructure::Transforms::MoveIndicesAfterCreateTable,
-    ActiveRecordPgFormatDbStructure::Transforms::GroupAlterTableStatements
+    ActiveRecordPgFormatDbStructure::Transforms::GroupAlterTableStatements,
+    ActiveRecordPgFormatDbStructure::Transforms::SortTableColumns,
   ]
 
   config.activerecord_pg_format_db_structure.deparser = ActiveRecordPgFormatDbStructure::Deparser
@@ -293,6 +300,10 @@ Remove unnecessary comment, whitespase and empty lines.
 
 Remove COMMENT statement applied to extensions
 
+### SortSchemaMigrations
+
+Sort schema_migrations inserts to be in chronological order, helps with reducing merge conflicts.
+
 ### InlinePrimaryKeys
 
 Inlines primary keys with the table declaration
@@ -334,6 +345,49 @@ table.
 
 Should be run after other operations that inline alter statements.
 
+### SortTableColumns
+
+Sort table columns, by order of priority and alphabetically:
+
+ 1. primary key
+ 2. foreign keys
+ 3. generic columns
+ 4. timestamps
+ 5. constraints
+
+Note that you can define your own ordering by replacing the default `priority_mapping`:
+
+```ruby
+ActiveRecordPgFormatDbStructure::Transforms::SortTableColumns.priority_mapping = lambda do |sortable_entry|
+  case sortable_entry
+  in is_column: true, is_primary_key: true, name:
+    [0, name]
+  in is_column: true, is_foreign_key: true, name:
+    [1, name]
+  in is_column: true, is_timestamp: false, name:
+    [2, name]
+  in is_column: true, is_timestamp: true, name:
+    [3, name]
+  in is_constraint: true, name:
+    [5, name]
+  end
+end
+```
+
+where `sortable_entry` is an instance of:
+
+```ruby
+SORTABLE_ENTRY = Data.define(
+  :name,
+  :is_column,
+  :is_constraint,
+  :is_primary_key,
+  :is_foreign_key,
+  :is_timestamp,
+  :raw_entry
+)
+```
+
 ## Deparser
 
 Returns an SQL string from raw PgQuery statements.

data/lib/activerecord-pg-format-db-structure/transforms/sort_schema_migrations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Sort schema migration inserts to reduce merge conflicts
+    class SortSchemaMigrations < Base
+      def transform!
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in insert_stmt: {
+            relation: { relname: "schema_migrations" },
+            select_stmt: { select_stmt: { values_lists: _ } }
+          }
+
+          raw_statement.stmt.insert_stmt.select_stmt.select_stmt.values_lists.sort_by! do |list|
+            list.list.items.first.a_const.sval.sval
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-pg-format-db-structure/transforms/sort_table_columns.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Sort table columns
+    class SortTableColumns < Base
+      SORTABLE_ENTRY = Data.define(
+        :name,
+        :is_column,
+        :is_constraint,
+        :is_primary_key,
+        :is_foreign_key,
+        :is_timestamp,
+        :raw_entry
+      )
+
+      class << self
+        attr_accessor :priority_mapping
+      end
+
+      self.priority_mapping = lambda do |sortable_entry|
+        case sortable_entry
+        in is_column: true, is_primary_key: true, name:
+          [0, name]
+        in is_column: true, is_foreign_key: true, name:
+          [1, name]
+        in is_column: true, is_timestamp: false, name:
+          [2, name]
+        in is_column: true, is_timestamp: true, name:
+          [3, name]
+        in is_constraint: true, name:
+          [5, name]
+          # :nocov:
+          # non-reachable else
+          # :nocov:
+        end
+      end
+
+      def transform!
+        foreign_keys = extract_foreign_keys
+        primary_keys = extract_primary_keys
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in create_stmt: { relation: { schemaname:, relname: } }
+
+          raw_statement.stmt.create_stmt.table_elts.sort_by! do |table_elt|
+            elt_priority(
+              table_elt:,
+              primary_keys: primary_keys.fetch({ schemaname:, relname: }, Set.new),
+              foreign_keys: foreign_keys.fetch({ schemaname:, relname: }, Set.new)
+            )
+          end
+        end
+      end
+
+      private
+
+      def extract_primary_keys
+        primary_keys = {}
+        raw_statements.each do |raw_statement|
+          case raw_statement.stmt.to_h
+          in alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            }
+          }
+            primary_keys[{ schemaname:, relname: }] ||= Set.new
+            raw_statement.stmt.alter_table_stmt.cmds.each do |cmd|
+              extract_primary_keys_from_alter_table_cmd(cmd:).each do |key|
+                primary_keys[{ schemaname:, relname: }] << key
+              end
+            end
+          in create_stmt: { relation: { schemaname:, relname: } }
+            primary_keys[{ schemaname:, relname: }] ||= Set.new
+            raw_statement.stmt.create_stmt.table_elts.each do |table_elt|
+              extract_primary_keys_from_table_elt(table_elt:).each do |key|
+                primary_keys[{ schemaname:, relname: }] << key
+              end
+            end
+          else
+          end
+        end
+        primary_keys
+      end
+
+      def extract_primary_keys_from_alter_table_cmd(cmd:)
+        if cmd.to_h in {
+          alter_table_cmd: {
+            subtype: :AT_AddConstraint,
+            def: {
+              constraint: {
+                contype: :CONSTR_PRIMARY
+              }
+            }
+          }
+        }
+          cmd.alter_table_cmd.def.constraint.keys.map do |key|
+            key.string.sval
+          end
+        else
+          []
+        end
+      end
+
+      def extract_primary_keys_from_table_elt(table_elt:)
+        case table_elt.to_h
+        in column_def: { constraints: [*, {constraint: {contype: :CONSTR_PRIMARY}}, *] }
+          [table_elt.column_def.colname]
+        in constraint: { contype: :CONSTR_PRIMARY }
+          table_elt.constraint.keys.map do |key|
+            key.string.sval
+          end
+        else
+          []
+        end
+      end
+
+      def extract_foreign_keys
+        foreign_keys = {}
+        raw_statements.each do |raw_statement|
+          case raw_statement.stmt.to_h
+          in alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            }
+          }
+            foreign_keys[{ schemaname:, relname: }] ||= Set.new
+            raw_statement.stmt.alter_table_stmt.cmds.each do |cmd|
+              extract_foreign_keys_from_alter_table_cmd(cmd:).each do |key|
+                foreign_keys[{ schemaname:, relname: }] << key
+              end
+            end
+          in create_stmt: { relation: { schemaname:, relname: } }
+            foreign_keys[{ schemaname:, relname: }] ||= Set.new
+            raw_statement.stmt.create_stmt.table_elts.each do |table_elt|
+              extract_foreign_keys_from_table_elt(table_elt:).each do |key|
+                foreign_keys[{ schemaname:, relname: }] << key
+              end
+            end
+          else
+          end
+        end
+        foreign_keys
+      end
+
+      def extract_foreign_keys_from_alter_table_cmd(cmd:)
+        if cmd.to_h in {
+          alter_table_cmd: {
+            subtype: :AT_AddConstraint,
+            def: {
+              constraint: {
+                contype: :CONSTR_FOREIGN
+              }
+            }
+          }
+        }
+          cmd.alter_table_cmd.def.constraint.fk_attrs.map do |fk_attr|
+            fk_attr.string.sval
+          end
+        else
+          []
+        end
+      end
+
+      def extract_foreign_keys_from_table_elt(table_elt:)
+        case table_elt.to_h
+        in column_def: { constraints: [*, {constraint: {contype: :CONSTR_FOREIGN}}, *] }
+          [table_elt.column_def.colname]
+        in constraint: { contype: :CONSTR_FOREIGN }
+          table_elt.constraint.fk_attrs.map do |fk_attr|
+            fk_attr.string.sval
+          end
+        else
+          []
+        end
+      end
+
+      def elt_priority(table_elt:, primary_keys:, foreign_keys:)
+        case table_elt.to_h
+        in column_def: _
+          self.class.priority_mapping[
+            SORTABLE_ENTRY.new(
+              name: table_elt.column_def.colname,
+              is_column: true,
+              is_constraint: false,
+              is_primary_key: primary_keys.include?(table_elt.column_def.colname),
+              is_timestamp: timestamp?(table_elt.column_def),
+              is_foreign_key: foreign_keys.include?(table_elt.column_def.colname),
+              raw_entry: table_elt
+            )
+          ]
+        in constraint: _
+          self.class.priority_mapping[
+            SORTABLE_ENTRY.new(
+              name: table_elt.constraint.conname,
+              is_column: false,
+              is_constraint: true,
+              is_primary_key: false,
+              is_timestamp: false,
+              is_foreign_key: false,
+              raw_entry: table_elt
+            )
+          ]
+          # :nocov:
+          # non-reachable else
+          # :nocov:
+        end
+      end
+
+      def timestamp?(table_elt)
+        table_elt.type_name.names.any? { |name| name.to_h in string: { sval: "timestamp" } }
+      end
+    end
+  end
+end

data/lib/activerecord-pg-format-db-structure/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordPgFormatDbStructure
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/activerecord-pg-format-db-structure.rb

@@ -11,6 +11,8 @@ require_relative "activerecord-pg-format-db-structure/transforms/inline_foreign_
 require_relative "activerecord-pg-format-db-structure/transforms/move_indices_after_create_table"
 require_relative "activerecord-pg-format-db-structure/transforms/inline_constraints"
 require_relative "activerecord-pg-format-db-structure/transforms/group_alter_table_statements"
+require_relative "activerecord-pg-format-db-structure/transforms/sort_schema_migrations"
+require_relative "activerecord-pg-format-db-structure/transforms/sort_table_columns"
 
 module ActiveRecordPgFormatDbStructure
   DEFAULT_PREPROCESSORS = [
@@ -19,12 +21,14 @@ module ActiveRecordPgFormatDbStructure
 
   DEFAULT_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
+    Transforms::SortSchemaMigrations,
     Transforms::InlinePrimaryKeys,
     # Transforms::InlineForeignKeys,
     Transforms::InlineSerials,
     Transforms::InlineConstraints,
     Transforms::MoveIndicesAfterCreateTable,
-    Transforms::GroupAlterTableStatements
+    Transforms::GroupAlterTableStatements,
+    Transforms::SortTableColumns
   ].freeze
 
   DEFAULT_DEPARSER = Deparser

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-format-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Jell
 bindir: exe
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -53,6 +53,8 @@ files:
 - lib/activerecord-pg-format-db-structure/transforms/inline_serials.rb
 - lib/activerecord-pg-format-db-structure/transforms/move_indices_after_create_table.rb
 - lib/activerecord-pg-format-db-structure/transforms/remove_comments_on_extensions.rb
+- lib/activerecord-pg-format-db-structure/transforms/sort_schema_migrations.rb
+- lib/activerecord-pg-format-db-structure/transforms/sort_table_columns.rb
 - lib/activerecord-pg-format-db-structure/version.rb
 homepage: https://github.com/ReifyAB/activerecord-pg-format-db-structure
 licenses: