commander 4.4.6 → 4.6.0

data/spec/configure_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'commander/configure'
 

data/spec/core_ext/array_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Array do
@@ -12,7 +14,7 @@ describe Array do
 
     it 'should match %w behavior with multiple backslashes' do
       str = 'just a\\ test'
-      expect(Array.parse(str)).to eq(eval("%w(#{str})"))
+      expect(Array.parse(str)).to eq(['just', 'a test'])
     end
   end
 end

data/spec/core_ext/object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Object do

data/spec/help_formatters/terminal_compact_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Commander::HelpFormatter::TerminalCompact do

data/spec/help_formatters/terminal_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Commander::HelpFormatter::Terminal do

data/spec/methods_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'commander/methods'
 
@@ -16,12 +18,12 @@ describe Commander::Methods do
 
       before do
         allow(terminal).to receive(:ask)
-        $_old_terminal = $terminal
-        $terminal = terminal
+        @old_highline = HighLine.default_instance
+        HighLine.default_instance = terminal
       end
 
       after do
-        $terminal = $_old_terminal
+        HighLine.default_instance = @old_highline
       end
 
       subject do

data/spec/runner_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Commander do
@@ -100,6 +102,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 +145,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 +390,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 +412,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 +441,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 +451,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!/)
@@ -408,6 +486,22 @@ describe Commander do
       expect(run('test', '--help')).to eq("Implement help for test here\n")
     end
 
+    it 'can be used after the command and command arguments' do
+      expect(run('test', 'command-arg', '--help')).to eq("Implement help for test here\n")
+    end
+
+    it 'can be used before a single-word command with command arguments' do
+      expect(run('help', 'test', 'command-arg')).to eq("Implement help for test here\n")
+    end
+
+    it 'can be used before a multi-word command with command arguments' do
+      expect(
+        run('help', 'module', 'install', 'command-arg') do
+          command('module install') { |c| c.when_called { say 'whee!' } }
+        end
+      ).to eq("Implement help for module install here\n")
+    end
+
     describe 'help_paging program information' do
       it 'enables paging when enabled' do
         run('--help') { program :help_paging, true }
@@ -430,7 +524,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 +532,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 +540,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 +548,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 +556,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 +589,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 +744,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'stringio'
 require 'simplecov'
@@ -6,7 +8,7 @@ SimpleCov.start do
 end
 
 # Unshift so that local files load instead of something in gems
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 
 # This basically replicates the behavior of `require 'commander/import'`
 # but without adding an `at_exit` hook, which interferes with exit code
@@ -14,11 +16,20 @@ require 'commander'
 require 'commander/methods'
 
 # Mock terminal IO streams so we can spec against them
-
 def mock_terminal
   @input = StringIO.new
   @output = StringIO.new
-  $terminal = HighLine.new @input, @output
+  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
@@ -40,7 +51,7 @@ end
 # Create a new command runner
 
 def new_command_runner(*args, &block)
-  Commander::Runner.instance_variable_set :"@singleton", Commander::Runner.new(args)
+  Commander::Runner.instance_variable_set :@instance, Commander::Runner.new(args)
   program :name, 'test'
   program :version, '1.2.3'
   program :description, 'something'

data/spec/ui_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Commander::UI do
@@ -5,7 +7,7 @@ describe Commander::UI do
 
   describe '.replace_tokens' do
     it 'should replace tokens within a string, with hash values' do
-      result = Commander::UI.replace_tokens 'Welcome :name, enjoy your :object'.freeze, name: 'TJ', object: 'cookie'
+      result = Commander::UI.replace_tokens 'Welcome :name, enjoy your :object', name: 'TJ', object: 'cookie'
       expect(result).to eq('Welcome TJ, enjoy your cookie')
     end
   end
@@ -15,7 +17,7 @@ describe Commander::UI do
       exception = false
       begin
         progress([]) {}
-      rescue
+      rescue StandardError
         exception = true
       end
       expect(exception).not_to be true

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.4.6
+  version: 4.6.0
 platform: ruby
 authors:
 - TJ Holowaychuk
 - Gabriel Gilder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -17,14 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -40,19 +54,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -67,20 +81,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.1
 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.
@@ -140,8 +140,13 @@ files:
 homepage: https://github.com/commander-rb/commander
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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.6.0
+  homepage_uri: https://github.com/commander-rb/commander
+  source_code_uri: https://github.com/commander-rb/commander/tree/v4.6.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,16 +154,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: The complete solution for Ruby command-line executables
 test_files: