ridgepole 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f850327d50c5d732987209c8c8eb5c9db3090e1b638f2ee9dbc8ced0959b128
-  data.tar.gz: 242e925ebc5c1a94d0c68e605e894a55efab238f1184b67d1a6a56f4aee51078
+  metadata.gz: 367dff4faf9fd7e94588cdefe290cf13953cf82b9dc5110e91cfd5d4ee2507a3
+  data.tar.gz: 20ad65390cd7b12fe97e8fbae409aa5bc0d86a6c73c79a9916bfc55f46f03cb6
 SHA512:
-  metadata.gz: 0451a8c71155ff9fd991045e04973cdf063c405dc1013c63883db20ce11bad93ce4f7cdd0533d5ae12f4a9c35bbf03e18e04a6487ad217baf614a090837095d4
-  data.tar.gz: f4bb253e35a0f7904a0b17effd29a5e388449d4a295282f9f1652f1dd11f6d8a9c1df8dbd176efcf884cda5e15e15bf80db61b69bfd7f702ee43de2e0b70a186
+  metadata.gz: 94039eb4e75e2f0b218275ffec9b8a1b4c28ae5b9c93ad64b584793acbabc1ece9eb8ddde4e6d3097ffc6a9346ef36a6318334048d99c8e85050e0b9ef3088bd
+  data.tar.gz: 5e4837104ea5b6b69e42fdcc82e29b71a33835ce8371b959c16f3c00b014047a88b3c01ecba74ab8d6e591fd3357d15019a1dc41c425ff4c10b49fcec6bbdc48

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'gemfiles/**/*'
     - 'omnibus-ridgepole/**/*'
   TargetRubyVersion: 2.4
+  NewCops: enable
 Bundler/OrderedGems:
   Include:
     - 'Appraisals'
@@ -39,39 +40,13 @@ Layout/ClosingHeredocIndentation:
   Enabled: false
 Style/NumericPredicate:
   Enabled: false
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
 Lint/MissingSuper:
   Enabled: false
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Style/AccessorGrouping:
-  Enabled: true
-Style/BisectedAttrAccessor:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/RedundantAssignment:
-  Enabled: true
-Style/RedundantFetchBlock:
-  Enabled: true
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-Style/RedundantRegexpEscape:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true
+Style/StringConcatenation:
+  Enabled: false
+Style/SoleNestedConditional:
+  Enabled: false
+Lint/DuplicateBranch:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false

data/README.md

@@ -122,6 +122,9 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * 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

data/lib/ridgepole/dsl_parser.rb

@@ -37,7 +37,8 @@ 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 }
-        next if attrs[:options][:primary_key] == 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
 
         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

data/lib/ridgepole/dsl_parser/context.rb

@@ -27,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

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ridgepole
-  VERSION = '0.8.10'
+  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/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/mysql/collation/collation_spec.rb

@@ -141,7 +141,7 @@ describe 'Ridgepole::Client#diff -> migrate' do
           # 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('')
+            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

data/spec/mysql/fk/migrate_create_fk_spec.rb

@@ -239,3 +239,56 @@ describe 'Ridgepole::Client#diff -> migrate' do
     }
   end
 end
+
+context 'when create fk on the first primary key' do
+  let(:dsl) do
+    erbh(<<-ERB)
+      create_table "users", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+      end
+
+      create_table "employee", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+      end
+
+      create_table "icons", primary_key: ["user_id", "employee_id"], force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+        t.integer "user_id", null: false
+        t.integer "employee_id", null: false
+      end
+      add_foreign_key "icons", "users", name: "fk_icons_users"
+    ERB
+  end
+
+  subject { client(dump_without_table_options: false) }
+
+  it {
+    expect(Ridgepole::Logger.instance).to_not receive(:warn)
+    subject.diff(dsl).migrate
+
+    expect(subject.diff(dsl).differ?).to be_falsey
+  }
+end
+
+context 'when create fk on the second primary key' do
+  let(:dsl) do
+    erbh(<<-ERB)
+      create_table "users", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+      end
+
+      create_table "employee", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+      end
+
+      create_table "icons", primary_key: ["user_id", "employee_id"], force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+        t.integer "user_id", null: false
+        t.integer "employee_id", null: false
+      end
+      add_foreign_key "icons", "employees", name: "fk_icons_employees"
+    ERB
+  end
+
+  subject { client(dump_without_table_options: false) }
+
+  it {
+    expect do
+      subject.diff(dsl).migrate
+    end.to raise_error('The column `employee_id` of the table `icons` 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

data/spec/mysql/migrate/migrate_change_column3_spec.rb

@@ -310,4 +310,126 @@ describe 'Ridgepole::Client#diff -> migrate' do
       expect(subject.dump).to match_ruby expected_dsl
     }
   end
+
+  context 'when use references with fk (no change)' do
+    let(:actual_dsl) do
+      erbh(<<-ERB)
+        create_table "products", force: :cascade do |t|
+        end
+
+        create_table "user", force: :cascade do |t|
+        end
+
+        create_table "employees", primary_key: "emp_no", force: :cascade do |t|
+          t.date   "birth_date", null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name", limit: 16, null: false
+          t.string "gender", limit: 1, null: false
+          t.date   "hire_date", null: false
+          t.<%= cond('>= 5.1','bigint', 'integer') %> "products_id"
+          t.<%= cond('>= 5.1','bigint', 'integer') %> "user_id"
+          t.index "products_id"
+          t.index "user_id"
+        end
+
+        add_foreign_key("employees", "products", **{:column=>"products_id"})
+        add_foreign_key("employees", "user")
+      ERB
+    end
+
+    let(:expected_dsl) do
+      erbh(<<-ERB)
+        create_table "products", force: :cascade do |t|
+        end
+
+        create_table "user", force: :cascade do |t|
+        end
+
+        create_table "employees", primary_key: "emp_no", force: :cascade do |t|
+          t.date   "birth_date", null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name", limit: 16, null: false
+          t.string "gender", limit: 1, null: false
+          t.date   "hire_date", null: false
+          t.references :products, :user, foreign_key: true
+        end
+      ERB
+    end
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_falsey
+    }
+  end
+
+  context 'when use references with fk (change)' do
+    let(:actual_dsl) do
+      erbh(<<-ERB)
+        create_table "employees", primary_key: "emp_no", force: :cascade do |t|
+          t.date   "birth_date", null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name", limit: 16, null: false
+          t.string "gender", limit: 1, null: false
+          t.date   "hire_date", null: false
+        end
+        create_table "products", force: :cascade do |t|
+        end
+        create_table "user", force: :cascade do |t|
+        end
+      ERB
+    end
+
+    let(:dsl) do
+      erbh(<<-ERB)
+        create_table "employees", primary_key: "emp_no", force: :cascade do |t|
+          t.date   "birth_date", null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name", limit: 16, null: false
+          t.string "gender", limit: 1, null: false
+          t.date   "hire_date", null: false
+          t.references :products, :user, foreign_key: true
+        end
+        create_table "products", force: :cascade do |t|
+        end
+        create_table "user", force: :cascade do |t|
+        end
+      ERB
+    end
+
+    let(:expected_dsl) do
+      erbh(<<-ERB)
+        create_table "employees", primary_key: "emp_no", force: :cascade do |t|
+          t.date   "birth_date", null: false
+          t.string "first_name", limit: 14, null: false
+          t.string "last_name", limit: 16, null: false
+          t.string "gender", limit: 1, null: false
+          t.date   "hire_date", null: false
+          t.<%= cond('>= 5.1','bigint', 'integer') %> "products_id"
+          t.<%= cond('>= 5.1','bigint', 'integer') %> "user_id"
+          t.index ["products_id"], name: "index_employees_on_products_id", <%= i cond(5.0, using: :btree) %>
+          t.index ["user_id"], name: "index_employees_on_user_id", <%= i cond(5.0, using: :btree) %>
+        end
+        create_table "products", force: :cascade do |t|
+        end
+        create_table "user", force: :cascade do |t|
+        end
+        add_foreign_key("employees", "products", column: "products_id")
+        add_foreign_key("employees", "user")
+      ERB
+    end
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client }
+
+    it {
+      delta = subject.diff(dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to match_ruby actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_ruby expected_dsl
+    }
+  end
 end

data/spec/spec_condition.rb

@@ -19,6 +19,10 @@ module SpecCondition
     def debug?
       ENV['DEBUG'] == '1'
     end
+
+    def verbose?
+      ENV['VERBOSE'] == '1'
+    end
   end
 
   def check_version_or_cond(version_or_cond)

data/spec/spec_helper.rb

@@ -25,10 +25,11 @@ require 'erb_helper'
 
 RSpec.configure do |config|
   config.before(:all) do
-    if condition(:debug)
+    if condition(:debug) || condition(:verbose)
       ActiveRecord::Migration.verbose = true
       logger = Ridgepole::Logger.instance
       logger.level = ::Logger::DEBUG
+      logger.verbose = condition(:verbose)
       ActiveRecord::Base.logger = logger
     else
       ActiveRecord::Migration.verbose = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - Genki Sugawara
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -429,7 +429,7 @@ homepage: https://github.com/winebarrel/ridgepole
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -444,8 +444,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ridgepole is a tool to manage DB schema.
 test_files: