ridgepole 0.7.0.beta7 → 0.7.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3d9d5631f7b5f23b80eab12746ba43042bbf7c9
-  data.tar.gz: 8694a5b48a72f4b0e20ad78d50b18fc2ff150c25
+  metadata.gz: 6379a32db8dc48969ccf8c184534eccdea98fdd0
+  data.tar.gz: efbb7beeb7656df70ed62a102585f7ef2bbe17d7
 SHA512:
-  metadata.gz: 0c95e9f942e81fd62e1c437e9a1501fb0bd95c4849c8deb0208d100c1cb3a0d326b4c2ee9d11838b58a63817413873727cb043be3195fe5c964bd2f7b007ca4a
-  data.tar.gz: f8f021d5b87e6183438885afc1f6e5a274f5e57ec336b9dd2f2b7fbafdfba278c57cad6b630114e24347fd04a27c2224ecaf0c5b45f6b2d9741e48aaa8f9fbb6
+  metadata.gz: 0dfbe2a44db029662943ad2f447e4d72a26f9d970807336f0cce0806cf1758337e1f65587cd9ba0b7496887e87ebcd82d0a42cec842fd2443e90bb5b8c4cf63b
+  data.tar.gz: 4ba605415d1d48c00eb462f9dc6573c1ee131c456eb9cc215f471604b401f11972a4023ee6c14664a2c23a21a274c6b466c9e78564092cc63e034225f2ba54bb

data/README.md

@@ -9,7 +9,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 [![Build Status](https://travis-ci.org/winebarrel/ridgepole.svg?branch=0.6)](https://travis-ci.org/winebarrel/ridgepole)
 [![Coverage Status](https://coveralls.io/repos/github/winebarrel/ridgepole/badge.svg?branch=0.6)](https://coveralls.io/github/winebarrel/ridgepole?branch=0.6)
 
-[![Edge Version](https://img.shields.io/badge/edge_version-0.7.0.beta7-brightgreen.svg)](https://rubygems.org/gems/ridgepole/versions/0.7.0.beta7)
+[![Edge Version](https://img.shields.io/badge/edge_version-0.7.0.beta8-brightgreen.svg)](https://rubygems.org/gems/ridgepole/versions/0.7.0.beta8)
 [![Build Status](https://travis-ci.org/winebarrel/ridgepole.svg?branch=0.7)](https://travis-ci.org/winebarrel/ridgepole)
 [![Coverage Status](https://coveralls.io/repos/github/winebarrel/ridgepole/badge.svg?branch=0.7)](https://coveralls.io/github/winebarrel/ridgepole?branch=0.7)
 
@@ -75,6 +75,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Add `--mysql-change-table-options` option
   * Pass config from env
   * Fix change fk order
+  * Add `--check-relation-type` option
 
 ## Installation
 
@@ -126,6 +127,7 @@ Usage: ridgepole [options]
         --index-removed-drop-column
         --skip-drop-table
         --mysql-change-table-options
+        --check-relation-type DEF_PK
     -r, --require LIBS
         --log-file LOG_FILE
         --verbose
@@ -350,6 +352,31 @@ Apply `Schemafile`
    -> 0.0243s
 ```
 
+## Relation column type check
+
+```ruby
+create_table "employees", force: :cascade do |t|
+  t.integer "emp_no", null: false
+  t.string  "first_name", limit: 14, null: false
+  t.string  "last_name", limit: 16, null: false
+end
+
+create_table "dept_manager", force: :cascade do |t|
+  t.integer "employee_id"
+  t.string  "dept_no", limit: 4, null: false
+end
+```
+
+```sh
+$ ridgepole -a -c database.yml --check-relation-type bigint # default primary key type (e.g. `<5.1`: integer, `>=5.1`: bigint for MySQL)
+Apply `Schemafile`
+...
+[WARNING] Relation column type is different.
+              employees.id: bigint
+  dept_manager.employee_id: integer
+...
+```
+
 ## Running tests
 
 ```sh

data/bin/ridgepole

@@ -110,22 +110,23 @@ ARGV.options do |opt|
       ARGV.shift
       diff_files = [diff_arg1, diff_arg2]
     }
-    opt.on('',   '--reverse')                         {    options[:reverse] = true                             }
-    opt.on('',   '--with-apply')                      {    diff_with_apply = true                               }
-    opt.on('-o', '--output SCHEMAFILE')               {|v| output_file = v                                      }
-    opt.on('-t', '--tables TABLES', Array)            {|v| options[:tables] = v                                 }
-    opt.on('',   '--ignore-tables REGEX_LIST', Array) {|v| options[:ignore_tables] = v.map {|i| Regexp.new(i) } }
-    opt.on('',   '--mysql-use-alter')                 {    options[:mysql_use_alter] = true                     }
-    opt.on('',   '--dump-without-table-options')      {    options[:dump_without_table_options] = true          }
-    opt.on('',   '--dump-with-default-fk-name')       {    options[:dump_with_default_fk_name] = true           }
-    opt.on('',   '--index-removed-drop-column')       {    options[:index_removed_drop_column] = true           }
-    opt.on('',   '--skip-drop-table')                 {    options[:skip_drop_table] = true                     }
-    opt.on('',   '--mysql-change-table-options')      {    options[:mysql_change_table_options] = true          }
-    opt.on('-r', '--require LIBS', Array)             {|v| v.each {|i| require i }                              }
-    opt.on(''  , '--log-file LOG_FILE')               {|v| options[:log_file] = v                               }
-    opt.on(''  , '--verbose')                         {    Ridgepole::Logger.verbose = true                     }
-    opt.on(''  , '--debug')                           {    options[:debug] = true                               }
-    opt.on(''  , '--[no-]color')                      {|v| options[:color] = v                                  }
+    opt.on('',   '--reverse')                                    {    options[:reverse] = true                             }
+    opt.on('',   '--with-apply')                                 {    diff_with_apply = true                               }
+    opt.on('-o', '--output SCHEMAFILE')                          {|v| output_file = v                                      }
+    opt.on('-t', '--tables TABLES', Array)                       {|v| options[:tables] = v                                 }
+    opt.on('',   '--ignore-tables REGEX_LIST', Array)            {|v| options[:ignore_tables] = v.map {|i| Regexp.new(i) } }
+    opt.on('',   '--mysql-use-alter')                            {    options[:mysql_use_alter] = true                     }
+    opt.on('',   '--dump-without-table-options')                 {    options[:dump_without_table_options] = true          }
+    opt.on('',   '--dump-with-default-fk-name')                  {    options[:dump_with_default_fk_name] = true           }
+    opt.on('',   '--index-removed-drop-column')                  {    options[:index_removed_drop_column] = true           }
+    opt.on('',   '--skip-drop-table')                            {    options[:skip_drop_table] = true                     }
+    opt.on('',   '--mysql-change-table-options')                 {    options[:mysql_change_table_options] = true          }
+    opt.on('',   '--check-relation-type DEF_PK')                 {|v| options[:check_relation_type] = v                    }
+    opt.on('-r', '--require LIBS', Array)                        {|v| v.each {|i| require i }                              }
+    opt.on(''  , '--log-file LOG_FILE')                          {|v| options[:log_file] = v                               }
+    opt.on(''  , '--verbose')                                    {    Ridgepole::Logger.verbose = true                     }
+    opt.on(''  , '--debug')                                      {    options[:debug] = true                               }
+    opt.on(''  , '--[no-]color')                                 {|v| options[:color] = v                                  }
 
     opt.on('-v', '--version') {
       puts opt.ver

data/lib/ridgepole/diff.rb

@@ -13,11 +13,15 @@ class Ridgepole::Diff
     end
 
     delta = {}
+    relation_info = {}
+
     scan_table_rename(from, to, delta)
     # for reverse option
     scan_table_rename(to, from, delta)
 
     to.each do |table_name, to_attrs|
+      collect_relation_info!(table_name, to_attrs, relation_info)
+
       next unless target?(table_name)
 
       if (from_attrs = from.delete(table_name))
@@ -34,6 +38,8 @@ class Ridgepole::Diff
       end
     end
 
+    scan_relation_info(relation_info)
+
     unless @options[:merge] or @options[:skip_drop_table]
       from.each do |table_name, from_attrs|
         next unless target?(table_name)
@@ -419,4 +425,63 @@ class Ridgepole::Diff
     diffy.to_s(@options[:color] ? :color : :text).gsub(/\s+\z/m, '')
   end
 
+  def collect_relation_info!(table_name, table_attr, relation_info)
+    return unless @options[:check_relation_type]
+
+    attrs_by_column = {}
+    definition = table_attr[:definition] || {}
+
+    definition.each do |column_name, column_attrs|
+      if column_name =~ /\w+_id\z/
+        attrs_by_column[column_name] = column_attrs.dup
+      end
+    end
+
+    relation_info[table_name] = {
+      :options => table_attr[:options] || {},
+      :columns => attrs_by_column,
+    }
+  end
+
+  def scan_relation_info(relation_info)
+    return unless @options[:check_relation_type]
+
+    relation_info.each do |child_table, table_info|
+      next unless target?(child_table)
+
+      attrs_by_column = table_info.fetch(:columns)
+      parent_table_info = nil
+
+      attrs_by_column.each do |column_name, column_attrs|
+        parent_table = column_name.sub(/_id\z/, '')
+
+        [parent_table.pluralize, parent_table.singularize].each do |table_name|
+          parent_table_info = relation_info[table_name]
+
+          if parent_table_info
+            parent_table = table_name
+            break
+          end
+        end
+
+        next unless parent_table_info
+
+        table_options = parent_table_info.fetch(:options)
+        pk_type = table_options[:id] || @options[:check_relation_type].to_sym
+        child_column_type = column_attrs[:type]
+
+        if pk_type != child_column_type
+          parent_label = "#{parent_table}.id"
+          child_label = "#{child_table}.#{column_name}"
+          label_len = [parent_label.length, child_label.length].max
+
+          @logger.warn(<<-EOS % [label_len, parent_label, label_len, child_label])
+[WARNING] Relation column type is different.
+  %*s: #{pk_type}
+  %*s: #{child_column_type}
+          EOS
+        end
+      end
+    end
+  end
 end

data/lib/ridgepole/version.rb

@@ -1,3 +1,3 @@
 module Ridgepole
-  VERSION = '0.7.0.beta7'
+  VERSION = '0.7.0.beta8'
 end

data/spec/mysql/cli/ridgepole_spec.rb

@@ -46,6 +46,7 @@ describe 'ridgepole' do
             --index-removed-drop-column
             --skip-drop-table
             --mysql-change-table-options
+            --check-relation-type DEF_PK
         -r, --require LIBS
             --log-file LOG_FILE
             --verbose

data/spec/mysql/migrate/migrate_check_relation_column_type_spec.rb

@@ -0,0 +1,112 @@
+describe 'Ridgepole::Client#diff -> migrate', 5.1 do
+  context 'with warning' do
+    let(:actual_dsl) {
+      erbh(<<-EOS)
+        create_table "dept_manager", force: :cascade do |t|
+          t.string  "dept_no", limit: 4, null: false
+          t.date    "from_date", null: false
+          t.date    "to_date", null: false
+        end
+
+        create_table "employees", force: :cascade do |t|
+          t.integer "emp_no", null: false
+          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
+      EOS
+    }
+
+    let(:expected_dsl) {
+      erbh(<<-EOS)
+        create_table "dept_manager", force: :cascade do |t|
+          t.integer "employee_id"
+          t.string  "dept_no", limit: 4, null: false
+          t.date    "from_date", null: false
+          t.date    "to_date", null: false
+        end
+
+        create_table "employees", force: :cascade do |t|
+          t.integer "emp_no", null: false
+          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
+      EOS
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(check_relation_type: 'bigint') }
+
+    it {
+      expect(Ridgepole::Logger.instance).to receive(:warn).with(<<-EOS)
+[WARNING] Relation column type is different.
+              employees.id: bigint
+  dept_manager.employee_id: integer
+      EOS
+
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to match_fuzzy actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_fuzzy expected_dsl
+    }
+  end
+
+  context 'without warning' do
+    let(:actual_dsl) {
+      erbh(<<-EOS)
+        create_table "dept_manager", force: :cascade do |t|
+          t.string  "dept_no", limit: 4, null: false
+          t.date    "from_date", null: false
+          t.date    "to_date", null: false
+        end
+
+        create_table "employees", force: :cascade do |t|
+          t.integer "emp_no", null: false
+          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
+      EOS
+    }
+
+    let(:expected_dsl) {
+      erbh(<<-EOS)
+        create_table "dept_manager", force: :cascade do |t|
+          t.bigint "employee_id"
+          t.string  "dept_no", limit: 4, null: false
+          t.date    "from_date", null: false
+          t.date    "to_date", null: false
+        end
+
+        create_table "employees", force: :cascade do |t|
+          t.integer "emp_no", null: false
+          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
+      EOS
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(check_relation_type: 'bigint') }
+
+    it {
+      expect(Ridgepole::Logger.instance).to_not receive(:warn)
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to match_fuzzy actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_fuzzy expected_dsl
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.7.0.beta7
+  version: 0.7.0.beta8
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -284,6 +284,7 @@ files:
 - spec/mysql/migrate/migrate_change_index7_spec.rb
 - spec/mysql/migrate/migrate_change_index_spec.rb
 - spec/mysql/migrate/migrate_change_table_option_spec.rb
+- spec/mysql/migrate/migrate_check_relation_column_type_spec.rb
 - spec/mysql/migrate/migrate_create_index2_spec.rb
 - spec/mysql/migrate/migrate_create_index_spec.rb
 - spec/mysql/migrate/migrate_create_table_spec.rb
@@ -425,6 +426,7 @@ test_files:
 - spec/mysql/migrate/migrate_change_index7_spec.rb
 - spec/mysql/migrate/migrate_change_index_spec.rb
 - spec/mysql/migrate/migrate_change_table_option_spec.rb
+- spec/mysql/migrate/migrate_check_relation_column_type_spec.rb
 - spec/mysql/migrate/migrate_create_index2_spec.rb
 - spec/mysql/migrate/migrate_create_index_spec.rb
 - spec/mysql/migrate/migrate_create_table_spec.rb