ridgepole 3.1.2 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda1a996982cb5d8b365f150166e2de5a71da139e881e0997a7d1cbe90e742cf
-  data.tar.gz: e81e61c580566fc1df3a2de2e7e7473a713aa2f7cdc64b573876c5eff8890987
+  metadata.gz: 3784ad1d842d1d94b1990eada126a7e089be6b7be6f1d764baf8d0f9e78f9dc1
+  data.tar.gz: f69dc5c28eac0444853c39bf46e0a64f3e6acfd7ced84d46485993594f56a3b4
 SHA512:
-  metadata.gz: 13ae80c21973f9e0901cd76e084fdf564267f65de8170e72cc3feae412d95619a532ca16147ecaa65275ad41f82a9ec31b93b38d499c381e7fb43fe09ec5710b
-  data.tar.gz: f19b7cec7f794af44aa5e5130d33088f033621a0344787d21a2d48362c954d49d8cd56be5b1c3da599eee35648f572bb6940bc44ae42085e4cdc45ebcca3216d
+  metadata.gz: 3c61e60599c78c740e21f36e087e8d9931e01ed801c05a64e78b11dcca30f872acbe34df427fe27da44734e07a1bbb2f408fb6e2bec6e037224a33cdb6455cd5
+  data.tar.gz: fd7fabfea47e6d71217e0b38463d3049c58864d02f5f7e094b98c533802b54dfb55fd2932af603a219c846830e73c3e6d6d408917f703f84a65377f486f5ec44

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## 3.0
 
+### 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)
+
 ### 3.1.2 (2025/11/03)
 
 - Normalize foreign key columns. [pull#607](https://github.com/ridgepole/ridgepole/pull/607)

data/README.md

@@ -7,7 +7,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 
 [![Gem Version](https://badge.fury.io/rb/ridgepole.svg)](https://badge.fury.io/rb/ridgepole)
 [![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)
+[![codecov](https://codecov.io/gh/ridgepole/ridgepole/graph/badge.svg)](https://codecov.io/gh/ridgepole/ridgepole)
 
 > [!warning]
 > The order of columns when exporting has changed in Rails 8.1. https://github.com/rails/rails/pull/53281
@@ -211,6 +211,31 @@ add_index "child", ["parent_id"], name: "par_ind", using: :btree
 add_foreign_key "child", "parent", name: "child_ibfk_1"
 ```
 
+## CHECK Constraint
+
+```ruby
+create_table "products", force: :cascade do |t|
+  t.string  "name", null: false
+  t.decimal "price", precision: 10, scale: 2
+  t.integer "quantity"
+
+  t.check_constraint "price > 0", name: "price_check"
+  t.check_constraint "quantity >= 0", name: "quantity_check"
+end
+```
+
+> [!important]
+> **Matching Schemafile to Database Output**
+>
+> CHECK constraint expressions may be formatted differently by your database when exported. For example:
+> - DSL: `"(price > 0)"`
+> - Database export: `` "`price` > 0" `` (MySQL) or `"((price > 0))"` (PostgreSQL)
+>
+> To avoid unnecessary migrations where constraints are dropped and recreated:
+> Please modify your Schemafile to match exactly what the SchemaDumper outputs. This approach maintains simplicity and prevents migration issues instead of maintaining complex normalization logic in Ridgepole.
+>
+> Run `ridgepole --export` to see the exact format your database uses, then update your Schemafile accordingly.
+
 ## Ignore Column/Index/FK
 
 ```ruby
@@ -387,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-7.0 rake
-# POSTGRESQL=1 bundle exec appraisal activerecord-7.0 rake
-# MYSQL80=1 bundle exec appraisal activerecord-7.0 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/bin/ridgepole

@@ -187,7 +187,12 @@ begin
   client = Ridgepole::Client.new(Ridgepole::Config.load(config, env, spec_name), options) if config
 
   ActiveRecord::Base.logger = logger
-  ActiveSupport::LogSubscriber.colorize_logging = options[:color]
+
+  if ActiveRecord.gem_version < Gem::Version.new('8.2.0.alpha')
+    ActiveSupport::LogSubscriber.colorize_logging = options[:color]
+  else
+    ActiveSupport.colorize_logging = options[:color]
+  end
 
   case mode
   when :export

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,8 +74,8 @@ module Ridgepole
           ActiveRecord::Migration.disable_logging = true
           buf = StringIO.new
 
-          callback = proc do |sql, _name|
-            buf.puts sql if sql =~ /\A(CREATE|ALTER|DROP|RENAME)\b/i
+          callback = proc do |sql|
+            buf.puts sql if sql =~ /\A(CREATE|ALTER|DROP|RENAME|COMMENT)\b/i
           end
 
           eval_script_block = proc do
@@ -446,6 +446,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

@@ -410,15 +410,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/dsl_parser/context.rb

@@ -48,7 +48,7 @@ module Ridgepole
         table_name = table_name.to_s
         # Keep column_name for expression index support
         # https://github.com/rails/rails/pull/23393
-        column_name = [column_name].flatten.map(&:to_s) unless column_name.is_a?(String) && /\W/ === column_name # rubocop:disable Style/CaseEquality
+        column_name = [column_name].flatten.map(&:to_s) unless column_name.is_a?(String) && /\W/ === column_name
         options[:name] = options[:name].to_s if options[:name]
         @__definition[table_name] ||= {}
         @__definition[table_name][:indices] ||= {}

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.2'
+  VERSION = '3.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.4
 platform: ruby
 authors:
 - Genki Sugawara
@@ -18,7 +18,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '8.3'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -119,14 +119,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: hash_order_helper
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +197,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-match_fuzzy
   requirement: !ruby/object:Gem::Requirement
@@ -231,14 +245,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.81.6
+        version: 1.85.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.81.6
+        version: 1.85.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -281,6 +295,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -364,7 +406,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ridgepole is a tool to manage DB schema.
 test_files: []