commander 4.4.7 → 4.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb88c28e0d43c3616cceb161661a306fbcb74ef6c68ce67bc5aee8e820498cd
-  data.tar.gz: 9c5295c278179f4325c179b61a07182c45f3ed911b8228294cdf53e83cb6fe74
+  metadata.gz: c911ee8aef66db7dbe8045f9f996ff0b810afeacb6f8efc7fc288e322937f59a
+  data.tar.gz: b22b126f597fad5adcc4ecc44c60ac57ac70b3ce2ffeb646d8001eabf088da8d
 SHA512:
-  metadata.gz: 977685b95002c9e0dcaafd60da783473dc1e2d90f72eec6c1fc209d7ba6ff498f7941f2ac263244775d58d5f41b7bda7e57d7a39041963d8ec85852c20b99ee9
-  data.tar.gz: 2c2eb1a834b1446b61d0ac7dbeb8f0575f80ab10e57d432a6710c4e37eb24eb870a6312655be5f27f3d4250505320f04fb46c763f91ef688b9e6c96fa573b45e
+  metadata.gz: '04589993f113b0ed3aab4d90ae8a963f5d68999535f523def84e9d6d2a355c0a5b2bbdc4a5969c0bcf8d44e6d1a40f42e1e6f5bbafe35126b321ef46c05f235f'
+  data.tar.gz: 52c16dd44e1801cb3ee353332dada749c013b452d3976c1a9aed9829d16b545f20b625cadcb37fba4fb09468c2c17a04d1dce14f665b2cdd4ac14e664d2a79fd

data/.travis.yml

@@ -4,11 +4,10 @@ before_install:
   - gem update --system
   - gem update bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-19mode
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby
+  - ruby-head

data/History.rdoc

@@ -1,3 +1,18 @@
+=== 4.5.2 / 2020-03-12
+
+* Fix bug handling global options provided in option=value form (#47). (@orien)
+* Fix ERB warnings under Ruby 2.7. (@esotericpig)
+* Fix bug handling global options placed before command name (#32). (@orien)
+
+=== 4.5.1 / 2020-03-08
+
+* Fix bug causing global options to be ignored when arguments are present (#86). (@orien)
+
+=== 4.5.0 / 2020-01-21
+
+* Drop support for Ruby < 2.3.
+* Fix bug parsing double dash (#75).
+
 === 4.4.7 / 2018-10-22
 
 * Update HighLine dependency to 2.0.0. (@rohitpaulk)

data/README.md

@@ -1,5 +1,5 @@
-[<img src="https://api.travis-ci.org/commander-rb/commander.svg" alt="Build Status" />](http://travis-ci.org/commander-rb/commander)
-[![Inline docs](http://inch-ci.org/github/commander-rb/commander.svg)](http://inch-ci.org/github/commander-rb/commander)
+[<img src="https://api.travis-ci.org/commander-rb/commander.svg" alt="Build Status" />](https://travis-ci.org/commander-rb/commander)
+[![Inline docs](https://inch-ci.org/github/commander-rb/commander.svg)](https://inch-ci.org/github/commander-rb/commander)
 
 # Commander
 
@@ -243,8 +243,8 @@ end
 ## Growl Notifications
 
 Commander provides methods for displaying Growl notifications. To use these
-methods you need to install http://github.com/tj/growl which utilizes
-the [growlnotify](http://growl.info/extras.php#growlnotify) executable. Note that
+methods you need to install https://github.com/tj/growl which utilizes
+the [growlnotify](https://growl.info/extras.php#growlnotify) executable. Note that
 growl is auto-imported by Commander when available, no need to require.
 
 ```ruby
@@ -449,7 +449,7 @@ global_option '--config FILE'
 
 ## ASCII Tables
 
-For feature rich ASCII tables for your terminal app check out the terminal-table gem at http://github.com/tj/terminal-table
+For feature rich ASCII tables for your terminal app check out the terminal-table gem at https://github.com/tj/terminal-table
 
     +----------+-------+----+--------+-----------------------+
     | Terminal | Table | Is | Wicked | Awesome               |
@@ -468,7 +468,7 @@ OR
 ## Contrib
 
 Feel free to fork and request a pull, or submit a ticket
-http://github.com/commander-rb/commander/issues
+https://github.com/commander-rb/commander/issues
 
 ## License
 

data/commander.gemspec

@@ -12,6 +12,13 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/commander-rb/commander'
   s.summary     = 'The complete solution for Ruby command-line executables'
   s.description = 'The complete solution for Ruby command-line executables. Commander bridges the gap between other terminal related libraries you know and love (OptionParser, HighLine), while providing many new features, and an elegant API.'
+  s.metadata    = {
+    'bug_tracker_uri'   => "#{s.homepage}/issues",
+    'changelog_uri'     => "#{s.homepage}/blob/master/History.rdoc",
+    'documentation_uri' => "https://www.rubydoc.info/gems/commander/#{s.version}",
+    'homepage_uri'      => s.homepage,
+    'source_code_uri'   => "#{s.homepage}/tree/v#{s.version}",
+  }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/commander/command.rb

@@ -4,6 +4,7 @@ module Commander
   class Command
     attr_accessor :name, :examples, :syntax, :description
     attr_accessor :summary, :proxy_options, :options
+    attr_reader :global_options
 
     ##
     # Options struct.
@@ -38,6 +39,7 @@ module Commander
     def initialize(name)
       @name, @examples, @when_called = name.to_s, [], []
       @options, @proxy_options = [], []
+      @global_options = []
     end
 
     ##
@@ -190,7 +192,7 @@ module Commander
     # collected by the #option_proc.
 
     def proxy_option_struct
-      proxy_options.each_with_object(Options.new) do |(option, value), options|
+      (global_options + proxy_options).each_with_object(Options.new) do |(option, value), options|
         # options that are present will evaluate to true
         value = true if value.nil?
         options.__send__ :"#{option}=", value

data/lib/commander/help_formatters/terminal.rb

@@ -12,7 +12,11 @@ module Commander
       end
 
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
+        if RUBY_VERSION < '2.6'
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
+        else
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), trim_mode: '-')
+        end
       end
     end
   end

data/lib/commander/help_formatters/terminal_compact.rb

@@ -4,7 +4,11 @@ module Commander
   module HelpFormatter
     class TerminalCompact < Terminal
       def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+        if RUBY_VERSION < '2.6'
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+        else
+          ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), trim_mode: '-')
+        end
       end
     end
   end

data/lib/commander/runner.rb

@@ -246,6 +246,7 @@ module Commander
     # Returns array of valid command names found within _args_.
 
     def valid_command_names_from(*args)
+      remove_global_options options, args
       arg_string = args.delete_if { |value| value =~ /^-/ }.join ' '
       commands.keys.find_all { |name| name if arg_string =~ /^#{name}\b/ }
     end
@@ -328,26 +329,31 @@ module Commander
     # again for the command.
 
     def remove_global_options(options, args)
-      # TODO: refactor with flipflop, please TJ ! have time to refactor me !
       options.each do |option|
-        switches = option[:switches].dup
+        switches = option[:switches]
         next if switches.empty?
-
-        if (switch_has_arg = switches.any? { |s| s =~ /[ =]/ })
-          switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
-        end
-
+        option_takes_argument = switches.any? { |s| s =~ /[ =]/ }
         switches = expand_optionally_negative_switches(switches)
 
-        past_switch, arg_removed = false, false
-        args.delete_if do |arg|
-          if switches.any? { |s| s[0, arg.length] == arg }
-            arg_removed = !switch_has_arg
-            past_switch = true
-          elsif past_switch && !arg_removed && arg !~ /^-/
-            arg_removed = true
+        option_argument_needs_removal = false
+        args.delete_if do |token|
+          break if token == '--'
+
+          # Use just the portion of the token before the = when
+          # comparing switches.
+          index_of_equals = token.index('=') if option_takes_argument
+          token = token[0, index_of_equals] if index_of_equals
+          token_contains_option_argument = !index_of_equals.nil?
+
+          if switches.any? { |s| s[0, token.length] == token }
+            option_argument_needs_removal =
+              option_takes_argument && !token_contains_option_argument
+            true
+          elsif option_argument_needs_removal && token !~ /^-/
+            option_argument_needs_removal = false
+            true
           else
-            arg_removed = true
+            option_argument_needs_removal = false
             false
           end
         end
@@ -395,7 +401,7 @@ module Commander
     def global_option_proc(switches, &block)
       lambda do |value|
         unless active_command.nil?
-          active_command.proxy_options << [Runner.switch_to_sym(switches.last), value]
+          active_command.global_options << [Runner.switch_to_sym(switches.last), value]
         end
         yield value if block && !value.nil?
       end

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.4.7'.freeze
+  VERSION = '4.5.2'.freeze
 end

data/spec/command_spec.rb

@@ -164,6 +164,33 @@ describe Commander::Command do
         end
         @command.run '--interval', '15'
       end
+
+      describe 'given a global option' do
+        before do
+          @command.global_options << [:global_option, 'gvalue']
+        end
+
+        describe 'and no command specific arguments' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run
+          end
+        end
+
+        describe 'and a command specific option' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run '--verbose'
+          end
+        end
+
+        describe 'and a command specific argument' do
+          it 'provides the global option to the command action' do
+            @command.when_called { |_, options| expect(options.global_option).to eq('gvalue') }
+            @command.run 'argument'
+          end
+        end
+      end
     end
   end
 end

data/spec/runner_spec.rb

@@ -100,6 +100,17 @@ describe Commander do
       expect(quiet).to be true
     end
 
+    it 'should be inherited by commands when provided before the command name' do
+      option = nil
+      new_command_runner '--global-option', 'option-value', 'command_name' do
+        global_option('--global-option=GLOBAL', 'A global option')
+        command :command_name do |c|
+          c.when_called { |_, options| option = options.global_option }
+        end
+      end.run!
+      expect(option).to eq('option-value')
+    end
+
     it 'should be inherited by commands even when a block is present' do
       quiet = nil
       new_command_runner 'foo', '--quiet' do
@@ -132,6 +143,57 @@ describe Commander do
       end.run!
       expect(quiet).to be false
     end
+
+    it 'should allow command arguments before the global option' do
+      config = nil
+      args = nil
+      new_command_runner 'foo', '--config', 'config-value', 'arg1', 'arg2' do
+        global_option('-c', '--config CONFIG', String)
+        command :foo do |c|
+          c.when_called do |arguments, options|
+            options.default(config: 'default')
+            args = arguments
+            config = options.config
+          end
+        end
+      end.run!
+      expect(config).to eq('config-value')
+      expect(args).to eq(%w(arg1 arg2))
+    end
+
+    it 'should allow command arguments after the global option' do
+      config = nil
+      args = nil
+      new_command_runner 'foo', 'arg1', 'arg2', '--config', 'config-value' do
+        global_option('-c', '--config CONFIG', String)
+        command :foo do |c|
+          c.when_called do |arguments, options|
+            options.default(config: 'default')
+            args = arguments
+            config = options.config
+          end
+        end
+      end.run!
+      expect(config).to eq('config-value')
+      expect(args).to eq(%w(arg1 arg2))
+    end
+
+    it 'allows global options in the form option=value' do
+      config = nil
+      args = nil
+      new_command_runner 'test', 'arg1', '--config=config-value', 'arg2' do
+        global_option('-c', '--config CONFIG', String)
+        command :test do |c|
+          c.when_called do |arguments, options|
+            options.default(config: 'default')
+            args = arguments
+            config = options.config
+          end
+        end
+      end.run!
+      expect(config).to eq('config-value')
+      expect(args).to eq(%w[arg1 arg2])
+    end
   end
 
   describe '#parse_global_options' do
@@ -326,6 +388,20 @@ describe Commander do
       command_runner.remove_global_options options, args
       expect(args).to eq(%w(--versionCode something))
     end
+
+    it 'should remove specified switches value provided via equals' do
+      options = [{ switches: ['--global GLOBAL'] }]
+      args = ['--command', '--global=option-value', 'arg']
+      command_runner.remove_global_options options, args
+      expect(args).to eq(['--command', 'arg'])
+    end
+
+    it 'should not remove extra values after switches' do
+      options = [{ switches: ['--global GLOBAL'] }]
+      args = ['--global', '--command', 'arg']
+      command_runner.remove_global_options options, args
+      expect(args).to eq(['--command', 'arg'])
+    end
   end
 
   describe '--trace' do
@@ -334,7 +410,7 @@ describe Commander do
         new_command_runner 'foo' do
           command(:foo) { |c| c.when_called { fail 'cookies!' } }
         end.run!
-      end.to raise_error(SystemExit, /error: cookies!. Use --trace/)
+      end.to raise_error(TestSystemExit, /error: cookies!. Use --trace/)
     end
 
     it 'should display callstack when using this switch' do
@@ -363,7 +439,7 @@ describe Commander do
         new_command_runner 'help', '--trace' do
           never_trace!
         end.run!
-      end.to raise_error(SystemExit, /invalid option: --trace/)
+      end.to raise_error(TestSystemExit, /invalid option: --trace/)
     end
 
     it 'should not prompt to use --trace switch on errors' do
@@ -373,7 +449,7 @@ describe Commander do
           never_trace!
           command(:foo) { |c| c.when_called { fail 'cookies!' } }
         end.run!
-      rescue SystemExit => e
+      rescue TestSystemExit => e
         msg = e.message
       end
       expect(msg).to match(/error: cookies!/)
@@ -430,7 +506,7 @@ describe Commander do
     it 'should output an invalid option message' do
       expect do
         run('test', '--invalid-option')
-      end.to raise_error(SystemExit, /invalid option: --invalid-option/)
+      end.to raise_error(TestSystemExit, /invalid option: --invalid-option/)
     end
   end
 
@@ -438,7 +514,7 @@ describe Commander do
     it 'should output an invalid command message' do
       expect do
         run('foo')
-      end.to raise_error(SystemExit, /invalid command. Use --help for more information/)
+      end.to raise_error(TestSystemExit, /invalid command. Use --help for more information/)
     end
   end
 
@@ -446,7 +522,7 @@ describe Commander do
     it 'should output an invalid command message' do
       expect do
         run('help', 'does_not_exist')
-      end.to raise_error(SystemExit, /invalid command. Use --help for more information/)
+      end.to raise_error(TestSystemExit, /invalid command. Use --help for more information/)
     end
   end
 
@@ -454,7 +530,7 @@ describe Commander do
     it 'should output an invalid command message' do
       expect do
         run('--help', 'does_not_exist')
-      end.to raise_error(SystemExit, /invalid command. Use --help for more information/)
+      end.to raise_error(TestSystemExit, /invalid command. Use --help for more information/)
     end
   end
 
@@ -462,7 +538,7 @@ describe Commander do
     it 'should output an invalid option message' do
       expect do
         run('--help', 'test', '--invalid-option')
-      end.to raise_error(SystemExit, /invalid option: --invalid-option/)
+      end.to raise_error(TestSystemExit, /invalid option: --invalid-option/)
     end
   end
 
@@ -495,6 +571,13 @@ describe Commander do
       expect(command_runner.command_name_from_args).to eq('test')
     end
 
+    it 'should locate command when provided after a global argument with value' do
+      new_command_runner '--global-option', 'option-value', 'test' do
+        global_option('--global-option=GLOBAL', 'A global option')
+      end
+      expect(command_runner.command_name_from_args).to eq('test')
+    end
+
     it 'should support multi-word commands' do
       new_command_runner '--help', '--arbitrary', 'some', 'long', 'command', 'foo'
       command('some long command') {}
@@ -643,4 +726,18 @@ describe Commander do
       end.run!
     end
   end
+
+  describe 'with double dash' do
+    it 'should interpret the remainder as arguments' do
+      new_command_runner 'foo', '--', '-x' do
+        command('foo') do |c|
+          c.option '-x', 'Switch'
+          c.when_called do |args, options|
+            expect(args).to eq(%w(-x))
+            expect(options.x).to be_nil
+          end
+        end
+      end.run!
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -14,13 +14,22 @@ require 'commander'
 require 'commander/methods'
 
 # Mock terminal IO streams so we can spec against them
-
 def mock_terminal
   @input = StringIO.new
   @output = StringIO.new
   HighLine.default_instance = HighLine.new(@input, @output)
 end
 
+# Stub Kernel.abort
+TestSystemExit = Class.new(RuntimeError)
+module Commander
+  class Runner
+    def abort(message)
+      fail TestSystemExit, message
+    end
+  end
+end
+
 # Create test command for usage within several specs
 
 def create_test_command

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.4.7
+  version: 4.5.2
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -140,7 +140,12 @@ files:
 homepage: https://github.com/commander-rb/commander
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/commander-rb/commander/issues
+  changelog_uri: https://github.com/commander-rb/commander/blob/master/History.rdoc
+  documentation_uri: https://www.rubydoc.info/gems/commander/4.5.2
+  homepage_uri: https://github.com/commander-rb/commander
+  source_code_uri: https://github.com/commander-rb/commander/tree/v4.5.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The complete solution for Ruby command-line executables