ridgepole 0.5.0 → 0.5.1.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0e5d99302d1d99724e9f053f8828e443e43830c
-  data.tar.gz: 2d23f1457802a52374e3c78aeabf56ab9d09b45f
+  metadata.gz: d48638146f584f343ed700c0e4fec7858e01dc4a
+  data.tar.gz: 259755ac2ee554776cf3a61683b1d5bf4e7084db
 SHA512:
-  metadata.gz: 4ed2764b3cdf2353fd7ce49036f40d2d667f9482a0d833c2eb824b68ecd6450552e1c55a83a8c74b4358514cd315cb8212cdc107e72f43902d9b8e8c2c9e8967
-  data.tar.gz: be1c4d45dde55c8030e6a025e6fc6a55a7934e549bac99b56dc0d1613a279ff306ed26cf402e78024aca194a34516818f5211aed93a0e65aceb801eea6488edc
+  metadata.gz: a73c8a63182aa7aa14ffc301d59b7ed610ce6450b3f380f4fdec980f3b3c0d32ff9cc93a5a5c0d130b06d47027c6b349ed239fd9483a546c037835274b135797
+  data.tar.gz: f2f7aed9e476a65789f9421b51cb7861d89ee3b75c6e0284d5b9f17f2cdce1d1c7516689077fded3f275c3ad72a624c0ab2f22b20abf0376e52ca45ec4c96d8c

data/README.md

@@ -20,6 +20,8 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Fix `activerecord-mysql-unsigned` version: `~> 0.2.0`
 * `>= 0.5.0`
   * Fix `activerecord-mysql-unsigned` version: `~> 0.3.1`
+* `>= 0.5.1`
+  * Add `--enable-migration-comments` option ([migration_comments](https://github.com/pinnymz/migration_comments) is required)
 
 ## Installation
 
@@ -61,6 +63,7 @@ Usage: ridgepole [options]
         --enable-mysql-unsigned
         --enable-mysql-pkdump
         --enable-foreigner
+        --enable-migration-comments
         --log-file LOG_FILE
         --verbose
         --debug
@@ -160,6 +163,18 @@ add_index "child", ["parent_id"], name: "par_ind", using: :btree
 add_foreign_key "child", "parent", name: "child_ibfk_1", dependent: :delete
 ```
 
+## Comment
+You can use the table/column comment by passing `--enable-migration-comments` ([migration_comments](https://github.com/pinnymz/migration_comments) is required)
+
+```ruby
+create_table "articles", force: true, comment: "table comment" do |t|
+  t.string   "title", comment: "column comment"
+  t.text     "text"
+  t.datetime "created_at"
+  t.datetime "updated_at"
+end
+```
+
 ## bigint support
 Export of `bigint` PK is enabled by passing `--enable-mysql-pkdump` ([activerecord-mysql-pkdump](https://github.com/winebarrel/activerecord-mysql-pkdump) is required)
 

data/bin/ridgepole

@@ -94,6 +94,7 @@ ARGV.options do |opt|
     opt.on('',   '--enable-mysql-unsigned')       {    options[:enable_mysql_unsigned] = true               }
     opt.on('',   '--enable-mysql-pkdump')         {    options[:enable_mysql_pkdump] = true                 }
     opt.on('',   '--enable-foreigner')            {    options[:enable_foreigner] = true                    }
+    opt.on('',   '--enable-migration-comments')   {    options[:migration_comments] = true                  }
     opt.on(''  , '--log-file LOG_FILE')           {|v| options[:log_file] = v                               }
     opt.on(''  , '--verbose')                     {    Ridgepole::Logger.verbose = true                     }
     opt.on(''  , '--debug')                       {    options[:debug] = true                               }

data/lib/ridgepole/client.rb

@@ -15,6 +15,10 @@ class Ridgepole::Client
       require 'activerecord-mysql-pkdump'
     end
 
+    if @options[:migration_comments]
+      require 'migration_comments'
+    end
+
     if @options[:enable_foreigner]
       Ridgepole::ForeignKey.init
     end

data/lib/ridgepole/version.rb

@@ -1,3 +1,3 @@
 module Ridgepole
-  VERSION = '0.5.0'
+  VERSION = '0.5.1.beta'
 end

data/ridgepole.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'activerecord-mysql-unsigned', '~> 0.3.1'
   spec.add_development_dependency 'foreigner'
   spec.add_development_dependency 'activerecord-mysql-pkdump', '>= 0.1.0'
+  spec.add_development_dependency 'migration_comments'
 end

data/spec/cli/ridgepole_spec.rb

@@ -32,6 +32,7 @@ describe 'ridgepole' do
             --enable-mysql-unsigned
             --enable-mysql-pkdump
             --enable-foreigner
+            --enable-migration-comments
             --log-file LOG_FILE
             --verbose
             --debug

data/spec/comment/comment_spec.rb

@@ -0,0 +1,177 @@
+describe 'Ridgepole::Client#diff -> migrate' do
+  context 'when change column (add comment)' do
+    let(:actual_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: true do |t|
+          t.integer "emp_no",  null: false
+          t.integer "club_id", null: false, unsigned: true
+          t.string  "string",  null: false
+          t.text    "text",    null: false
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: true do |t|
+          t.integer "emp_no",  null: false,                 comment: "any comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "any comment2"
+          t.string  "string",  null: false,                 comment: "any comment3"
+          t.text    "text",    null: false,                 comment: "any comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(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: true do |t|
+          t.integer "emp_no",  null: false,                 comment: "any comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "any comment2"
+          t.string  "string",  null: false,                 comment: "any comment3"
+          t.text    "text",    null: false,                 comment: "any comment4"
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: true do |t|
+          t.integer "emp_no",  null: false
+          t.integer "club_id", null: false, unsigned: true
+          t.string  "string",  null: false
+          t.text    "text",    null: false
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(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: true do |t|
+          t.integer "emp_no",  null: false,                 comment: "any comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "any comment2"
+          t.string  "string",  null: false,                 comment: "any comment3"
+          t.text    "text",    null: false,                 comment: "any comment4"
+        end
+      RUBY
+    }
+
+    let(:expected_dsl) {
+      <<-RUBY
+        create_table "employee_clubs", force: true do |t|
+          t.integer "emp_no",  null: false,                 comment: "other comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "other comment2"
+          t.string  "string",  null: false,                 comment: "other comment3"
+          t.text    "text",    null: false,                 comment: "other comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(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: true do |t|
+          t.integer "emp_no",  null: false,                 comment: "any comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "any comment2"
+          t.string  "string",  null: false,                 comment: "any comment3"
+          t.text    "text",    null: false,                 comment: "any comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(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: true, comment: "table comment" do |t|
+          t.integer "emp_no",  null: false,                 comment: "other comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "other comment2"
+          t.string  "string",  null: false,                 comment: "other comment3"
+          t.text    "text",    null: false,                 comment: "other comment4"
+        end
+      RUBY
+    }
+
+    subject { client(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: true, comment: "table comment" do |t|
+          t.integer "emp_no",  null: false,                 comment: "other comment"
+          t.integer "club_id", null: false, unsigned: true, comment: "other comment2"
+          t.string  "string",  null: false,                 comment: "other comment3"
+          t.text    "text",    null: false,                 comment: "other comment4"
+        end
+      RUBY
+    }
+
+    before { subject.diff(actual_dsl).migrate }
+    subject { client(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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridgepole
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1.beta
 platform: ruby
 authors:
 - Genki Sugawara
@@ -136,6 +136,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !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:
@@ -170,6 +184,7 @@ files:
 - spec/0_diff/dump_disable_unsigned_spec.rb
 - spec/cli/config_spec.rb
 - spec/cli/ridgepole_spec.rb
+- spec/comment/comment_spec.rb
 - spec/diff/diff_spec.rb
 - spec/dump/dump_class_method_spec.rb
 - spec/dump/dump_some_tables_spec.rb
@@ -233,9 +248,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
@@ -246,6 +261,7 @@ test_files:
 - spec/0_diff/dump_disable_unsigned_spec.rb
 - spec/cli/config_spec.rb
 - spec/cli/ridgepole_spec.rb
+- spec/comment/comment_spec.rb
 - spec/diff/diff_spec.rb
 - spec/dump/dump_class_method_spec.rb
 - spec/dump/dump_some_tables_spec.rb