boson 0.2.1 → 0.2.2

data/lib/boson/scientist.rb

@@ -33,7 +33,6 @@ module Boson
     extend self
     # Handles all Scientist errors.
     class Error < StandardError; end
-    class EscapeGlobalOption < StandardError; end
 
     attr_accessor :global_options, :rendered
     @no_option_commands ||= []
@@ -83,36 +82,63 @@ module Boson
       @option_commands[cmd] ||= OptionCommand.new(cmd)
     end
 
-    def translate_and_render(obj, command, args)
-      @global_options, @command = {}, command
-      args = translate_args(obj, command, args)
-      if @global_options[:verbose] || @global_options[:pretend]
-        puts "Arguments: #{args.inspect}", "Global options: #{@global_options.inspect}"
-      end
-      return @rendered = true if @global_options[:pretend]
-      render_or_raw yield(args)
-    rescue EscapeGlobalOption
-      Boson.invoke(:usage, command.name, :verbose=>@global_options[:verbose]) if @global_options[:help]
+    def call_original_command(args, &block)
+      block.call(args)
+    end
+
+    def translate_and_render(obj, command, args, &block)
+      @global_options, @command, original_args = {}, command, args.dup
+      args = translate_args(obj, args)
+      return run_help_option if @global_options[:help]
+      run_pretend_option(args)
+      render_or_raw call_original_command(args, &block) unless @global_options[:pretend]
+    rescue OptionCommand::CommandArgumentError
+      run_pretend_option(args ||= [])
+      return if !@global_options[:pretend] && run_verbose_help(option_command, original_args)
+      raise unless @global_options[:pretend]
     rescue OptionParser::Error, Error
-      $stderr.puts "Error: " + $!.message
+      raise if Runner.in_shell?
+      message = @global_options[:verbose] ? "#{$!}\n#{$!.backtrace.inspect}" : $!.message
+      $stderr.puts "Error: " + message
     end
 
-    def translate_args(obj, command, args)
-      option_command.prepend_default_option(args)
+    def translate_args(obj, args)
+      option_command.modify_args(args)
       @global_options, parsed_options, args = option_command.parse(args)
-      raise EscapeGlobalOption if @global_options[:help]
+      return if @global_options[:help]
+
+      (@global_options[:delete_options] || []).map {|e|
+        @global_options.keys.map {|k| k.to_s }.grep(/^#{e}/)
+      }.flatten.each {|e| @global_options.delete(e.to_sym) }
+
       if parsed_options
         option_command.add_default_args(args, obj)
-        return args if @no_option_commands.include?(command)
+        return args if @no_option_commands.include?(@command)
         args << parsed_options
         option_command.check_argument_size(args)
       end
       args
-    rescue Error, ArgumentError, EscapeGlobalOption
-      raise
-    rescue Exception
-      message = @global_options[:verbose] ? "#{$!}\n#{$!.backtrace.inspect}" : $!.message
-      raise Error, message
+    end
+
+    def run_verbose_help(option_command, original_args)
+      global_opts = option_command.parse_global_options(original_args)
+      if global_opts[:help] && global_opts[:verbose]
+        @global_options = global_opts
+        run_help_option
+        return true
+      end
+      false
+    end
+
+    def run_help_option
+      Boson.invoke(:usage, @command.name, :verbose=>@global_options[:verbose])
+    end
+
+    def run_pretend_option(args)
+      if @global_options[:verbose] || @global_options[:pretend]
+        puts "Arguments: #{args.inspect}", "Global options: #{@global_options.inspect}"
+      end
+      @rendered = true if @global_options[:pretend]
     end
 
     def render_or_raw(result)
@@ -123,9 +149,8 @@ module Boson
       else
         Pipe.process(result, @global_options)
       end
-    rescue Exception
-      message = @global_options[:verbose] ? "#{$!}\n#{$!.backtrace.inspect}" : $!.message
-      raise Error, message
+    rescue StandardError
+      raise Error, $!.message, $!.backtrace
     end
 
     def render?

data/lib/boson/view.rb

@@ -66,6 +66,14 @@ module Boson
     end
 
     #:stopdoc:
+    def class_config(klass)
+      opts = (Hirb::View.formatter_config[klass] || {}).dup
+      opts.delete(:ancestor)
+      opts.merge!((opts.delete(:options) || {}).dup)
+      OptionParser.make_mergeable!(opts)
+      opts
+    end
+
     def toggle_pager
       Hirb::View.toggle_pager
     end

data/test/argument_inspector_test.rb

@@ -7,6 +7,10 @@ module Boson
         ArgumentInspector.scrape_with_text(file_string, "blah")
       end
 
+      test "parses arguments of class method" do
+        args_from("    def YAML.blah( filepath )\n").should == [['filepath']]
+      end
+
       test "parses arguments with no spacing" do
         args_from("def bong; end\ndef blah(arg1,arg2='val2')\nend").should == [["arg1"], ['arg2', "'val2'"]]
       end

data/test/bin_runner_test.rb

@@ -55,8 +55,8 @@ module Boson
       end
 
       test "global option takes value with whitespace" do
-        View.expects(:render).with(anything, {:vertical=>true, :fields => [:name, :lib]}, anything)
-        start('commands', '-g', 'f=name,lib vertical')
+        View.expects(:render).with {|*args| args[1][:fields] = %w{f1 f2} }
+        start('commands', '-f', 'f1, f2')
       end
 
       test "execute option errors are caught" do

data/test/file_library_test.rb

@@ -30,8 +30,10 @@ module Boson
         command_exists?('blah')
       end
 
-      test "prints error for file library with no module" do
-        capture_stderr { load(:blah, :file_string=>"def blah; end") }.should =~ /Can't.*at least/
+      test "loads a plugin library by creating its module" do
+        load(:blah, :file_string=>"def blah; end")
+        library_has_module('blah', "Boson::Commands::Blah")
+        command_exists?('blah', false)
       end
 
       test "prints error for file library with multiple modules" do

data/test/loader_test.rb

@@ -18,20 +18,20 @@ module Boson
 
       # if this test fails, other exists? using methods fail
       test "from callback recursively merges with user's config" do
-        with_config(:libraries=>{'blah'=>{:commands=>{'bling'=>{:description=>'bling', :options=>{:num=>3}}}}}) do
+        with_config(:libraries=>{'blah'=>{:commands=>{'bling'=>{:desc=>'bling', :options=>{:num=>3}}}}}) do
           File.stubs(:exists?).returns(true)
           load :blah, :file_string=> "module Blah; def self.config; {:commands=>{'blang'=>{:alias=>'ba'}, " +
             "'bling'=>{:options=>{:verbose=>:boolean}}}}; end; end"
           library('blah').command_object('bling').options.should == {:verbose=>:boolean, :num=>3}
-          library('blah').command_object('bling').description.should == 'bling'
+          library('blah').command_object('bling').desc.should == 'bling'
           library('blah').command_object('blang').alias.should == 'ba'
         end
       end
 
       test "non-hash from inspector overridden by user's config" do
-        with_config(:libraries=>{'blah'=>{:commands=>{'bling'=>{:description=>'already'}}}}) do
+        with_config(:libraries=>{'blah'=>{:commands=>{'bling'=>{:desc=>'already'}}}}) do
           load :blah, :file_string=>"module Blah; #from file\ndef bling; end; end"
-          library('blah').command_object('bling').description.should == 'already'
+          library('blah').command_object('bling').desc.should == 'already'
         end
       end
 

data/test/option_parser_test.rb

@@ -116,7 +116,12 @@ module Boson
       parse("--no-f")["foo"].should == false
       parse("--foo")["foo"].should == true
     end
-    
+
+    it "accepts --[no-]opt variant for single letter booleans" do
+      create :e=>true
+      parse("--no-e")[:e].should == false
+    end
+
     it "will prefer 'no-opt' variant over inverting 'opt' if explicitly set" do
       create "--no-foo" => true
       parse("--no-foo")["no-foo"].should == true
@@ -166,6 +171,13 @@ module Boson
       @opt.non_opts.should == ["foo", "bar", "--baz", "-T", "bang"]
     end
 
+    it "stopped by --" do
+      create :foo=>:boolean, :dude=>:boolean
+      parse("foo", "bar", "--", "-f").should == {}
+      @opt.leading_non_opts.should == %w{foo bar}
+      @opt.trailing_non_opts.should == %w{-- -f}
+    end
+
     context "with parse flag" do
       it ":delete_invalid_opts deletes and warns of invalid options" do
         create(:foo=>:boolean)
@@ -175,6 +187,16 @@ module Boson
         @opt.non_opts.should == ['ok']
       end
 
+      it ":delete_invalid_opts deletes until - or --" do
+        create(:foo=>:boolean, :bar=>:boolean)
+        %w{- --}.each do |stop_char|
+          capture_stderr {
+            @opt.parse(%w{ok -b -d} << stop_char << '-f', :delete_invalid_opts=>true)
+          }.should =~ /'-d'/
+          @opt.non_opts.should == %w{ok -d} << stop_char << '-f'
+        end
+      end
+
       it ":opts_before_args only allows options before args" do
         create(:foo=>:boolean)
         @opt.parse(%w{ok -f}, :opts_before_args=>true).should == {}
@@ -345,7 +367,8 @@ module Boson
   context ":array type" do
     before(:all) {
       create :a=>:array, :b=>[1,2,3], :c=>{:type=>:array, :values=>%w{foo fa bar zebra}, :enum=>false},
-        :d=>{:type=>:array, :split=>" ", :values=>[:ab, :bc, :cd], :enum=>false}
+        :d=>{:type=>:array, :split=>" ", :values=>[:ab, :bc, :cd], :enum=>false},
+        :e=>{:type=>:array, :values=>%w{some so silly}, :regexp=>true}
     }
 
     it "supports array defaults" do
@@ -376,6 +399,10 @@ module Boson
       parse("-c", '*')[:c].sort.should == %w{bar fa foo zebra}
       parse("-c", '*,ok')[:c].sort.should == %w{bar fa foo ok zebra}
     end
+
+    it "aliases correctly with :regexp on" do
+      parse("-e", 'so')[:e].sort.should == %w{so some}
+    end
   end
 
   context ":hash type" do

data/test/runner_test.rb

@@ -35,7 +35,7 @@ module Boson
         start(:autoload_libraries=>true)
         Index.expects(:read)
         Index.expects(:find_library).with('blah').returns('blah')
-        Manager.expects(:load).with('blah', :verbose=>true)
+        Manager.expects(:load).with('blah', :verbose=>nil)
         Boson.main_object.blah
       end
     end

data/test/scientist_test.rb

@@ -25,6 +25,7 @@ module Boson
       end
       @opt_cmd = Object.new.extend Blah
     }
+    after(:all) { Runner.in_shell = false }
 
     def command(hash, args)
       hash = {:name=>'blah', :lib=>'bling', :options=>{:force=>:boolean, :level=>2}}.merge(hash)
@@ -131,18 +132,13 @@ module Boson
           capture_stderr { command_with_args('a1 -l') }.should =~ /Error.*level/
         end
 
-        test "with unexpected error in translation" do
-          Scientist.expects(:option_command).raises("unexpected")
-          capture_stderr { command_with_args('a1') }.should =~ /Error.*unexpected/
-        end
-
         test "with unexpected error in render" do
           Scientist.expects(:render?).raises("unexpected")
           capture_stderr { command_with_args('a1') }.should =~ /Error.*unexpected/
         end
 
         test "with no argument defined for options" do
-          assert_error(ArgumentError, '2 for 1') { command({:args=>1}, 'ok') }
+          assert_error(OptionCommand::CommandArgumentError, '2 for 1') { command({:args=>1}, 'ok') }
         end
       end
 
@@ -170,17 +166,17 @@ module Boson
         capture_stdout { command_with_args("-p ok") } =~ /Arguments.*ok/
       end
 
-      test "with not enough args raises ArgumentError" do
-        args = [ArgumentError, '0 for 1']
+      test "with not enough args raises CommandArgumentError" do
+        args = [OptionCommand::CommandArgumentError, '0 for 1']
         assert_error(*args) { command_with_args }
         assert_error(*args) { command_with_args '' }
         assert_error(*args) { command_with_arg_size }
         assert_error(*args) { command_with_arg_size '' }
       end
 
-      test "with too many args raises ArgumentError" do
+      test "with too many args raises CommandArgumentError" do
         args3 = [ArgumentError, '3 for 2']
-        args4 = [ArgumentError, '4 for 2']
+        args4 = [OptionCommand::CommandArgumentError, '4 for 2']
         assert_error(*args3) { command_with_args 1,2,3 }
         assert_error(*args4) { command_with_args '1 2 3' }
         assert_error(*args3) { command_with_arg_size 1,2,3 }
@@ -252,7 +248,7 @@ module Boson
       end
 
       test "parses normally from cmdline" do
-        Boson.expects(:const_defined?).returns true
+        Runner.expects(:in_shell?).times(2).returns true
         command(@cmd_attributes, ['--force', '--level=3']).should == {:level=>3, :force=>true}
       end
 
@@ -269,7 +265,7 @@ module Boson
       end
 
       test "prepends correctly from cmdline" do
-        Boson.expects(:const_defined?).returns true
+        Runner.expects(:in_shell?).times(2).returns true
         command(@cmd_attributes, ['3','-f']).should == {:level=>3, :force=>true}
       end
     end
@@ -307,6 +303,11 @@ module Boson
         end
       end
 
+      test "delete_options deletes global options" do
+        local_and_global('--delete_options=r,p -rp -f').should ==
+          [{:foo=>true}, {:delete_options=>["r", "p"]}]
+      end
+
       test "global option after local one is invalid" do
         args_arr = ['-f --dude', '-f doh --dude', '-f --dude doh', [:doh, '-f --dude'] ]
         args_arr.each_with_index do |args, i|
@@ -317,12 +318,16 @@ module Boson
         end
       end
 
-      test "--global option adds additional global options" do
-        local_and_global('-g=d -d').should == [{:do=>true}, {:dude=>true, :global=>'d'}]
-        local_and_global('-g "r dude" -d').should == [{:do=>true},
-          {:global=>"r dude", :dude=>true, :render=>true}]
+      test "global option after local one and -" do
+        local_and_global("doh -r -f - --dude").should == [{:foo=>true}, {:dude=>true, :render=>true}]
       end
-    end
 
+      test "no options parsed after --" do
+        local_and_global('doh -f -- -r').should == [{:foo=>true}, {}]
+        local_and_global('doh -- -r -f').should == [{}, {}]
+        local_and_global('-- -r -f').should == [{}, {}]
+        local_and_global('doh -r -- -f').should == [{}, {:render=>true}]
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: boson
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 -05:00
+date: 2010-01-23 00:00:00 -05:00
 default_executable: boson
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,7 +81,6 @@ files:
 - test/argument_inspector_test.rb
 - test/bin_runner_test.rb
 - test/comment_inspector_test.rb
-- test/config/index.marshal
 - test/file_library_test.rb
 - test/loader_test.rb
 - test/manager_test.rb