activerecord-pg-format-db-structure 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0b4f6730ac7a280afddd46b476a8443e4cbbb3eac4004b92692223437f432c
-  data.tar.gz: b23c3a6ed71d6c46efa516d21f4c546dbdd3d2638f7c60046af0ff015d576f4d
+  metadata.gz: a18ecc82be3d91f7163c58a3e585c2fa4792767cf07467d3bee7e741fac2281b
+  data.tar.gz: 33def417b36f7f11eba8fce6d57f270aaf29b1320e6cf75b3a183719493bb2b5
 SHA512:
-  metadata.gz: f74568c5dcdecd2b0fe20d0823167e97a59da8593d534f877370b8e91b333a1a1c397c37913d5c81e91d8ccdfd254fc594f930ea1a0dab1ada589815ed8c38b5
-  data.tar.gz: 0eec46264e79d1ff729e12bef71bf6fd90291dbaff13ed88ae259f4e26b15cf7584ddb91a581d05d00df6c5b1ce4add028b4dc5f1318b32f89ef34dbbb8b0ddb
+  metadata.gz: a9a16f498480f55da503970918cf3a6df4e1899dd0c9331faa684b12ddbb32f1bde3935d7becae37f3e7f9e15190e0939f9587348c5786031c1c1edbf7cd7cfb
+  data.tar.gz: a1cead05ba2829d0fee3364e097495f7c100cc84cee09bfe2ae08e8b8a23d99ec5a16500af9d0611f5bf4f9db2b3fcc70ed492e1acc508aa2aa038e5db55de8e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-03-15
+
+- Introduce StatementAppender for better spacing between statements
+
+## [0.2.1] - 2025-02-15
+
+- Add transform to remove SET commands with default values
+
 ## [0.2.0] - 2025-02-15
 
 - Remove preprocessors (no longer relevant now that we don't reuse the source string in the output)

data/README.md

@@ -5,7 +5,7 @@
 
 Automatically cleans up your PostgreSQL `structure.sql` file after each rails migration.
 
-Say good-bye to small those small diffs you get between coworkers!
+Say good-bye to those pesky diffs you get between coworkers!
 
 By default, it will:
 
@@ -191,8 +191,6 @@ INSERT INTO "schema_migrations" (version) VALUES
 into this normalize (and much more compatch & readable) version:
 
 ```sql
-
-
 CREATE EXTENSION IF NOT EXISTS pgcrypto SCHEMA public;
 
 
@@ -265,6 +263,7 @@ If you want to configure which transforms to use, you can configure the library
 Rails.application.configure do
   config.activerecord_pg_format_db_structure.transforms = [
     ActiveRecordPgFormatDbStructure::Transforms::RemoveCommentsOnExtensions,
+    ActiveRecordPgFormatDbStructure::Transforms::RemoveDefaultsSetCommands,
     ActiveRecordPgFormatDbStructure::Transforms::SortSchemaMigrations,
     ActiveRecordPgFormatDbStructure::Transforms::InlinePrimaryKeys,
     # ActiveRecordPgFormatDbStructure::Transforms::InlineForeignKeys,
@@ -295,6 +294,27 @@ File.write("db/structure.sql", formatted)
 
 Remove COMMENT statement applied to extensions
 
+### RemoveDefaultsSetCommands
+
+Remove SET commands that apply default values to postgres settings. By default, the following defaults are handled:
+
+```ruby
+ActiveRecordPgFormatDbStructure::Transforms::RemoveDefaultsSetCommands.postgres_config_defaults = {
+  default_table_access_method: "heap",
+  default_with_oids: false,
+  idle_in_transaction_session_timeout: 0,
+  lock_timeout: 0,
+  statement_timeout: 0,
+  transaction_timeout: 0,
+  standard_conforming_strings: true,
+  xmloption: "content"
+}
+```
+
+Which are the default values since Postgres 9.1. You can make changes
+to the above config in case you want to handle more cases.
+
+
 ### SortSchemaMigrations
 
 Sort schema_migrations inserts to be in chronological order, helps with reducing merge conflicts.

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

@@ -32,42 +32,42 @@ module ActiveRecordPgFormatDbStructure
     private
 
     def deparse_stmt_generic(stmt)
-      generic_str = +"\n\n"
+      generic_str = +""
       generic_str << deparse_stmt_and_indent(stmt)
       generic_str << ";"
       generic_str
     end
 
     def deparse_stmt_compact(stmt)
-      compact_str = +"\n"
+      compact_str = +""
       compact_str << deparse_stmt(stmt)
       compact_str << ";"
       compact_str
     end
 
     def deparse_insert_stmt(stmt)
-      insert_str = +"\n\n\n"
+      insert_str = +""
       insert_str << deparse_stmt_and_indent(stmt)
       insert_str << "\n;"
       insert_str
     end
 
     def deparse_create_stmt(stmt)
-      table_str = "\n\n\n-- Name: #{stmt.relation.relname}; Type: TABLE;\n\n"
+      table_str = "-- Name: #{stmt.relation.relname}; Type: TABLE;\n\n"
       table_str << deparse_stmt_and_indent(stmt)
       table_str << ";"
       table_str
     end
 
     def deparse_view_stmt(stmt)
-      table_str = "\n\n\n-- Name: #{stmt.view.relname}; Type: VIEW;\n\n"
+      table_str = "-- Name: #{stmt.view.relname}; Type: VIEW;\n\n"
       table_str << deparse_stmt_and_indent(stmt)
       table_str << ";"
       table_str
     end
 
     def deparse_create_table_as_stmt(stmt)
-      table_str = "\n\n\n-- Name: #{stmt.into.rel.relname}; Type: MATERIALIZED VIEW;\n\n"
+      table_str = "-- Name: #{stmt.into.rel.relname}; Type: MATERIALIZED VIEW;\n\n"
       table_str << deparse_stmt_and_indent(stmt)
 
       # couldn't find a better solution for this, but probably an OK workaround?

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

@@ -6,14 +6,16 @@ require_relative "../activerecord-pg-format-db-structure"
 module ActiveRecordPgFormatDbStructure
   # Formats & normalizes in place the given SQL string
   class Formatter
-    attr_reader :transforms, :deparser
+    attr_reader :transforms, :deparser, :statement_appender
 
     def initialize(
       transforms: DEFAULT_TRANSFORMS,
-      deparser: DEFAULT_DEPARSER
+      deparser: DEFAULT_DEPARSER,
+      statement_appender: DEFAULT_STATEMENT_APPENDER
     )
       @transforms = transforms
       @deparser = deparser
+      @statement_appender = statement_appender
     end
 
     def format(source)
@@ -23,9 +25,17 @@ module ActiveRecordPgFormatDbStructure
         transform.new(raw_statements).transform!
       end
 
-      raw_statements.map do |raw_statement|
-        deparser.new(source).deparse_raw_statement(raw_statement)
-      end.compact.join
+      appender = statement_appender.new
+      raw_statements.each do |raw_statement|
+        statement = deparser.new(source).deparse_raw_statement(raw_statement)
+        appender.append_statement!(
+          statement,
+          statement_kind: PgQuery::Node.inner_class_to_name(
+            raw_statement.stmt.inner.class
+          )
+        )
+      end
+      appender.output
     end
   end
 end

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

@@ -6,6 +6,7 @@ module ActiveRecordPgFormatDbStructure
     config.activerecord_pg_format_db_structure = ActiveSupport::OrderedOptions.new
     config.activerecord_pg_format_db_structure.transforms = DEFAULT_TRANSFORMS.dup
     config.activerecord_pg_format_db_structure.deparser = DEFAULT_DEPARSER
+    config.activerecord_pg_format_db_structure.statement_appender = DEFAULT_STATEMENT_APPENDER
 
     rake_tasks do
       load "activerecord-pg-format-db-structure/tasks/clean_db_structure.rake"

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "pg_query"
+require_relative "indenter"
+
+module ActiveRecordPgFormatDbStructure
+  # Appends statements with reasonable spacing in-between
+  class StatementAppender
+    attr_reader :output
+
+    def initialize(output = +"")
+      @output = output
+      @previous_statement_kind = nil
+    end
+
+    def append_statement!(statement, statement_kind:)
+      output.chomp!
+      output << newlines_separator(
+        previous_kind: @previous_statement_kind,
+        current_kind: statement_kind
+      )
+      @previous_statement_kind = statement_kind
+      output << statement
+      output << "\n"
+    end
+
+    private
+
+    def newlines_separator(previous_kind:, current_kind:)
+      case [
+        previous_kind,
+        current_kind
+      ]
+      in [
+        nil,
+        _
+      ]
+        ""
+      in [
+        _,
+        :insert_stmt | :create_stmt | :view_stmt | :create_table_as_stmt
+      ]
+        "\n\n\n"
+      in [
+        :create_stmt | :view_stmt | :create_table_as_stmt | :index_stmt,
+        :index_stmt
+      ] | [
+        :variable_set_stmt,
+        :variable_set_stmt
+      ]
+        "\n"
+      else
+        "\n\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ActiveRecordPgFormatDbStructure
+  module Transforms
+    # Remove SET commands that apply default values to postgres settings
+    class RemoveDefaultsSetCommands < Base
+      class << self
+        attr_accessor :postgres_config_defaults
+      end
+
+      self.postgres_config_defaults = {
+        default_table_access_method: "heap",
+        default_with_oids: false,
+        idle_in_transaction_session_timeout: 0,
+        lock_timeout: 0,
+        statement_timeout: 0,
+        transaction_timeout: 0,
+        standard_conforming_strings: true,
+        xmloption: "content"
+      }
+
+      def transform!
+        raw_statements.delete_if do |raw_statement|
+          next unless raw_statement.stmt.to_h in variable_set_stmt: {kind: :VAR_SET_VALUE, name:, args: [{a_const:}]}
+
+          next unless self.class.postgres_config_defaults.key?(name.to_sym)
+
+          pattern = value_to_pattern(self.class.postgres_config_defaults[name.to_sym])
+
+          val_from_a_const(a_const) in ^pattern
+        end
+      end
+
+      private
+
+      def value_to_pattern(value)
+        case value
+        in false
+          Set.new(["false", "no", "off", 0])
+        in true
+          Set.new(["true", "yes", "on", 1])
+        else
+          value
+        end
+      end
+
+      def val_from_a_const(a_const)
+        case a_const
+        in ival:
+          ival.fetch(:ival, 0)
+        in sval:
+          sval.fetch(:sval, "").downcase
+        else
+          a_const.values.first
+        end
+      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.2.0"
+  VERSION = "0.3.0"
 end

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

@@ -3,6 +3,7 @@
 require_relative "activerecord-pg-format-db-structure/version"
 
 require_relative "activerecord-pg-format-db-structure/deparser"
+require_relative "activerecord-pg-format-db-structure/statement_appender"
 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"
@@ -10,12 +11,14 @@ 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/remove_defaults_set_commands"
 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_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
+    Transforms::RemoveDefaultsSetCommands,
     Transforms::SortSchemaMigrations,
     Transforms::InlinePrimaryKeys,
     # Transforms::InlineForeignKeys,
@@ -27,6 +30,7 @@ module ActiveRecordPgFormatDbStructure
   ].freeze
 
   DEFAULT_DEPARSER = Deparser
+  DEFAULT_STATEMENT_APPENDER = StatementAppender
 end
 
 # :nocov:

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-format-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jell
 bindir: exe
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -43,6 +43,7 @@ files:
 - lib/activerecord-pg-format-db-structure/formatter.rb
 - lib/activerecord-pg-format-db-structure/indenter.rb
 - lib/activerecord-pg-format-db-structure/railtie.rb
+- lib/activerecord-pg-format-db-structure/statement_appender.rb
 - lib/activerecord-pg-format-db-structure/tasks/clean_db_structure.rake
 - lib/activerecord-pg-format-db-structure/transforms/base.rb
 - lib/activerecord-pg-format-db-structure/transforms/group_alter_table_statements.rb
@@ -52,6 +53,7 @@ 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/remove_defaults_set_commands.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