convergence 0.2.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef1510b43ccf48e6a03e2fd52d2db4bde278b310
-  data.tar.gz: fc57a20928217ecdd52231365a9dbd76366e26ac
+  metadata.gz: c26bf3742a050cf1c1f19c5077900c5399eab4ed
+  data.tar.gz: f956e136b15aa7da59b076876130397a5541f2a8
 SHA512:
-  metadata.gz: 9a83c88ec1b880cc029fa3ce993b907f51dc4e8987274a0a2d2fac2a1cef0ee1f5accf0d89f4ee603521a13863ae7a4b51e27671ea426887c8a590011054e55d
-  data.tar.gz: a8e5a9ce6069bfb6285dd5855c4c8082c35989c4c537cbb9a5791eadabd5209b2161c93d7126ae6e514ed573e6a141132c434b8e8a785c5293a36e0274cebef2
+  metadata.gz: 69b9bf97488d41d38c77653cf670cd1d8dd83462e275609fb4b08d808def10802e23f7bb12666229cde592faf127503c2cd88f136c990614ce4b2d860b69436a
+  data.tar.gz: 760af609f15854528884f4861d44bad95a6c4e3038e82b489c69ebb081a5b9714a4615909180648019ed36325a7a5364b448ca54758cfc76137b2f92d49cd53f

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Convergence 1.0.0 (August 28, 2018) ##
+
+* [BREAKING CHANGE] Change flag style command to sub-command style (PR: #60)
+
+  A flag style command has been deprecated
+
+      e.g. convergence -c database.yml -i example.schema --apply
+
+  Introduce a sub command style.
+
+      e.g. convergence apply example.schema -c database.yml
+
+  *yujideveloper*
+
 ## Convergence 0.2.7 (August 20, 2018) ##
 
 * Fix issues of Convergence::Config (PR: #58)

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    convergence (0.2.7)
+    convergence (1.0.0)
       diff-lcs
       diffy
       mysql2
-      slop (~> 3.6)
+      thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
@@ -77,7 +77,6 @@ GEM
     ruby-progressbar (1.9.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    slop (3.6.0)
     thor (0.20.0)
     unicode-display_width (1.3.0)
 
@@ -91,8 +90,8 @@ DEPENDENCIES
   guard-rspec
   pry
   rake (~> 10.0)
-  rspec
+  rspec (>= 3.5)
   rubocop
 
 BUNDLED WITH
-   1.16.1
+   1.16.3

data/README.md

@@ -53,7 +53,7 @@ create_table 'test_tables' do |t|
   t.index :name
 end
 
-$ convergence -c database.yml -i example.schema --dryrun
+$ convergence apply example.schema -c database.yml --dry-run
 
 # CREATE TABLE `test_tables` (
 #   `id` int(11) NOT NULL AUTO_INCREMENT,
@@ -64,7 +64,7 @@ $ convergence -c database.yml -i example.schema --dryrun
 #   KEY `index_test_tables_on_name` (`name`)
 # ) ENGINE=InnoDB ROW_FORMAT=Compact DEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci;
 
-$ convergence -c database.yml -i example.schema --apply
+$ convergence apply example.schema -c database.yml
 
 SET FOREIGN_KEY_CHECKS=0;
   --> 0.0005826340056955814s
@@ -89,7 +89,7 @@ create_table 'test_tables', comment: 'Table Comment Test', engine: 'MyISAM' do |
   t.datetime :posted_at
 end
 
-$ convergence -c database.yml -i changed_example.schema  --dryrun
+$ convergence apply changed_example.schema -c database.yml --dry-run
 
 # DROP INDEX `index_test_tables_on_name` ON `test_tables`;
 # ALTER TABLE `test_tables`
@@ -98,7 +98,7 @@ $ convergence -c database.yml -i changed_example.schema  --dryrun
 #   ADD COLUMN `posted_at` datetime NOT NULL AFTER `created_at`;
 # ALTER TABLE `test_tables` ENGINE=MyISAM COMMENT='Table Comment Test';
 
-$ convergence -c database.yml -i changed_example.schema  --apply
+$ convergence apply changed_example.schema -c database.yml
 
 SET FOREIGN_KEY_CHECKS=0;
   --> 0.0005331430002115667s
@@ -131,15 +131,12 @@ Create Table: CREATE TABLE `test_tables` (
 ## Usage
 
 ```
-Usage: convergence [options]
-    -v, --version
-    -c, --config       Database Yaml Setting
-    -d, --diff         DSL1,DSL2
-    -e, --export       export db schema to dsl
-    -i, --input        Input DSL
-        --dryrun
-        --apply        execute sql to your database
-    -h, --help         Display this help message.
+Commands:
+  convergence apply FILE -c, --config=CONFIG   # execute sql to your database
+  convergence diff FILE1 FILE2                 # print diff of DSLs
+  convergence export -c, --config=CONFIG       # export db schema to dsl
+  convergence help [COMMAND]                   # Describe available commands or one specific command
+  convergence version                          # print the version
 ```
 
 ### DB Config
@@ -161,7 +158,7 @@ First, you need to create database.yml.
 And then, execute command like below.
 
 ```
-$ convergence -c database.yml --export > example.schema
+$ convergence export -c database.yml > example.schema
 ```
 
 Export DSL like this.
@@ -193,16 +190,16 @@ create_table "paper_authors", collate: "utf8_general_ci", comment: "Paper Author
 end
 ```
 
-### Dryrun
+### Dry run
 
 ```
-$ convergence -c database.yml -i example.schema --dryrun
+$ convergence apply example.schema -c database.yml --dry-run
 ```
 
 ### Apply
 
 ```
-$ convergence -c database.yml -i example.schema --apply
+$ convergence apply example.schema -c database.yml
 ```
 
 ### Include Other Schema files

data/bin/convergence

@@ -1,23 +1,6 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'rubygems'
-require 'convergence'
-require 'slop'
+require 'convergence/cli'
 
-opts = Slop.parse(help: true) do |opt|
-  opt.banner 'Usage: convergence [options]'
-
-  opt.on 'v', 'version' do
-    puts "version #{Convergence::VERSION}"
-    exit
-  end
-
-  opt.on 'c=', 'config=', 'Database Yaml Setting'
-  opt.on 'd=', 'diff=', 'DSL1,DSL2', as: Array, limit: 2
-  opt.on 'e', 'export', 'export db schema to dsl'
-  opt.on 'i=', 'input=', 'Input DSL'
-  opt.on 'dryrun'
-  opt.on 'apply', 'execute sql to your database'
-end
-
-Convergence::Command.new(opts).execute
+Convergence::CLI.start

data/convergence.gemspec

@@ -21,13 +21,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mysql2'
   spec.add_dependency 'diff-lcs'
   spec.add_dependency 'diffy'
-  spec.add_dependency 'slop', '~> 3.6'
+  spec.add_dependency 'thor', '~> 0.20'
 
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '>= 3.5'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'guard'

data/lib/convergence.rb

@@ -1,24 +1,2 @@
 require 'convergence/module'
-require 'convergence/logger'
 require 'convergence/version'
-require 'convergence/config'
-require 'convergence/command'
-require 'convergence/command/diff'
-require 'convergence/command/export'
-require 'convergence/command/dryrun'
-require 'convergence/command/apply'
-require 'convergence/pretty_diff'
-require 'convergence/database_connector'
-require 'convergence/database_connector/mysql_connector'
-require 'convergence/column'
-require 'convergence/index'
-require 'convergence/foreign_key'
-require 'convergence/table'
-require 'convergence/dsl'
-require 'convergence/diff'
-require 'convergence/sql_generator'
-require 'convergence/sql_generator/mysql_generator'
-require 'convergence/dumper'
-require 'convergence/dumper/mysql_schema_dumper'
-require 'convergence/default_parameter'
-require 'convergence/default_parameter/mysql_default_parameter'

data/lib/convergence/cli.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'convergence/module'
+require 'convergence/config'
+
+class Convergence::CLI < Thor
+  default_command :__fallback # TODO: `__fallback` will be removed in a future version(maybe v0.4.0)
+ 
+  map %w[--version -v] => :version
+
+  desc 'apply FILE', 'execute sql to your database'
+  method_option :config, aliases: '-c', type: :string, required: true, desc: 'Database Yaml Setting'
+  method_option :dry_run, type: :boolean
+  def apply(file)
+    opts = { input: file }
+    if options[:dry_run]
+      require 'convergence/command/dryrun'
+      Convergence::Command::Dryrun.new(opts, config: config).execute
+    else
+      require 'convergence/command/apply'
+      Convergence::Command::Apply.new(opts, config: config).execute
+    end
+  end
+
+  desc 'diff FILE1 FILE2', 'print diff of DSLs'
+  def diff(file1, file2)
+    require 'convergence/command/diff'
+    opts = { diff: [file1, file2] }
+    Convergence::Command::Diff.new(opts, config: config).execute
+  end
+
+  desc 'export', 'export db schema to dsl'
+  method_option :config, aliases: '-c', type: :string, required: true, desc: 'Database Yaml Setting'
+  def export
+    require 'convergence/command/export'
+    opts = {}
+    Convergence::Command::Export.new(opts, config: config).execute
+  end
+
+  desc 'version', 'print the version'
+  def version
+    require 'convergence/version'
+    puts "version #{Convergence::VERSION}"
+  end
+
+  # TODO: `__fallback` will be removed in a future version(maybe v0.4.0)
+  desc '', '', hide: true
+  method_option :config,
+                aliases: '-c', type: :string,
+                desc: 'Database Yaml Setting'
+  method_option :diff,
+                aliases: '-d', type: :array, default: nil,
+                banner: 'DSL1 DSL2'
+  method_option :export,
+                aliases: '-e', type: :boolean, default: false,
+                desc: 'export db schema to dsl'
+  method_option :input,
+                aliases: '-i', type: :string,
+                desc: 'Input DSL'
+  method_option :dryrun,
+                type: :boolean, default: false
+  method_option :apply,
+                type: :boolean, default: false,
+                desc: 'execute sql to your database'
+  def __fallback
+    command_klass =
+      if !options[:diff].nil? && !options[:diff].empty?
+        require 'convergence/command/diff'
+        opts = { diff: options[:diff] }
+        Convergence::Command::Diff
+      elsif options[:export]
+        require 'convergence/command/export'
+        opts = {}
+        Convergence::Command::Export
+      elsif options[:dryrun]
+        require 'convergence/command/dryrun'
+        opts = { input: options[:input] }
+        Convergence::Command::Dryrun
+      elsif options[:apply]
+        require 'convergence/command/apply'
+        opts = { input: options[:input] }
+        Convergence::Command::Apply
+      end
+
+    if command_klass
+      deprecation_warning
+      command_klass.new(opts, config: config).execute
+    else
+      help
+    end
+  end
+
+  private
+
+  def config
+    return unless options[:config]
+    @config ||= Convergence::Config.load(options[:config])
+  end
+
+  def deprecation_warning
+    warn '[DEPRECATION] Option style is deprecated. Please use subscommand style.'
+  end
+end

data/lib/convergence/command.rb

@@ -1,3 +1,7 @@
+require 'convergence/config'
+require 'convergence/logger'
+require 'convergence/database_connector'
+
 class Convergence::Command
   def initialize(opts, config: nil)
     @opts = opts
@@ -8,24 +12,6 @@ class Convergence::Command
     end
   end
 
-  def execute
-    execute_klass =
-      if @opts[:diff]
-        Convergence::Command::Diff
-      elsif @opts[:export]
-        Convergence::Command::Export
-      elsif @opts[:dryrun]
-        Convergence::Command::Dryrun
-      elsif @opts[:apply]
-        Convergence::Command::Apply
-      end
-    if execute_klass.nil?
-      puts @opts
-    else
-      execute_klass.new(@opts, config: @config).execute
-    end
-  end
-
   def database_adapter
     @config.nil? ? 'mysql' : @config.adapter
   end
@@ -37,6 +23,7 @@ class Convergence::Command
   def dumper
     @dumper ||= case database_adapter
                 when 'mysql', 'mysql2'
+                  require 'convergence/dumper/mysql_schema_dumper'
                   Convergence::Dumper::MysqlSchemaDumper.new(connector)
                 else
                   fail NotImplementedError.new('unknown database adapter')
@@ -46,6 +33,7 @@ class Convergence::Command
   def sql_generator
     @sql_generator ||= case database_adapter
                        when 'mysql', 'mysql2'
+                         require 'convergence/sql_generator/mysql_generator'
                          SQLGenerator::MysqlGenerator.new
                        else
                          fail NotImplementedError.new('unknown database adapter')

data/lib/convergence/command/apply.rb

@@ -1,10 +1,14 @@
 require 'benchmark'
 require 'pathname'
+require 'convergence/command'
+require 'convergence/dsl'
+require 'convergence/default_parameter'
+require 'convergence/diff'
 
 class Convergence::Command::Apply < Convergence::Command
   def validate!
-    fail ArgumentError.new('--config required') if @config.nil?
-    fail ArgumentError.new('--input required') unless @opts[:input]
+    fail ArgumentError.new('config required') if @config.nil?
+    fail ArgumentError.new('input required') unless @opts[:input]
   end
 
   def execute

data/lib/convergence/command/diff.rb

@@ -1,3 +1,9 @@
+require 'pathname'
+require 'convergence/command'
+require 'convergence/default_parameter'
+require 'convergence/pretty_diff'
+require 'convergence/dsl'
+
 class Convergence::Command::Diff < Convergence::Command
   def validate!
     unless @opts[:diff].size == 2

data/lib/convergence/command/dryrun.rb

@@ -1,8 +1,14 @@
 require 'pathname'
+require 'convergence/command'
+require 'convergence/command/apply'
+require 'convergence/dsl'
+require 'convergence/default_parameter'
+require 'convergence/pretty_diff'
+
 class Convergence::Command::Dryrun < Convergence::Command
   def validate!
-    fail ArgumentError.new('--config required') if @config.nil?
-    fail ArgumentError.new('--input required') unless @opts[:input]
+    fail ArgumentError.new('config required') if @config.nil?
+    fail ArgumentError.new('input required') unless @opts[:input]
   end
 
   def execute

data/lib/convergence/command/export.rb

@@ -1,7 +1,11 @@
+require 'convergence/command'
+require 'convergence/dumper'
+require 'convergence/default_parameter'
+
 class Convergence::Command::Export < Convergence::Command
   def validate!
     if @config.nil?
-      fail ArgumentError.new('--config required')
+      fail ArgumentError.new('config required')
     end
   end
 

data/lib/convergence/database_connector.rb

@@ -5,6 +5,7 @@ class Convergence::DatabaseConnector
     @connector =
       case config.adapter
       when 'mysql', 'mysql2'
+        require 'convergence/database_connector/mysql_connector'
         Convergence::DatabaseConnector::MysqlConnector.new(config)
       else
         fail NotImplementedError.new("#{config.adapter} not supported yet")

data/lib/convergence/database_connector/mysql_connector.rb

@@ -1,4 +1,6 @@
 require 'mysql2'
+require 'convergence/database_connector'
+
 class Convergence::DatabaseConnector::MysqlConnector
   attr_reader :config
 

data/lib/convergence/default_parameter.rb

@@ -2,6 +2,7 @@ class Convergence::DefaultParameter
   def initialize(adapter)
     case adapter.downcase
     when 'mysql', 'mysql2'
+      require 'convergence/default_parameter/mysql_default_parameter'
       @parameter_klass = Convergence::DefaultParameter::MysqlDefaultParameter.new
     else
       fail NotImplementedError.new("unknown adapter #{config.adapter}.")

data/lib/convergence/default_parameter/mysql_default_parameter.rb

@@ -1,3 +1,5 @@
+require 'convergence/default_parameter'
+
 class Convergence::DefaultParameter::MysqlDefaultParameter
   DEFAULT_TABLE_PARAMETERS = {
     engine: 'InnoDB',

data/lib/convergence/dsl.rb

@@ -1,3 +1,5 @@
+require 'convergence/table'
+
 class Convergence::DSL
   attr_accessor :tables, :current_dir_path
 

data/lib/convergence/dumper/mysql_schema_dumper.rb

@@ -1,3 +1,6 @@
+require 'convergence/dumper'
+require 'convergence/table'
+
 class Convergence::Dumper::MysqlSchemaDumper
   def initialize(connector)
     @connector = connector

data/lib/convergence/pretty_diff.rb

@@ -1,4 +1,6 @@
 require 'diffy'
+require 'convergence/diff'
+require 'convergence/dumper'
 
 class Convergence::PrettyDiff
   def initialize(from_tables, to_tables)

data/lib/convergence/sql_generator/mysql_generator.rb

@@ -1,3 +1,5 @@
+require 'convergence/sql_generator'
+
 class SQLGenerator::MysqlGenerator < SQLGenerator
   OPTION_MAPPING = {
     engine: 'ENGINE',

data/lib/convergence/table.rb

@@ -1,3 +1,7 @@
+require 'convergence/column'
+require 'convergence/index'
+require 'convergence/foreign_key'
+
 class Convergence::Table
   attr_accessor :table_name, :table_options, :columns, :indexes, :foreign_keys
 

data/lib/convergence/version.rb

@@ -1,3 +1,3 @@
 module Convergence
-  VERSION = '0.2.7'
+  VERSION = '1.0.0'
 end

data/spec/convergence/diff_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'convergence/diff'
+require 'convergence/table'
 
 describe Convergence::DSL do
   describe '#diff' do

data/spec/convergence/dsl_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'convergence/dsl'
 
 describe Convergence::DSL do
   let(:dsl_single_table) do

data/spec/convergence/dumper/mysql_schema_dumper_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'convergence/dumper/mysql_schema_dumper'
+require 'convergence/database_connector'
 
 describe Convergence::Dumper::MysqlSchemaDumper do
   before do

data/spec/convergence/dumper_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'convergence/dumper'
+require 'convergence/table'
 
 describe Convergence::Dumper do
   let(:table1) do

data/spec/convergence/table_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'convergence/table'
 
 describe Convergence::Table do
   let(:table_name) { 'dummy_table' }

data/spec/integrations/command_dryrun.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
+require 'convergence/command/dryrun'
 
 describe 'Command::Dryrun#execute' do
   def execute(dsl_path)
     parse_option = {
-      dryrun: true,
       input: File.expand_path("#{File.dirname(__FILE__)}/../fixtures/#{dsl_path}")
     }
-    Convergence::Command.new(parse_option, config: mysql_settings).execute
+    Convergence::Command::Dryrun.new(parse_option, config: mysql_settings).execute
   end
 
   describe 'change table options' do

data/spec/integrations/drop_foreign_key.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'convergence/command/apply'
 
 describe 'Changeable Foreign key' do
   after(:each) do
@@ -7,10 +8,9 @@ describe 'Changeable Foreign key' do
 
   def execute(dsl_path)
     parse_option = {
-      apply: true,
       input: File.expand_path("#{File.dirname(__FILE__)}/../fixtures/#{dsl_path}")
     }
-    Convergence::Command.new(parse_option, config: mysql_settings).execute
+    Convergence::Command::Apply.new(parse_option, config: mysql_settings).execute
   end
 
   describe 'drop foreign key' do

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler/setup'
 require 'rspec'
 require 'pry'
 require 'convergence'
+require 'convergence/database_connector'
 Dir["#{File.dirname(__FILE__)}/integrations/**/*.rb"].each { |f| require f }
 
 $default_output = File.open('/dev/null', 'w')
@@ -20,14 +21,12 @@ def rollback
     .map(&:strip)
     .reject(&:empty?)
   sqls.each do |sql|
-    Convergence::Command.new({}, config: mysql_settings)
-      .connector
+    Convergence::DatabaseConnector.new(mysql_settings)
       .client
       .query("#{sql};")
   end
 end
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
+  config.filter_run_when_matching :focus
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convergence
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Shinsuke Nishio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,7 @@ files:
 - convergence.gemspec
 - database.yml.example
 - lib/convergence.rb
+- lib/convergence/cli.rb
 - lib/convergence/column.rb
 - lib/convergence/command.rb
 - lib/convergence/command/apply.rb