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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231e1ce74a64d5b68e27b122465855bf382cb24c5f573da3983b2ab1e11b3c23
-  data.tar.gz: 3341fb271ea14d6762cb879f28b6b526d51a76c37c83163fe26ce2955d9b1b83
+  metadata.gz: 476baa5e7f08de7b010ef98240bf4dc9d5f92d8c381759682dfdcbdd33ba5723
+  data.tar.gz: 8a9337bff151ccadbfc77cb638aca3b1097831979206cf971d4e3af4b3258c7c
 SHA512:
-  metadata.gz: 2f06ac5c8140c6766f4dd77909ba62f60fb2b86b2453d4fad3eb190221de590025eb079e6c2e74999ff3e39fcf90dcac8b1751d52fa33bf9a33ec26ea9c05b91
-  data.tar.gz: 790f40bbc56b3b0062e72b7793a9c1645ea286f9a3f557f180aea1fc261dc52401ef721ee2320901cf2ec30d1dc6b763eb0662d30906ab6e351e0b4ab33b1377
+  metadata.gz: a6c728fe8aba0d6c943ff8ac5cf16d386099ea85f4a35c101eed701b899ab3ec266b9004313007bba2d5e2567273f5aedfff857567743ea64c1a2d5bdaa1961c
+  data.tar.gz: 17b9b5722ac383a92969640cf30a6a68aaee073eec784cbe8545eae6f85d983a5fc7a5b2bebd66755bcf097340a8e931a4e831cc298647759f039078b51663f4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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)
+
 ## [0.1.5] - 2025-02-08
 
 - Sort table columns

data/README.md

@@ -3,7 +3,9 @@
 ![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.
+Automatically cleans up your PostgreSQL `structure.sql` file after each rails migration.
+
+Say good-bye to small those small diffs you get between coworkers!
 
 By default, it will:
 
@@ -14,9 +16,11 @@ By default, it will:
 * 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
+* Format and indent the entire file consistently
+
+It can also optionally inline foreign key declarations (see below).
 
-The task will transform this raw `structure.sql`:
+As an example, the task will transform this raw `structure.sql`:
 
 <details>
 
@@ -184,7 +188,7 @@ INSERT INTO "schema_migrations" (version) VALUES
 ```
 </details>
 
-into this much more compact and normalized version:
+into this normalize (and much more compatch & readable) version:
 
 ```sql
 
@@ -230,8 +234,9 @@ INSERT INTO schema_migrations (version) VALUES
 ;
 ```
 
-which is a lot more compact, easier to read, and reduces the risk of
-getting random diffs between machines after each migration.
+The goal is to make your `structure.sql` file easier to read and to
+reduce the risk of getting random diffs between machines after each
+migration.
 
 Those transformations are made by manipulating the SQL AST directly
 using [pg_query](https://github.com/pganalyze/pg_query), and each
@@ -245,7 +250,7 @@ You can also add your own transforms (see below).
 Add the following to your Gemfile:
 
 ```ruby
-gem 'activerecord-clean-db-structure'
+gem 'activerecord-pg-format-db-structure'
 ```
 
 ## Usage
@@ -258,12 +263,9 @@ If you want to configure which transforms to use, you can configure the library
 
 ```ruby
 Rails.application.configure do
-  config.activerecord_pg_format_db_structure.preprocessors = [
-    ActiveRecordPgFormatDbStructure::Preprocessors::RemoveWhitespaces
-  ]
-
   config.activerecord_pg_format_db_structure.transforms = [
     ActiveRecordPgFormatDbStructure::Transforms::RemoveCommentsOnExtensions,
+    ActiveRecordPgFormatDbStructure::Transforms::RemoveDefaultsSetCommands,
     ActiveRecordPgFormatDbStructure::Transforms::SortSchemaMigrations,
     ActiveRecordPgFormatDbStructure::Transforms::InlinePrimaryKeys,
     # ActiveRecordPgFormatDbStructure::Transforms::InlineForeignKeys,
@@ -288,18 +290,33 @@ formatted = ActiveRecordPgFormatDbStructure::Formatter.new.format(structure)
 File.write("db/structure.sql", formatted)
 ```
 
-## Preprocessors
-
-### RemoveWhitespaces
-
-Remove unnecessary comment, whitespase and empty lines.
-
 ## Transformers
 
 ### RemoveCommentsOnExtensions
 
 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/formatter.rb

@@ -6,23 +6,17 @@ require_relative "../activerecord-pg-format-db-structure"
 module ActiveRecordPgFormatDbStructure
   # Formats & normalizes in place the given SQL string
   class Formatter
-    attr_reader :preprocessors, :transforms, :deparser
+    attr_reader :transforms, :deparser
 
     def initialize(
-      preprocessors: DEFAULT_PREPROCESSORS,
       transforms: DEFAULT_TRANSFORMS,
       deparser: DEFAULT_DEPARSER
     )
-      @preprocessors = preprocessors
       @transforms = transforms
       @deparser = deparser
     end
 
     def format(source)
-      preprocessors.each do |preprocessor|
-        preprocessor.new(source).preprocess!
-      end
-
       raw_statements = PgQuery.parse(source).tree.stmts
 
       transforms.each do |transform|

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

@@ -4,7 +4,6 @@ module ActiveRecordPgFormatDbStructure
   # Setup for Rails
   class Railtie < Rails::Railtie
     config.activerecord_pg_format_db_structure = ActiveSupport::OrderedOptions.new
-    config.activerecord_pg_format_db_structure.preprocessors = DEFAULT_PREPROCESSORS.dup
     config.activerecord_pg_format_db_structure.transforms = DEFAULT_TRANSFORMS.dup
     config.activerecord_pg_format_db_structure.deparser = DEFAULT_DEPARSER
 

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.1.5"
+  VERSION = "0.2.1"
 end

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

@@ -3,7 +3,6 @@
 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"
@@ -11,16 +10,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_PREPROCESSORS = [
-    Preprocessors::RemoveWhitespaces
-  ].freeze
-
   DEFAULT_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
+    Transforms::RemoveDefaultsSetCommands,
     Transforms::SortSchemaMigrations,
     Transforms::InlinePrimaryKeys,
     # Transforms::InlineForeignKeys,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-format-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Jell
 bindir: exe
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -42,7 +42,6 @@ files:
 - lib/activerecord-pg-format-db-structure/deparser.rb
 - lib/activerecord-pg-format-db-structure/formatter.rb
 - lib/activerecord-pg-format-db-structure/indenter.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/base.rb
@@ -53,6 +52,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

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecordPgFormatDbStructure
-  module Preprocessors
-    # Remove whitespace and SQL comments from an SQL string
-    class RemoveWhitespaces
-      attr_reader :source
-
-      def initialize(source)
-        @source = source
-      end
-
-      def preprocess!
-        # Remove trailing whitespace
-        source.gsub!(/[ \t]+$/, "")
-        source.gsub!(/\A\n/, "")
-        source.gsub!(/\n\n\z/, "\n")
-
-        # Remove useless comment lines
-        source.gsub!(/^--\n/, "")
-
-        # Remove useless, version-specific parts of comments
-        source.gsub!(/^-- (.*); Schema: ([\w.]+|-); Owner: -.*/, '-- \1')
-      end
-    end
-  end
-end