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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0b4f6730ac7a280afddd46b476a8443e4cbbb3eac4004b92692223437f432c
-  data.tar.gz: b23c3a6ed71d6c46efa516d21f4c546dbdd3d2638f7c60046af0ff015d576f4d
+  metadata.gz: 476baa5e7f08de7b010ef98240bf4dc9d5f92d8c381759682dfdcbdd33ba5723
+  data.tar.gz: 8a9337bff151ccadbfc77cb638aca3b1097831979206cf971d4e3af4b3258c7c
 SHA512:
-  metadata.gz: f74568c5dcdecd2b0fe20d0823167e97a59da8593d534f877370b8e91b333a1a1c397c37913d5c81e91d8ccdfd254fc594f930ea1a0dab1ada589815ed8c38b5
-  data.tar.gz: 0eec46264e79d1ff729e12bef71bf6fd90291dbaff13ed88ae259f4e26b15cf7584ddb91a581d05d00df6c5b1ce4add028b4dc5f1318b32f89ef34dbbb8b0ddb
+  metadata.gz: a6c728fe8aba0d6c943ff8ac5cf16d386099ea85f4a35c101eed701b899ab3ec266b9004313007bba2d5e2567273f5aedfff857567743ea64c1a2d5bdaa1961c
+  data.tar.gz: 17b9b5722ac383a92969640cf30a6a68aaee073eec784cbe8545eae6f85d983a5fc7a5b2bebd66755bcf097340a8e931a4e831cc298647759f039078b51663f4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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)

data/README.md

@@ -265,6 +265,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 +296,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/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.2.1"
 end

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

@@ -10,12 +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_TRANSFORMS = [
     Transforms::RemoveCommentsOnExtensions,
+    Transforms::RemoveDefaultsSetCommands,
     Transforms::SortSchemaMigrations,
     Transforms::InlinePrimaryKeys,
     # Transforms::InlineForeignKeys,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pg-format-db-structure
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jell
@@ -52,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