boson 0.4.0 → 1.0.0

data/test/method_inspector_test.rb

@@ -1,22 +1,28 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe "MethodInspector" do
+  before { MethodInspector.instance = nil }
+
+  def method_inspector
+    MethodInspector.instance
+  end
+
   it "non commands module can't set anything" do
+    remove_constant :Blah
     eval "module Blah; end"
-    MethodInspector.current_module = Blah
+    method_inspector.current_module = Blah
     Inspector.enable
     Blah.module_eval("desc 'test'; def test; end; options :a=>1; def test2; end")
     Inspector.disable
-    MethodInspector.store[:desc].empty?.should == true
-    MethodInspector.store[:options].empty?.should == true
+    method_inspector.store[:desc].empty?.should == true
+    method_inspector.store[:options].empty?.should == true
   end
 
   it "handles anonymous classes" do
-    MethodInspector.mod_store = {}
     Inspector.enable
     Class.new.module_eval "def blah; end"
     Inspector.disable
-    MethodInspector.store.should == nil
+    method_inspector.store.should == nil
   end
 
   describe "commands module with" do
@@ -24,11 +30,10 @@ describe "MethodInspector" do
       Inspector.enable
       ::Boson::Commands::Zzz.module_eval(string)
       Inspector.disable
-      MethodInspector.store
+      method_inspector.store
     end
 
     before_all { eval "module ::Boson::Commands::Zzz; end" }
-    before { MethodInspector.mod_store.delete(::Boson::Commands::Zzz) }
 
     it "desc sets descriptions" do
       parsed = parse "desc 'test'; def m1; end; desc 'one'; desc 'more'; def m2; end"
@@ -54,37 +59,8 @@ describe "MethodInspector" do
         {"zee"=>{:z=>:string}}
     end
 
-    it "render_options sets render_options" do
-      parse("render_options :z=>true; def zee; end")[:render_options].should == {"zee"=>{:z=>true}}
-    end
-
     it "config sets config" do
       parse("config :z=>true; def zee; end")[:config].should == {"zee"=>{:z=>true}}
     end
-
-    it "not all method attributes set causes method_locations to be set" do
-      MethodInspector.stubs(:find_method_locations).returns(["/some/path", 10])
-      parsed = parse "desc 'yo'; def yo; end; options :yep=>1; def yep; end; " +
-        "option :b, :boolean; render_options :a=>1; config :a=>1; desc 'z'; options :a=>1; def az; end"
-      parsed[:method_locations].key?('yo').should == true
-      parsed[:method_locations].key?('yep').should == true
-      parsed[:method_locations].key?('az').should == false
-    end
-
-    it "no find_method_locations doesn't set method_locations" do
-      MethodInspector.stubs(:find_method_locations).returns(nil)
-      parse("def bluh; end")[:method_locations].key?('bluh').should == false
-    end
-
-    it "options calls scrape_with_eval" do
-      ArgumentInspector.expects(:scrape_with_eval).returns([['arg1']])
-      parse("desc 'desc'; options :some=>:opts; def doy(arg1); end")[:args]['doy'].should == [['arg1']]
-    end
-
-    it "options in file calls scrape_with_eval" do
-      MethodInspector.expects(:inspector_in_file?).returns(true)
-      ArgumentInspector.expects(:scrape_with_eval).returns([['arg1']])
-      parse("desc 'desc'; def doz(arg1); end")[:args]['doz'].should == [['arg1']]
-    end
   end
 end

data/test/option_parser_test.rb

@@ -6,36 +6,28 @@ describe "OptionParser" do
   end
 
   def opt; @opt; end
-  
+
   def parse(*args)
     @non_opts = []
     opt.parse(args.flatten)
   end
 
-  describe "IndifferentAccessHash" do
+  describe "#indifferent_hash" do
     before {
-      @hash = IndifferentAccessHash.new 'foo' => 'bar', 'baz' => 'bee'
+      @hash = OptionParser.new({}).indifferent_hash
+      @hash.update foo: 'bar'
     }
+
     it "can access values indifferently" do
       @hash['foo'].should == 'bar'
       @hash[:foo].should  == 'bar'
-      @hash.values_at(:foo, :baz).should == ['bar', 'bee']
-    end
-
-    it "can be initialized with either strings or symbols and be equal" do
-      hash2 = IndifferentAccessHash.new :foo=>'bar', :baz=>'bee'
-      @hash.should == hash2
-    end
-
-    it "returns keys as symbols by default" do
-      @hash.should == {:foo=>'bar', :baz=>'bee'}
     end
 
-    it "can set values indifferently" do
-      @hash['foo'] = 'duh'
-      @hash[:foo].should == 'duh'
-      @hash[:baz] = 'wasp'
-      @hash['baz'].should == 'wasp'
+    it "cannot set values indifferently" do
+      @hash['foo'] = 'barred'
+      @hash['foo'].should == 'barred'
+      @hash[:foo].should_not == 'barred'
+      @hash[:foo].should == 'bar'
     end
   end
 
@@ -49,7 +41,7 @@ describe "OptionParser" do
       create :verbose=>:boolean, :vertical=>:string, :verz=>:boolean
       parse('-v', '-V','2').should == {:verbose=>true, :vertical=>'2'}
     end
-    
+
     it "doesn't auto-alias options that have multiple names given" do
       create ["--foo", "--bar"] => :boolean
       parse("-f")["foo"].should == nil
@@ -61,14 +53,14 @@ describe "OptionParser" do
       parse("--bar", "12")[:foo].should == "12"
       parse("--baz", "12")[:foo].should == "12"
     end
-    
+
     it "allows multiple aliases for a given opt" do
       create ["--foo", "--bar", "--baz"] => :string
       parse("--foo", "12")["foo"].should == "12"
       parse("--bar", "12")["foo"].should == "12"
       parse("--baz", "12")["foo"].should == "12"
     end
-    
+
     it "allows custom short names" do
       create "-f" => :string
       parse("-f", "12").should == {:f => "12"}
@@ -89,7 +81,7 @@ describe "OptionParser" do
       create ["--bar", "-f"] => :string
       parse("-f", "12").should == {:bar => "12"}
     end
-    
+
     it "allows humanized opt name" do
       create 'foo' => :string, :bar => :string
       parse("-f", "1", "-b", "2").should == {:foo => "1", :bar => "2"}
@@ -110,7 +102,7 @@ describe "OptionParser" do
       parse("-f", "1").should == {:f => "1"}
       parse("--f", "1").should == {}
     end
-    
+
     it "accepts --[no-]opt variant for booleans, setting false for value" do
       create "--foo" => :boolean
       parse("--no-foo")["foo"].should == false
@@ -127,7 +119,7 @@ describe "OptionParser" do
       create "--no-foo" => true
       parse("--no-foo")["no-foo"].should == true
     end
-    
+
   end
 
   describe "option values can be set with" do
@@ -138,12 +130,12 @@ describe "OptionParser" do
       parse("--foo=bar=baz")["foo"].should == "bar=baz"
       parse("--foo=sentence with spaces")["foo"].should == "sentence with spaces"
     end
-  
+
     it "a -nXY assignment" do
       create "--num" => :numeric
       parse("-n12")["num"].should == 12
     end
-  
+
     it "conjoined short options" do
       create "--foo" => true, "--bar" => true, "--app" => true
       opts = parse "-fba"
@@ -151,7 +143,7 @@ describe "OptionParser" do
       opts["bar"].should == true
       opts["app"].should == true
     end
-  
+
     it "conjoined short options with argument" do
       create "--foo" => true, "--bar" => true, "--app" => :numeric
       opts = parse "-fba", "12"
@@ -161,7 +153,7 @@ describe "OptionParser" do
     end
   end
 
-  describe "parse" do
+  describe "#parse" do
     it "extracts non-option arguments" do
       create "--foo" => :string, "--bar" => true
       parse("foo", "bar", "--baz", "--foo", "12", "--bar", "-T", "bang").should == {
@@ -188,7 +180,8 @@ describe "OptionParser" do
         opt.non_opts.should == ['ok']
       end
 
-      it ":delete_invalid_opts deletes until - or --" do
+      # TODO: Fix for 1.9.3
+      xit ":delete_invalid_opts deletes until - or --" do
         create(:foo=>:boolean, :bar=>:boolean)
         %w{- --}.each do |stop_char|
           capture_stderr {
@@ -295,7 +288,7 @@ describe "OptionParser" do
       parse('-f')[:foo].should == true
     end
   end
-  
+
   def usage
     opt.formatted_usage.split(" ").sort
   end
@@ -305,7 +298,7 @@ describe "OptionParser" do
       create "--repo" => :string, "--branch" => "bugfix", "-n" => 6
       usage.should == %w([--branch=bugfix] [--repo=REPO] [-n=6])
     end
-    
+
     it "outputs numeric args with 'N' as sample value" do
       create "--iter" => :numeric
       usage.should == ["[--iter=N]"]
@@ -322,6 +315,26 @@ describe "OptionParser" do
     end
   end
 
+  describe "#render_table" do
+    it "renders normal options with desc correctly" do
+      create regexp: {type: :string, desc: 'A regex, ya know'},
+        all: {type: :boolean, desc: 'Search all fields'}
+      capture_stdout { opt.print_usage_table no_headers: true }.should == <<-STR
+  -a, --all     Search all fields
+  -r, --regexp  A regex, ya know
+STR
+    end
+
+    it "renders an option without an alias correctly" do
+      create regexp: :string, reverse_sort: :boolean, reload: :boolean
+      capture_stdout { opt.print_usage_table no_headers: true }.should == <<-STR
+  -r, --regexp
+  -R, --reload
+  --reverse_sort
+STR
+    end
+  end
+
   describe "user defined option class" do
     before_all {
       ::FooBoo = Struct.new(:name)
@@ -364,4 +377,4 @@ describe "OptionParser" do
       assert_error(OptionParser::Error, "invalid.*:blah_blah") { parse("-c", 'ok') }
     end
   end
-end
+end

data/test/runner_library_test.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe "RunnerLibrary" do
+  before { reset }
+
+  it "creates a library with correct commands" do
+    Manager.load create_runner(:blah)
+    library('blarg').commands.should == ['blah']
+  end
+end

data/test/runner_test.rb

@@ -1,40 +1,170 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.dirname(__FILE__) + '/test_helper'
 
-describe "repl_runner" do
-  def start(hash={})
-    Hirb.stubs(:enable)
-    Boson.start(hash.merge(:verbose=>false))
+class MyRunner < Boson::Runner
+  desc "This is a small"
+  def small(*args)
+    p args
   end
 
-  before_all { reset }
-  before { ConsoleRunner.instance_eval("@initialized = false") }
+  option :spicy, type: :boolean, desc: 'hot'
+  desc "This is a medium"
+  def medium(arg=nil, opts={})
+    p [arg, opts]
+  end
+
+  desc "This is a mini"
+  def mini(me)
+  end
+
+  def quiet
+  end
+
+  def boom
+    nil.boom
+  end
 
-  it "loads default libraries and libraries in :console_defaults config" do
-    defaults = Runner.default_libraries + ['yo']
-    with_config(:console_defaults=>['yo']) do
-      Manager.expects(:load).with {|*args| args[0] == defaults }
-      start
+  def broken
+    raise ArgumentError
+  end
+
+  private
+  def no_run
+  end
+end
+
+describe "Runner" do
+  before_all { $0 = 'my_command'; reset }
+
+  def my_command(cmd='')
+    capture_stdout do
+      MyRunner.start cmd.split(/\s+/)
     end
   end
 
-  it "doesn't call init twice" do
-    capture_stderr { start }
-    ConsoleRunner.expects(:init).never
-    start
+  def default_usage
+    <<-STR
+Usage: my_command COMMAND [ARGS]
+
+Available commands:
+  boom
+  broken
+  medium  This is a medium
+  mini    This is a mini
+  quiet
+  small   This is a small
+
+For help on a command: my_command COMMAND -h
+STR
   end
 
-  it "loads multiple libraries with :libraries option" do
-    ConsoleRunner.expects(:init)
-    Manager.expects(:load).with([:lib1,:lib2], anything)
-    start(:libraries=>[:lib1, :lib2])
+  it "prints sorted commands by default" do
+    my_command.should == default_usage
   end
 
-  it "autoloader autoloads libraries" do
-    start(:autoload_libraries=>true)
-    Index.expects(:read)
-    Index.expects(:find_library).with('blah').returns('blah')
-    Manager.expects(:load).with('blah', anything)
-    Boson.main_object.blah
+  it "prints default usage for -h and --help" do
+    my_command('-h').should == default_usage
+    my_command('--help').should == default_usage
+  end
+
+  describe "for COMMAND -h" do
+    it "prints help for descriptionless command" do
+      my_command('quiet -h').should == <<-STR
+Usage: my_command quiet
+
+Description:
+  TODO
+STR
+    end
+
+    it "prints help for optionless command with splat args" do
+      my_command('small -h').should == <<-STR
+Usage: my_command small *ARGS
+
+Description:
+  This is a small
+STR
+    end
+
+    it "prints help for optionless command with required args" do
+      my_command('mini -h').should == <<-STR
+Usage: my_command mini ME
+
+Description:
+  This is a mini
+STR
+    end
+
+    it "prints help for command with options and optional args" do
+      my_command('medium -h').should == <<-STR
+Usage: my_command medium [ARG]
+
+Options:
+  -s, --spicy  hot
+
+Description:
+  This is a medium
+STR
+    end
+  end
+
+  it "handles command with default arguments correctly" do
+    my_command('medium').chomp.should == '[nil, {}]'
+  end
+
+  it "calls command with options correctly" do
+    my_command('medium 1 --spicy').chomp.should == '["1", {:spicy=>true}]'
+  end
+
+  it "calls optionless command correctly" do
+    my_command('small 1 2').chomp.should == '["1", "2"]'
+  end
+
+  it "calls command with too many args" do
+    MyRunner.expects(:abort).with <<-STR.chomp
+'medium' was called incorrectly.
+Usage: medium [ARG]
+STR
+    my_command('medium 1 2 3')
+  end
+
+  it "prints error message for internal public method" do
+    MyRunner.expects(:abort).with %[Could not find command "to_s"]
+    my_command('to_s').should == ''
+  end
+
+  it "prints error message for nonexistant command" do
+    MyRunner.expects(:abort).with %[Could not find command "blarg"]
+    my_command('blarg').should == ''
+  end
+
+  it "allows no method error in command" do
+    assert_error(NoMethodError) { my_command('boom') }
+  end
+
+  it "allows no method error in command" do
+    assert_error(ArgumentError) { my_command('broken') }
+  end
+
+  it "prints error message for private method" do
+    MyRunner.expects(:abort).with %[Could not find command "no_run"]
+    my_command('no_run').should == ''
+  end
+
+  describe "$BOSONRC" do
+    before { ENV.delete('BOSONRC') }
+
+    it "is not loaded by default" do
+      MyRunner.expects(:load).never
+      my_command('quiet').should == ''
+    end
+
+    it "is loaded if set" do
+      ENV['BOSONRC'] = 'whoop'
+      File.expects(:exists?).returns(true)
+      MyRunner.expects(:load).with('whoop')
+      my_command('quiet')
+    end
+
+    after_all { ENV['BOSONRC'] = File.dirname(__FILE__) + '/.bosonrc' }
   end
-  after_all { FileUtils.rm_r File.dirname(__FILE__)+'/config', :force=>true }
-end
+end