visionmedia-commander 3.0.1 → 3.0.2

data/History.rdoc

@@ -1,4 +1,9 @@
 
+=== 3.0.2 / 2009-03-12
+
+* Added terminal formatter specs
+* Fixed bug preventing command names passed to help from working
+
 === 3.0.1 / 2009-03-12
 
 * Fixed bug in #command_name_from_args preventing the left-most match for a command name to be used

data/Manifest

@@ -22,7 +22,8 @@ spec/command_spec.rb
 spec/core_ext/array_spec.rb
 spec/core_ext/object_spec.rb
 spec/core_ext/string_spec.rb
-spec/help_formatter_spec.rb
+spec/help_formatters/base_spec.rb
+spec/help_formatters/terminal_spec.rb
 spec/runner_spec.rb
 spec/spec_helper.rb
 tasks/docs.rake

data/Todo.rdoc

@@ -1,8 +1,6 @@
 
 == Major
 
-* Fix help command ...
-* Rough out some formatter specs using include?
 * 1.9.x compatability
 * Publish RDoc on mini page / screencasts
 

data/commander.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.0.1"
+  s.version = "3.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email = %q{tj@vision-media.ca}
   s.executables = ["commander"]
   s.extra_rdoc_files = ["bin/commander", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.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/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"]
-  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.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/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/core_ext/string_spec.rb", "spec/help_formatter_spec.rb", "spec/runner_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "test/pbar", "test/ui", "Todo.rdoc"]
+  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.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/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/core_ext/string_spec.rb", "spec/help_formatters/base_spec.rb", "spec/help_formatters/terminal_spec.rb", "spec/runner_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "test/pbar", "test/ui", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]

data/lib/commander/runner.rb

@@ -39,7 +39,7 @@ module Commander
       require_program :name, :version, :description
       case 
       when options[:version] ; $terminal.say "#{program(:name)} #{program(:version)}" 
-      when options[:help]    ; command(:help).run(*@args[1..@args.length])
+      when options[:help]    ; command(:help).run(*@args[1..-1])
       else                     active_command.run *args_without_command_name
       end
     rescue InvalidCommandError
@@ -132,19 +132,10 @@ module Commander
     
     ##
     # Attemps to locate a command name from within the arguments.
-    # Supports multi-word commands, using the largest left-most possible match.
+    # Supports multi-word commands, using the largest possible match.
     
     def command_name_from_args
-      @__command_name_from_args ||= begin
-          names = valid_command_names_from *@args.dup
-          if names.length > 1
-            names.first.length == names.last.length ? 
-              names.first :
-              names.last
-          else
-            names.first
-          end
-        end
+      @__command_name_from_args ||= valid_command_names_from(*@args.dup).sort.last
     end
     
     ##
@@ -152,7 +143,7 @@ module Commander
     
     def valid_command_names_from *args
       arg_string = args.delete_switches.join ' '
-      commands.keys.map { |key| key if arg_string.include? key }.compact
+      commands.keys.find_all { |name| name if /^#{name}/.match arg_string }
     end
     
     ##

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'
 end

data/spec/help_formatters/terminal_spec.rb

@@ -0,0 +1,66 @@
+
+describe Commander::HelpFormatter::Terminal do
+  
+  before :each do
+    mock_terminal
+  end
+  
+  describe "global help" do
+    before :each do
+      new_command_runner 'help' do
+        command :'install gem' do |c|
+          c.syntax = 'foo install gem [options]'
+          c.summary = 'Install some gem'
+        end
+      end.run!
+      @global_help = @output.string
+    end
+    
+    describe "should display" do
+      it "the sub-command name" do
+        @global_help.should include('install gem')
+      end
+      
+      it "the summary" do
+        @global_help.should include('Install some gem')
+      end
+    end
+  end
+  
+  describe "sub-command help" do
+    before :each do
+      new_command_runner 'help', 'install', 'gem' do
+        command :'install gem' do |c|
+          c.syntax = 'foo install gem [options]'
+          c.summary = 'Install some gem'
+          c.description = 'Install some gem, blah blah blah'
+          c.example 'one', 'two'
+          c.example 'three', 'four'
+        end
+      end.run!
+      @command_help = @output.string
+    end
+    
+    describe "should display" do
+      it "the sub-command name" do
+        @command_help.should include('install gem')
+      end
+      
+      it "the description" do
+        @command_help.should include('Install some gem, blah blah blah')
+      end
+      
+      it "all examples" do
+        @command_help.should include('# one')
+        @command_help.should include('two')
+        @command_help.should include('# three')
+        @command_help.should include('four')
+      end
+      
+      it "the syntax" do
+        @command_help.should include('foo install gem [options]')
+      end
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -73,7 +73,8 @@ files:
 - spec/core_ext/array_spec.rb
 - spec/core_ext/object_spec.rb
 - spec/core_ext/string_spec.rb
-- spec/help_formatter_spec.rb
+- spec/help_formatters/base_spec.rb
+- spec/help_formatters/terminal_spec.rb
 - spec/runner_spec.rb
 - spec/spec_helper.rb
 - tasks/docs.rake