ridgepole 0.7.3.beta → 0.7.3.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d1090705cdbaf9295339b121d07f08efd6fdbc7
-  data.tar.gz: 781eb9b40326854690496a54e120e51fbf98b33d
+  metadata.gz: acad17ac1fb19603bbf36ba03f17510ddd752db8
+  data.tar.gz: 93ccceda898278fb96684aaaa23bff4a6b1a0fb2
 SHA512:
-  metadata.gz: 6b94add224450fbc51140fe4acf7e7ce34bb654dcc88c61fcf54edabd356d4e72bdd78ec5d8a13c0d7b893e39631a3395e1af31a5f946fa28d9508358caecf4f
-  data.tar.gz: f9bb43e119c95da180813260fe620e2b57bd8af2d7ae0fbebd64f80c1fb65ba94856b81f1d0fefa5c064e76c68a0eb7dd17ad6fb81c530a9c4cf4f04668bf87c
+  metadata.gz: 4013ac5fff9afef7c70282b2b1a26543ec08832e30e8551b18f8ae9f3e019629d6143a8167084bc0556d2d116a4a2822b449af34fcc64e0a00480cc01ceeaadf
+  data.tar.gz: a081d8554675a28c9b55fefcb959d39d48c640ce768935b53eb0ccefdaff2a5e8b1eb84a3a1540ae4bde82c765af096dd17abb620412018f96b01c64247b3d46

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*'
+  TargetRubyVersion: 2.2
+Bundler/OrderedGems:
+  Include:
+    - 'Appraisals'
+Layout/IndentHeredoc:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/MethodMissingSuper:
+  Enabled: false
+Style/MixinUsage:
+  Exclude:
+    - 'spec/**/*'
+Layout/ClosingHeredocIndentation:
+  Enabled: false

data/Appraisals

@@ -1,6 +1,6 @@
 appraise 'activerecord-5.0' do
   gem 'activerecord', '~> 5.0.1'
-  gem "pg", "< 1.0.0"
+  gem 'pg', '< 1.0.0'
 end
 
 appraise 'activerecord-5.1' do
@@ -8,6 +8,6 @@ appraise 'activerecord-5.1' do
 end
 
 appraise 'activerecord-5.2' do
-  gem 'mysql2', '~> 0.4.4'
   gem 'activerecord', '~> 5.2.0'
+  gem 'mysql2', '~> 0.4.4'
 end

data/README.md

@@ -6,6 +6,7 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
 (like Chef/Puppet)
 
 [![Gem Version](https://badge.fury.io/rb/ridgepole.svg)](http://badge.fury.io/rb/ridgepole)
+[![Unstable Version](https://img.shields.io/badge/unstable-0.7.3.beta-green.svg?longCache=true&style=flat)](https://rubygems.org/gems/ridgepole/versions/0.7.3.beta)
 [![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)
 
@@ -84,6 +85,8 @@ It defines DB schema using [Rails DSL](http://guides.rubyonrails.org/migrations.
   * Support Rails 5.2
 * `>= 0.7.3`
   * Add `--mysql-change-table-comment option` ([pull#166](https://github.com/winebarrel/ridgepole/pull/166))
+  * Refactoring with RuboCop
+  * Support primary key dropping ([issue#246](https://github.com/winebarrel/ridgepole/issues/246))
 
 ## Installation
 
@@ -379,15 +382,6 @@ bundle exec appraisal activerecord-5.1 rake
 
 **Notice:** mysql-client/postgresql-client is required.
 
-### on OS X (docker-machine & VirtualBox)
-
-Port forwarding is required.
-
-```sh
-VBoxManage controlvm default natpf1 "mysql,tcp,127.0.0.1,3306,,3306"
-VBoxManage controlvm default natpf1 "psql,tcp,127.0.0.1,5432,,5432"
-```
-
 ## Demo
 
 * [asciinema.org/a/9349](https://asciinema.org/a/9349)

data/Rakefile

@@ -1,5 +1,11 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
-task :default => :spec
+
+RuboCop::RakeTask.new do |task|
+  task.options = %w[-c .rubocop.yml]
+end
+
+task default: %i[rubocop spec]

data/bin/ridgepole

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$: << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __dir__)
 require 'yaml'
 require 'optparse'
 require 'fileutils'
@@ -10,22 +10,22 @@ $stdout.sync = true
 $stderr.sync = true
 
 Version = Ridgepole::VERSION
-DEFAULT_FILENAME = 'Schemafile'
+DEFAULT_FILENAME = 'Schemafile'.freeze
 
-MAGIC_COMMENT = <<-EOS
+MAGIC_COMMENT = <<-RUBY.freeze
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
-EOS
+RUBY
 
 COLUMN_TYPES = {
-  :boolean => :bool,
-  :integer => :int,
-  :bigint  => :bigint,
-  :float   => :float,
-  :string  => :string,
-  :text    => :text,
-  :binary  => :binary,
-}
+  boolean: :bool,
+  integer: :int,
+  bigint: :bigint,
+  float: :float,
+  string: :string,
+  text: :text,
+  binary: :binary
+}.freeze
 
 config = nil
 env = 'development'
@@ -38,9 +38,9 @@ diff_with_apply = false
 exit_code = 0
 
 options = {
-  :dry_run => false,
-  :debug   => false,
-  :color   => $stdout.tty?,
+  dry_run: false,
+  debug: false,
+  color: $stdout.tty?
 }
 
 set_mode = proc do |m|
@@ -49,13 +49,11 @@ set_mode = proc do |m|
 end
 
 def noop_migrate(delta, options)
-  unless delta.script.empty?
-    puts delta.script + "\n\n"
-  end
+  puts delta.script + "\n\n" unless delta.script.empty?
 
   migrated, out = delta.migrate(
-    :noop => true,
-    :alter_extra => options[:alter_extra]
+    noop: true,
+    alter_extra: options[:alter_extra]
   )
 
   if migrated
@@ -63,99 +61,102 @@ def noop_migrate(delta, options)
       if line =~ /\A\s+/
         puts "# #{line}"
       else
-        puts line.strip.gsub(/([^\d])([(),])([^\d])/) { "#{$1}#{$2}\n#{$3}" }.each_line.map {|i| "# #{i.gsub(/^\s+/, '')}"}.join + "\n"
+        puts line.strip.gsub(/([^\d])([(),])([^\d])/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2)}\n#{Regexp.last_match(3)}" }.each_line.map { |i| "# #{i.gsub(/^\s+/, '')}" }.join + "\n"
       end
     end
   end
 
-  return migrated
+  migrated
 end
 
 ARGV.options do |opt|
   begin
-    opt.on('-c', '--config CONF_OR_FILE')         {|v| config = v                                           }
-    opt.on('-E', '--env ENVIRONMENT')             {|v| env = v                                              }
-    opt.on('-a', '--apply')                       {    set_mode[:apply]                                     }
-    opt.on('-m', '--merge')                       {    set_mode[:apply]; options[:merge] = true             }
-    opt.on('-f', '--file SCHEMAFILE')             {|v| file = v                                             }
-    opt.on('',   '--dry-run')                     {    options[:dry_run] = true                             }
-    opt.on('',   '--table-options OPTIONS')       {|v| options[:table_options] = v                          }
-    opt.on('',   '--alter-extra ALTER_SPEC')      {|v| options[:alter_extra] = v                            }
-    opt.on('',   '--external-script SCRIPT')      {|v| options[:external_script] = v                        }
-    opt.on('',   '--bulk-change') {
-      raise OptionParser::InvalidOption, "Cannot use `bulk-change` in `merge`" if options[:merge]
+    opt.on('-c', '--config CONF_OR_FILE') { |v| config = v }
+    opt.on('-E', '--env ENVIRONMENT') { |v| env = v }
+    opt.on('-a', '--apply') { set_mode[:apply] }
+    opt.on('-m', '--merge') do
+      set_mode[:apply]
+      options[:merge] = true
+    end
+    opt.on('-f', '--file SCHEMAFILE') { |v| file = v }
+    opt.on('',   '--dry-run') { options[:dry_run] = true }
+    opt.on('',   '--table-options OPTIONS') { |v| options[:table_options] = v }
+    opt.on('',   '--alter-extra ALTER_SPEC') { |v| options[:alter_extra] = v }
+    opt.on('',   '--external-script SCRIPT') { |v| options[:external_script] = v }
+    opt.on('',   '--bulk-change') do
+      raise OptionParser::InvalidOption, 'Cannot use `bulk-change` in `merge`' if options[:merge]
       options[:bulk_change] = true
-    }
+    end
 
     COLUMN_TYPES.each do |column_type, column_type_alias|
-      opt.on('', "--default-#{column_type_alias}-limit LIMIT", Integer) {|v|
+      opt.on('', "--default-#{column_type_alias}-limit LIMIT", Integer) do |v|
         options[:"default_#{column_type}_limit"] = v
-      }
+      end
     end
 
-    opt.on('',   '--pre-query QUERY')             {|v| options[:pre_query] = v                              }
-    opt.on('',   '--post-query QUERY')            {|v| options[:post_query] = v                             }
-    opt.on('-e', '--export')                      {    set_mode[:export]                                    }
-    opt.on('',   '--split')                       {|v| split = true                                         }
-    opt.on('',   '--split-with-dir')              {|v| split = :with_dir                                    }
-    opt.on('-d', '--diff DSL1 DSL2') {|diff_arg1|
+    opt.on('',   '--pre-query QUERY') { |v| options[:pre_query] = v }
+    opt.on('',   '--post-query QUERY') { |v| options[:post_query] = v }
+    opt.on('-e', '--export') { set_mode[:export] }
+    opt.on('',   '--split') { split = true }
+    opt.on('',   '--split-with-dir') { split = :with_dir }
+    opt.on('-d', '--diff DSL1 DSL2') do |diff_arg1|
       set_mode[:diff]
       diff_arg2 = ARGV.first
 
-      if [diff_arg1, diff_arg2].any? {|i| i.nil? or i =~ /\A-/ }
+      if [diff_arg1, diff_arg2].any? { |i| i.nil? || i.start_with?('-') }
         puts opt.help
         exit 1
       end
 
       ARGV.shift
       diff_files = [diff_arg1, diff_arg2]
-    }
-    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('',   '--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          }
-    opt.on('',   '--allow-pk-change')                            {    options[:allow_pk_change] = true                     }
-    opt.on('',   '--create-table-with-index')                    {    options[:create_table_with_index] = true             }
-
-    opt.on('',   '--mysql-dump-auto-increment') {
+    end
+    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('',   '--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 }
+    opt.on('',   '--allow-pk-change') { options[:allow_pk_change] = true }
+    opt.on('',   '--create-table-with-index') { options[:create_table_with_index] = true }
+
+    opt.on('',   '--mysql-dump-auto-increment') do
       if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('5.1')
         raise OptionParser::InvalidOption, '`mysql-dump-auto-increment` is not available in `activerecord < 5.1`'
       end
 
       options[:mysql_dump_auto_increment] = true
-    }
+    end
 
-    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('-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') {
+    opt.on('-v', '--version') do
       puts opt.ver
       exit
-    }
+    end
 
     opt.parse!
 
-    if not mode or ([:apply, :export].include?(mode) and not config) or  (options[:with_apply] and not config)
+    if !mode || (%i[apply export].include?(mode) && !config) || (options[:with_apply] && !config)
       puts opt.help
       exit 1
     end
-  rescue => e
-    $stderr.puts("[ERROR] #{e.message}")
+  rescue StandardError => e
+    warn("[ERROR] #{e.message}")
 
-    unless e.kind_of?(OptionParser::ParseError)
+    unless e.is_a?(OptionParser::ParseError)
       puts "\t" + e.backtrace.join("\n\t")
     end
 
@@ -165,7 +166,7 @@ end
 
 begin
   logger = Ridgepole::Logger.instance
-  logger.set_debug(options[:debug])
+  logger.debug = options[:debug]
 
   client = Ridgepole::Client.new(Ridgepole::Config.load(config, env), options) if config
 
@@ -192,7 +193,7 @@ begin
         logger.info("  write `#{schema_file}`")
         FileUtils.mkdir_p(schema_dir)
 
-        open(schema_file, 'wb') do |f|
+        File.open(schema_file, 'wb') do |f|
           f.puts MAGIC_COMMENT
           f.puts definition
         end
@@ -200,66 +201,58 @@ begin
 
       logger.info("  write `#{output_file}`")
 
-      open(output_file, 'wb') do |f|
+      File.open(output_file, 'wb') do |f|
         f.puts MAGIC_COMMENT
 
         requires.each do |require_path|
           f.puts "require '#{require_path}'"
         end
       end
+    elsif output_file == '-'
+      logger.info('# Export Schema')
+      puts client.dump
     else
-      if output_file == '-'
-        logger.info('# Export Schema')
-        puts client.dump
-      else
-        logger.info("Export Schema to `#{output_file}`")
-        open(output_file, 'wb') do |f|
-          f.puts MAGIC_COMMENT
-          f.puts client.dump
-        end
+      logger.info("Export Schema to `#{output_file}`")
+      File.open(output_file, 'wb') do |f|
+        f.puts MAGIC_COMMENT
+        f.puts client.dump
       end
     end
   when :apply
-    unless File.exist?(file)
-      raise "No Schemafile found (looking for: #{file})"
-    end
+    raise "No Schemafile found (looking for: #{file})" unless File.exist?(file)
 
     msg = (options[:merge] ? 'Merge' : 'Apply') + " `#{file}`"
     msg << ' (dry-run)' if options[:dry_run]
     logger.info(msg)
 
     dsl = File.read(file)
-    delta = client.diff(dsl, :path => file)
+    delta = client.diff(dsl, path: file)
     differ = delta.differ?
 
     if options[:dry_run]
-      if differ
-        differ = noop_migrate(delta, options)
-      end
+      differ = noop_migrate(delta, options) if differ
     else
       logger.verbose_info('# Update schema')
 
       differ, _out = delta.migrate(
-        :external_script => options[:external_script],
-        :alter_extra => options[:alter_extra]
+        external_script: options[:external_script],
+        alter_extra: options[:alter_extra]
       )
     end
 
-    unless differ
-      logger.info('No change')
-    end
+    logger.info('No change') unless differ
   when :diff
     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)
+        if %w[.yml .yaml].include?(file_ext)
           Ridgepole::Config.load(diff_file, env)
         else
           File.open(diff_file)
         end
       else
-        YAML.load(diff_file)
+        YAML.safe_load(diff_file, [], [], true)
       end
     end
 
@@ -269,23 +262,19 @@ begin
       logger.verbose_info('# Update schema')
       differ = delta.differ?
 
-      if differ
-        differ, _out = delta.migrate
-      end
+      differ, _out = delta.migrate if differ
 
-      if differ
-        logger.info('No change')
-      end
+      logger.info('No change') if differ
     elsif delta.differ?
       differ = noop_migrate(delta, options)
       exit_code = 1 if differ
     end
   end
-rescue => e
+rescue StandardError => e
   if options[:debug]
     raise e
   else
-    $stderr.puts("[ERROR] #{[e.message, e.backtrace.first].join("\n\t")}")
+    warn("[ERROR] #{[e.message, e.backtrace.first].join("\n\t")}")
     exit 1
   end
 end