visionmedia-commander 1.2.2 → 2.4.2

data/spec/commander_spec.rb

@@ -1,42 +1,223 @@
 
 describe Commander do
-	
+  
 	before :each do
-		init_commander :version => '1.3.2', :name => 'My Program'
-		command :test_command do |c|
-			c.syntax = 'test_command [options]'
-			c.description = 'Just a test command.'
-			c.option '-h', '--help', 'View help information.'
-			c.option '--version', 'View program version.'
-			c.option '-v', '--verbose', 'Verbose output.'
-			c.example 'View help', 'test_command --help'
-			c.example 'View version', 'test_command --version'
-		end
-		@manager = Commander::Manager.instance
+    @input = StringIO.new
+    @output = StringIO.new
+    $terminal = HighLine.new @input, @output
+	  create_test_command
 	end
 	
-	it "should add commands" do
-		@manager.length.should == 1
+	it "should allow access to all commands using #commands" do
+	  commands.length.should eql(2) # our test command as well as help default
 	end
 	
-	it "should fetch commands with the #get_command method" do
-		get_command(:test_command).syntax.should == 'test_command [options]'
+	it "should set program information using #program" do
+	  program :name, "test"
+	  program :version, "1.2.3"
+	  program :description, "just a test."
+	  program(:name).should eql("test")
+	  program(:version).should eql("1.2.3")
+	  program(:description).should eql("just a test.")
 	end
 	
-	it "should test existance of a command using #command_exists?" do
-		command_exists?(:test_command).should == true
-		command_exists?(:test).should == false
+	it "should allow arbitrary blocks of global help documentation" do
+	  program :help, 'Copyright', 'TJ Holowaychuk'
+	  program(:help)['Copyright'].should eql('TJ Holowaychuk')
 	end
 	
-	it "should inialize and set the version" do
-		info(:version).should == '1.3.2'
-		info(:major).should == 1
-		info(:minor).should == 3
-		info(:tiny).should == 2
+  it "should raise an error when crutial program info is not set" do
+    new_command_runner '--help'
+	  program :name, ''
+    lambda { run! }.should raise_error(Commander::Runner::CommandError)
+  end
+  
+  it "should output program version using --version switch" do
+    new_command_runner '--version'
+    program :help_formatter, Commander::HelpFormatter::Base
+    command_runner.run!
+    @output.string.should eql("test 1.2.3\n")
+  end
+      	
+	it "should get command instances using #get_command" do
+	  get_command(:test).name.should eql('test')
 	end
 	
-	it "should set program name" do
-		info(:name).should == 'My Program'
+	it "should assign options" do
+	  get_command(:test).options.length.should eql(2)
 	end
-end
+	
+	it "should invoke #when_called with arguments properly" do
+	  get_command(:test).call([1, 2]).should eql("test 12")
+	end
+
+  it "should output invalid option message when invalid options passed to command" do
+    new_command_runner 'test', '--invalid-option'
+    command_runner.run!
+    @output.string.should eql("invalid option: --invalid-option\n")
+  end
+  
+  it "should output invalid command message when help sub-command does not exist" do
+    new_command_runner 'help', 'does_not_exist'
+    command_runner.run!
+    @output.string.should eql("invalid command. Use --help for more information\n")
+  end
 
+ 	it "should locate command within arbitrary arguments passed" do
+ 	  new_command_runner '--help', '--arbitrary', 'test'
+ 	  command_runner.command_name_from_args.should eql('test')
+ 	end
+
+  it "should resolve active command from global options passed" do
+    new_command_runner '--help', 'test'
+    command_runner.active_command.should be_instance_of(Commander::Command)
+  end
+    	
+	it "should distinguish between switches and descriptions passed to #option" do
+	  get_command(:test).options[0][:description].should eql("trace description")
+	  get_command(:test).options[0][:switches].should eql(["-t", "--trace"])
+	  get_command(:test).options[1][:description].should eql("verbose description")
+	  get_command(:test).options[1][:switches].should eql(["--verbose"])
+	  get_command(:test).option "--test"
+	  get_command(:test).options[2][:description].should be_nil
+	  get_command(:test).options[2][:switches].should eql(["--test"])
+	end
+
+  it "should generate a symbol from switches" do
+    get_command(:test).sym_from_switch("--trace").should eql(:trace)
+    get_command(:test).sym_from_switch("--foo-bar").should eql(:foo_bar)
+    get_command(:test).sym_from_switch("--[no]-feature").should eql(:feature)
+    get_command(:test).sym_from_switch("--[no]-feature ARG").should eql(:feature)
+    get_command(:test).sym_from_switch("--file [ARG]").should eql(:file)
+    get_command(:test).sym_from_switch("--colors colors").should eql(:colors)
+  end
+  	
+  it "should resolve active command from invalid options 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 in the arguments passed"do
+    new_command_runner '--help'
+    lambda { command_runner.active_command }.should raise_error(Commander::Runner::InvalidCommandError)
+  end
+  
+  it "should add options to previously created commands" do
+    get_command(:test).option("--recursive") {}
+    get_command(:test).options.length.should eql(3)
+  end
+  
+  it "should call command option procs" do
+    recursive = false
+    get_command(:test).option("--recursive") { recursive = true }
+    get_command(:test).run ['--recursive']
+    recursive.should be_true
+  end
+  
+  it "should call the #when_called proc when #run" do
+    result = nil
+    get_command(:test).when_called { |args, options| result = args.join(' ') }  
+    get_command(:test).run ['--trace', 'just', 'some', 'args']
+    result.should eql("just some args")
+  end
+  
+  it "should handle boolean options" do
+    opts = nil
+    get_command(:test).when_called { |args, options| opts = options }  
+    get_command(:test).run ['--trace', 'foo', 'bar']
+    opts.trace.should be_true
+  end
+  
+  it "should handle toggle options" do
+    options = nil
+    get_command(:test).when_called { |args, opts| options = opts }  
+    get_command(:test).option "--[no-]toggle"
+    get_command(:test).run ['--no-toggle']
+    options.toggle.should be_false
+  end
+  
+  it "should handle manditory arg options" do
+    options = nil
+    get_command(:test).when_called { |args, opts| options = opts }  
+    get_command(:test).option "--manditory ARG"
+    get_command(:test).run ['--manditory', "foo"]
+    options.manditory.should eql("foo")
+    lambda { get_command(:test).run ['--manditory'] }.should raise_error(OptionParser::MissingArgument)
+  end  
+  
+  it "should handle optional arg options" do
+    options = nil
+    get_command(:test).when_called { |args, opts| options = opts }  
+    get_command(:test).option "--optional [ARG]"
+    get_command(:test).run ['--optional', "foo"]
+    options.optional.should eql("foo") 
+    get_command(:test).run ['--optional']
+    options.optiona.should be_nil  
+  end
+  
+  it "should handle list options" do
+    options = nil
+    get_command(:test).when_called { |args, opts| options = opts }  
+    get_command(:test).option "--list words", Array
+    get_command(:test).run ['--list', "im,a,list"]
+    options.list.should eql(["im", "a", "list"]) 
+  end
+  
+  it "should initialize and call object when a class is passed to #when_called" do
+   $_when_called_value = nil
+   class HandleWhenCalled1
+     def initialize(args, options) $_when_called_value = args.join('-') end 
+   end
+   get_command(:test).when_called HandleWhenCalled1
+   get_command(:test).call(["hello", "world"])
+   $_when_called_value.should eql("hello-world")
+  end
+   
+  it "should initialize and call object when a class is passed to #when_called with an arbitrary method" do
+   class HandleWhenCalled2
+     def arbitrary_method(args, options) args.join('-') end 
+   end
+   get_command(:test).when_called HandleWhenCalled2, :arbitrary_method
+   get_command(:test).call(["hello", "world"]).should eql("hello-world")
+  end
+  
+  it "should call object when passed to #when_called " do
+    class HandleWhenCalled3
+      def arbitrary_method(args, options) args.join('-') end 
+    end
+    get_command(:test).when_called HandleWhenCalled3.new, :arbitrary_method
+    get_command(:test).call(["hello", "world"]).should eql("hello-world")
+  end
+  
+  it "should populate options when passed before command name" do
+    options = nil
+    new_command_runner '--foo', 'test', 'some', 'args'
+    get_command(:test).option "--foo"
+    get_command(:test).when_called { |args, opts| options = opts }
+    command_runner.run!
+    options.foo.should be_true 
+  end
+  
+  it "should populate options when passed after command name" do
+    options = nil
+    new_command_runner 'test', '--foo', 'some', 'args'
+    get_command(:test).option "--foo"
+    get_command(:test).when_called { |args, opts| options = opts }
+    command_runner.run!
+    options.foo.should be_true 
+  end
+  
+  it "should allow multi-word strings as command names to be called correctly" do
+    arguments = nil
+    options = nil
+    new_command_runner 'foo', 'bar', 'i', 'like', '--i-like', 'cookies', 'bar'
+    command 'foo bar' do |c|
+      c.option '--i-like WHAT'
+      c.when_called { |args, opts| arguments, options = args, opts } 
+    end
+    command_runner.run!
+    arguments.should eql(['i', 'like', 'bar'])
+    options.i_like.should eql('cookies')
+  end
+
+end

data/spec/help_formatter_spec.rb

@@ -0,0 +1,31 @@
+
+describe Commander::HelpFormatter do
+  
+  before :each do
+    @input = StringIO.new
+    @output = StringIO.new
+    $terminal = HighLine.new @input, @output
+  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")
+  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")
+  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")
+  end
+      
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+require 'commander'
+require 'stringio'
+
+def create_test_command
+  command :test do |c|
+    c.syntax = "test [options] <file>"
+    c.description = "test description"
+    c.example "description", "command"
+    c.example "description 2", "command 2"
+    c.option "-t", "--trace", "trace description"
+    c.option "--verbose", "verbose description"
+    c.when_called do |args, options|
+      "test %s" % args.join
+    end
+  end
+end
+
+def new_command_runner *args
+  $command_runner = Commander::Runner.new args
+  program :name, "test"
+  program :version, "1.2.3"
+  program :description, "something"
+  create_test_command
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 2.4.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-06 00:00:00 -08:00
+date: 2009-01-12 00:00:00 -08:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,47 +22,87 @@ dependencies:
         version: 1.5.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: echoe
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: "0"
     version: 
-description: Commander is a small framework for creating a sub-command utility. For example a sub command would be 'git add' or 'git rm', where 'add' and 'rm' are sub commands.
-email: 
-- tj@vision-media.ca
+description: The complete solution for Ruby command-line executables
+email: tj@vision-media.ca
 executables: 
 - commander
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
 - bin/commander
+- lib/commander/command.rb
+- lib/commander/core_ext/array.rb
+- lib/commander/core_ext/kernel.rb
+- lib/commander/core_ext/object.rb
+- lib/commander/core_ext/string.rb
+- lib/commander/core_ext.rb
+- lib/commander/fileutils.rb
+- lib/commander/help_formatters/base.rb
+- lib/commander/help_formatters/terminal/command_help.erb
+- lib/commander/help_formatters/terminal/help.erb
+- lib/commander/help_formatters/terminal.rb
+- lib/commander/help_formatters.rb
+- lib/commander/import.rb
+- lib/commander/runner.rb
+- lib/commander/user_interaction.rb
+- lib/commander/version.rb
 - lib/commander.rb
+- README.rdoc
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- bin/commander
+- commander.gemspec
+- History.rdoc
 - lib/commander/command.rb
-- lib/commander/commander.rb
-- lib/commander/help_generators.rb
-- lib/commander/help_generators/default.rb
-- lib/commander/manager.rb
+- lib/commander/core_ext/array.rb
+- lib/commander/core_ext/kernel.rb
+- lib/commander/core_ext/object.rb
+- lib/commander/core_ext/string.rb
+- lib/commander/core_ext.rb
+- lib/commander/fileutils.rb
+- lib/commander/help_formatters/base.rb
+- lib/commander/help_formatters/terminal/command_help.erb
+- lib/commander/help_formatters/terminal/help.erb
+- lib/commander/help_formatters/terminal.rb
+- lib/commander/help_formatters.rb
+- lib/commander/import.rb
+- lib/commander/runner.rb
+- lib/commander/user_interaction.rb
 - lib/commander/version.rb
-- spec/all_spec.rb
+- lib/commander.rb
+- Manifest
+- Rakefile
+- README.rdoc
 - spec/commander_spec.rb
-- spec/manager_spec.rb
+- spec/help_formatter_spec.rb
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- test/fileutils.rb
+- test/progress.rb
+- test/ui.rb
+- Todo.rdoc
 has_rdoc: true
-homepage: 
+homepage: http://github.com/visionmedia/commander
 post_install_message: 
 rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Commander
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -75,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
@@ -83,6 +123,6 @@ rubyforge_project: commander
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Commander is a small framework for creating a sub-command utility
+summary: The complete solution for Ruby command-line executables
 test_files: []
 

data/History.txt

@@ -1,48 +0,0 @@
-
-=== 1.2.2 / 2008-11-06
-
-  * 1 Bug Fix:
-
-    * Forgot to add array.rb
-
-=== 1.2.0 / 2008-11-06
-
-  * 2 Major Enhancements:
-
-    * Added paging ability (similar to 'less')
-    * Added coloring to default help generator
-
-=== 1.1.0 / 2008-11-06
-
-  * 1 Major Enhancements:
-
-    * Added dependency for Highline gem, which replaces Commander's user interaction lib
-
-=== 1.0.4 / 2008-11-04
-
-  * 1 Minor Enhancements:
-
-    * Added support for --help and --version flags
-
-=== 1.0.3 / 2008-11-01
-
-  * 1 Bug Fix:
-
-    * Typo causing the gem to fail build on github
-
-=== 1.0.2 / 2008-11-01
-
-  * 1 Minor Enhancements:
-
-    * Added gemspec for github
-
-=== 1.0.1 / 2008-10-31
-
-  * 2 Minor Enhancements:
-
-    * Added shebang line to commander init
-    * Added require 'rubygems' 
-
-=== 1.0.0 / 2008-10-31
-
-  * Initial release

data/Manifest.txt

@@ -1,17 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/commander
-commander.gemspec
-lib/commander.rb
-lib/commander/command.rb
-lib/commander/commander.rb
-lib/commander/core_ext/array.rb
-lib/commander/help_generators.rb
-lib/commander/help_generators/default.rb
-lib/commander/manager.rb
-lib/commander/version.rb
-spec/all_spec.rb
-spec/commander_spec.rb
-spec/manager_spec.rb

data/README.txt

@@ -1,76 +0,0 @@
-
-== DESCRIPTION:
-
-  Commander is a small framework for creating a sub-command utility. 
-  For example a sub command would be 'git add' or 'git rm', where 'add' and
-  'rm' are sub commands.
-
-== FEATURES:
-
-  * Sub-commands
-  * Auto-generated help documentation globally and per sub-command
-  * Simple syntax and implementation
-  * Extensible help generators for various output formats
-  * Use the 'commander' command to initialize a commander driven program
-  * Dependent on highline for terminal interaction (ask, choose, etc)
-  
-== USAGE:
-
-  require 'commander'
-  
-  init_commander(
-      :name => 'Commander', 
-      :version => Commander::VERSION, 
-      :description => 'Commander utility program.'
-    )
-  
-  command :init do |c|
-    c.syntax = 'commander init <filepath>'
-    c.description = 'Initialize an empty file with a commander skeleton.'
-    c.example 'Apply commander to a blank file.', 'commander init ./bin/my_executable'
-    c.option('-r', '--recursive', 'Do something recursively') { puts "I am recursive." } 
-    c.option('-v', '--verbose', 'Do something verbosely') { puts "I am verbose." } 
-    c.when_called do |args|
-       list = ask 'List some items:', Array
-       # Do something with list
-    end
-  end
-
-== KNOWN ISSUES:
-  
-  * none
-
-== TODO:
-
-  * look at newgem gem and copy the whole 'create   ./path' verbose listing conventions
-  * do testing for these apps like highline does with mock IO
-  * look at highline examples and change commander commands to work without new-lines etc
-  * more / better documentation
-  * help generator options (such as large option description etc)
-  * help generators should use erb
-  * refactor
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2008 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/commander/commander.rb

@@ -1,35 +0,0 @@
-
-require 'commander/version'
-require 'commander/command'
-require 'commander/manager'
-require 'commander/help_generators'
-require 'commander/core_ext/array'
-require 'optparse'
-
-module Commander
-  	
-	def init_commander(options = {})
-		Commander::Manager.instance options
-	end
-	
-	def add_command(command, &block)
-		_command = command
-		command = Commander::Command.new(_command)
-		yield command
-		Commander::Manager.instance.add_command command
-	end
-	alias :command :add_command
-	
-	def get_command(command)
-		Commander::Manager.instance.get_command command
-	end
-	
-	def command_exists?(command)
-		Commander::Manager.instance.include? command
-	end
-	
-	def info(option)
-		Commander::Manager.instance.info[option]
-	end
-end
-