ridgepole 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a86332195811295a61f945779cad2b09c6fd8b01df116e505f89995c576f978c
-  data.tar.gz: 491952fd6d83ffb361bbae4153b0fff3d216512948ed0f6b521e408375f898ab
+  metadata.gz: 8a09a114ad24ead5072a479593d757ea2dad1d0f42ebf9ae84febad36db8ba78
+  data.tar.gz: e4e14f15a869ac1b66cff3b869f4ca5d246975e4b62e4a8f5e8ecf040efe9d9c
 SHA512:
-  metadata.gz: e7868cb379bb0329e9efef9a5402c9ef5f369740aa4cd1ff68e80798582fbf32bdb6b15840e9866c0dff7aa3fe903aab8f7d7b07359137072face3c462407698
-  data.tar.gz: 94a72fd2146fbcdaa81c235916b3445c13d8eb3297b5c686c011938f6918d85383fb44b00513c52e96fca78b34b1a7b035558d03f36991e1cc0d277f9aa75ebe
+  metadata.gz: a664d190502ef67c91b9dc96f95cf4289812195939f8193354fea005de1bb83a31e479758dc0c64115dae02b6c7d62588fcd89f9129ebc2664c0bf8eef5906c1
+  data.tar.gz: ac81928fe43c71c13542686361af7d54868782728a1d02731f431827dba66204098baf6b2a674cf817b239f285b94b5e2edf48d842997e7cdf47b238234aac71

data/README.md

@@ -107,6 +107,8 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Support `postgres://` schema ([pull#285](https://github.com/winebarrel/ridgepole/pull/285))
 * `>= 0.8.3`
   * Fix "topological sort failed" error ([pull#287](https://github.com/winebarrel/ridgepole/pull/287))
+* `>= 0.8.4`
+  * Display a warning if an InnoDB table doesn't have any indexes on a column where it has a foreign key ([pull#290](https://github.com/winebarrel/ridgepole/pull/290))
 </details>
 
 ## Installation

data/lib/ridgepole/delta.rb

@@ -191,7 +191,7 @@ module Ridgepole
       errmsg = lines.with_index.map do |l, i|
         line_num = i + 1
         prefix = line_num == err_num ? '* ' : '  '
-        format("#{prefix}%*d: #{l}", digit_number, line_num)
+        format("#{prefix}%<line_num>#{digit_number}d: #{l}", line_num: line_num)
       end
 
       if err_num > 0

data/lib/ridgepole/diff.rb

@@ -565,10 +565,10 @@ module Ridgepole
           child_label = "#{child_table}.#{column_name}"
           label_len = [parent_label.length, child_label.length].max
 
-          @logger.warn(format(<<-MSG, label_len, parent_label, label_len, child_label))
+          @logger.warn(format(<<-MSG, parent_label: parent_label, child_label: child_label))
 [WARNING] Relation column type is different.
-  %*s: #{parent_column_info}
-  %*s: #{child_column_info}
+  %<parent_label>#{label_len}s: #{parent_column_info}
+  %<child_label>#{label_len}s: #{child_column_info}
         MSG
         end
       end

data/lib/ridgepole/dsl_parser.rb

@@ -8,22 +8,40 @@ module Ridgepole
 
     def parse(dsl, opts = {})
       definition, execute = Context.eval(dsl, opts)
-      check_orphan_index(definition)
-      check_orphan_foreign_key(definition)
+      check_definition(definition)
       [definition, execute]
     end
 
     private
 
-    def check_orphan_index(definition)
+    def check_definition(definition)
       definition.each do |table_name, attrs|
-        raise "Table `#{table_name}` to create the index is not defined: #{attrs[:indices].keys.join(',')}" if attrs[:indices] && !(attrs[:definition])
+        check_orphan_index(table_name, attrs)
+        check_orphan_foreign_key(table_name, attrs)
+        check_foreign_key_without_index(table_name, attrs)
       end
     end
 
-    def check_orphan_foreign_key(definition)
-      definition.each do |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])
+    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])
+    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])
+    end
+
+    def check_foreign_key_without_index(table_name, attrs)
+      return unless attrs[:foreign_keys]
+      return unless attrs[:options][:options]&.include?('ENGINE=InnoDB')
+
+      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 }
+
+        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
       end
     end
   end

data/lib/ridgepole/version.rb

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

data/spec/mysql/fk/migrate_create_fk_spec.rb

@@ -169,4 +169,57 @@ describe 'Ridgepole::Client#diff -> migrate' do
       end.to raise_error('Table `child` to create the foreign key is not defined: child_ibfk_1')
     }
   end
+
+  context 'when create fk without any indexes for its column' do
+    let(:dsl) do
+      erbh(<<-ERB)
+        create_table "parent", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+        end
+
+        create_table "child", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+          t.integer "parent_id"
+        end
+        add_foreign_key "child", "parent", name: "child_ibfk_1"
+      ERB
+    end
+
+    subject { client(dump_without_table_options: false) }
+
+    it {
+      expect(Ridgepole::Logger.instance).to receive(:warn).with(<<-MSG).twice
+[WARNING] Table `child` has a foreign key on `parent_id` 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
+      subject.diff(dsl).migrate
+
+      expect do
+        subject.diff(dsl).migrate
+      end.to raise_error(/Mysql2::Error: Cannot drop index/)
+    }
+  end
+
+  context 'when create fk with first key of multiple column indexes for its column' do
+    let(:dsl) do
+      erbh(<<-ERB)
+        create_table "parent", <%= i cond('>= 5.1',id: :integer) %>, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+        end
+
+        create_table "child", force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8" do |t|
+          t.integer "parent_id"
+          t.string "name"
+          t.index ["parent_id", "name"], name: "par_id", <%= i cond(5.0, using: :btree) %>
+        end
+        add_foreign_key "child", "parent", name: "child_ibfk_1"
+      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).migrate }.to_not raise_error
+    }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord