ridgepole 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9ad7e2017aa2af02dd9f0fb5c45cdc7fd1a4f3925778e966246589e352d5ea
-  data.tar.gz: b07a08f0001ed86483597794962e0293be0dc609b7c0a5fdc4425c28c10b8b49
+  metadata.gz: d387024f72e2f0cadf0c913d9d6d1863753401ed8cdd35759effd47e5405d3fd
+  data.tar.gz: ed16c2c4ce6e91797eba24c94384dc2e03db5e39ca18e9119daa4e19a67bd97e
 SHA512:
-  metadata.gz: 5747b6d95e0fb69c35c40508935d5474f1ed3750d09354218cfdda6a35de7b5ecbe2a45307bcdca718f2d15a1af12e9c7d95271837c1ae46e0903def31568e09
-  data.tar.gz: 1ca608fb67b6fcfb6b21fd2c2d4a6fd354a1f7e93333c7e183b5af01a7fbf711693ba4910a43019145d342cb311523c6b54395c5afceb5624b36fddb7a0d361d
+  metadata.gz: ea58375d9d0f3aa45084f08dabdea2719bbdd973229214dd60388fdd375d05dc3814b9131afb48a0c3b445b505a23f7c25b99a27f255549db81abf948a88a04e
+  data.tar.gz: 692d7e680804f86feab03fdebf1aa8f0f88af8f752e04cafec57a5406be64240114d6327a1651a74dae483d31336d0ab09b0f566524f8bd7f133a3e0e9862bb7

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## 3.0
 
+### 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)
+- Use `change_column_comment` for comment-only column changes [pull#567](https://github.com/ridgepole/ridgepole/pull/567)
+
 ### 3.0.3 (2025/07/23)
 
 - Fix for index `algorithm` option [pull#555](https://github.com/ridgepole/ridgepole/pull/555)

data/README.md

@@ -181,6 +181,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|
@@ -329,6 +336,42 @@ Apply `Schemafile`
 ...
 ```
 
+## Define a partial index in PostgreSQL
+
+Partial indexes in PostgreSQL are normalized so differences are always detected.
+
+```ruby
+create_table "users", id: :serial, force: :cascade do |t|
+  t.text "email"
+  t.text "name"
+  t.index ["email"], name: "idx_users_email", unique: true, where: "email is not null"
+end
+```
+
+```sh
+% ridgepole -a -c database.yml --dry-run --verbose
+Apply `Schemafile` (dry-run)
+# Parse DSL
+# ...
+# Compare definitions
+#   users
+      :options=>
+       {:name=>"idx_users_email",
+        :unique=>true,
+-       :where=>"(email IS NOT NULL)"}}},
++       :where=>"email is not null"}}},
+  :options=>{:id=>:serial}}
+```
+
+Use a normalized WHERE clause to avoid detecting differences.
+
+```ruby
+#t.index ["email"], name: "idx_users_email", unique: true, where: "email is not null"
+t.index ["email"], name: "idx_users_email", unique: true, where: "(email IS NOT NULL)"
+```
+
+see https://github.com/ridgepole/ridgepole/issues/568
+
 ## Run tests
 
 

data/bin/ridgepole

@@ -139,6 +139,7 @@ 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 }

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)
@@ -344,6 +350,7 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
       table_charset = attrs[:table_charset]
       table_collation = attrs[:table_collation]
       table_comment = attrs[:table_comment]
+      column_comments = attrs[:column_comments] || {}
 
       if !definition.empty? || !indices.empty? || !primary_key_definition.empty?
         append_change_table(table_name, buf) do
@@ -365,12 +372,21 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
       end
 
       append_change_table_comment(table_name, table_comment, buf) if table_comment
+      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
     end
 
+    def append_change_column_comments(table_name, column_comments, buf)
+      column_comments.each do |column_name, comment|
+        buf.puts(<<-RUBY)
+change_column_comment(#{table_name.inspect}, #{column_name.inspect}, #{comment.inspect})
+        RUBY
+      end
+    end
+
     def append_change_table(table_name, buf)
       buf.puts "change_table(#{table_name.inspect}, bulk: true) do |t|" if @options[:bulk_change]
       yield
@@ -428,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)
@@ -234,6 +242,7 @@ module Ridgepole
       from = (from || {}).dup
       to = (to || {}).dup
       definition_delta = {}
+      column_comments = {}
 
       scan_column_rename(from, to, definition_delta)
 
@@ -249,10 +258,14 @@ module Ridgepole
         next if ignore_column
 
         if from_attrs
-          to_attrs = build_attrs_if_changed(to_attrs, from_attrs)
-          if to_attrs
-            definition_delta[:change] ||= {}
-            definition_delta[:change][column_name] = to_attrs
+          changed_attrs = build_attrs_if_changed(to_attrs, from_attrs)
+          if changed_attrs
+            if comment_only_change?(from_attrs, to_attrs)
+              column_comments[column_name] = to_attrs[:options][:comment]
+            else
+              definition_delta[:change] ||= {}
+              definition_delta[:change][column_name] = changed_attrs
+            end
           end
         else
           definition_delta[:add] ||= {}
@@ -307,6 +320,7 @@ module Ridgepole
       end
 
       table_delta[:definition] = definition_delta unless definition_delta.empty?
+      table_delta[:column_comments] = column_comments unless column_comments.empty?
     end
 
     def scan_column_rename(from, to, definition_delta)
@@ -626,6 +640,19 @@ module Ridgepole
       attrs1 == attrs2
     end
 
+    def comment_only_change?(attrs1, attrs2)
+      return false if @options[:skip_column_comment_change]
+
+      attrs1 = attrs1.merge(options: attrs1.fetch(:options, {}).dup)
+      attrs2 = attrs2.merge(options: attrs2.fetch(:options, {}).dup)
+      normalize_default_proc_options!(attrs1[:options], attrs2[:options])
+
+      comment1 = attrs1.fetch(:options).delete(:comment)
+      comment2 = attrs2.fetch(:options).delete(:comment)
+
+      attrs1 == attrs2 && comment1 != comment2
+    end
+
     def normalize_default_proc_options!(opts1, opts2)
       if opts1[:default].is_a?(Proc) && opts2[:default].is_a?(Proc)
         opts1[:default] = opts1[:default].call

data/lib/ridgepole/dsl_parser.rb

@@ -31,8 +31,9 @@ module Ridgepole
     end
 
     def check_foreign_key_without_index(table_name, attrs)
+      return if Ridgepole::ConnectionAdapters.postgresql?
       return unless attrs[:foreign_keys]
-      return unless attrs[:options][:options]&.include?('ENGINE=InnoDB')
+      return unless innodb_table?(attrs)
 
       attrs[:foreign_keys].each_value do |foreign_key_attrs|
         fk_index = foreign_key_attrs[:options][:column] || "#{foreign_key_attrs[:to_table].singularize}_id"
@@ -53,5 +54,10 @@ module Ridgepole
         Array(index_column_name).first == fk_index
       end
     end
+
+    def innodb_table?(attrs)
+      engine = attrs[:options][:options]&.match(/ENGINE=([^ ]+)/) && Regexp.last_match(1)
+      engine.nil? || engine == 'InnoDB'
+    end
   end
 end

data/lib/ridgepole/logger.rb

@@ -3,6 +3,7 @@
 module Ridgepole
   class Logger < ::Logger
     include Singleton
+
     cattr_accessor :verbose
 
     def initialize

data/lib/ridgepole/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 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.78.0
+        version: 1.81.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.78.0
+        version: 1.81.6
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -318,22 +318,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/ridgepole
-- compose.yml
-- gemfiles/activerecord_6.1.gemfile
-- gemfiles/activerecord_7.0.gemfile
-- gemfiles/activerecord_7.1.gemfile
-- gemfiles/activerecord_7.2.gemfile
-- gemfiles/activerecord_8.0.gemfile
 - lib/ridgepole.rb
 - lib/ridgepole/cli/config.rb
 - lib/ridgepole/client.rb
@@ -356,7 +344,6 @@ files:
 - lib/ridgepole/schema_dumper_ext.rb
 - lib/ridgepole/schema_statements_ext.rb
 - lib/ridgepole/version.rb
-- ridgepole.gemspec
 homepage: https://github.com/ridgepole/ridgepole
 licenses:
 - MIT
@@ -376,7 +363,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/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---format HidePendingFormatter

data/.rubocop.yml

@@ -1,64 +0,0 @@
-AllCops:
-  Exclude:
-    - "gemfiles/**/*"
-    - "omnibus-ridgepole/**/*"
-    - "vendor/bundle/**/*"
-    - "Schemafile"
-    - "**/*.schema"
-  TargetRubyVersion: 2.7
-  NewCops: enable
-  SuggestExtensions: false
-Bundler/OrderedGems:
-  Include:
-    - "Appraisals"
-Layout/HeredocIndentation:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/BlockNesting:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Layout/LineLength:
-  Max: 200
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Max: 106
-Metrics/ParameterLists:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false
-Style/MixinUsage:
-  Exclude:
-    - "spec/**/*"
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-Layout/ClosingHeredocIndentation:
-  Enabled: false
-Style/NumericPredicate:
-  Enabled: false
-Lint/MissingSuper:
-  Enabled: false
-Style/StringConcatenation:
-  Enabled: false
-Style/SoleNestedConditional:
-  Enabled: false
-Lint/DuplicateBranch:
-  Enabled: false
-Style/OptionalBooleanParameter:
-  Enabled: false
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-Lint/LiteralInInterpolation:
-  Enabled: false
-Naming/PredicateMethod:
-  Enabled: false

data/.simplecov

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-SimpleCov.configure do
-  # exclude directories and files
-  add_filter '/spec/'
-end

data/Appraisals

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'activerecord-6.1' do
-  gem 'activerecord', '~> 6.1.7'
-end
-
-appraise 'activerecord-7.0' do
-  gem 'activerecord', '~> 7.0.4'
-end
-
-appraise 'activerecord-7.1' do
-  gem 'activerecord', '~> 7.1.0'
-end
-
-appraise 'activerecord-7.2' do
-  gem 'activerecord', '~> 7.2.0'
-end
-
-appraise 'activerecord-8.0' do
-  gem 'activerecord', '~> 8.0.0'
-end

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in ridgepole.gemspec
-gemspec
-
-gem 'mutex_m' if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.4.0')

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new('spec')
-
-RuboCop::RakeTask.new do |task|
-  task.options = %w[-c .rubocop.yml]
-end
-
-task default: %i[rubocop spec]

data/compose.yml

@@ -1,20 +0,0 @@
-services:
-  mysql57:
-    image: "mysql:5.7"
-    platform: linux/amd64
-    ports:
-      - "13316:3306"
-    environment:
-      MYSQL_ROOT_PASSWORD: password
-  mysql80:
-    image: "mysql:8.0"
-    ports:
-      - "13318:3306"
-    environment:
-      MYSQL_ROOT_PASSWORD: password
-  postgres:
-    image: "postgres:14"
-    ports:
-      - "15442:5432"
-    environment:
-      POSTGRES_PASSWORD: password

data/gemfiles/activerecord_6.1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.1.7"
-
-gemspec path: "../"

data/gemfiles/activerecord_7.0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.0.4"
-
-gemspec path: "../"

data/gemfiles/activerecord_7.1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.1.0"
-
-gemspec path: "../"

data/gemfiles/activerecord_7.2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.2.0"
-
-gemspec path: "../"

data/gemfiles/activerecord_8.0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 8.0.0"
-
-gemspec path: "../"

data/ridgepole.gemspec

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ridgepole/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'ridgepole'
-  spec.version       = Ridgepole::VERSION
-  spec.authors       = ['Genki Sugawara']
-  spec.email         = ['sugawara@winebarrel.jp']
-  spec.summary       = 'Ridgepole is a tool to manage DB schema.'
-  spec.description   = 'Ridgepole is a tool to manage DB schema. It defines DB schema using Rails DSL, and updates DB schema according to DSL.'
-  spec.homepage      = 'https://github.com/ridgepole/ridgepole'
-  spec.license       = 'MIT'
-  spec.platform      = Gem::Platform::RUBY
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
-
-  spec.add_dependency 'activerecord', '>= 6.1', '< 8.1'
-  spec.add_dependency 'diffy'
-  spec.add_dependency 'logger'
-
-  spec.add_development_dependency 'appraisal', '>= 2.2.0'
-  spec.add_development_dependency 'bigdecimal'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'erbh', '>= 0.2.1'
-  spec.add_development_dependency 'hash_modern_inspect', '>= 0.1.1'
-  spec.add_development_dependency 'hash_order_helper', '>= 0.1.6'
-  spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'pg'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 3.0.0'
-  spec.add_development_dependency 'rspec-match_fuzzy', '>= 0.2.0'
-  spec.add_development_dependency 'rspec-match_ruby', '>= 0.1.3'
-  spec.add_development_dependency 'rubocop', '1.78.0'
-  spec.add_development_dependency 'rubocop-rake', '>= 0.5.1'
-  spec.add_development_dependency 'rubocop-rspec', '>= 2.1.0'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov-lcov'
-  spec.add_development_dependency 'trilogy'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end