ridgepole 0.6.3.beta2 → 0.6.3.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de78f0c1a68e3c21972a27b2181a42534920567
-  data.tar.gz: 81b644deea5beba444ad3f4dcd79d9e816a3398f
+  metadata.gz: d9dccc6fb46e2a4ce256f609bc34f20d26e7ee7f
+  data.tar.gz: eaeb693abd59b0b18b1af4c08b732a8cee33d3e9
 SHA512:
-  metadata.gz: fe51fa0e32f37492ab00ca349c6102d9e1db6e185c958ccbdca63375194f832ddb194f6d4c3280bf9f85e5de909d87c9b225b685afc0c793d66f096c3c103350
-  data.tar.gz: de8500f55d963d31cf18589dfe238fa1cc6e6b2a327c8707ed6faa2d04cdb8315138d2ef9503b2ed8b8c9e5ae1f7e0cb5ba092f8ebecd17abb3ad07d98fa7bfb
+  metadata.gz: 8a509d05ff9be9707428841a5e3de70547a306b4f2177c78e4af3cd6d314b5178f9f7179c504ede8aa19670f3fe78d0a7bafc781f795b4a0a0aea5d6a83c471c
+  data.tar.gz: 85818652ad578355c891b4d1fd74669a8506c6399ac02af8996d5f079df89387d3612f071bf37a5d1c05e2f5c237c40f1ff1609534ab99e4ad1e194e0252dd38

data/.travis.yml

@@ -8,8 +8,10 @@ script:
   - bundle exec rake
 env:
   matrix:
-    - ENABLE_MYSQL_AWESOME=0
-    - ENABLE_MYSQL_AWESOME=1
+    - ENABLE_MYSQL_AWESOME=0 ENABLE_MIGRATION_COMMENTS=0
+    - ENABLE_MYSQL_AWESOME=1 ENABLE_MIGRATION_COMMENTS=0
+    - ENABLE_MYSQL_AWESOME=0 ENABLE_MIGRATION_COMMENTS=1
+    - ENABLE_MYSQL_AWESOME=1 ENABLE_MIGRATION_COMMENTS=1
     - POSTGRESQL=1
 before_install:
   - sudo /etc/init.d/postgresql stop

data/README.md

@@ -40,6 +40,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Support [PostgreSQL columns](https://github.com/winebarrel/rails/blob/v4.2.1/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L79)
 * `>= 0.6.3`
   * Fix `default` option ([pull#48](https://github.com/winebarrel/ridgepole/pull/48))
+  * Add `--enable-migration-comments` option ([pull#50](https://github.com/winebarrel/ridgepole/pull/50))
 
 ## Installation
 
@@ -86,6 +87,7 @@ Usage: ridgepole [options]
         --enable-mysql-awesome
         --dump-without-table-options
         --index-removed-drop-column
+        --enable-migration-comments
     -r, --require LIBS
         --log-file LOG_FILE
         --verbose

data/bin/ridgepole

@@ -107,6 +107,7 @@ ARGV.options do |opt|
     opt.on('',   '--enable-mysql-awesome')        {    options[:enable_mysql_awesome] = true                }
     opt.on('',   '--dump-without-table-options')  {    options[:dump_without_table_options] = true          }
     opt.on('',   '--index-removed-drop-column')   {    options[:index_removed_drop_column] = true           }
+    opt.on('',   '--enable-migration-comments')   {    options[:enable_migration_comments] = 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                     }

data/lib/ridgepole/client.rb

@@ -14,7 +14,15 @@ class Ridgepole::Client
     @parser = Ridgepole::DSLParser.new(@options)
     @diff = Ridgepole::Diff.new(@options)
 
+    if @options[:enable_migration_comments]
+      require 'migration_comments'
+    end
+
     if @options[:enable_mysql_awesome]
+      if @options[:enable_migration_comments]
+        require 'ridgepole/ext/migration_comments'
+      end
+
       require 'activerecord/mysql/awesome/base'
     end
   end

data/lib/ridgepole/ext/migration_comments.rb

@@ -0,0 +1,37 @@
+require 'migration_comments/active_record/schema_dumper'
+
+module MigrationComments::ActiveRecord
+  module SchemaDumper
+    def append_comments(table, stream)
+      table_name = table.inspect.gsub('"', '')
+      column_comments = @connection.retrieve_column_comments(table_name)
+      comment_stream = StringIO.new
+      lines = []
+      col_names = {}
+
+      while (line = stream.gets)
+        content = line.chomp
+
+        if content =~ /t\.\w+\s+"(\w+)"/
+          col_names[lines.size] = $1.to_sym
+        end
+
+        lines << content
+      end
+
+      len = col_names.keys.map{|index| lines[index]}.map(&:length).max + 2 unless col_names.empty?
+
+      lines.each_with_index do |line, index|
+        if col_names[index]
+          comment = column_comments[col_names[index]]
+          line << ' ' * (len - line.length) << "# #{comment}" unless comment.blank?
+        end
+
+        comment_stream.puts line
+      end
+
+      comment_stream.rewind
+      comment_stream
+    end
+  end
+end

data/lib/ridgepole/version.rb

@@ -1,3 +1,3 @@
 module Ridgepole
-  VERSION = '0.6.3.beta2'
+  VERSION = '0.6.3.beta3'
 end

data/ridgepole.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'activerecord-mysql-awesome', '>= 0.0.7'
+  spec.add_development_dependency 'migration_comments'
 end

data/spec/mysql/0_comment/comment_mysql_awesome_spec.rb

@@ -0,0 +1,45 @@
+unless postgresql?
+if migration_comments_enabled?
+if mysql_awesome_enabled?
+describe 'Ridgepole::Client#diff -> migrate' do
+  context 'when change column (add comment)' do
+    let(:dsl) {
+      <<-RUBY
+        create_table "employee_clubs", unsigned: true, force: :cascade, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='テーブルコメント'" do |t|
+          t.integer "emp_no",  limit: 4,     null: false, unsigned: true
+          t.integer "club_id", limit: 4,     null: false
+          t.string  "string",  limit: 255,   null: false,                 collation: "utf8mb4_bin"  # カラムコメント
+          t.text    "text",    limit: 65535, null: false
+        end
+      RUBY
+    }
+
+    before do
+      subject.diff('').migrate
+
+      ActiveRecord::Base.connection.raw_connection.query(<<-EOS)
+        CREATE TABLE `employee_clubs` (
+          `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+          `emp_no` int(11) unsigned NOT NULL ,
+          `club_id` int(11) NOT NULL ,
+          `string` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL COMMENT 'カラムコメント',
+          `text` text NOT NULL,
+          PRIMARY KEY (`id`)
+        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='テーブルコメント';
+      EOS
+    end
+
+    subject do
+      client(enable_migration_comments: true, dump_without_table_options: false)
+    end
+
+    it {
+      delta = subject.diff(dsl)
+      expect(delta.differ?).to be_falsey
+      expect(subject.dump).to eq dsl.strip_heredoc.strip
+    }
+  end
+end
+end
+end
+end

data/spec/mysql/0_comment/comment_spec.rb

@@ -0,0 +1,183 @@
+unless postgresql?
+if migration_comments_enabled?
+unless mysql_awesome_enabled?
+describe 'Ridgepole::Client#diff -> migrate' do
+  context 'when change column (add comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false
+          t.integer "club_id", limit: 4,     null: false
+          t.string  "string",  limit: 255,   null: false
+          t.text    "text",    limit: 65535, null: false
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "any comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "any comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "any comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "any comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+      delta.migrate
+      expect(subject.dump).to eq expected_dsl.strip_heredoc.strip
+    }
+  end
+
+  context 'when change column (delete comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "any comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "any comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "any comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "any comment4"
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false
+          t.integer "club_id", limit: 4,     null: false
+          t.string  "string",  limit: 255,   null: false
+          t.text    "text",    limit: 65535, null: false
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+      delta.migrate
+      expect(subject.dump).to eq expected_dsl.strip_heredoc.strip
+    }
+  end
+
+  context 'when change column (change comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "any comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "any comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "any comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "any comment4"
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "other comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "other comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "other comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "other comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+      delta.migrate
+      expect(subject.dump).to eq expected_dsl.strip_heredoc.strip
+    }
+  end
+
+  context 'when change column (no change comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "any comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "any comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "any comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "any comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff(actual_dsl)
+      expect(delta.differ?).to be_falsey
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+      delta.migrate
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+    }
+  end
+
+  context 'when create table (with comment)' do
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade, comment: "table comment" do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "other comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "other comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "other comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "other comment4"
+        end
+      RUBY
+    }
+
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff(expected_dsl)
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump.strip).to be_empty
+      delta.migrate
+      expect(subject.dump).to eq expected_dsl.strip_heredoc.strip
+    }
+  end
+
+  context 'when drop table (with comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: :cascade, comment: "table comment" do |t|
+          t.integer "emp_no",  limit: 4,     null: false, comment: "other comment"
+          t.integer "club_id", limit: 4,     null: false, comment: "other comment2"
+          t.string  "string",  limit: 255,   null: false, comment: "other comment3"
+          t.text    "text",    limit: 65535, null: false, comment: "other comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(enable_migration_comments: true) }
+
+    it {
+      delta = subject.diff('')
+      expect(delta.differ?).to be_truthy
+      expect(subject.dump).to eq actual_dsl.strip_heredoc.strip
+      delta.migrate
+      expect(subject.dump).to be_empty
+    }
+  end
+end
+end
+end
+end

data/spec/mysql/cli/ridgepole_spec.rb

@@ -38,6 +38,7 @@ describe 'ridgepole' do
             --enable-mysql-awesome
             --dump-without-table-options
             --index-removed-drop-column
+            --enable-migration-comments
         -r, --require LIBS
             --log-file LOG_FILE
             --verbose

data/spec/postgresql/ridgepole_test_database.sql

@@ -1,7 +1,3 @@
-CREATE DATABASE ridgepole_test;
-
-\c ridgepole_test;
-
 CREATE EXTENSION hstore;
 CREATE EXTENSION ltree;
 CREATE EXTENSION citext;

data/spec/postgresql/ridgepole_test_tables.sql

@@ -1,5 +1,3 @@
-\c ridgepole_test;
-
 DROP TABLE IF EXISTS clubs;
 CREATE TABLE clubs (
   id serial PRIMARY KEY,

data/spec/spec_helper.rb

@@ -48,14 +48,21 @@ def restore_database
   end
 end
 
+def system_raise_on_fail(*args)
+  unless system(*args)
+    raise RuntimeError.new("Failed to run: #{args}")
+  end
+end
+
 def restore_database_mysql
   sql_file = File.expand_path('../mysql/ridgepole_test_database.sql', __FILE__)
-  system("mysql -uroot < #{sql_file}")
+  system_raise_on_fail("mysql -uroot < #{sql_file}")
 end
 
 def restore_database_postgresql
   sql_file = File.expand_path('../postgresql/ridgepole_test_database.sql', __FILE__)
-  system("psql #{travis? ? '-U postgres' : ''} --set ON_ERROR_STOP=off -q -f #{sql_file} 2>/dev/null")
+  system("createdb ridgepole_test #{travis? ? '-U postgres' : ''} 2>/dev/null")
+  system_raise_on_fail("psql ridgepole_test #{travis? ? '-U postgres' : ''} --set ON_ERROR_STOP=off -q -f #{sql_file} 2>/dev/null")
 end
 
 def restore_tables
@@ -68,12 +75,12 @@ end
 
 def restore_tables_mysql
   sql_file = File.expand_path('../mysql/ridgepole_test_tables.sql', __FILE__)
-  system("mysql -uroot < #{sql_file}")
+  system_raise_on_fail("mysql -uroot < #{sql_file}")
 end
 
 def restore_tables_postgresql
   sql_file = File.expand_path('../postgresql/ridgepole_test_tables.sql', __FILE__)
-  system("psql #{travis? ? '-U postgres' : ''} -q -f #{sql_file} 2>/dev/null")
+  system_raise_on_fail("psql ridgepole_test #{travis? ? '-U postgres' : ''} -q -f #{sql_file} 2>/dev/null")
 end
 
 def client(options = {}, config = {})
@@ -86,7 +93,6 @@ def client(options = {}, config = {})
   if mysql_awesome_enabled?
     default_options[:enable_mysql_awesome] = true
     default_options[:dump_without_table_options] = true
-    default_options[:mysql_awesome_unsigned_pk] = true
   end
 
   options = default_options.merge(options)
@@ -193,6 +199,10 @@ def mysql_awesome_enabled?
   ENV['ENABLE_MYSQL_AWESOME'] == '1'
 end
 
+def migration_comments_enabled?
+  ENV['ENABLE_MIGRATION_COMMENTS'] == '1'
+end
+
 def postgresql?
   ENV['POSTGRESQL'] == '1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.6.3.beta2
+  version: 0.6.3.beta3
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: migration_comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ridgepole is a tool to manage DB schema. It defines DB schema using Rails
   DSL, and updates DB schema according to DSL.
 email:
@@ -148,11 +162,14 @@ files:
 - lib/ridgepole/dsl_parser.rb
 - lib/ridgepole/dumper.rb
 - lib/ridgepole/execute_expander.rb
+- lib/ridgepole/ext/migration_comments.rb
 - lib/ridgepole/logger.rb
 - lib/ridgepole/migration_ext.rb
 - lib/ridgepole/schema_dumper_ext.rb
 - lib/ridgepole/version.rb
 - ridgepole.gemspec
+- spec/mysql/0_comment/comment_mysql_awesome_spec.rb
+- spec/mysql/0_comment/comment_spec.rb
 - spec/mysql/bigint_pk/bigint_pkspec.rb
 - spec/mysql/cli/config_spec.rb
 - spec/mysql/cli/ridgepole_spec.rb
@@ -256,6 +273,8 @@ signing_key:
 specification_version: 4
 summary: Ridgepole is a tool to manage DB schema.
 test_files:
+- spec/mysql/0_comment/comment_mysql_awesome_spec.rb
+- spec/mysql/0_comment/comment_spec.rb
 - spec/mysql/bigint_pk/bigint_pkspec.rb
 - spec/mysql/cli/config_spec.rb
 - spec/mysql/cli/ridgepole_spec.rb