ridgepole 3.0.4 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931a6b90df6d277ffd72a272342058290e4fcc8b793ffc0b94f2719a9fc6de4e
-  data.tar.gz: '01879ec62757730657f0197c052f2601fe74561286cef3fc4d7c9e82bc329764'
+  metadata.gz: 90db85660b9c1b91946bec50b7af82e03d3b686a3270ba4c12f7253dd31ecd40
+  data.tar.gz: '09660a78f0e35155b58423d737391b531405aa895edab86bcc8f6f4213461fef'
 SHA512:
-  metadata.gz: ada25e648306fce2dbb1755c5746e2bcaf6a7e4413fada585ce278f4750f7b28493b2e156139b17cacdb5b95d70073771dc174c11ce32986033bfa80a8cc3bf9
-  data.tar.gz: 61e689542f00d014065941fab911c0c11a6cbd1f41ef0f293cce18ffb4f71de37f9499985f9a6c4241699fe796c7a7bc2721979834a3882ad52bb2fcbfac0011
+  metadata.gz: 4e86c295eaafec04bcd2235932312e74d327abb7db2f5be519da092c87a585ade3c9ce7887720426b76ad532ec7e467e4cebd1f570e9a8cb6b0ff3dbcba7f13e
+  data.tar.gz: 55dc8d759ec3d788fc07f24ca15c48ca323166bf838f6ebe8ae13383192c5c15577da07d2f431f30c5c8571dfed24fa90dd62aa72cd20afff7abc40af0bca4ba

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## 3.0
 
+### 3.1.1 (2025/10/31)
+
+- Add `--disable-sort-columns` option [pull#601](https://github.com/ridgepole/ridgepole/pull/601)
+
+### 3.1.0 (2025/10/30)
+
+- Support Rails 8.1 [pull#589](https://github.com/ridgepole/ridgepole/pull/589)
+- Support for migrating PostgreSQL table comments [pull#587](https://github.com/ridgepole/ridgepole/pull/587)
+
 ### 3.0.4 (2025/08/31)
 
 - Fix checking foreign key without index [pull#571](https://github.com/ridgepole/ridgepole/pull/571)

data/README.md

@@ -9,7 +9,14 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 [![test](https://github.com/ridgepole/ridgepole/actions/workflows/test.yml/badge.svg)](https://github.com/ridgepole/ridgepole/actions/workflows/test.yml)
 [![Coverage Status](https://coveralls.io/repos/github/ridgepole/ridgepole/badge.svg?branch=3.0)](https://coveralls.io/github/ridgepole/ridgepole?branch=3.0)
 
+> [!warning]
+> The order of columns when exporting has changed in Rails 8.1. https://github.com/rails/rails/pull/53281
+>
+> If you do not want to sort the columns, use `--disable-sort-columns` option.
+
 > [!note]
+> * ridgepole v3.1.0
+>   * Support Rails 8.1 (cf. https://github.com/ridgepole/ridgepole/pull/589)
 > * ridgepole v3.0.0
 >   * Support Rails 8.0 (cf. https://github.com/ridgepole/ridgepole/pull/504)
 > * ridgepole v2.0.0
@@ -92,6 +99,7 @@ Usage: ridgepole [options]
         --skip-column-comment-change
         --allow-pk-change
         --create-table-with-index
+        --disable-sort-columns
         --mysql-dump-auto-increment
     -r, --require LIBS
         --log-file LOG_FILE
@@ -181,6 +189,13 @@ create_table "user_comments", force: :cascade, renamed_from: "comments" do |t|
 end
 ```
 
+> [!note]
+> When using `renamed_from` on a table, Ridgepole will only perform the rename operation. All other changes to that table (columns, indexes, foreign keys, etc.) will not be detected during the same migration.
+>
+> If you need to rename AND modify a table, do it in two separate steps:
+> 1. First migration: Add `renamed_from` to rename the table
+> 2. Second migration: Remove `renamed_from` and apply your desired changes
+
 ## Foreign Key
 ```ruby
 create_table "parent", force: :cascade do |t|

data/bin/ridgepole

@@ -139,11 +139,13 @@ ARGV.options do |opt|
   opt.on('',   '--drop-table-only') { options[:drop_table_only] = true }
   opt.on('',   '--mysql-change-table-options') { options[:mysql_change_table_options] = true }
   opt.on('',   '--mysql-change-table-comment') { options[:mysql_change_table_comment] = true }
+  opt.on('',   '--pg-change-table-comment') { options[:postgresql_change_table_comment] = true }
   opt.on('',   '--check-relation-type DEF_PK') { |v| options[:check_relation_type] = v }
   opt.on('',   '--ignore-table-comment') { options[:ignore_table_comment] = true }
   opt.on('',   '--skip-column-comment-change') { options[:skip_column_comment_change] = true }
   opt.on('',   '--allow-pk-change') { options[:allow_pk_change] = true }
   opt.on('',   '--create-table-with-index') { options[:create_table_with_index] = true }
+  opt.on('',   '--disable-sort-columns') { options[:disable_sort_columns] = true }
 
   opt.on('',   '--mysql-dump-auto-increment') do
     options[:mysql_dump_auto_increment] = true

data/lib/ridgepole/client.rb

@@ -16,6 +16,7 @@ module Ridgepole
       @diff = Ridgepole::Diff.new(@options)
 
       require 'ridgepole/ext/abstract_mysql_adapter/dump_auto_increment' if @options[:mysql_dump_auto_increment]
+      require 'ridgepole/ext/schema_dumper/disable_sort_columns' if @options[:disable_sort_columns]
     end
 
     def dump(&block)

data/lib/ridgepole/default_limit.rb

@@ -3,14 +3,15 @@
 module Ridgepole
   class DefaultsLimit
     DEFAULT_LIMIT_FOR_MYSQL = {
-      boolean: 1,
       integer: 4,
       bigint: 8,
       float: 24,
       string: 255,
       text: 65_535,
       binary: 65_535,
-    }.freeze
+    }.tap do |limits|
+      limits[:boolean] = 1 if ActiveRecord.gem_version < Gem::Version.new('8.1.0.beta1')
+    end.freeze
 
     DEFAULTS_LIMITS = {
       mysql2: DEFAULT_LIMIT_FOR_MYSQL,

data/lib/ridgepole/delta.rb

@@ -328,8 +328,14 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
     end
 
     def append_change_table_comment(table_name, table_comment, buf)
-      comment_literal = "COMMENT=#{ActiveRecord::Base.connection.quote(table_comment)}"
-      append_change_table_options(table_name, comment_literal, buf)
+      if Ridgepole::ConnectionAdapters.postgresql?
+        buf.puts(<<-RUBY)
+change_table_comment(#{table_name.inspect}, #{table_comment.inspect})
+        RUBY
+      else
+        comment_literal = "COMMENT=#{ActiveRecord::Base.connection.quote(table_comment)}"
+        append_change_table_options(table_name, comment_literal, buf)
+      end
     end
 
     def append_change(table_name, attrs, buf, pre_buf_for_fk, post_buf_for_fk)
@@ -438,7 +444,7 @@ rename_column(#{table_name.inspect}, #{from_column_name.inspect}, #{to_column_na
       options = attrs[:options] || {}
 
       # Fix for https://github.com/rails/rails/commit/7f0567b43b73b1bd1a16bfac9cd32fcbf1321b51
-      if Ridgepole::ConnectionAdapters.mysql? && ActiveRecord::VERSION::STRING !~ /\A5\.0\./
+      if Ridgepole::ConnectionAdapters.mysql?
         options[:comment] = nil unless options.key?(:comment)
       end
 

data/lib/ridgepole/diff.rb

@@ -157,6 +157,14 @@ module Ridgepole
         end
       end
 
+      if Ridgepole::ConnectionAdapters.postgresql?
+        if @options[:postgresql_change_table_comment] && (from[:comment] != to[:comment])
+          from.delete(:comment)
+          to_comment = to.delete(:comment)
+          table_delta[:table_comment] = to_comment
+        end
+      end
+
       if @options[:dump_without_table_options]
         from.delete(:options)
         from.delete(:charset)

data/lib/ridgepole/ext/schema_dumper/disable_sort_columns.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_record/schema_dumper'
+
+module Ridgepole
+  module Ext
+    module SchemaDumper
+      module DisableSortColumns
+        def table(table, stream)
+          def @connection.columns(*_args)
+            cols = super
+            def cols.sort_by(*_args, &_block)
+              self
+            end
+            cols
+          end
+          super
+        end
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  class SchemaDumper
+    prepend Ridgepole::Ext::SchemaDumper::DisableSortColumns
+  end
+end

data/lib/ridgepole/ext/schema_dumper/foreign_keys.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'active_record/schema_dumper'
+
+module Ridgepole
+  module Ext
+    module SchemaDumper
+      module ForeignKeys
+        def self.prepended(klass)
+          klass.extend ClassMethods
+        end
+
+        module ClassMethods
+          attr_reader :__with_default_fk_name
+
+          def with_default_fk_name(value)
+            @__with_default_fk_name = value
+            yield
+          ensure
+            remove_instance_variable(:@__with_default_fk_name)
+          end
+        end
+
+        def foreign_keys(table, stream)
+          return super unless ActiveRecord::SchemaDumper.__with_default_fk_name
+
+          if (foreign_keys = @connection.foreign_keys(table)).any?
+            add_foreign_key_statements = foreign_keys.map do |foreign_key|
+              parts = [
+                "add_foreign_key #{remove_prefix_and_suffix(foreign_key.from_table).inspect}",
+                remove_prefix_and_suffix(foreign_key.to_table).inspect
+              ]
+
+              parts << "column: #{foreign_key.column.inspect}" if foreign_key.column != foreign_key_column_for(foreign_key)
+
+              parts << "primary_key: #{foreign_key.primary_key.inspect}" if foreign_key.custom_primary_key?
+
+              parts << "name: #{foreign_key.name.inspect}"
+
+              parts << "on_update: #{foreign_key.on_update.inspect}" if foreign_key.on_update
+              parts << "on_delete: #{foreign_key.on_delete.inspect}" if foreign_key.on_delete
+
+              "  #{parts.join(', ')}"
+            end
+
+            stream.puts add_foreign_key_statements.sort.join("\n")
+          end
+        end
+
+        private
+
+        def foreign_key_column_for(foreign_key)
+          if ActiveRecord.gem_version < Gem::Version.new('7.1.0')
+            @connection.foreign_key_column_for(foreign_key.to_table)
+          else
+            @connection.foreign_key_column_for(foreign_key.to_table, 'id')
+          end
+        end
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  class SchemaDumper
+    prepend Ridgepole::Ext::SchemaDumper::ForeignKeys
+  end
+end

data/lib/ridgepole/version.rb

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

data/lib/ridgepole.rb

@@ -17,7 +17,7 @@ module Ridgepole; end
 
 require 'ridgepole/ext/abstract_adapter/disable_table_options'
 require 'ridgepole/ext/pp_sort_hash'
-require 'ridgepole/ext/schema_dumper'
+require 'ridgepole/ext/schema_dumper/foreign_keys'
 require 'ridgepole/client'
 require 'ridgepole/connection_adapters'
 require 'ridgepole/default_limit'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.1
 platform: ruby
 authors:
 - Genki Sugawara
@@ -18,7 +18,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -217,28 +217,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.80.0
+        version: 1.81.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.80.0
+        version: 1.81.6
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -337,7 +337,8 @@ files:
 - lib/ridgepole/ext/abstract_adapter/disable_table_options.rb
 - lib/ridgepole/ext/abstract_mysql_adapter/dump_auto_increment.rb
 - lib/ridgepole/ext/pp_sort_hash.rb
-- lib/ridgepole/ext/schema_dumper.rb
+- lib/ridgepole/ext/schema_dumper/disable_sort_columns.rb
+- lib/ridgepole/ext/schema_dumper/foreign_keys.rb
 - lib/ridgepole/external_sql_executer.rb
 - lib/ridgepole/logger.rb
 - lib/ridgepole/migration_ext.rb
@@ -363,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Ridgepole is a tool to manage DB schema.
 test_files: []

data/lib/ridgepole/ext/schema_dumper.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record/schema_dumper'
-
-module Ridgepole
-  module Ext
-    module SchemaDumper
-      def self.prepended(klass)
-        klass.extend ClassMethods
-      end
-
-      module ClassMethods
-        attr_reader :__with_default_fk_name
-
-        def with_default_fk_name(value)
-          @__with_default_fk_name = value
-          yield
-        ensure
-          remove_instance_variable(:@__with_default_fk_name)
-        end
-      end
-
-      def foreign_keys(table, stream)
-        return super unless ActiveRecord::SchemaDumper.__with_default_fk_name
-
-        if (foreign_keys = @connection.foreign_keys(table)).any?
-          add_foreign_key_statements = foreign_keys.map do |foreign_key|
-            parts = [
-              "add_foreign_key #{remove_prefix_and_suffix(foreign_key.from_table).inspect}",
-              remove_prefix_and_suffix(foreign_key.to_table).inspect
-            ]
-
-            parts << "column: #{foreign_key.column.inspect}" if foreign_key.column != foreign_key_column_for(foreign_key)
-
-            parts << "primary_key: #{foreign_key.primary_key.inspect}" if foreign_key.custom_primary_key?
-
-            parts << "name: #{foreign_key.name.inspect}"
-
-            parts << "on_update: #{foreign_key.on_update.inspect}" if foreign_key.on_update
-            parts << "on_delete: #{foreign_key.on_delete.inspect}" if foreign_key.on_delete
-
-            "  #{parts.join(', ')}"
-          end
-
-          stream.puts add_foreign_key_statements.sort.join("\n")
-        end
-      end
-
-      private
-
-      def foreign_key_column_for(foreign_key)
-        if ActiveRecord.gem_version < Gem::Version.new('7.1.0')
-          @connection.foreign_key_column_for(foreign_key.to_table)
-        else
-          @connection.foreign_key_column_for(foreign_key.to_table, 'id')
-        end
-      end
-    end
-  end
-end
-
-module ActiveRecord
-  class SchemaDumper
-    prepend Ridgepole::Ext::SchemaDumper
-  end
-end