ridgepole 0.7.2 → 0.7.3.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40108f2b75644df8ce23f3d8a1aa0ee2107aa25c
-  data.tar.gz: fa253124674f5d34a96b0db3ba0e7594cbf42fdb
+  metadata.gz: 3d1090705cdbaf9295339b121d07f08efd6fdbc7
+  data.tar.gz: 781eb9b40326854690496a54e120e51fbf98b33d
 SHA512:
-  metadata.gz: 5a12b6e017baf87cca9aae8b817c503efa4dfffbcffc7b2ffc5ab9e96278bbbebe0d7f06d8af034da55a2dd20fae70d35a8d4ba4b70f327ae95f9690f564aff3
-  data.tar.gz: ac5e4ef666a799b883f87238a4b35cd48d47b8e04d67152205c3ce19392f425d98126de95274ee660cb474097421f85fcfe29f0df05c7b5c40f0e15448f1ba21
+  metadata.gz: 6b94add224450fbc51140fe4acf7e7ce34bb654dcc88c61fcf54edabd356d4e72bdd78ec5d8a13c0d7b893e39631a3395e1af31a5f946fa28d9508358caecf4f
+  data.tar.gz: f9bb43e119c95da180813260fe620e2b57bd8af2d7ae0fbebd64f80c1fb65ba94856b81f1d0fefa5c064e76c68a0eb7dd17ad6fb81c530a9c4cf4f04668bf87c

data/README.md

@@ -82,6 +82,8 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Add `--mysql-dump-auto-increment` option (`rails >= 5.1`)
 * `>= 0.7.2`
   * Support Rails 5.2
+* `>= 0.7.3`
+  * Add `--mysql-change-table-comment option` ([pull#166](https://github.com/winebarrel/ridgepole/pull/166))
 
 ## Installation
 
@@ -133,6 +135,7 @@ Usage: ridgepole [options]
         --index-removed-drop-column
         --skip-drop-table
         --mysql-change-table-options
+        --mysql-change-table-comment
         --check-relation-type DEF_PK
         --ignore-table-comment
         --skip-column-comment-change

data/bin/ridgepole

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 $: << File.expand_path('../../lib', __FILE__)
-require 'rubygems'
 require 'yaml'
 require 'optparse'
 require 'fileutils'
@@ -121,6 +120,7 @@ ARGV.options do |opt|
     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('',   '--mysql-change-table-comment')                 {    options[:mysql_change_table_comment] = true          }
     opt.on('',   '--check-relation-type DEF_PK')                 {|v| options[:check_relation_type] = v                    }
     opt.on('',   '--ignore-table-comment')                       {    options[:ignore_table_comment] = true                }
     opt.on('',   '--skip-column-comment-change')                 {    options[:skip_column_comment_change] = true          }
@@ -239,7 +239,7 @@ begin
     else
       logger.verbose_info('# Update schema')
 
-      differ, out = delta.migrate(
+      differ, _out = delta.migrate(
         :external_script => options[:external_script],
         :alter_extra => options[:alter_extra]
       )
@@ -249,17 +249,17 @@ begin
       logger.info('No change')
     end
   when :diff
-    diff_files = diff_files.map do |file|
-      if File.exist?(file)
-        file_ext = File.extname(file)
+    diff_files = diff_files.map do |diff_file|
+      if File.exist?(diff_file)
+        file_ext = File.extname(diff_file)
 
         if %w(.yml .yaml).include?(file_ext)
-          Ridgepole::Config.load(file, env)
+          Ridgepole::Config.load(diff_file, env)
         else
-          File.open(file)
+          File.open(diff_file)
         end
       else
-        YAML.load(file)
+        YAML.load(diff_file)
       end
     end
 
@@ -270,7 +270,7 @@ begin
       differ = delta.differ?
 
       if differ
-        differ, out = delta.migrate
+        differ, _out = delta.migrate
       end
 
       if differ

data/lib/ridgepole/delta.rb

@@ -288,12 +288,18 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
     buf.puts
   end
 
+  def append_change_table_comment(table_name, table_comment, buf)
+    comment_literal = "COMMENT=#{ActiveRecord::Base.connection.quote(table_comment)}"
+    append_change_table_options(table_name, comment_literal, buf)
+  end
+
   def append_change(table_name, attrs, buf, pre_buf_for_fk, post_buf_for_fk)
     definition = attrs[:definition] || {}
     primary_key_definition = attrs[:primary_key_definition] || {}
     indices = attrs[:indices] || {}
     foreign_keys = attrs[:foreign_keys] || {}
     table_options = attrs[:table_options]
+    table_comment = attrs[:table_comment]
 
     if not definition.empty? or not indices.empty? or not primary_key_definition.empty?
       append_change_table(table_name, buf) do
@@ -312,6 +318,10 @@ execute "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name
       append_change_table_options(table_name, table_options, buf)
     end
 
+    if table_comment
+      append_change_table_comment(table_name, table_comment, buf)
+    end
+
     buf.puts
     pre_buf_for_fk.puts
     post_buf_for_fk.puts

data/lib/ridgepole/diff.rb

@@ -1,5 +1,5 @@
 class Ridgepole::Diff
-  PRIMARY_KEY_OPTIONS = %i(id limit default null precision scale collation unsigned comment).freeze
+  PRIMARY_KEY_OPTIONS = %i(id limit default null precision scale collation unsigned).freeze
 
   def initialize(options = {})
     @options = options
@@ -117,10 +117,18 @@ class Ridgepole::Diff
       end
     end
 
-    if @options[:mysql_change_table_options] and from_options != to_options and Ridgepole::ConnectionAdapters.mysql?
-      from.delete(:options)
-      to.delete(:options)
-      table_delta[:table_options] = to_options
+    if Ridgepole::ConnectionAdapters.mysql?
+      if @options[:mysql_change_table_options] and from_options != to_options
+        from.delete(:options)
+        to.delete(:options)
+        table_delta[:table_options] = to_options
+      end
+
+      if @options[:mysql_change_table_comment] and from[:comment] != to[:comment]
+        from.delete(:comment)
+        to_comment = to.delete(:comment)
+        table_delta[:table_comment] = to_comment
+      end
     end
 
     if @options[:dump_without_table_options]

data/lib/ridgepole/version.rb

@@ -1,3 +1,3 @@
 module Ridgepole
-  VERSION = '0.7.2'
+  VERSION = '0.7.3.beta'
 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
+            --mysql-change-table-comment
             --check-relation-type DEF_PK
             --ignore-table-comment
             --skip-column-comment-change

data/spec/mysql/migrate/migrate_change_table_comment_spec.rb

@@ -0,0 +1,70 @@
+describe 'Ridgepole::Client#diff -> migrate' do
+  let(:actual_dsl) {
+    erbh(<<-EOS)
+      create_table "employees", force: :cascade, comment: "old comment" 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
+    EOS
+  }
+
+  let(:expected_dsl) {
+    erbh(<<-EOS)
+      create_table "employees", force: :cascade, comment: "new comment" 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
+    EOS
+  }
+
+  before { subject.diff(actual_dsl).migrate }
+
+  context 'when ignore_table_comment option is false' do
+    subject { client }
+
+    it {
+      expect(Ridgepole::Logger.instance).to receive(:warn).with(<<-EOS)
+[WARNING] No difference of schema configuration for table `employees` but table options differ.
+  from: {:comment=>"old comment"}
+    to: {:comment=>"new comment"}
+      EOS
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_falsey
+      expect(subject.dump).to match_ruby actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_ruby actual_dsl
+    }
+  end
+
+  context 'when ignore_table_comment option is true' do
+    subject { client(ignore_table_comment: true) }
+
+    it {
+      expect(Ridgepole::Logger.instance).to_not receive(:warn)
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_falsey
+      expect(subject.dump).to match_ruby actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_ruby actual_dsl
+    }
+  end
+
+  context 'when mysql_change_table_comment option is true' do
+    subject { client(mysql_change_table_comment: true) }
+
+    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_ruby actual_dsl
+      delta.migrate
+      expect(subject.dump).to match_ruby expected_dsl
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3.beta
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -303,6 +303,7 @@ files:
 - spec/mysql/migrate/migrate_change_index7_spec.rb
 - spec/mysql/migrate/migrate_change_index8_spec.rb
 - spec/mysql/migrate/migrate_change_index_spec.rb
+- spec/mysql/migrate/migrate_change_table_comment_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
@@ -402,9 +403,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13
@@ -457,6 +458,7 @@ test_files:
 - spec/mysql/migrate/migrate_change_index7_spec.rb
 - spec/mysql/migrate/migrate_change_index8_spec.rb
 - spec/mysql/migrate/migrate_change_index_spec.rb
+- spec/mysql/migrate/migrate_change_table_comment_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