visionmedia-commander 2.5.7 → 3.0.0

data/lib/commander/user_interaction.rb

@@ -11,19 +11,14 @@ module Commander
   
   module UI
     
-    ##
-    # Format used within #log.
-    
-    LOG_FORMAT = "%15s  %s"
-    
     ##
     # Ask the user for a password. Specify a custom
-    # _msg_ other than 'Password: ' or override the 
+    # +message+ other than 'Password: ' or override the 
     # default +mask+ of '*'.
     
-    def password msg = "Password: ", mask = '*'
-      pass = ask(msg) { |q| q.echo = mask }
-      pass = password msg, mask if pass.empty?
+    def password message = 'Password: ', mask = '*'
+      pass = ask(message) { |q| q.echo = mask }
+      pass = password message, mask if pass.empty?
       pass
     end
     
@@ -35,11 +30,9 @@ module Commander
     #   remove  path/to/old_file.rb
     #   remove  path/to/old_file2.rb
     #
-    # To alter this format simply change the Commander::UI::LOG_FORMAT
-    # constant to whatever you like.
     
     def log action, *args
-      say LOG_FORMAT % [action, args.join(' ')]
+      say '%15s  %s' % [action, args.join(' ')]
     end
     
     ##
@@ -48,33 +41,34 @@ module Commander
     # Terminal progress bar utility. In its most basic form
     # requires that the developer specifies when the bar should
     # be incremented. Note that a hash of tokens may be passed to
-    # #increment, (or returned when using Kernel#progress).
+    # #increment, (or returned when using Object#progress).
     #
-    #    uris = %w( 
-    #      http://vision-media.ca
-    #      http://yahoo.com
-    #      http://google.com
-    #      )
+    #   uris = %w( 
+    #     http://vision-media.ca
+    #     http://yahoo.com
+    #     http://google.com
+    #     )
+    #   
+    #   bar = Commander::UI::ProgressBar.new uris.length, options
+    #   threads = []
+    #   uris.each do |uri|
+    #     threads << Thread.new do
+    #       begin
+    #         res = open uri
+    #         bar.increment :uri => uri
+    #       rescue Exception => e
+    #         bar.increment :uri => "#{uri} failed"
+    #       end
+    #     end
+    #   end
+    #   threads.each { |t| t.join }
     #
-    #    bar = Commander::UI::ProgressBar.new uris.length, options
-    #    threads = []
-    #    uris.each do |uri|
-    #      threads << Thread.new do
-    #        begin
-    #          res = open uri
-    #          bar.increment :uri => uri
-    #        rescue Exception => e
-    #          bar.increment :uri => "#{uri} failed"
-    #        end
-    #      end
-    #    end
-    #    threads.each { |t| t.join }
+    # The Object method #progress is also available:
     #
-    # The Kernel method #progress is also available:
-    #
-    #    progress uris, :width => 10 do |uri|
-    #      res = open uri
-    #    end
+    #   progress uris, :width => 10 do |uri|
+    #     res = open uri
+    #     { :uri => uri } # Can now use :uri within :format option
+    #   end
     #
 
     class ProgressBar
@@ -171,14 +165,12 @@ module Commander
       # Output the progress bar.
 
       def show
-        # TODO: shift steps stack instead
         unless finished?
           erase_line
           if completed?
-            puts @complete_message.tokenize(generate_tokens) if @complete_message.is_a? String
+            $terminal.say @complete_message.tokenize(generate_tokens) if @complete_message.is_a? String
           else
-            print @format.tokenize(generate_tokens)
-            $stdout.flush
+            $terminal.say @format.tokenize(generate_tokens) << ' '
           end
         end
       end
@@ -211,7 +203,8 @@ module Commander
       # Erase previous terminal line.
 
       def erase_line
-        print "\r\e[K"
+        # highline does not expose the output stream
+        $terminal.instance_variable_get('@output').print "\r\e[K"
       end
 
       ##
@@ -226,7 +219,8 @@ module Commander
       #
       # === See:
       #
-      # * Kernel#progress
+      # * Object#progress
+      #
 
       def self.progress arr, options = {}, &block
         bar = ProgressBar.new arr.length, options

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '2.5.7'
+  VERSION = '3.0.0'
 end

data/spec/command_spec.rb

@@ -0,0 +1,128 @@
+
+describe Commander::Command do
+  
+  before :each do
+    mock_terminal
+    create_test_command
+  end
+  
+  describe "#seperate_switches_from_description" do
+    it "should seperate switches and description returning both" do
+      switches, description = *@command.seperate_switches_from_description('-h', '--help', 'display help')
+      switches.should == ['-h', '--help']
+      description.should == 'display help'
+    end
+  end
+    
+  describe "#option" do
+    it "should add options" do
+      lambda { @command.option '--recursive' }.should change(@command.options, :length).from(2).to(3)
+    end
+    
+    it "should allow procs as option handlers" do
+      @command.option('--recursive') { |recursive| recursive.should be_true }
+      @command.run '--recursive'
+    end
+  end
+    
+  describe "#options" do
+  	it "should distinguish between switches and descriptions" do
+  	  @command.option '-t', '--trace', 'some description'
+  	  @command.options[2][:description].should == 'some description'
+  	  @command.options[2][:switches].should == ['-t', '--trace']
+  	end
+  end
+  
+  describe "#switch_to_sym" do
+    it "should return a symbol based on the switch name" do
+      @command.switch_to_sym('--trace').should == :trace
+      @command.switch_to_sym('--foo-bar').should == :foo_bar
+      @command.switch_to_sym('--[no-]feature"').should == :feature
+      @command.switch_to_sym('--[no-]feature ARG').should == :feature
+      @command.switch_to_sym('--file [ARG]').should == :file
+      @command.switch_to_sym('--colors colors').should == :colors
+    end
+  end
+  
+  describe "#run" do
+    describe "should invoke #when_called" do
+      it "with arguments seperated from options" do
+        @command.when_called { |args, options| args.join(' ').should == 'just some args' }  
+        @command.run '--trace', 'just', 'some', 'args'
+      end
+      
+      it "calling the #call method by default when an object is called" do
+        object = mock 'Object'
+        object.should_receive(:call).with(an_instance_of(Array), an_instance_of(Commander::Command::Options)).once
+        @command.when_called object
+        @command.run 'foo'        
+      end
+            
+      it "calling an arbitrary method when an object is called" do
+        object = mock 'Object'
+        object.should_receive(:foo).with(an_instance_of(Array), an_instance_of(Commander::Command::Options)).once
+        @command.when_called object, :foo
+        @command.run 'foo'        
+      end
+      
+      it "should raise an error when no handler is present" do
+        lambda { @command.when_called }.should raise_error(ArgumentError)
+      end
+    end
+    
+    describe "should populate options with" do
+      it "boolean values" do
+        @command.option '--[no-]toggle'
+        @command.when_called { |_, options| options.toggle.should be_true }  
+        @command.run '--toggle'
+        @command.when_called { |_, options| options.toggle.should be_false }  
+        @command.run '--no-toggle'
+      end
+
+      it "manditory arguments" do
+        @command.option '--file FILE'
+        @command.when_called { |_, options| options.file.should == 'foo' }  
+        @command.run '--file', 'foo'
+        lambda { @command.run '--file' }.should raise_error(OptionParser::MissingArgument)
+      end  
+
+      it "optional arguments" do
+        @command.option '--use-config [file] '
+        @command.when_called { |_, options| options.use_config.should == '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 == 5 }  
+        @command.run '--interval', '5'
+        lambda { @command.run '--interval', 'invalid' }.should raise_error(OptionParser::InvalidArgument)
+      end
+      
+      it "lists" do
+        @command.option '--fav COLORS', Array
+        @command.when_called { |_, options| options.fav.should == ['red', 'green', 'blue'] }  
+        @command.run '--fav', 'red,green,blue'
+      end
+      
+      it "lists with multi-word items" do
+        @command.option '--fav MOVIES', Array
+        @command.when_called { |_, options| options.fav.should == ['super\ bad', 'nightmare'] }  
+        @command.run '--fav', 'super\ bad,nightmare'        
+      end
+      
+      it "defaults" do
+        @command.option '--files LIST', Array
+        @command.option '--interval N', Integer
+        @command.when_called do |_, options|
+          options.default \
+            :files => ['foo', 'bar'],
+            :interval => 5
+          options.files.should == ['foo', 'bar']
+          options.interval.should == 15
+        end
+        @command.run '--interval', '15'
+      end
+    end
+  end
+  
+end

data/spec/core_ext/array_spec.rb

@@ -0,0 +1,20 @@
+
+describe Array do
+  
+  describe "#delete_switches" do
+    it "should delete switches such as -h or --help, returning a new array" do
+      ['foo', '-h', 'bar', '--help'].delete_switches.should == ['foo', 'bar']
+    end
+  end
+  
+  describe "#parse" do
+    it "should seperate a list of words into an array" do
+      Array.parse('just a test').should == ['just', 'a', 'test']
+    end
+    
+    it "should preserve escaped whitespace" do
+      Array.parse('just a\ test').should == ['just', 'a test']
+    end
+  end
+
+end

data/spec/{import_spec.rb → core_ext/object_spec.rb}

@@ -1,13 +1,20 @@
-describe Kernel do
+
+describe Object do
   
+  describe "#get_binding" do
+    it "should return the objects binding" do
+      lambda {}.get_binding.should be_instance_of(Binding)
+    end
+  end
+
   describe "#method_missing" do
     it "should preserve its original behavior for missing methods" do
       lambda { i_am_a_missing_method() }.should raise_error(NoMethodError)
     end
-    
+
     it "should preserve its original behavior for missing variables" do
       lambda { i_am_a_missing_variable }.should raise_error(NameError)
     end
   end
-  
+
 end

data/spec/help_formatter_spec.rb

@@ -2,30 +2,30 @@
 describe Commander::HelpFormatter do
   
   before :each do
-    @input = StringIO.new
-    @output = StringIO.new
-    $terminal = HighLine.new @input, @output
+    mock_terminal
+  end
+  
+  def run *args
+    new_command_runner *args do
+      program :help_formatter, Commander::HelpFormatter::Base
+    end.run!    
+    @output.string
   end
   
   it "should display global help using --help switch" do
-    new_command_runner '--help'
-    program :help_formatter, Commander::HelpFormatter::Base
-    command_runner.run!
-    @output.string.should eql("Implement global help here\n")
+    run('--help').should == "Implement global help here\n"
   end
   
   it "should display global help using help command" do
-    new_command_runner 'help'
-    program :help_formatter, Commander::HelpFormatter::Base
-    command_runner.run!
-    @output.string.should eql("Implement global help here\n")
+    run('help').should == "Implement global help here\n"
   end
   
   it "should display command help" do
-    new_command_runner 'help', 'test'
-    program :help_formatter, Commander::HelpFormatter::Base
-    command_runner.run!
-    @output.string.should eql("Implement help for test here\n")
+    run('help', 'test').should == "Implement help for test here\n"
+  end
+  
+  it "should display command help using --help switch" do
+    run('--help', 'test').should == "Implement help for test here\n"
   end
       
 end

data/spec/runner_spec.rb

@@ -0,0 +1,168 @@
+
+describe Commander do
+  
+	before :each do
+    mock_terminal
+	  create_test_command
+	end
+	
+  describe "#program" do
+    it "should set / get program information" do
+      program :name, 'test'
+  	  program(:name).should == 'test'
+    end
+    
+    it "should allow arbitrary blocks of global help documentation" do
+      program :help, 'Copyright', 'TJ Holowaychuk'
+  	  program(:help)['Copyright'].should == 'TJ Holowaychuk'
+    end
+    
+    it "should raise an error when required info has not been set" do
+      new_command_runner '--help'
+  	  program :name, ''
+      lambda { run! }.should raise_error(Commander::Runner::CommandError)
+    end
+  end
+  
+  describe "#command" do
+  	it "should return a command instance when only the name is passed" do
+  	  command(:test).should be_instance_of(Commander::Command)
+  	end
+    
+    it "should raise InvalidCommandError when the command does not exist" do
+      lambda { command(:im_not_real) }.should raise_error(Commander::Runner::InvalidCommandError)
+    end
+  end
+  
+  describe "--version" do
+    it "should output program version" do
+      new_command_runner '--version' do
+        program :help_formatter, Commander::HelpFormatter::Base
+      end.run!
+      @output.string.should == "test 1.2.3\n"
+    end
+  end
+  
+  describe "--help" do
+    it "should not output an invalid command message" do
+      new_command_runner('--help').run!
+      @output.string.should_not == "invalid command. Use --help for more information\n"
+    end
+  end
+  
+  describe "with invalid options" do
+    it "should output an invalid option message" do
+      new_command_runner('test', '--invalid-option').run!
+      @output.string.should == "invalid option: --invalid-option\n"
+    end
+  end
+  
+  describe "with invalid sub-command passed" do
+    it "should output an invalid command message" do
+      new_command_runner('foo').run!
+      @output.string.should == "invalid command. Use --help for more information\n"
+    end
+  end
+  
+  describe "with invalid sub-command passed to help" do
+    it "should output an invalid command message" do
+      new_command_runner('help', 'does_not_exist').run!
+      @output.string.should == "invalid command. Use --help for more information\n"
+    end
+  end
+  
+  describe "#valid_command_names_from" do
+    it "should return array of valid command names" do
+      command('foo bar') {}
+   	  command('foo bar foo') {}
+   	  command_runner.valid_command_names_from('foo', 'bar', 'foo').should == ['foo bar', 'foo bar foo']
+    end
+    
+    it "should return empty array when no possible command names exist" do
+   	  command_runner.valid_command_names_from('fake', 'command', 'name').should == []
+    end
+  end
+  
+  describe "#command_name_from_args" do
+    it "should locate command within arbitrary arguments passed" do
+   	  new_command_runner '--help', '--arbitrary', 'test'
+   	  command_runner.command_name_from_args.should == 'test'
+    end
+    
+    it "should support multi-word commands" do
+   	  new_command_runner '--help', '--arbitrary', 'some', 'long', 'command', 'foo'
+   	  command('some long command') {}
+   	  command_runner.command_name_from_args.should == 'some long command'
+    end
+    
+    it "should match the longest possible command" do
+   	  new_command_runner '--help', '--arbitrary', 'foo', 'bar', 'foo'
+   	  command('foo bar') {}
+   	  command('foo bar foo') {}
+   	  command_runner.command_name_from_args.should == 'foo bar foo'      
+    end
+  end
+  
+  describe "#active_command" do
+    it "should resolve the active command" do
+      new_command_runner '--help', 'test'
+      command_runner.active_command.should be_instance_of(Commander::Command)
+    end
+    
+    it "should resolve active command when invalid options are passed" do
+      new_command_runner '--help', 'test', '--arbitrary'
+      command_runner.active_command.should be_instance_of(Commander::Command)
+    end
+    
+    it "should raise invalid command error when the command is not found" do
+      new_command_runner 'foo'
+      lambda { command_runner.active_command }.should raise_error(Commander::Runner::InvalidCommandError)
+    end
+  end
+  
+  describe "should function correctly" do
+    it "when options are passed before the command name" do
+      new_command_runner '--trace', 'test', 'foo', 'bar' do
+        @command.when_called do |args, options|
+          args.should == ['foo', 'bar']
+          options.trace.should be_true
+        end
+      end.run!
+    end
+
+    it "when options are passed after the command name" do
+      new_command_runner 'test', '--trace', 'foo', 'bar' do
+        @command.when_called do |args, options|
+          args.should == ['foo', 'bar']
+          options.trace.should be_true
+        end
+      end.run!
+    end
+
+    it "when an argument passed is the same name as the command" do
+      new_command_runner 'test', '--trace', 'foo', 'test', 'bar' do
+        @command.when_called do |args, options|
+          args.should == ['foo', 'test', 'bar']
+          options.trace.should be_true
+        end
+      end.run!
+    end
+    
+    it "when using multi-word commands" do
+      new_command_runner '--trace', 'my', 'command', 'something', 'foo', 'bar' do
+        command('my command') {}
+        command_runner.command_name_from_args.should == 'my command'
+        command_runner.args_without_command_name.should == ['--trace', 'something', 'foo', 'bar']
+      end.run!
+    end
+
+    it "when using multi-word commands with parts of the command name as arguments" do
+      new_command_runner '--trace', 'my', 'command', 'something', 'my', 'command' do
+        command('my command') {}
+        command_runner.command_name_from_args.should == 'my command'
+        command_runner.args_without_command_name.should == ['--trace', 'something', 'my', 'command']
+      end.run!
+    end
+  end
+  
+end