ridgepole 3.2.1 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c06587d61c4599e0f7f0b10cdcc16829bd43122c9545a9e7441e22e5d1a5be
-  data.tar.gz: 350526f0a2303c72901e214c9c01996062a3758581815605152ef702ffefcc16
+  metadata.gz: 1a307f88c8f4187e3ec20de74f563caa0041e66749b0c2bf0345724a2a15103b
+  data.tar.gz: b74fc6cae628ac13466fd7dde31679d518f3bcc963bb7dd5877c193720bebf25
 SHA512:
-  metadata.gz: 0634c00dfc3a1c34f44e22d76cef892d17b5115a344ed600f5152ebba12e776668e8aa987650ee680cf8263a1cf779f39963a1b5cf2c7cbd20393d8a31c29b40
-  data.tar.gz: e5303a3b7c53068957d7b27613cb2b608043d1cd6a7adf9ee278378d7e6227794909f32d01289f484e00c5b480613c6dd6ce18066b6cf634b6849d69e9a304b0
+  metadata.gz: 9b6d880d3b5f91ab5947dd416180c097df2ea99c566df051195357898ee457dbcc35a724467e43b23620d8fc62b1dba7a44460d71535ad7977f1f851a616f08b
+  data.tar.gz: 37b2b51fbbf5aadb34fd85d1526b30ddc550bbd85467e3183148f8f8376caf78c0b25f62ed7a32585c6f03caddae73a6e8b8dcbeb762058b609fc382b971bec9

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## 3.2
 
+### 3.2.3 (2026/08/01)
+
+- Emit `validate_constraint` when DB is NOT VALID and DSL implies validated. [pull#718](https://github.com/ridgepole/ridgepole/pull/718)
+- Ignore `validate: false` diff when existing constraint lacks `:validate`. [pull#716](https://github.com/ridgepole/ridgepole/pull/716)
+
+### 3.2.2 (2026/06/14)
+
+- Fix constraint removal order when dropping columns. [pull#705](https://github.com/ridgepole/ridgepole/pull/705)
+
 ### 3.2.1 (2026/05/04)
 
 - Warn when an anonymous index ambiguously matches multiple DB indexes. [pull#692](https://github.com/ridgepole/ridgepole/pull/692)

data/README.md

@@ -10,9 +10,10 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 [![codecov](https://codecov.io/gh/ridgepole/ridgepole/graph/badge.svg)](https://codecov.io/gh/ridgepole/ridgepole)
 
 > [!TIP]
-> Currently developing a similar tool for PostgreSQL.
-> 
-> see https://github.com/winebarrel/pistachio
+> Also developing similar declarative schema tools — single Go binary, plain SQL as the schema definition:
+>
+> * [pistachio](https://github.com/winebarrel/pistachio): for PostgreSQL
+> * [myschema](https://github.com/winebarrel/myschema): for MySQL
 
 > [!warning]
 > The order of columns when exporting has changed in Rails 8.1. https://github.com/rails/rails/pull/53281

data/lib/ridgepole/delta.rb

@@ -31,11 +31,11 @@ module Ridgepole
 
     def script
       buf = StringIO.new
-      pre_buf_for_fk = StringIO.new
-      post_buf_for_fk = StringIO.new
+      pre_buf = StringIO.new
+      post_buf = StringIO.new
 
       (@delta[:add] || {}).each do |table_name, attrs|
-        append_create_table(table_name, attrs, buf, post_buf_for_fk)
+        append_create_table(table_name, attrs, buf, post_buf)
       end
 
       (@delta[:rename] || {}).each do |table_name, attrs|
@@ -43,7 +43,7 @@ module Ridgepole
       end
 
       (@delta[:change] || {}).each do |table_name, attrs|
-        append_change(table_name, attrs, buf, pre_buf_for_fk, post_buf_for_fk)
+        append_change(table_name, attrs, buf, pre_buf, post_buf)
       end
 
       (@delta[:delete] || {}).each do |table_name, attrs|
@@ -51,9 +51,9 @@ module Ridgepole
       end
 
       [
-        pre_buf_for_fk,
+        pre_buf,
         buf,
-        post_buf_for_fk
+        post_buf
       ].map { |b| b.string.strip }.join("\n\n").strip
     end
 
@@ -221,7 +221,7 @@ module Ridgepole
       end
     end
 
-    def append_create_table(table_name, attrs, buf, post_buf_for_fk)
+    def append_create_table(table_name, attrs, buf, post_buf)
       options = attrs[:options] || {}
       definition = attrs[:definition] || {}
       indices = attrs[:indices] || {}
@@ -289,12 +289,12 @@ end
 
       unless (foreign_keys = attrs[:foreign_keys] || {}).empty?
         foreign_keys.each_value do |foreign_key_attrs|
-          append_add_foreign_key(table_name, foreign_key_attrs, post_buf_for_fk, @options)
+          append_add_foreign_key(table_name, foreign_key_attrs, post_buf, @options)
         end
       end
 
       buf.puts
-      post_buf_for_fk.puts
+      post_buf.puts
     end
 
     def partition_indices_for_create(definition, indices)
@@ -370,7 +370,7 @@ change_table_comment(#{table_name.inspect}, #{table_comment.inspect})
       end
     end
 
-    def append_change(table_name, attrs, buf, pre_buf_for_fk, post_buf_for_fk)
+    def append_change(table_name, attrs, buf, pre_buf, post_buf)
       definition = attrs[:definition] || {}
       primary_key_definition = attrs[:primary_key_definition] || {}
       indices = attrs[:indices] || {}
@@ -393,10 +393,10 @@ change_table_comment(#{table_name.inspect}, #{table_comment.inspect})
         end
       end
 
-      append_change_foreign_keys(table_name, foreign_keys, pre_buf_for_fk, post_buf_for_fk, @options) unless foreign_keys.empty?
-      append_change_check_constraints(table_name, check_constraints, buf) unless check_constraints.empty?
-      append_change_exclusion_constraints(table_name, exclusion_constraints, buf) unless exclusion_constraints.empty?
-      append_change_unique_constraints(table_name, unique_constraints, buf) unless unique_constraints.empty?
+      append_change_foreign_keys(table_name, foreign_keys, pre_buf, post_buf, @options) unless foreign_keys.empty?
+      append_change_check_constraints(table_name, check_constraints, pre_buf, post_buf) unless check_constraints.empty?
+      append_change_exclusion_constraints(table_name, exclusion_constraints, pre_buf, post_buf) unless exclusion_constraints.empty?
+      append_change_unique_constraints(table_name, unique_constraints, pre_buf, post_buf) unless unique_constraints.empty?
 
       if table_options || table_charset || table_collation
         append_change_table_raw_options(table_name, table_options, table_charset, table_collation,
@@ -407,8 +407,8 @@ change_table_comment(#{table_name.inspect}, #{table_comment.inspect})
       append_change_column_comments(table_name, column_comments, buf) unless column_comments.empty?
 
       buf.puts
-      pre_buf_for_fk.puts
-      post_buf_for_fk.puts
+      pre_buf.puts
+      post_buf.puts
     end
 
     def append_change_column_comments(table_name, column_comments, buf)
@@ -560,13 +560,17 @@ remove_index(#{table_name.inspect}, #{target})
       end
     end
 
-    def append_change_foreign_keys(table_name, delta, pre_buf_for_fk, post_buf_for_fk, options)
+    def append_change_foreign_keys(table_name, delta, pre_buf, post_buf, options)
       (delta[:delete] || {}).each_value do |attrs|
-        append_remove_foreign_key(table_name, attrs, pre_buf_for_fk, options)
+        append_remove_foreign_key(table_name, attrs, pre_buf, options)
       end
 
       (delta[:add] || {}).each_value do |attrs|
-        append_add_foreign_key(table_name, attrs, post_buf_for_fk, options)
+        append_add_foreign_key(table_name, attrs, post_buf, options)
+      end
+
+      (delta[:validate] || {}).each_value do |attrs|
+        append_validate_foreign_key(table_name, attrs, post_buf)
       end
     end
 
@@ -594,13 +598,32 @@ remove_foreign_key(#{table_name.inspect}, #{target})
     RUBY
     end
 
-    def append_change_check_constraints(table_name, delta, buf)
+    def append_validate_foreign_key(table_name, attrs, buf)
+      attrs_options = attrs[:options] || {}
+      fk_name = attrs_options[:name]
+
+      target = if fk_name
+                 "name: #{fk_name.inspect}"
+               else
+                 attrs.fetch(:to_table).inspect
+               end
+
+      buf.puts(<<-RUBY)
+validate_foreign_key(#{table_name.inspect}, #{target})
+      RUBY
+    end
+
+    def append_change_check_constraints(table_name, delta, pre_buf, post_buf)
       (delta[:delete] || {}).each_value do |attrs|
-        append_remove_check_constraint(table_name, attrs, buf)
+        append_remove_check_constraint(table_name, attrs, pre_buf)
       end
 
       (delta[:add] || {}).each_value do |attrs|
-        append_add_check_constraint(table_name, attrs, buf)
+        append_add_check_constraint(table_name, attrs, post_buf)
+      end
+
+      (delta[:validate] || {}).each_value do |attrs|
+        append_validate_check_constraint(table_name, attrs, post_buf)
       end
     end
 
@@ -628,13 +651,22 @@ remove_check_constraint(#{table_name.inspect}, #{expression.inspect}, **#{attrs_
       RUBY
     end
 
-    def append_change_exclusion_constraints(table_name, delta, buf)
+    def append_validate_check_constraint(table_name, attrs, buf)
+      attrs_options = attrs[:options] || {}
+      name = attrs_options[:name]
+
+      buf.puts(<<-RUBY)
+validate_check_constraint(#{table_name.inspect}, name: #{name.inspect})
+      RUBY
+    end
+
+    def append_change_exclusion_constraints(table_name, delta, pre_buf, post_buf)
       (delta[:delete] || {}).each_value do |attrs|
-        append_remove_exclusion_constraint(table_name, attrs, buf)
+        append_remove_exclusion_constraint(table_name, attrs, pre_buf)
       end
 
       (delta[:add] || {}).each_value do |attrs|
-        append_add_exclusion_constraint(table_name, attrs, buf)
+        append_add_exclusion_constraint(table_name, attrs, post_buf)
       end
     end
 
@@ -662,13 +694,13 @@ remove_exclusion_constraint(#{table_name.inspect}, #{expression.inspect}, **#{at
       RUBY
     end
 
-    def append_change_unique_constraints(table_name, delta, buf)
+    def append_change_unique_constraints(table_name, delta, pre_buf, post_buf)
       (delta[:delete] || {}).each_value do |attrs|
-        append_remove_unique_constraint(table_name, attrs, buf)
+        append_remove_unique_constraint(table_name, attrs, pre_buf)
       end
 
       (delta[:add] || {}).each_value do |attrs|
-        append_add_unique_constraint(table_name, attrs, buf)
+        append_add_unique_constraint(table_name, attrs, post_buf)
       end
     end
 

data/lib/ridgepole/diff.rb

@@ -524,13 +524,18 @@ module Ridgepole
         next if ignore_fk
 
         if from_attrs
-          if from_attrs != to_attrs
-            foreign_keys_delta[:add] ||= {}
-            foreign_keys_delta[:add][foreign_key_name_or_tables] = to_attrs
+          if from_attrs != to_attrs && !ignorable_validate_diff?(from_attrs, to_attrs)
+            if validate_only_diff?(from_attrs, to_attrs)
+              foreign_keys_delta[:validate] ||= {}
+              foreign_keys_delta[:validate][foreign_key_name_or_tables] = to_attrs
+            else
+              foreign_keys_delta[:add] ||= {}
+              foreign_keys_delta[:add][foreign_key_name_or_tables] = to_attrs
 
-            unless options[:merge]
-              foreign_keys_delta[:delete] ||= {}
-              foreign_keys_delta[:delete][foreign_key_name_or_tables] = from_attrs
+              unless options[:merge]
+                foreign_keys_delta[:delete] ||= {}
+                foreign_keys_delta[:delete][foreign_key_name_or_tables] = from_attrs
+              end
             end
           end
         else
@@ -558,12 +563,19 @@ module Ridgepole
         from_attrs = from.delete(name)
 
         if from_attrs
-          if normalize_check_constraint(from_attrs) != normalize_check_constraint(to_attrs)
-            check_constraints_delta[:add] ||= {}
-            check_constraints_delta[:add][name] = to_attrs
+          from_normalized = normalize_check_constraint(from_attrs)
+          to_normalized = normalize_check_constraint(to_attrs)
+          if from_normalized != to_normalized && !ignorable_validate_diff?(from_normalized, to_normalized)
+            if validate_only_diff?(from_normalized, to_normalized)
+              check_constraints_delta[:validate] ||= {}
+              check_constraints_delta[:validate][name] = to_attrs
+            else
+              check_constraints_delta[:add] ||= {}
+              check_constraints_delta[:add][name] = to_attrs
 
-            check_constraints_delta[:delete] ||= {}
-            check_constraints_delta[:delete][name] = from_attrs
+              check_constraints_delta[:delete] ||= {}
+              check_constraints_delta[:delete][name] = from_attrs
+            end
           end
         else
           check_constraints_delta[:add] ||= {}
@@ -587,6 +599,33 @@ module Ridgepole
       attr
     end
 
+    # 'validate: false' (NOT VALID) is a strategy for ALTER TABLE ADD CONSTRAINT to avoid
+    # ACCESS EXCLUSIVE lock on large tables. NOT VALID state itself is persisted by the DB,
+    # but PostgreSQL ignores NOT VALID for constraints created inline within CREATE TABLE, so
+    # whether the resulting constraint is NOT VALID depends on how it was created. Restoring
+    # NOT VALID via DROP + ADD has no benefit, so ignore the diff when the DB dump lacks
+    # :validate and the DSL specifies validate: false.
+    def ignorable_validate_diff?(from_attrs, to_attrs)
+      from_options = from_attrs[:options] || {}
+      to_options = to_attrs[:options] || {}
+      return false unless to_options[:validate] == false && !from_options.key?(:validate)
+
+      from_attrs == to_attrs.merge(options: to_options.except(:validate))
+    end
+
+    # Reverse of ignorable_validate_diff?: DB has a NOT VALID constraint (validate: false)
+    # and the DSL implies validated (:validate missing or true). Emit VALIDATE CONSTRAINT
+    # instead of DROP + re-ADD so the full-table scan runs under SHARE UPDATE EXCLUSIVE
+    # (concurrent DML allowed) rather than ACCESS EXCLUSIVE lock.
+    def validate_only_diff?(from_attrs, to_attrs)
+      from_options = from_attrs[:options] || {}
+      to_options = to_attrs[:options] || {}
+      return false unless from_options[:validate] == false && to_options[:validate] != false
+
+      from_attrs.merge(options: from_options.except(:validate)) ==
+        to_attrs.merge(options: to_options.except(:validate))
+    end
+
     def scan_exclusion_constraints_change(from, to, table_delta)
       from = (from || {}).dup
       to = (to || {}).dup

data/lib/ridgepole/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ridgepole
-  VERSION = '3.2.1'
+  VERSION = '3.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.3
 platform: ruby
 authors:
 - Genki Sugawara
@@ -245,14 +245,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.86.1
+        version: 1.88.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.86.1
+        version: 1.88.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement