ridgepole 1.0.1 → 3.1.5

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/ext/abstract_adapter/disable_table_options.rb

@@ -18,8 +18,6 @@ module Ridgepole
 
           if options && @__without_table_options
             options.delete(:options)
-
-            # For >= AR 6.1.0
             options.delete(:charset)
             options.delete(:collation)
           end

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/external_sql_executer.rb

@@ -8,7 +8,7 @@ module Ridgepole
     end
 
     def execute(sql)
-      cmd = Shellwords.join([@script, sql, JSON.dump(connection_configuration_hash)])
+      cmd = Shellwords.join([@script, sql, JSON.dump(ActiveRecord::Base.connection_db_config.configuration_hash)])
       @logger.info("Execute #{@script}")
       script_basename = File.basename(@script)
 
@@ -46,16 +46,5 @@ module Ridgepole
         raise "`#{@script}` execution failed" unless wait_thr.value.success?
       end
     end
-
-    private
-
-    def connection_configuration_hash
-      if ActiveRecord.gem_version < Gem::Version.new('6.1.0')
-        # NOTE: Remove code when stopping support for versions below 6.1
-        ActiveRecord::Base.connection_config
-      else
-        ActiveRecord::Base.connection_db_config.configuration_hash
-      end
-    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 = '1.0.1'
+  VERSION = '3.1.5'
 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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 3.1.5
 platform: ruby
 authors:
 - Genki Sugawara
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.3'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +71,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,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
@@ -170,48 +197,62 @@ 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
     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: rspec-match_ruby
   requirement: !ruby/object:Gem::Requirement
     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.24.1
+        version: 1.85.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.24.1
+        version: 1.85.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -254,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
@@ -268,6 +337,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trilogy
+  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'
 description: Ridgepole is a tool to manage DB schema. It defines DB schema using Rails
   DSL, and updates DB schema according to DSL.
 email:
@@ -277,22 +360,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/ridgepole
-- docker-compose.yml
-- gemfiles/activerecord_5.1.gemfile
-- gemfiles/activerecord_5.2.gemfile
-- gemfiles/activerecord_6.0.gemfile
-- gemfiles/activerecord_6.1.gemfile
-- gemfiles/activerecord_7.0.gemfile
 - lib/ridgepole.rb
 - lib/ridgepole/cli/config.rb
 - lib/ridgepole/client.rb
@@ -308,20 +379,19 @@ 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
 - 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
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -329,15 +399,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.7
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 4.0.3
 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,53 +0,0 @@
-AllCops:
-  Exclude:
-    - "gemfiles/**/*"
-    - "omnibus-ridgepole/**/*"
-    - "vendor/bundle/**/*"
-  TargetRubyVersion: 2.5
-  NewCops: enable
-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:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-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

data/.simplecov

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

data/Appraisals

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'activerecord-5.1' do
-  gem 'activerecord', '~> 5.1.0'
-end
-
-appraise 'activerecord-5.2' do
-  gem 'activerecord', '~> 5.2.0'
-  gem 'mysql2', '~> 0.4.4'
-end
-
-appraise 'activerecord-6.0' do
-  gem 'activerecord', '~> 6.0.0'
-end
-
-appraise 'activerecord-6.1' do
-  gem 'activerecord', '~> 6.1.0'
-end
-
-appraise 'activerecord-7.0' do
-  gem 'activerecord', '~> 7.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/docker-compose.yml

@@ -1,26 +0,0 @@
-version: "3.8"
-services:
-  mysql:
-    image: "mysql:5.6"
-    ports:
-      - "13316:3306"
-    environment:
-      MYSQL_ROOT_PASSWORD: password
-  mysql57:
-    image: "mysql:5.7"
-    ports:
-      - "13317: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_5.1.gemfile

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

data/gemfiles/activerecord_5.2.gemfile

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