commander 4.0.7 → 4.1.0

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
+before_install: gem update --system
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - jruby-18mode
-  - jruby-19mode
+# rspec 2.8.0 failing in jruby 1.9 mode
+#  - jruby-19mode
   - rbx-18mode

data/History.rdoc

@@ -1,49 +1,47 @@
-4.0.7 / 2012-01-23
-==================
+=== 4.1.0 / 2012-02-12
 
-  * Improved support for JRuby and Windows (and any other platforms that don't support Kernel.fork).
-  * Fixed bug #33 - support `--help` after commands.
-  * Reorganized help output to display synopsis before description (issue #12).
+* Update highline dependency.
+* Make optional arguments true when present (issue #2).
 
-4.0.6 / 2011-09-15
-==================
+=== 4.0.7 / 2012-01-23
 
-  * Improved load time on Ruby 1.9. (thanks to Jonathon M. Abbott)
-  * Updated documentation.
+* Improved support for JRuby and Windows (and any other platforms that don't support Kernel.fork).
+* Fixed bug #33 - support `--help` after commands.
+* Reorganized help output to display synopsis before description (issue #12).
 
-4.0.5 / 2011-08-09
-==================
+=== 4.0.6 / 2011-09-15
 
-  * Updated documentation to fix inaccuracies and unclear information.
-  * Improved rake tasks for gem development.
-  * Added say_ok, say_warning and say_error methods to print messages in green, yellow or red. (thanks to Simon Courtois)
-  * Fixed; Allow global options to be passed in any order, even mixed with command options. (thanks to Rich Grundy)
-  * Fixed; Global options can be passed before or after the command, they can even be mixed with command options. Closes #8. (thanks to Rich Grundy)
-  * Fixed; Platform test should now correctly identify JRuby. (thanks to Justin Lynn)
-  * Fixed; Add to_s to exceptions as option parser no longer does implicit conversion. (thanks to Justin Lynn)
+* Improved load time on Ruby 1.9. (thanks to Jonathon M. Abbott)
+* Updated documentation.
 
-4.0.4 / 2011-04-04
-==================
+=== 4.0.5 / 2011-08-09
 
-  * Fixed program(:key) behavior for non-Array keys like name, version, description under Ruby 1.9
-  * All specs should pass under Ruby 1.9 now
+* Updated documentation to fix inaccuracies and unclear information.
+* Improved rake tasks for gem development.
+* Added say_ok, say_warning and say_error methods to print messages in green, yellow or red. (thanks to Simon Courtois)
+* Fixed; Allow global options to be passed in any order, even mixed with command options. (thanks to Rich Grundy)
+* Fixed; Global options can be passed before or after the command, they can even be mixed with command options. Closes #8. (thanks to Rich Grundy)
+* Fixed; Platform test should now correctly identify JRuby. (thanks to Justin Lynn)
+* Fixed; Add to_s to exceptions as option parser no longer does implicit conversion. (thanks to Justin Lynn)
 
-4.0.3 / 2010-04-06
-==================
+=== 4.0.4 / 2011-04-04
 
-  * Fixed global_option which was consuming arguments when not expected. Closes #22
+* Fixed program(:key) behavior for non-Array keys like name, version, description under Ruby 1.9
+* All specs should pass under Ruby 1.9 now
 
-4.0.2 / 2010-01-19
-==================
+=== 4.0.3 / 2010-04-06
 
-  * Added program(:int_block) to allow a block to be run on interrupt.
-  * Fixed; ProgressBar immediately shows, and doesn't die on empty lists.
+* Fixed global_option which was consuming arguments when not expected. Closes #22
 
-4.0.1 / 2010-01-14
-==================
+=== 4.0.2 / 2010-01-19
 
-  * Fixed commander when using JRuby
-  * Fixed template; should require "commander/import"
+* Added program(:int_block) to allow a block to be run on interrupt.
+* Fixed; ProgressBar immediately shows, and doesn't die on empty lists.
+
+=== 4.0.1 / 2010-01-14
+
+* Fixed commander when using JRuby
+* Fixed template; should require "commander/import"
 
 === 4.0.0 / 2009-10-10
 

data/commander.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency("highline", "~> 1.5.0")
+  s.add_runtime_dependency("highline", "~> 1.6.11")
+  
   s.add_development_dependency("rspec", "~> 2")
   s.add_development_dependency("rake")
   s.add_development_dependency("simplecov")
-end
+end

data/lib/commander/command.rb

@@ -107,7 +107,7 @@ module Commander
     #
     
     def option *args, &block
-      switches, description = Runner.separate_switches_from_description *args
+      switches, description = Runner.separate_switches_from_description(*args)
       proc = block || option_proc(switches)
       @options << {
         :args => args,
@@ -164,7 +164,7 @@ module Commander
     def parse_options_and_call_procs *args
       return args if args.empty?
       @options.inject OptionParser.new do |opts, option| 
-        opts.on *option[:args], &option[:proc]
+        opts.on(*option[:args], &option[:proc])
         opts
       end.parse! args
     end
@@ -189,6 +189,8 @@ module Commander
     
     def proxy_option_struct
       proxy_options.inject Options.new do |options, (option, value)|
+        # options that are present will evaluate to true
+        value = true if value.nil?
         options.__send__ :"#{option}=", value
         options
       end

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.0.7'
+  VERSION = '4.1.0'
 end

data/spec/command_spec.rb

@@ -89,20 +89,44 @@ describe Commander::Command do
         @command.when_called { |_, options| options.file.should eq('foo') }  
         @command.run '--file', 'foo'
         lambda { @command.run '--file' }.should raise_error(OptionParser::MissingArgument)
-      end  
+      end
 
-      it "optional arguments" do
-        @command.option '--use-config [file] '
-        @command.when_called { |_, options| options.use_config.should eq('foo') }  
-        @command.run '--use-config', 'foo'
-        @command.when_called { |_, options| options.use_config.should be_nil }  
-        @command.run '--use-config'
-        @command.option '--interval N', Integer
-        @command.when_called { |_, options| options.interval.should eq(5) }  
-        @command.run '--interval', '5'
-        lambda { @command.run '--interval', 'invalid' }.should raise_error(OptionParser::InvalidArgument)
+      describe "optional arguments" do
+        before do
+          @command.option '--use-config [file] '
+        end
+
+        it "should return the argument when provided" do
+          @command.when_called { |_, options| options.use_config.should eq('foo') }
+          @command.run '--use-config', 'foo'
+        end
+
+        it "should return true when present without an argument" do
+          @command.when_called { |_, options| options.use_config.should be_true }
+          @command.run '--use-config'
+        end
+
+        it "should return nil when not present" do
+          @command.when_called { |_, options| options.use_config.should be_nil }
+          @command.run
+        end
       end
-      
+
+      describe "typed arguments" do
+        before do
+          @command.option '--interval N', Integer
+        end
+
+        it "should parse valid values" do
+          @command.when_called { |_, options| options.interval.should eq(5) }
+          @command.run '--interval', '5'
+        end
+
+        it "should reject invalid values" do
+          lambda { @command.run '--interval', 'invalid' }.should raise_error(OptionParser::InvalidArgument)
+        end
+      end
+
       it "lists" do
         @command.option '--fav COLORS', Array
         @command.when_called { |_, options| options.fav.should eq(['red', 'green', 'blue']) }  

data/spec/runner_spec.rb

@@ -493,5 +493,29 @@ describe Commander do
       end.run!
     end
   end
-  
+
+  describe "options with optional arguments" do
+    it "should return the argument when it is specified" do
+      new_command_runner 'foo', '--optional', 'arg1' do
+        command('foo') do |c|
+          c.option('--optional [argument]')
+          c.when_called do |_, options|
+            options.optional.should eq('arg1')
+          end
+        end
+      end.run!
+    end
+
+    it "should return true when no argument is specified for the option" do
+      new_command_runner 'foo', '--optional' do
+        command('foo') do |c|
+          c.option('--optional [argument]')
+          c.when_called do |_, options|
+            options.optional.should be_true
+          end
+        end
+      end.run!
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -2,6 +2,9 @@ require 'rubygems'
 require 'simplecov'
 SimpleCov.start
 
+# prevent paging (through less) from actually occurring in test environment
+ENV['PAGER'] = 'cat'
+
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'commander/import'
 require 'stringio'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-23 00:00:00.000000000Z
+date: 2012-02-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70326274634880 !ruby/object:Gem::Requirement
+  requirement: &70213543949460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.11
   type: :runtime
   prerelease: false
-  version_requirements: *70326274634880
+  version_requirements: *70213543949460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70326274634380 !ruby/object:Gem::Requirement
+  requirement: &70213543948960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70326274634380
+  version_requirements: *70213543948960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70326274634000 !ruby/object:Gem::Requirement
+  requirement: &70213543948580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70326274634000
+  version_requirements: *70213543948580
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70326274633540 !ruby/object:Gem::Requirement
+  requirement: &70213543948120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70326274633540
+  version_requirements: *70213543948120
 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.