boson 1.2.0 → 1.2.1

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 1.2.1
+* Fix only option being invalid and not deleted
+* Fix handling option parse errors in Runner
+* Fix argument error handling for commands with optional args
+
 == 1.2.0
 * Add help subcommand for executables
 * Allow Runner help methods to be extended

data/README.md

@@ -117,6 +117,9 @@ Now for pros thor has over boson. Thor
 * Change your requires and subclass from Boson::Runner instead of Thor.
 * Delete the first argument from `desc`. Usage is automatically created in boson.
 * Rename `method_option` to `option`
+* For options with a type option, make sure it maps to a symbol i.e. :array or :boolean.
+  If left a string, the option will be interpreted to be a string option with that
+  string as a default.
 * `class_option` doesn't exist yet but you can emulate it for now by defining
   your class option in a class method and then calling your class method before
   every command. See [vimdb](http://github.com/cldwalker/vimdb) for an example.

data/lib/boson/bare_runner.rb

@@ -58,8 +58,8 @@ module Boson
       def allowed_argument_error?(err, cmd, args)
         msg = RUBY_ENGINE == 'rbx' && err.class == ArgumentError ?
           /given \d+, expected \d+/ : /wrong number of arguments/
-        (err.message[msg] && (cmd_obj = Command.find(cmd)) &&
-          cmd_obj.arg_size != args.size)
+        err.message[msg] && (cmd_obj = Command.find(cmd)) &&
+          cmd_obj.incorrect_arg_size?(args)
       end
 
       def option_parser

data/lib/boson/command.rb

@@ -136,6 +136,18 @@ module Boson
       !!(args && @args[-1] && @args[-1][0][/^\*/])
     end
 
+    # Indicates if arg size can handle a numerical comparison
+    def numerical_arg_size?
+      !has_splat_args? && arg_size
+    end
+
+    # Determines if incorrect # of args given i.e. too little or too much
+    def incorrect_arg_size?(args)
+      return false if has_splat_args?
+      required_arg_size = args.take_while {|e| e[1].nil? }.size
+      args.size < required_arg_size || args.size > arg_size
+    end
+
     # Number of arguments
     def arg_size
       unless instance_variable_defined?("@arg_size")

data/lib/boson/option_command.rb

@@ -51,7 +51,7 @@ module Boson
         Boson.in_shell ? args = new_args : args += new_args
       # add default options
       elsif @command.options.nil? || @command.options.empty? ||
-        (!@command.has_splat_args? && args.size <= (@command.arg_size - 1).abs) ||
+        (@command.numerical_arg_size? && args.size <= (@command.arg_size - 1).abs) ||
         (@command.has_splat_args? && !args[-1].is_a?(Hash))
           global_opt, parsed_options = parse_options([])[0,2]
       # merge default options with given hash of options
@@ -77,8 +77,8 @@ module Boson
 
     # modifies args for edge cases
     def modify_args(args)
-      if @command.default_option && @command.arg_size <= 1 &&
-        !@command.has_splat_args? &&
+      if @command.default_option && @command.numerical_arg_size? &&
+        @command.arg_size <= 1 &&
         !args[0].is_a?(Hash) && args[0].to_s[/./] != '-' && !args.join.empty?
           args[0] = "--#{@command.default_option}=#{args[0]}"
       end
@@ -86,7 +86,7 @@ module Boson
 
     # raises CommandArgumentError if argument size is incorrect for given args
     def check_argument_size(args)
-      if args.size != @command.arg_size && !@command.has_splat_args?
+      if @command.numerical_arg_size? && args.size != @command.arg_size
         command_size, args_size = args.size > @command.arg_size ?
           [@command.arg_size, args.size] :
           [@command.arg_size - 1, args.size - 1]
@@ -97,7 +97,7 @@ module Boson
 
     # Adds default args as original method would
     def add_default_args(args, obj)
-      if @command.args && args.size < @command.args.size - 1
+      if @command.args && args.size < @command.arg_size - 1
         # leave off last arg since its an option
         @command.args.slice(0..-2).each_with_index {|arr,i|
           next if args.size >= i + 1 # only fill in once args run out
@@ -118,6 +118,13 @@ module Boson
       trailing, unparseable = split_trailing
       global_options = parse_global_options @command.option_parser.leading_non_opts +
         trailing
+
+      # delete invalid options not deleted since no other options present
+      if @command.numerical_arg_size? &&
+        @command.option_parser.leading_non_opts.size > @command.arg_size - 1
+        option_parser.delete_leading_invalid_opts
+      end
+
       new_args = option_parser.non_opts.dup + unparseable
       [global_options, parsed_options, new_args]
     rescue OptionParser::Error

data/lib/boson/option_parser.rb

@@ -331,6 +331,10 @@ module Boson
       Hash.new {|hash,key| hash[key.to_sym] if String === key }
     end
 
+    def delete_leading_invalid_opts
+      delete_invalid_opts @leading_non_opts
+    end
+
     private
     def all_options_with_fields(fields)
       aliases = @opt_aliases.invert
@@ -417,9 +421,9 @@ module Boson
       send("validate_#{type}", peek) if respond_to?("validate_#{type}", true)
     end
 
-    def delete_invalid_opts
+    def delete_invalid_opts(arr=@trailing_non_opts)
       stop = nil
-      @trailing_non_opts.delete_if do |e|
+      arr.delete_if do |e|
         stop ||= STOP_STRINGS.include?(e)
         invalid = e.start_with?('-') && !stop
         warn "Deleted invalid option '#{e}'" if invalid

data/lib/boson/runner.rb

@@ -33,6 +33,8 @@ module Boson
 
     def self.execute_command(cmd, args, options)
       Command.find(cmd) ? super(cmd, args) : no_command_error(cmd)
+    rescue OptionParser::Error => err
+      abort_with err.message
     end
 
     def self.display_command_help(cmd)

data/lib/boson/version.rb

@@ -1,3 +1,3 @@
 module Boson
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/test/runner_test.rb

@@ -17,7 +17,7 @@ class MyRunner < Boson::Runner
   end
 
   option :tags, :type => :array
-  option :blurg, :type => :boolean
+  option :blurg, :type => :boolean, :required => true
   desc 'This is splot'
   def splot(*args)
     p args
@@ -36,6 +36,10 @@ class MyRunner < Boson::Runner
   def quiet
   end
 
+  def explode(arg=nil)
+    {}.update
+  end
+
   def boom
     nil.boom
   end
@@ -88,12 +92,13 @@ Usage: my_command [OPTIONS] COMMAND [ARGS]
 Available commands:
   boom
   broken
-  help    Displays help for a command
-  medium  This is a medium
-  mini    This is a mini
+  explode
+  help     Displays help for a command
+  medium   This is a medium
+  mini     This is a mini
   quiet
-  small   This is a small
-  splot   This is splot
+  small    This is a small
+  splot    This is splot
   test
 
 Options:
@@ -176,6 +181,12 @@ STR
     my_command('medium 1 --spicy').chomp.should == '["1", {:spicy=>true}]'
   end
 
+  it "calls command with additional invalid option" do
+    capture_stderr {
+      my_command('medium 1 -z').chomp.should == '["1", {}]'
+    }.should == "Deleted invalid option '-z'\n"
+  end
+
   it "calls command with quoted arguments correctly" do
     my_command("medium '1 2'").chomp.should == '["1 2", {}]'
   end
@@ -199,6 +210,13 @@ STR
     Boson.in_shell = nil
   end
 
+  it "prints error for command with option parse error" do
+    MyRunner.expects(:abort).with <<-STR.chomp
+my_command: no value provided for required option 'blurg'
+STR
+    my_command('splot 1')
+  end
+
   it "executes custom global option" do
     # setup goes here to avoid coupling to other runner
     ExtendedRunner::GLOBAL_OPTIONS[:version] = {
@@ -226,10 +244,14 @@ STR
     assert_error(NoMethodError) { my_command('boom') }
   end
 
-  it "allows no method error in command" do
+  it "allows argument error in command" do
     assert_error(ArgumentError) { my_command('broken') }
   end
 
+  it "allows argument error in command with optional args" do
+    assert_error(ArgumentError) { my_command('explode') }
+  end
+
   it "prints error message for private method" do
     MyRunner.expects(:abort).with %[my_command: Could not find command "no_run"]
     my_command('no_run').should == ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boson
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-18 00:00:00.000000000 Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70095971880980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.10.4
   type: :development
   prerelease: false
-  version_requirements: *70095971880980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70095971880140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70095971880140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: mocha-on-bacon
-  requirement: &70095971878980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095971878980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bacon-bits
-  requirement: &70095971878240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095971878240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bahia
-  requirement: &70095971877400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70095971877400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: Boson is a modular command/task framework. Thanks to its rich set of
   plugins, it differentiates itself from rake and thor by being usable from irb and
   the commandline, having optional automated views generated by hirb and allowing
@@ -140,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: A command/task framework similar to rake and thor that opens your ruby universe