Remove preprocessor, update pitch in readme

Author: Jell

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+- 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

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
@@ -258,10 +263,6 @@ 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::SortSchemaMigrations,
@@ -288,12 +289,6 @@ formatted = ActiveRecordPgFormatDbStructure::Formatter.new.format(structure)
 File.write("db/structure.sql", formatted)
 ```
 
-## Preprocessors
-
-### RemoveWhitespaces
-
-Remove unnecessary comment, whitespase and empty lines.
-
 ## Transformers
 
 ### RemoveCommentsOnExtensions

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"
@@ -15,10 +14,6 @@
 require_relative "activerecord-pg-format-db-structure/transforms/sort_table_columns"
 
 module ActiveRecordPgFormatDbStructure
-  DEFAULT_PREPROCESSORS = [
-    Preprocessors::RemoveWhitespaces
-  ].freeze
-
   DEFAULT_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
     Transforms::SortSchemaMigrations,

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

@@ -6,23 +6,17 @@
 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|

lib/activerecord-pg-format-db-structure/preprocessors/remove_whitespaces.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
 

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

@@ -3,7 +3,6 @@
 RSpec.describe ActiveRecordPgFormatDbStructure::Deparser do
   let(:formatter) do
     ActiveRecordPgFormatDbStructure::Formatter.new(
-      preprocessors: [],
       transforms: [],
       deparser: described_class
     )