ridgepole 3.1.3 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f54f0a59342af5d5d5bc4a1bce81f963a5f85b8b6da78702dbb03db59488dfe
-  data.tar.gz: d163b0a5ef7ff03125b83d40b977e6c6f7097f7a6286a4c7d1ae165e19638126
+  metadata.gz: b6de4765b254e55e4087b4fe7d99a9c23493e0c54b0a7c7e957b88488fa234d2
+  data.tar.gz: 6d05534c60e9f9f0967179520d8ecd83bee84b96cbe1e80cd4336327f7cb8c37
 SHA512:
-  metadata.gz: 1092d39833a655561847f2e04a98056311b63249baabf246bfc25aacd23003a6b8573e17ba835afe3b75bd1f88e6c903dc8f8d7aa471c3c9a69a7331f55acaaf
-  data.tar.gz: 2c6ceafe3191a18f0558ab0d7acf74b6133c5389a439602d1159cbdc47980cc8727ed21dfef11e55b3fc026312e32b6ceaf4475dbe36be5df6fe2a0d109bb877
+  metadata.gz: 1bb9273027a3b3d74c7c18faf25ba4b47033a44b98b12b1de80e04cd521aeb994f45168e97603b56c87dac6839990322eb8b2131e438320772983b9636a8695e
+  data.tar.gz: 49099509a1f3d8e5ae98fb7fe442e942ba7c7def24cf8a065e7c0d8838826e8ba4ec6394e4f9a5fa12cb906f2e850cb1a89e10496bbd07801ba746bf429f6389

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## 3.0
 
+### 3.1.5 (2026/03/21)
+
+- Fix for renaming references column. [pull#652](https://github.com/ridgepole/ridgepole/pull/652)
+- Fix for creating table with non-PK auto_increment column. [pull#650](https://github.com/ridgepole/ridgepole/pull/650)
+
+### 3.1.4 (2026/03/20)
+
+- Fix for errors when changing generated columns. [pull#642](https://github.com/ridgepole/ridgepole/pull/642) [pull#646](https://github.com/ridgepole/ridgepole/pull/646)
+- Fix for changes to `create_table` in ActiveRecord 8.2. [pull#645](https://github.com/ridgepole/ridgepole/pull/645)
+
 ### 3.1.3 (2026/01/29)
 
 - Show `COMMENT` SQL in dry-run. [pull#632](https://github.com/ridgepole/ridgepole/pull/632)

data/README.md

@@ -412,9 +412,9 @@ see https://github.com/ridgepole/ridgepole/issues/568
 docker compose up -d
 bundle install
 bundle exec appraisal install
-bundle exec appraisal activerecord-8.2 rake
-# POSTGRESQL=1 bundle exec appraisal activerecord-8.2 rake
-# MYSQL80=1 bundle exec appraisal activerecord-8.2 rake
+bundle exec appraisal activerecord-8.1 rake
+# POSTGRESQL=1 bundle exec appraisal activerecord-8.1 rake
+# MYSQL80=1 bundle exec appraisal activerecord-8.1 rake
 ```
 
 > [!note]

data/lib/ridgepole/client.rb

@@ -10,7 +10,7 @@ module Ridgepole
       # XXX: If the required processing in class method?
       @options[:index_removed_drop_column] = true if !@options.key?(:index_removed_drop_column) && (Ridgepole::DefaultsLimit.adapter == :postgresql)
 
-      Ridgepole::ExecuteExpander.expand_execute(ActiveRecord::Base.connection)
+      Ridgepole::ExecuteExpander.expand_execute(ActiveRecord::Base.connection, @options)
       @dumper = Ridgepole::Dumper.new(@options)
       @parser = Ridgepole::DSLParser.new(@options)
       @diff = Ridgepole::Diff.new(@options)

data/lib/ridgepole/delta.rb

@@ -74,7 +74,7 @@ module Ridgepole
           ActiveRecord::Migration.disable_logging = true
           buf = StringIO.new
 
-          callback = proc do |sql, _name|
+          callback = proc do |sql|
             buf.puts sql if sql =~ /\A(CREATE|ALTER|DROP|RENAME|COMMENT)\b/i
           end
 
@@ -243,10 +243,18 @@ create_table(#{table_name.inspect}, #{inspect_options_include_default_proc(optio
       RUBY
       end
 
-      if @options[:create_table_with_index] && !indices.empty?
-        indices.each do |index_name, index_attrs|
-          append_add_index(table_name, index_name, index_attrs, buf, true)
-        end
+      # Partition indices: indices referencing auto_increment columns must be
+      # inside CREATE TABLE on MySQL to avoid "must be defined as a key" error.
+      # cf. https://github.com/ridgepole/ridgepole/issues/494
+      if @options[:create_table_with_index]
+        indices_in_create = indices
+        indices_after_create = {}
+      else
+        indices_in_create, indices_after_create = partition_indices_for_create(definition, indices)
+      end
+
+      indices_in_create.each do |index_name, index_attrs|
+        append_add_index(table_name, index_name, index_attrs, buf, true)
       end
 
       unless (check_constraints = attrs[:check_constraints] || {}).empty?
@@ -271,9 +279,9 @@ create_table(#{table_name.inspect}, #{inspect_options_include_default_proc(optio
 end
       RUBY
 
-      if !@options[:create_table_with_index] && !indices.empty?
+      unless indices_after_create.empty?
         append_change_table(table_name, buf) do
-          indices.each do |index_name, index_attrs|
+          indices_after_create.each do |index_name, index_attrs|
             append_add_index(table_name, index_name, index_attrs, buf)
           end
         end
@@ -289,6 +297,30 @@ end
       post_buf_for_fk.puts
     end
 
+    def partition_indices_for_create(definition, indices)
+      return [{}, indices] unless Ridgepole::ConnectionAdapters.mysql?
+
+      auto_increment_columns = definition.select do |_col_name, col_attrs|
+        col_attrs.dig(:options, :auto_increment)
+      end.keys
+
+      return [{}, indices] if auto_increment_columns.empty?
+
+      in_create = {}
+      after_create = {}
+
+      indices.each do |idx_name, idx_attrs|
+        columns = Array(idx_attrs[:column_name])
+        if (columns & auto_increment_columns).any?
+          in_create[idx_name] = idx_attrs
+        else
+          after_create[idx_name] = idx_attrs
+        end
+      end
+
+      [in_create, after_create]
+    end
+
     def append_rename_table(to_table_name, from_table_name, buf)
       buf.puts(<<-RUBY)
 rename_table(#{from_table_name.inspect}, #{to_table_name.inspect})
@@ -446,6 +478,13 @@ rename_column(#{table_name.inspect}, #{from_column_name.inspect}, #{to_column_na
       # Fix for https://github.com/rails/rails/commit/7f0567b43b73b1bd1a16bfac9cd32fcbf1321b51
       if Ridgepole::ConnectionAdapters.mysql?
         options[:comment] = nil unless options.key?(:comment)
+
+        # Generated/virtual columns cannot have DEFAULT values in MySQL.
+        # cf. https://github.com/ridgepole/ridgepole/issues/482
+        if type == :virtual
+          options.delete(:default)
+          options.delete(:unsigned)
+        end
       end
 
       if @options[:bulk_change]

data/lib/ridgepole/diff.rb

@@ -103,6 +103,7 @@ module Ridgepole
 
       scan_options_change(table_name, from[:options], to[:options], table_delta)
       scan_definition_change(from[:definition], to[:definition], from[:indices], table_name, from[:options], table_delta)
+      apply_column_renames_to_indices(from[:indices], table_delta.dig(:definition, :rename))
       scan_indices_change(from[:indices], to[:indices], to[:definition], table_delta, from[:options], to[:options])
       scan_foreign_keys_change(from[:foreign_keys], to[:foreign_keys], table_delta, @options)
       scan_check_constraints_change(from[:check_constraints], to[:check_constraints], table_delta)
@@ -342,6 +343,19 @@ module Ridgepole
       end
     end
 
+    def apply_column_renames_to_indices(indices, renames)
+      return unless indices && renames
+
+      # renames: { new_column_name => old_column_name }
+      rename_map = renames.invert # { old_column_name => new_column_name }
+
+      indices.each_value do |attrs|
+        next unless attrs[:column_name].is_a?(Array)
+
+        attrs[:column_name] = attrs[:column_name].map { |col| rename_map[col] || col }
+      end
+    end
+
     def scan_indices_change(from, to, to_columns, table_delta, _from_table_options, to_table_options)
       from = (from || {}).dup
       to = (to || {}).dup
@@ -410,15 +424,17 @@ module Ridgepole
 
     def normalize_column_options!(attrs, primary_key = false)
       opts = attrs[:options]
-      opts[:null] = true if !opts.key?(:null) && !primary_key
+      opts[:null] = true if !opts.key?(:null) && !primary_key && attrs[:type] != :virtual
       default_limit = Ridgepole::DefaultsLimit.default_limit(attrs[:type], @options)
       opts.delete(:limit) if opts[:limit] == default_limit
 
       # XXX: MySQL only?
-      opts[:default] = nil if !opts.key?(:default) && !primary_key
+      # Generated/virtual columns cannot have DEFAULT values in MySQL.
+      # cf. https://github.com/ridgepole/ridgepole/issues/482
+      opts[:default] = nil if !opts.key?(:default) && !primary_key && attrs[:type] != :virtual
 
       if Ridgepole::ConnectionAdapters.mysql?
-        opts[:unsigned] = false unless opts.key?(:unsigned)
+        opts[:unsigned] = false if !opts.key?(:unsigned) && attrs[:type] != :virtual
 
         if attrs[:type] == :integer && opts[:limit]
           min = Ridgepole::DefaultsLimit.default_limit(:integer, @options)

data/lib/ridgepole/execute_expander.rb

@@ -13,19 +13,24 @@ module Ridgepole
     end
 
     module ConnectionAdapterExt
-      def execute(*args)
-        sql = args.fetch(0)
-        name = args[1]
-
+      def execute_expander_internal_execute(sql, &block)
+        # Generated/virtual columns cannot have DEFAULT values in MySQL.
+        # Rails' change_column always adds DEFAULT from the existing column,
+        # so we strip it from the SQL for virtual columns.
+        # cf. https://github.com/ridgepole/ridgepole/issues/482
+        if Ridgepole::ConnectionAdapters.mysql? && !Ridgepole::ExecuteExpander.options[:bulk_change]
+          # NOTE: bulk_change does not support changing MySQL generated columns with `DEFAULT NULL`.
+          sql = sql.sub(/\bDEFAULT\s+NULL\z/i, '') if /\AALTER\s+TABLE\b/i.match?(sql) && /\bAS\s*\(/i.match?(sql) && /\bDEFAULT\s+NULL\z/i.match?(sql)
+        end
         if Ridgepole::ExecuteExpander.noop
           if (callback = Ridgepole::ExecuteExpander.callback)
             sql = append_alter_extra(sql)
-            callback.call(sql, name)
+            callback.call(sql)
           end
 
           if /\A(SELECT|SHOW)\b/i.match?(sql)
             begin
-              super(sql, name)
+              block.call(sql)
             rescue StandardError
               Stub.new
             end
@@ -34,7 +39,7 @@ module Ridgepole
           end
         elsif Ridgepole::ExecuteExpander.use_script
           if /\A(SELECT|SHOW)\b/i.match?(sql)
-            super(sql, name)
+            block.call(sql)
           else
             sql = append_alter_extra(sql)
             Ridgepole::ExecuteExpander.sql_executer.execute(sql)
@@ -42,10 +47,28 @@ module Ridgepole
           end
         else
           sql = append_alter_extra(sql)
+          block.call(sql)
+        end
+      end
+
+      def execute(*args)
+        name = args[1]
+        execute_expander_internal_execute(args.fetch(0)) do |sql|
           super(sql, name)
         end
       end
 
+      def execute_batch(statements, name = nil, **kwargs)
+        new_statements = []
+        statements.each do |statement|
+          execute_expander_internal_execute(statement) do |sql|
+            new_statements << sql
+          end
+        end
+        super(new_statements, name, **kwargs) unless new_statements.empty?
+        statements
+      end
+
       private
 
       def append_alter_extra(sql)
@@ -69,6 +92,7 @@ module Ridgepole
     cattr_accessor :use_script,   instance_writer: false, instance_reader: false
     cattr_accessor :sql_executer, instance_writer: false, instance_reader: false
     cattr_accessor :alter_extra,  instance_writer: false, instance_reader: false
+    cattr_accessor :options,      instance_writer: false, instance_reader: false
 
     class << self
       def without_operation(callback = nil)
@@ -96,9 +120,11 @@ module Ridgepole
         self.alter_extra = nil
       end
 
-      def expand_execute(connection)
+      def expand_execute(connection, options)
         return if connection.is_a?(ConnectionAdapterExt)
 
+        self.options = options
+
         connection.class_eval do
           prepend ConnectionAdapterExt
         end

data/lib/ridgepole/version.rb

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

metadata

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