ridgepole 0.8.6 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e81708c1fcd99a721354e49bdd8281e42657271da21acd80ecbf87e5a6b51890
-  data.tar.gz: d4d2321cfc763a9f23bd9e3d57e16ef5e07c852653e198286ef9d39ef16275b4
+  metadata.gz: 367dff4faf9fd7e94588cdefe290cf13953cf82b9dc5110e91cfd5d4ee2507a3
+  data.tar.gz: 20ad65390cd7b12fe97e8fbae409aa5bc0d86a6c73c79a9916bfc55f46f03cb6
 SHA512:
-  metadata.gz: 55bf02b0f28ea259810c140697def6312f937e14cfc023be4aa6da75699844fd654b6d519896691ee1ddf7d1e2c60a12630d3820ce7e5e3505f210f400b02726
-  data.tar.gz: cd121f6363ffb2136a124990c9f373f984a634302d0e8633cfe2f9fc164e0e244eaf0997d52bdd4c3aa618e28b02593f755b8e6485a87dc0b6aba023a3237d45
+  metadata.gz: 94039eb4e75e2f0b218275ffec9b8a1b4c28ae5b9c93ad64b584793acbabc1ece9eb8ddde4e6d3097ffc6a9346ef36a6318334048d99c8e85050e0b9ef3088bd
+  data.tar.gz: 5e4837104ea5b6b69e42fdcc82e29b71a33835ce8371b959c16f3c00b014047a88b3c01ecba74ab8d6e591fd3357d15019a1dc41c425ff4c10b49fcec6bbdc48

data/.github/workflows/test.yml

@@ -0,0 +1,62 @@
+name: test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        env:
+          - MYSQL56=1
+          - MYSQL57=1
+          - POSTGRESQL=1
+        gemfile:
+          - gemfiles/activerecord_5.0.gemfile
+          - gemfiles/activerecord_5.1.gemfile
+          - gemfiles/activerecord_5.2.gemfile
+          - gemfiles/activerecord_6.0.gemfile
+        exclude:
+          - ruby: 2.4
+            gemfile: gemfiles/activerecord_6.0.gemfile
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: gemfiles/vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles('ridgepole.gemspec', '**/Gemfile', '${{ matrix.gemfile }}') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.gemfile }}-
+
+      - name: Setup dependencies
+        run: |
+          for i in {1..60}; do docker-compose up -d && break; sleep 1; done
+
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+          # Wait until database servers start
+          function mysql_ping { mysqladmin -u root -h 127.0.0.1 -P 13316 -ppassword ping; }
+          function mysql57_ping { mysqladmin -u root -h 127.0.0.1 -P 13317 -ppassword ping; }
+          function pg_ping { PGPASSWORD=password pg_isready -U postgres -h 127.0.0.1 -p 15442; }
+          for i in {1..60}; do mysql_ping && break; sleep 1; done
+          for i in {1..60}; do mysql57_ping && break; sleep 1; done
+          for i in {1..60}; do pg_ping && break; sleep 1; done
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+      - run: ${{ matrix.env }} bundle exec rake
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'gemfiles/**/*'
     - 'omnibus-ridgepole/**/*'
   TargetRubyVersion: 2.4
+  NewCops: enable
 Bundler/OrderedGems:
   Include:
     - 'Appraisals'
@@ -18,7 +19,7 @@ Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
-Style/LineLength:
+Layout/LineLength:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
@@ -30,8 +31,6 @@ Style/Documentation:
   Enabled: false
 Style/GuardClause:
   Enabled: false
-Style/MethodMissingSuper:
-  Enabled: false
 Style/MixinUsage:
   Exclude:
     - 'spec/**/*'
@@ -41,3 +40,13 @@ 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/README.md

@@ -6,7 +6,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 (like Chef/Puppet)
 
 [![Gem Version](https://badge.fury.io/rb/ridgepole.svg)](http://badge.fury.io/rb/ridgepole)
-[![Build Status](https://travis-ci.org/winebarrel/ridgepole.svg?branch=0.8)](https://travis-ci.org/winebarrel/ridgepole)
+[![Build Status](https://github.com/winebarrel/ridgepole/workflows/test/badge.svg?branch=0.8)](https://github.com/winebarrel/ridgepole/actions)
 [![Coverage Status](https://coveralls.io/repos/github/winebarrel/ridgepole/badge.svg?branch=0.8)](https://coveralls.io/github/winebarrel/ridgepole?branch=0.8)
 
 <details><summary>ChangeLog</summary>
@@ -113,6 +113,18 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Improve warning message on table options ([pull#291](https://github.com/winebarrel/ridgepole/pull/291))
 * `>= 0.8.6`
   * Support multiple databases feature ([pull#297](https://github.com/winebarrel/ridgepole/pull/297))
+* `>= 0.8.7`
+  * Support `require_relative` ([pull#298](https://github.com/winebarrel/ridgepole/pull/298))
+* `>= 0.8.8`
+  * Fix keyword arguments warnings in Ruby 2.7 ([pull#303](https://github.com/winebarrel/ridgepole/pull/303))
+* `>= 0.8.9`
+  * Fix unexpected differences on text types and blob types on Rails 6 ([pull#306](https://github.com/winebarrel/ridgepole/pull/306))
+  * Fix unexpected warning when a foreign key is added on the primary key ([pull#307](https://github.com/winebarrel/ridgepole/pull/307))
+* `>= 0.8.10`
+  * Raise an error if an InnoDB column has a foreign key but no index ([pull#310](https://github.com/winebarrel/ridgepole/pull/310))
+* `>= 0.8.11`
+  * Fix FK index check support multiple PK ([pull#315](https://github.com/winebarrel/ridgepole/pull/315))
+  * Support t.reference() foreign_key option ([pull#316](https://github.com/winebarrel/ridgepole/pull/316))
 </details>
 
 ## Installation
@@ -191,6 +203,7 @@ Usage: ridgepole [options]
         --ignore-table-comment
         --skip-column-comment-change
         --create-table-with-index
+        --allow-pk-change
         --mysql-dump-auto-increment
     -r, --require LIBS
         --log-file LOG_FILE
@@ -307,7 +320,6 @@ end
 ```
 
 ## Collation/Charset
-You can use the column collation by passing `--enable-mysql-awesome` ([activerecord-mysql-awesome](https://github.com/kamipo/activerecord-mysql-awesome) is required)
 
 ```ruby
 create_table "articles", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|

data/lib/ridgepole/delta.rb

@@ -246,7 +246,7 @@ create_table(#{table_name.inspect}, #{inspect_options_include_default_proc(optio
       end
 
       buf.puts(<<-RUBY)
-  end
+end
       RUBY
 
       if !(@options[:create_table_with_index]) && !indices.empty?
@@ -326,7 +326,7 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
     end
 
     def append_change_table(table_name, buf)
-      buf.puts "change_table(#{table_name.inspect}, {:bulk => true}) do |t|" if @options[:bulk_change]
+      buf.puts "change_table(#{table_name.inspect}, bulk: true) do |t|" if @options[:bulk_change]
       yield
       buf.puts 'end' if @options[:bulk_change]
     end
@@ -429,11 +429,11 @@ remove_column(#{table_name.inspect}, #{column_name.inspect})
 
       if force_bulk_change || @options[:bulk_change]
         buf.puts(<<-RUBY)
-  t.index(#{column_name.inspect}, #{options.inspect})
+  t.index(#{column_name.inspect}, **#{options.inspect})
       RUBY
       else
         buf.puts(<<-RUBY)
-add_index(#{table_name.inspect}, #{column_name.inspect}, #{options.inspect})
+add_index(#{table_name.inspect}, #{column_name.inspect}, **#{options.inspect})
       RUBY
       end
     end
@@ -441,15 +441,20 @@ add_index(#{table_name.inspect}, #{column_name.inspect}, #{options.inspect})
     def append_remove_index(table_name, _index_name, attrs, buf)
       column_name = attrs.fetch(:column_name)
       options = attrs[:options] || {}
-      target = options[:name] ? { name: options[:name] } : column_name
+      target =
+        if options[:name]
+          "name: #{options[:name].inspect}"
+        else
+          column_name.inspect
+        end
 
       if @options[:bulk_change]
         buf.puts(<<-RUBY)
-  t.remove_index(#{target.inspect})
+  t.remove_index(#{target})
       RUBY
       else
         buf.puts(<<-RUBY)
-remove_index(#{table_name.inspect}, #{target.inspect})
+remove_index(#{table_name.inspect}, #{target})
       RUBY
       end
     end
@@ -469,7 +474,7 @@ remove_index(#{table_name.inspect}, #{target.inspect})
       attrs_options = attrs[:options] || {}
 
       buf.puts(<<-RUBY)
-add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, #{attrs_options.inspect})
+add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, **#{attrs_options.inspect})
     RUBY
     end
 
@@ -478,13 +483,13 @@ add_foreign_key(#{table_name.inspect}, #{to_table.inspect}, #{attrs_options.insp
       fk_name = attrs_options[:name]
 
       target = if fk_name
-                 { name: fk_name }
+                 "name: #{fk_name.inspect}"
                else
-                 attrs.fetch(:to_table)
+                 attrs.fetch(:to_table).inspect
                end
 
       buf.puts(<<-RUBY)
-remove_foreign_key(#{table_name.inspect}, #{target.inspect})
+remove_foreign_key(#{table_name.inspect}, #{target})
     RUBY
     end
 
@@ -500,17 +505,19 @@ remove_foreign_key(#{table_name.inspect}, #{target.inspect})
     def inspect_options_include_default_proc(options)
       options = options.dup
 
-      if options[:default].is_a?(Proc)
-        proc_default = options.delete(:default)
-        proc_default = ":default=>proc{#{proc_default.call.inspect}}"
-        options_inspect = options.inspect
-        options_inspect.sub!(/\}\z/, '')
-        options_inspect << ', ' if options_inspect !~ /\{\z/
-        options_inspect << proc_default << '}'
-        options_inspect
-      else
-        options.inspect
-      end
+      kwargs =
+        if options[:default].is_a?(Proc)
+          proc_default = options.delete(:default)
+          proc_default = ":default=>proc{#{proc_default.call.inspect}}"
+          options_inspect = options.inspect
+          options_inspect.sub!(/\}\z/, '')
+          options_inspect << ', ' if options_inspect !~ /\{\z/
+          options_inspect << proc_default << '}'
+          options_inspect
+        else
+          options.inspect
+        end
+      "**#{kwargs}"
     end
   end
 end

data/lib/ridgepole/diff.rb

@@ -386,6 +386,18 @@ module Ridgepole
           attrs[:type] = :bigint
           opts.delete(:limit)
         end
+
+        if opts[:size] && (attrs[:type] == :text || attrs[:type] == :blob || attrs[:type] == :binary)
+          case opts.delete(:size)
+          when :tiny
+            attrs[:type] = :blob if attrs[:type] == :binary
+            opts[:limit] = 255
+          when :medium
+            opts[:limit] = 16_777_215
+          when :long
+            opts[:limit] = 4_294_967_295
+          end
+        end
       end
     end
 

data/lib/ridgepole/dsl_parser.rb

@@ -37,11 +37,10 @@ module Ridgepole
       attrs[:foreign_keys].each do |_, foreign_key_attrs|
         fk_index = foreign_key_attrs[:options][:column] || "#{foreign_key_attrs[:to_table].singularize}_id"
         next if attrs[:indices]&.any? { |_k, v| v[:column_name].first == fk_index }
+        # NOTE: For composite primary keys, the first column of the primary key is used as the foreign key index
+        next if Array(attrs[:options][:primary_key]).first == fk_index
 
-        Ridgepole::Logger.instance.warn(<<-MSG)
-[WARNING] Table `#{table_name}` has a foreign key on `#{fk_index}` column, but doesn't have any indexes on the column.
-          Although an index will be added automatically by InnoDB, please add an index explicitly for your future operations.
-        MSG
+        raise "The column `#{fk_index}` of the table `#{table_name}` has a foreign key but no index. Although InnoDB creates an index automatically, please add one explicitly in order for ridgepole to manage it."
       end
     end
   end

data/lib/ridgepole/dsl_parser/context.rb

@@ -3,8 +3,7 @@
 module Ridgepole
   class DSLParser
     class Context
-      attr_reader :__definition
-      attr_reader :__execute
+      attr_reader :__definition, :__execute
 
       def initialize(opts = {})
         @__working_dir = File.expand_path(opts[:path] ? File.dirname(opts[:path]) : Dir.pwd)
@@ -28,7 +27,7 @@ module Ridgepole
         table_name = table_name.to_s
         table_definition = TableDefinition.new(table_name, self)
 
-        options[:primary_key] = options[:primary_key].to_s if options[:primary_key]&.is_a?(Symbol)
+        options[:primary_key] = options[:primary_key].to_s if options[:primary_key].is_a?(Symbol)
         if options[:id] && TableDefinition::ALIAS_TYPES.key?(options[:id])
           type, type_default_opts = TableDefinition::ALIAS_TYPES[options[:id]]
           options[:id] = type
@@ -104,6 +103,10 @@ module Ridgepole
         end
       end
 
+      def require_relative(relative_path)
+        require(File.expand_path(relative_path, File.dirname(caller[0])))
+      end
+
       def execute(sql, _name = nil, &cond)
         @__execute << {
           sql: sql,

data/lib/ridgepole/dsl_parser/table_definition.rb

@@ -131,6 +131,7 @@ module Ridgepole
         polymorphic_options.merge!(options.slice(:null, :first, :after))
         index_options = options.key?(:index) ? options.delete(:index) : true
         type = options.delete(:type) || DEFAULT_PRIMARY_KEY_TYPE
+        foreign_key_options = options.delete(:foreign_key)
 
         args.each do |col|
           column("#{col}_id", type, options)
@@ -139,6 +140,12 @@ module Ridgepole
             columns = polymorphic ? ["#{col}_type", "#{col}_id"] : ["#{col}_id"]
             index(columns, index_options.is_a?(Hash) ? index_options : {})
           end
+          if foreign_key_options # rubocop:disable Style/Next
+            fk_opts = foreign_key_options.is_a?(Hash) ? foreign_key_options.dup : {}
+            fk_opts.update(column: "#{col}_id") if col.to_s.singularize != col.to_s
+            to_table = fk_opts.delete(:to_table) || col
+            @base.add_foreign_key(@table_name, to_table, fk_opts)
+          end
         end
       end
       alias belongs_to references

data/lib/ridgepole/ext/abstract_mysql_adapter/use_alter_index.rb

@@ -7,7 +7,7 @@ module Ridgepole
     module AbstractMysqlAdapter
       module UseAlterIndex
         def add_index(table_name, column_name, options = {})
-          index_name, index_type, index_columns, index_options, _index_algorithm, index_using = add_index_options(table_name, column_name, options)
+          index_name, index_type, index_columns, index_options, _index_algorithm, index_using = add_index_options(table_name, column_name, **options)
 
           # cannot specify index_algorithm
           execute "ALTER TABLE #{quote_table_name(table_name)} ADD #{index_type} INDEX #{quote_column_name(index_name)} #{index_using} (#{index_columns})#{index_options}"

data/lib/ridgepole/external_sql_executer.rb

@@ -41,7 +41,7 @@ module Ridgepole
               end
             end
           end
-        rescue EOFError # rubocop:disable Lint/SuppressedException
+        rescue EOFError
           # nothing to do
         end
 

data/lib/ridgepole/version.rb

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

data/ridgepole.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.2.7')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.2.7') # rubocop:disable Gemspec/RequiredRubyVersion
 
   spec.add_dependency 'activerecord', '>= 5.0.1', '< 6.1'
   spec.add_dependency 'diffy'

data/spec/dsl_parser/context_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe Ridgepole::DSLParser::Context do
+  describe '#require_relative' do
+    subject { context.require_relative(relative_path) }
+
+    let!(:context) do
+      Ridgepole::DSLParser::Context.new
+    end
+    let!(:relative_path) do
+      '../fixtures/for_require_relative_spec.rb'
+    end
+
+    it { is_expected.to be_truthy }
+  end
+end

data/spec/erb_helper.rb

@@ -18,9 +18,9 @@ ERBh.define_method(:cond) do |conds, m, e = nil|
     m
   else
     e || (begin
-            m.class.new
-          rescue StandardError
-            nil
-          end)
+      m.class.new
+    rescue StandardError
+      nil
+    end)
   end
 end

data/spec/fixtures/for_require_relative_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+'This file is used by dsl_parser/context_spec.'

data/spec/mysql/collation/collation_spec.rb

@@ -138,6 +138,12 @@ describe 'Ridgepole::Client#diff -> migrate' do
           opts = ['--dump-without-table-options']
           out, status = run_ridgepole('--diff', "'#{JSON.dump(conn_spec)}'", f.path, *opts)
 
+          # v6.0.3 is the oldest version that doesn't produce any kwargs warnings with Ruby 2.7
+          if condition('< 6.0.3')
+            # https://github.com/jeremyevans/ruby-warning/blob/1.1.0/lib/warning.rb#L18
+            out = out.lines.grep_v(/: warning: (?:Using the last argument (?:for `.+' )?as keyword parameters is deprecated; maybe \*\* should be added to the call|Passing the keyword argument (?:for `.+' )?as the last hash parameter is deprecated|Splitting the last argument (?:for `.+' )?into positional and keyword parameters is deprecated|The called method (?:`.+' )?is defined here)\n\z/).join
+          end
+
           expect(out).to be_empty
           expect(status.success?).to be_truthy
         end

data/spec/mysql/diff/diff2_spec.rb

@@ -175,10 +175,10 @@ describe 'Ridgepole::Client.diff' do
       delta = subject.diff(actual_dsl, expected_dsl)
       expect(delta.differ?).to be_truthy
       expect(delta.script).to match_ruby erbh(<<-ERB)
-        change_column("employee_clubs", "club_id", :integer, <%= {:unsigned=>false, :null=>true, :default=>nil} + cond('>= 5.1', comment: nil) %>)
+        change_column("employee_clubs", "club_id", :integer, **<%= {:unsigned=>false, :null=>true, :default=>nil} + cond('>= 5.1', comment: nil) %>)
 
-        change_column("employees", "last_name", :string, <%= {:limit=>20, :default=>"XXX", :unsigned=>false} + cond('>= 5.1', comment: nil) %>)
-        change_column("employees", "gender", :string, <%= {:limit=>2, :null=>false, :default=>nil, :unsigned=>false} + cond('>= 5.1', comment: nil) %>)
+        change_column("employees", "last_name", :string, **<%= {:limit=>20, :default=>"XXX", :unsigned=>false} + cond('>= 5.1', comment: nil) %>)
+        change_column("employees", "gender", :string, **<%= {:limit=>2, :null=>false, :default=>nil, :unsigned=>false} + cond('>= 5.1', comment: nil) %>)
       ERB
     }