ridgepole 3.0.1 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cccf60348e4baf7ac0988edb6e68bc14b0cbb945a167e4a2e6d9ef71d5e35c8a
-  data.tar.gz: 9ff98ff1c8a823fe988129816db0bcc4dac1c9f1a5c565faa47ef8aa3852507b
+  metadata.gz: 931a6b90df6d277ffd72a272342058290e4fcc8b793ffc0b94f2719a9fc6de4e
+  data.tar.gz: '01879ec62757730657f0197c052f2601fe74561286cef3fc4d7c9e82bc329764'
 SHA512:
-  metadata.gz: f0dc88f6715d8500bb4edfa106140ea7ca6cd1c207edd51cf65d12a76453ed2eb3d575ee8b73d7d96a0e386c4dec3e34ff985bf81bcc7a8026529946c3b40f74
-  data.tar.gz: 750a855f189b49cafbc35db15d227b2b2cbf8f2a545075b46a390697f768b3b9c606d9c6403c74c3491fdc76a408944aba2a3a2f7781dd475d096b82ec6f330a
+  metadata.gz: ada25e648306fce2dbb1755c5746e2bcaf6a7e4413fada585ce278f4750f7b28493b2e156139b17cacdb5b95d70073771dc174c11ce32986033bfa80a8cc3bf9
+  data.tar.gz: 61e689542f00d014065941fab911c0c11a6cbd1f41ef0f293cce18ffb4f71de37f9499985f9a6c4241699fe796c7a7bc2721979834a3882ad52bb2fcbfac0011

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## 3.0
 
+### 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)
+
+### 3.0.2 (2025/06/22)
+
+- Faster table definition comparisons [pull#549](https://github.com/ridgepole/ridgepole/pull/549)
+
 ### 3.0.1 (2025/01/12)
 
 - Normalize `check_constraint` [pull#512](https://github.com/ridgepole/ridgepole/pull/512)

data/README.md

@@ -329,6 +329,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/lib/ridgepole/delta.rb

@@ -271,7 +271,7 @@ create_table(#{table_name.inspect}, #{inspect_options_include_default_proc(optio
 end
       RUBY
 
-      if !(@options[:create_table_with_index]) && !indices.empty?
+      if !@options[:create_table_with_index] && !indices.empty?
         append_change_table(table_name, buf) do
           indices.each do |index_name, index_attrs|
             append_add_index(table_name, index_name, index_attrs, buf)
@@ -344,6 +344,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 +366,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

data/lib/ridgepole/diff.rb

@@ -30,8 +30,9 @@ module Ridgepole
           @logger.verbose_info("#   #{table_name}")
 
           unless @options[:drop_table_only]
-            unless (attrs_delta = diff_inspect(from_attrs, to_attrs)).empty?
-              @logger.verbose_info(attrs_delta)
+            unless hash_deep_equal?(from_attrs, to_attrs)
+              attrs_delta = diff_inspect(from_attrs, to_attrs)
+              @logger.verbose_info(attrs_delta) unless attrs_delta.empty?
             end
 
             scan_change(table_name, from_attrs, to_attrs, delta)
@@ -233,6 +234,7 @@ module Ridgepole
       from = (from || {}).dup
       to = (to || {}).dup
       definition_delta = {}
+      column_comments = {}
 
       scan_column_rename(from, to, definition_delta)
 
@@ -248,10 +250,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] ||= {}
@@ -306,6 +312,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)
@@ -414,7 +421,7 @@ module Ridgepole
           end
         end
 
-        if opts[:size] && (attrs[:type] == :text || attrs[:type] == :blob || attrs[:type] == :binary)
+        if opts[:size] && %i[text blob binary].include?(attrs[:type])
           case opts.delete(:size)
           when :tiny
             attrs[:type] = :blob if attrs[:type] == :binary
@@ -432,6 +439,9 @@ module Ridgepole
       # XXX: MySQL only?
       opts[:using] = :btree unless opts.key?(:using)
       opts[:unique] = false unless opts.key?(:unique)
+
+      # 'algorithm: concurrently' is required for index creation but not stored in PostgreSQL DB metadata, so remove 'algorithm' to prevent diff
+      opts.delete(:algorithm)
     end
 
     def columns_all_include?(expected_columns, actual_columns, table_options)
@@ -622,6 +632,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
@@ -732,5 +755,16 @@ module Ridgepole
         @logger.warn "[WARNING] '#{table_name}' definition is not found" unless definition.key?(table_name)
       end
     end
+
+    def hash_deep_equal?(hash1, hash2)
+      return false unless hash1.is_a?(Hash) && hash2.is_a?(Hash)
+      return false if hash1.keys.to_set != hash2.keys.to_set
+
+      hash1.each do |k, v|
+        return false unless hash2.key?(k) && v == hash2[k]
+      end
+
+      true
+    end
   end
 end

data/lib/ridgepole/dsl_parser.rb

@@ -23,16 +23,17 @@ module Ridgepole
     end
 
     def check_orphan_index(table_name, attrs)
-      raise "Table `#{table_name}` to create the index is not defined: #{attrs[:indices].keys.join(',')}" if attrs[:indices] && !(attrs[:definition])
+      raise "Table `#{table_name}` to create the index is not defined: #{attrs[:indices].keys.join(',')}" if attrs[:indices] && !attrs[:definition]
     end
 
     def check_orphan_foreign_key(table_name, attrs)
-      raise "Table `#{table_name}` to create the foreign key is not defined: #{attrs[:foreign_keys].keys.join(',')}" if attrs[:foreign_keys] && !(attrs[:definition])
+      raise "Table `#{table_name}` to create the foreign key is not defined: #{attrs[:foreign_keys].keys.join(',')}" if attrs[:foreign_keys] && !attrs[:definition]
     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/dumper.rb

@@ -85,7 +85,7 @@ module Ridgepole
     end
 
     def target?(table_name)
-      !(@options[:tables]) || @options[:tables].include?(table_name)
+      !@options[:tables] || @options[:tables].include?(table_name)
     end
 
     def dump_from(conn)

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.1'
+  VERSION = '3.0.4'
 end

data/lib/ridgepole.rb

@@ -2,7 +2,7 @@
 
 require 'logger'
 require 'open3'
-require 'pp' # rubocop:disable Lint/RedundantRequireStatement
+require 'pp'
 require 'shellwords'
 require 'singleton'
 require 'stringio'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.4
 platform: ruby
 authors:
 - Genki Sugawara
 bindir: bin
 cert_chain: []
-date: 2025-01-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -231,14 +231,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.69.2
+        version: 1.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.69.2
+        version: 1.80.0
 - !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.2
+rubygems_version: 3.6.7
 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,62 +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

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,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in ridgepole.gemspec
-gemspec

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,50 +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.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.69.2'
-  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