commander 4.5.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bdbd13d121e9ed4efc4a21970fd4465d3f2e516a6440499b67e6bd32868b0d
-  data.tar.gz: 6bd6e26d357bf26af390ebd4be9a33f7c1f1c91c3efc296b4d21cb138887ac15
+  metadata.gz: 81b7ddc3a162a5470bc710c813ae0c774bc120154029d1a4fcbc3dbe5ffc13b9
+  data.tar.gz: 1375cade2955ac64e702c982572406a7b4f5e3e6e983bc4d52e5a19521c19e05
 SHA512:
-  metadata.gz: c806f1a602eb89351344ff1f7209ec63f547a4659ee62678117cd77795bdc0e9579c8a3e3fecd34a0b167315ab4bdede104485be2e9682d05b2dcea34e170312
-  data.tar.gz: db8f3b2fc17a1a790533b6d6609bcd5a0904bfb426549a6e6de9707f1ac804ee552efa338c07ef48ec8b2634892858ba4522d0292793064be8cba1f486a78270
+  metadata.gz: cf813e48a0d891a9998d96bf92a82d4e771d69a147fd1a45cb9af96f1bf1237050d9a7ba552f35cb27c78e48086fd93f3ea696d4d8207a2b9d025f084c91cf88
+  data.tar.gz: ab019b9db4e5dfe26fedea6bc611c8ac7162827fdb402c025b1e68b80b05d19c1ad0563b90b303c64820ed136b9259ce9fcda6b38f35254fe6ce4cee86b23349

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 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.

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/runner.rb

@@ -395,7 +395,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.5.0'.freeze
+  VERSION = '4.5.1'.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

@@ -132,6 +132,40 @@ 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
   end
 
   describe '#parse_global_options' do
@@ -334,7 +368,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 +397,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 +407,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 +464,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 +472,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 +480,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 +488,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 +496,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
 

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.5.0
+  version: 4.5.1
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-03-08 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.1
+  homepage_uri: https://github.com/commander-rb/commander
+  source_code_uri: https://github.com/commander-rb/commander/tree/v4.5.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The complete solution for Ruby command-line executables