activerecord-pg-format-db-structure 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74eff8ba4546f71002cc784146845e66b74a38cfdfe6f2604b6ee34994269564
-  data.tar.gz: 330f056b6883d6dbbfc253ac9230794756f0a45b19527ecdb8af3005b01dc55e
+  metadata.gz: b916a4b16cf31a2799f9513691052d87b71eadd8fe9e96897f9a94123f4d670d
+  data.tar.gz: c86d19f089cc15288cb9a664da548f93e95c451827b6d030229d5c59dd86ffc3
 SHA512:
-  metadata.gz: 64f5bcc1ca4e2b6033b83acc918372e20c19765315f7c03bfb8666190d255a7e9c8bb4fde73c28ce2c2af109423bc739af0938e638c003bb6dabdcb277a12861
-  data.tar.gz: 30fb3d9e684ac251b20f6eee82a791c075173cf2385f8e8c69b14e726ceda554cc6ab768f8bca0fea6f4fedc1b08d7b34a71c64d0002fbff95b8d32f8951ae06
+  metadata.gz: a4c57555371d9aa30151ffb5fd329f6e1bbee46a7bec5be0956eee482b2a7b8bdf9740c9a12466f03c8e57d604d802f82abce1cd95818615b255c8fcc2619a7c
+  data.tar.gz: ed0865a617ce28462019287d4a1d1db62ea42f34c98e13d4cad8a80bcd5ab92a9b78599e7912691102e2698bc79d2055e68e01cafc721829b0b7f7e126e68aea

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.6.0] - 2025-08-21
+
+- Add preprocessors config that allows applying text transforms to the input before parsing
+- Add preprocessor to remove `\restrict` and `\unrestrict` pragmas that appeared in newer versions of pg_dump
+
+## [0.5.0] - 2025-08-04
+
+- Upgrade pg_query to 6.1 to add support for latest mac OS version
+
 ## [0.4.0] - 2025-03-21
 
 - Remove no-op `NOT VALID` setting when inlining constraints

data/README.md

@@ -9,6 +9,7 @@ Say good-bye to those pesky diffs you get between coworkers!
 
 By default, it will:
 
+* remove `\restrict` and `\unrestrict` pragmas
 * Inline primary key declarations
 * Inline SERIAL type declarations
 * Inline table constraints
@@ -27,6 +28,8 @@ As an example, the task will transform this raw `structure.sql`:
 <summary>Click to expand</summary>
 
 ```sql
+\restrict 1234
+
 --
 -- Name: pgcrypto; Type: EXTENSION; Schema: -; Owner: -
 --
@@ -261,6 +264,10 @@ 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 = [
+    Preprocessors::RemoveRestrictPragmas
+  ]
+
   config.activerecord_pg_format_db_structure.transforms = [
     ActiveRecordPgFormatDbStructure::Transforms::RemoveCommentsOnExtensions,
     ActiveRecordPgFormatDbStructure::Transforms::RemoveDefaultsSetCommands,
@@ -271,7 +278,7 @@ Rails.application.configure do
     ActiveRecordPgFormatDbStructure::Transforms::InlineConstraints,
     ActiveRecordPgFormatDbStructure::Transforms::MoveIndicesAfterCreateTable,
     ActiveRecordPgFormatDbStructure::Transforms::GroupAlterTableStatements,
-    ActiveRecordPgFormatDbStructure::Transforms::SortTableColumns,
+    ActiveRecordPgFormatDbStructure::Transforms::SortTableColumns
   ]
 
   config.activerecord_pg_format_db_structure.deparser = ActiveRecordPgFormatDbStructure::Deparser
@@ -287,6 +294,13 @@ structure = File.read("db/structure.sql")
 formatted = ActiveRecordPgFormatDbStructure::Formatter.new.format(structure)
 File.write("db/structure.sql", formatted)
 ```
+## Preprocessors
+
+### RemoveRestrictPragmas
+
+Remove `\restrict` and `\unrestrict` pragmas that were added in newer
+versions of `pg_dump`, since they are not valid SQL syntax and
+therefore prevent parsing the file as SQL.
 
 ## Transformers
 

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

@@ -6,19 +6,25 @@ require_relative "../activerecord-pg-format-db-structure"
 module ActiveRecordPgFormatDbStructure
   # Formats & normalizes in place the given SQL string
   class Formatter
-    attr_reader :transforms, :deparser, :statement_appender
+    attr_reader :preprocessors, :transforms, :deparser, :statement_appender
 
     def initialize(
+      preprocessors: DEFAULT_PREPROCESSORS,
       transforms: DEFAULT_TRANSFORMS,
       deparser: DEFAULT_DEPARSER,
       statement_appender: DEFAULT_STATEMENT_APPENDER
     )
+      @preprocessors = preprocessors
       @transforms = transforms
       @deparser = deparser
       @statement_appender = statement_appender
     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/preprocessors/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "pg_query"
+
+module ActiveRecordPgFormatDbStructure
+  module Preprocessors
+    # :nodoc:
+    class Base
+      attr_reader :source
+
+      def initialize(source)
+        @source = source
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module ActiveRecordPgFormatDbStructure
+  module Preprocessors
+    # Inline non-foreign key constraints into table declaration
+    class RemoveRestrictPragmas < Base
+      def preprocess!
+        source.gsub!(/^(\\restrict .*)$/, "")
+        source.gsub!(/^(\\unrestrict .*)$/, "")
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ 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
     config.activerecord_pg_format_db_structure.statement_appender = DEFAULT_STATEMENT_APPENDER

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

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

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

@@ -4,6 +4,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/preprocessors/remove_restrict_pragmas"
 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"
@@ -16,6 +17,10 @@ require_relative "activerecord-pg-format-db-structure/transforms/sort_schema_mig
 require_relative "activerecord-pg-format-db-structure/transforms/sort_table_columns"
 
 module ActiveRecordPgFormatDbStructure
+  DEFAULT_PREPROCESSORS = [
+    Preprocessors::RemoveRestrictPragmas
+  ].freeze
+
   DEFAULT_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
     Transforms::RemoveDefaultsSetCommands,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-format-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jell
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_query
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 description: automatically runs after each db:schema:dump and formats the output
 email:
 - rubygems@reify.se
@@ -42,6 +42,8 @@ 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/base.rb
+- lib/activerecord-pg-format-db-structure/preprocessors/remove_restrict_pragmas.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