activerecord-pg-format-db-structure 0.1.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Inline non-foreign key constraints into table declaration
+    class InlineConstraints
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+        @tables_with_constraint = {}
+      end
+
+      def transform!
+        extract_constraints_to_inline!
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in create_stmt: { relation: { schemaname:, relname: }}
+
+          relation = { schemaname:, relname: }
+          next unless @tables_with_constraint.include?(relation)
+
+          @tables_with_constraint[relation].each do |constraint|
+            add_constraint!(raw_statement, constraint)
+          end
+        end
+      end
+
+      private
+
+      def extract_constraints_to_inline!
+        raw_statements.delete_if do |raw_statement|
+          next unless match_alter_column_statement(raw_statement) in { table:, constraint: }
+
+          @tables_with_constraint[table] ||= []
+          @tables_with_constraint[table] << constraint
+
+          true
+        end
+      end
+
+      def match_alter_column_statement(raw_statement)
+        return unless raw_statement.stmt.to_h in {
+          alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            },
+            cmds: [{
+              alter_table_cmd: {
+                subtype: :AT_AddConstraint,
+                def: { constraint: },
+                behavior: :DROP_RESTRICT
+              }
+            }]
+          }
+        }
+
+        # Skip foreign keys
+        return if constraint in contype: :CONSTR_FOREIGN
+
+        {
+          table: { schemaname:, relname: },
+          constraint:
+        }
+      end
+
+      def add_constraint!(raw_statement, constraint)
+        raw_statement.stmt.create_stmt.table_elts << PgQuery::Node.new(
+          constraint: PgQuery::Constraint.new(constraint)
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Inline foreign key constraints.
+    #
+    # Note: using this transform makes the structure file no longer
+    # loadable, since tables should be created before a foreign key
+    # can target it.
+    class InlineForeignKeys
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+        @columns_with_foreign_key = {}
+      end
+
+      def transform!
+        extract_foreign_keys_to_inline!
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in create_stmt: { relation: { schemaname:, relname: }}
+
+          relation = { schemaname:, relname: }
+          next unless @columns_with_foreign_key.include?(relation)
+
+          @columns_with_foreign_key[relation].each do |column_name, constraint|
+            add_constraint!(raw_statement, column_name, constraint)
+          end
+        end
+      end
+
+      private
+
+      def extract_foreign_keys_to_inline!
+        raw_statements.delete_if do |raw_statement|
+          next unless match_alter_column_statement(raw_statement) in { column:, constraint: }
+
+          table = column.except(:colname)
+          @columns_with_foreign_key[table] ||= {}
+          @columns_with_foreign_key[table][column[:colname]] = constraint
+
+          true
+        end
+      end
+
+      def match_alter_column_statement(raw_statement)
+        # Extracting statements of this shape:
+        #
+        # ALTER TABLE ONLY ts.tn ALTER COLUMN c SET DEFAULT nextval('ts.tn_c_seq'::regclass);
+        #
+        # Which corresponds to what we get when using a SERIAL column
+        if raw_statement.stmt.to_h in {
+          alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            },
+            cmds: [{
+              alter_table_cmd: {
+                subtype: :AT_AddConstraint,
+                def: {
+                  constraint: {
+                    contype: :CONSTR_FOREIGN,
+                    conname:,
+                    initially_valid:,
+                    pktable:,
+                    fk_attrs: [{string: {sval: colname}}],
+                    pk_attrs:,
+                    fk_matchtype:,
+                    fk_upd_action:,
+                    fk_del_action:
+                  }
+                },
+                behavior: :DROP_RESTRICT
+              }
+            }]
+          }
+        }
+          {
+            column: { schemaname:, relname:, colname: },
+            constraint: {
+              contype: :CONSTR_FOREIGN,
+              conname:,
+              initially_valid:,
+              pktable:,
+              pk_attrs:,
+              fk_matchtype:,
+              fk_upd_action:,
+              fk_del_action:
+            }
+          }
+        end
+      end
+
+      def add_constraint!(raw_statement, colname, constraint)
+        raw_statement.stmt.create_stmt.table_elts.each do |table_elt|
+          next unless table_elt.to_h in { column_def: { colname: ^colname } }
+
+          table_elt.column_def.constraints << PgQuery::Node.new(
+            constraint: PgQuery::Constraint.new(constraint)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Inlines primary keys with the table declaration
+    class InlinePrimaryKeys
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+        @columns_with_primary_key = {}
+      end
+
+      def transform!
+        extract_primary_keys_to_inline!
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in create_stmt: { relation: { schemaname:, relname: }}
+
+          relation = { schemaname:, relname: }
+          primary_key = @columns_with_primary_key[relation]
+          add_primary_key!(raw_statement, primary_key) if primary_key
+        end
+      end
+
+      private
+
+      def extract_primary_keys_to_inline!
+        raw_statements.delete_if do |raw_statement|
+          next unless match_alter_column_statement(raw_statement) in { schemaname:, relname:, colname: }
+
+          column = { schemaname:, relname:, colname: }
+          table = column.except(:colname)
+          @columns_with_primary_key[table] = column[:colname]
+
+          true
+        end
+      end
+
+      def match_alter_column_statement(raw_statement)
+        return unless raw_statement.stmt.to_h in {
+          alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            },
+            cmds: [{
+              alter_table_cmd: {
+                subtype: :AT_AddConstraint,
+                def: {
+                  constraint: {
+                    contype: :CONSTR_PRIMARY,
+                    conname: _,
+                    keys: [{string: {sval: colname}}]
+                  }
+                },
+                behavior: :DROP_RESTRICT
+              }
+            }]
+          }
+        }
+
+        { schemaname:, relname:, colname: }
+      end
+
+      def add_primary_key!(raw_statement, colname)
+        raw_statement.stmt.create_stmt.table_elts.each do |table_elt|
+          next unless table_elt.to_h in { column_def: { colname: ^colname } }
+
+          table_elt.column_def.constraints.delete_if do |c|
+            c.to_h in { constraint: { contype: :CONSTR_NOTNULL } }
+          end
+
+          table_elt.column_def.constraints << PgQuery::Node.new(
+            constraint: PgQuery::Constraint.new(
+              contype: :CONSTR_PRIMARY
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Inline SERIAL declaration inside table declaration.
+    #
+    # Note: the logic looks for statements of this shape:
+    #
+    #    ALTER TABLE ONLY ts.tn ALTER COLUMN c SET DEFAULT nextval('ts.tn_c_seq'::regclass);
+    #
+    # It also assumes that the associated sequence has default settings. A
+    # later version could try to be more strict / validate that the
+    # sequence indeed has default settings.
+    class InlineSerials
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+        @columns_to_replace_with_serial = {}
+        @sequences_to_remove = Set.new
+      end
+
+      def transform!
+        extract_serials_to_inline!
+        delete_redundant_statements!
+        raw_statements.each do |raw_statement|
+          next unless raw_statement.stmt.to_h in create_stmt: { relation: { schemaname:, relname: }}
+
+          relation = { schemaname:, relname: }
+          next unless @columns_to_replace_with_serial.include?(relation)
+
+          @columns_to_replace_with_serial[relation].each do |colname|
+            replace_id_with_serial!(raw_statement, colname)
+          end
+        end
+      end
+
+      private
+
+      def extract_serials_to_inline!
+        raw_statements.delete_if do |raw_statement|
+          next unless match_alter_column_statement(raw_statement) in { column:, sequence: }
+
+          table = column.except(:column_name)
+          @columns_to_replace_with_serial[table] ||= []
+          @columns_to_replace_with_serial[table] << column[:column_name]
+          @sequences_to_remove << sequence
+
+          true
+        end
+      end
+
+      def match_alter_column_statement(raw_statement)
+        # Extracting statements of this shape:
+        #
+        # ALTER TABLE ONLY ts.tn ALTER COLUMN c SET DEFAULT nextval('ts.tn_c_seq'::regclass);
+        #
+        # Which corresponds to what we get when using a SERIAL column
+        return unless raw_statement.stmt.to_h in {
+          alter_table_stmt: {
+            objtype: :OBJECT_TABLE,
+            relation: {
+              schemaname:,
+              relname:
+            },
+            cmds: [{
+              alter_table_cmd: {
+                subtype: :AT_ColumnDefault,
+                name: column_name,
+                def: {
+                  func_call: {
+                    funcname: [{string: {sval: "nextval"}}],
+                    args: [{ type_cast: {arg: {a_const: {sval: {sval: sequence_qualified_name}}},
+                                         type_name: {names: [{string: {sval: "regclass"}}]}}}],
+                    funcformat: :COERCE_EXPLICIT_CALL
+                  }
+                },
+                behavior: :DROP_RESTRICT
+              }
+            }]
+          }
+        }
+        return unless sequence_qualified_name == "#{schemaname}.#{relname}_#{column_name}_seq"
+
+        {
+          column: { schemaname:, relname:, column_name: },
+          sequence: { schemaname:, relname: "#{relname}_#{column_name}_seq" }
+        }
+      end
+
+      COLUMN_TYPE_TO_SERIAL_TYPE = {
+        "int2" => "smallserial",
+        "int4" => "serial",
+        "int8" => "bigserial"
+      }.freeze
+
+      def replace_id_with_serial!(raw_statement, colname)
+        raw_statement.stmt.create_stmt.table_elts.each do |table_elt|
+          next unless table_elt.to_h in {
+            column_def: {
+              colname: ^colname,
+              type_name: { names: [{string: {sval: "pg_catalog"}},
+                                   {string: {sval: "int2" | "int4" | "int8" => integer_type}}] }}
+          }
+
+          table_elt.column_def.type_name = PgQuery::TypeName.new(
+            names: [
+              PgQuery::Node.new(string: PgQuery::String.new(
+                sval: COLUMN_TYPE_TO_SERIAL_TYPE.fetch(integer_type)
+              ))
+            ]
+          )
+        end
+      end
+
+      def delete_redundant_statements!
+        raw_statements.delete_if do |raw_statement|
+          case raw_statement.stmt.to_h
+          in create_seq_stmt: { sequence: { schemaname:, relname: }}
+            @sequences_to_remove.include?({ schemaname:, relname: })
+          in alter_seq_stmt: {sequence: { schemaname:, relname: }}
+            @sequences_to_remove.include?({ schemaname:, relname: })
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Move indice declaration just below the table they index
+    class MoveIndicesAfterCreateTable
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+      end
+
+      def transform!
+        extract_table_indices!.each do |table, indices|
+          insert_index = find_insert_index(**table)
+          sort_indices(indices).reverse.each do |index|
+            raw_statements.insert(insert_index + 1, index)
+          end
+        end
+      end
+
+      private
+
+      def find_insert_index(schemaname:, relname:)
+        raw_statements.find_index do |s|
+          s.stmt.to_h in {
+            create_stmt: { relation: { schemaname: ^schemaname, relname: ^relname } }
+          } | {
+            create_table_as_stmt: { into: { rel: { schemaname: ^schemaname, relname: ^relname } }}
+          }
+        end
+      end
+
+      def sort_indices(indices)
+        indices.sort_by do |s|
+          [
+            s.stmt.index_stmt.unique ? 0 : 1, # unique indices first
+            s.stmt.index_stmt.idxname
+          ]
+        end
+      end
+
+      def extract_table_indices!
+        indices = raw_statements.select { |s| s.stmt.to_h in index_stmt: _ }
+        raw_statements.delete_if { |s| s.stmt.to_h in index_stmt: _ }
+        indices.group_by do |s|
+          {
+            schemaname: s.stmt.index_stmt.relation.schemaname,
+            relname: s.stmt.index_stmt.relation.relname
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Remove COMMENT statement applied to extensions
+    class RemoveCommentsOnExtensions
+      attr_reader :raw_statements
+
+      def initialize(raw_statements)
+        @raw_statements = raw_statements
+      end
+
+      def transform!
+        raw_statements.delete_if do |raw_statement|
+          raw_statement.stmt.to_h in {
+            comment_stmt: { objtype: :OBJECT_EXTENSION }
+          }
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "activerecord-pg-format-db-structure/version"
+
+require_relative "activerecord-pg-format-db-structure/deparser"
+require_relative "activerecord-pg-format-db-structure/preprocessors/remove_whitespaces"
+require_relative "activerecord-pg-format-db-structure/transforms/remove_comments_on_extensions"
+require_relative "activerecord-pg-format-db-structure/transforms/inline_serials"
+require_relative "activerecord-pg-format-db-structure/transforms/inline_primary_keys"
+require_relative "activerecord-pg-format-db-structure/transforms/inline_foreign_keys"
+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"
+
+module ActiveRecordPgFormatDbStructure
+  DEFAULT_PREPROCESSORS = [
+    Preprocessors::RemoveWhitespaces
+  ].freeze
+
+  DEFAULT_TRANSFORMS = [
+    Transforms::RemoveCommentsOnExtensions,
+    Transforms::InlinePrimaryKeys,
+    # Transforms::InlineForeignKeys,
+    Transforms::InlineSerials,
+    Transforms::InlineConstraints,
+    Transforms::MoveIndicesAfterCreateTable,
+    Transforms::GroupAlterTableStatements
+  ].freeze
+
+  DEFAULT_DEPARSER = Deparser
+end
+
+# :nocov:
+require_relative "activerecord-pg-format-db-structure/railtie" if defined?(Rails)
+# :nocov:

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pg-format-db-structure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jell
+bindir: exe
+cert_chain: []
+date: 2025-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: automatically runs after each db:schema:dump and formats the output
+email:
+- rubygems@reify.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord-pg-format-db-structure.rb
+- lib/activerecord-pg-format-db-structure/deparser.rb
+- lib/activerecord-pg-format-db-structure/formatter.rb
+- lib/activerecord-pg-format-db-structure/preprocessors/remove_whitespaces.rb
+- lib/activerecord-pg-format-db-structure/railtie.rb
+- lib/activerecord-pg-format-db-structure/tasks/clean_db_structure.rake
+- lib/activerecord-pg-format-db-structure/transforms/group_alter_table_statements.rb
+- lib/activerecord-pg-format-db-structure/transforms/inline_constraints.rb
+- lib/activerecord-pg-format-db-structure/transforms/inline_foreign_keys.rb
+- lib/activerecord-pg-format-db-structure/transforms/inline_primary_keys.rb
+- 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/version.rb
+homepage: https://github.com/ReifyAB/activerecord-pg-format-db-structure
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ReifyAB/activerecord-pg-format-db-structure
+  source_code_uri: https://github.com/ReifyAB/activerecord-pg-format-db-structure
+  changelog_uri: https://github.com/ReifyAB/activerecord-pg-format-db-structure/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Automatic formatting of Rails db/structure.sql file using pg_query
+test_files: []