visionmedia-commander 2.4.2 → 2.4.3

data/History.rdoc

@@ -1,4 +1,8 @@
 
+=== 2.4.3 / 2009-01-15
+
+* Fixed bug in command_name_from_args, preventing multi-word commands
+
 === 2.4.2 / 2009-01-12
 
 * Github! build me!

data/Manifest

@@ -22,6 +22,7 @@ Manifest
 Rakefile
 README.rdoc
 spec/commander_spec.rb
+spec/core_ext_spec.rb
 spec/help_formatter_spec.rb
 spec/spec_helper.rb
 tasks/docs.rake

data/README.rdoc

@@ -57,12 +57,12 @@ are some quick examples for how to utilize highline in your command(s):
    ask("Password:  ") { |q| q.echo = "*" }
   
    # Ask for password 
-   p ask("Password:  ") { |q| q.echo = false }
+   ask("Password:  ") { |q| q.echo = false }
 
    # Ask if the user agrees (yes or no)
    agree("Do something?")
 
-   # Asks on a single line (note the space after ':'
+   # Asks on a single line (note the space after ':')
    ask("Name: ")
 
    # Asks with new line after "Description:"
@@ -148,6 +148,12 @@ methods directly.
 For feature rich ASCII tables for your terminal app check out visionmedia's terminal-table gem at
 http://github.com/visionmedia/terminal-table
 
+   +----------+-------+----+--------+-----------------------+
+   | Terminal | Table | Is | Wicked | Awesome               |
+   +----------+-------+----+--------+-----------------------+
+   |          |       |    |        | get it while its hot! |
+   +----------+-------+----+--------+-----------------------+
+
 == Known Issues:
   
 * none

data/Todo.rdoc

@@ -1,12 +1,11 @@
 
-* Release to RubyForge as well
-* Fix excessive Dir#[] calls due to rubygems, http://rubyforge.org/tracker/index.php?func=detail&aid=23170&group_id=126&atid=575
 * Change; Have VerboseFileUtils only output basename ? 
+* Change; refactor specs
+* Release to RubyForge as well
 * Add highline paging ... clean it up
 * Add global options... change runner implementations as well as displaying in terminal formatter, OpenStruct inherit these options?
 * Add global --options switch for loading options from a filepath
 * Add; dynamically generate padding erb templates, command lists, multi-line text bodies etc
 * Add; display global options with global help
-* Change; consider reversing |options, args| so args can be |options, file, dir| etc.. adjust doc
-* Change; refactor specs
+* Change; consider reversing |options, args| so args make use of ruby block param defaults |options, file, dir = SOME_DIR| etc.. adjust doc
 * Publish rdoc

data/bin/commander

@@ -28,7 +28,7 @@ require '#{name}'
 
 program :name, '#{name}'
 program :version, #{name.camelcase}::VERSION::STRING
-program :description, '#{description}.'
+program :description, '#{description}'
  
 CODE
         commands.each do |command|

data/commander.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "2.4.2"
+  s.version = "2.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-01-12}
+  s.date = %q{2009-01-15}
   s.default_executable = %q{commander}
   s.description = %q{The complete solution for Ruby command-line executables}
   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/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"]
-  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "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", "Manifest", "Rakefile", "README.rdoc", "spec/commander_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"]
+  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "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", "Manifest", "Rakefile", "README.rdoc", "spec/commander_spec.rb", "spec/core_ext_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"]
   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/core_ext/string.rb

@@ -2,17 +2,14 @@
 class String
     
   ##
-  # Replace _hash_ keys with associated values. Mutative.
+  # Replace +hash+ keys with associated values. Mutative.
   
   def tokenize! hash
-    hash.each_pair do |k, v|
-      self.gsub! Regexp.new(":#{k}"), v.to_s
-    end
-    self
+    hash.inject(self) { |s, (k, v)| s.gsub! /:#{k}/, v }
   end
     
   ##
-  # Replace _hash_ keys with associated values.
+  # Replace +hash+ keys with associated values.
   
   def tokenize hash
     self.dup.tokenize! hash
@@ -23,11 +20,11 @@ class String
   
   def camelcase upcase_first_letter = true
     up = upcase_first_letter
-    str = dup
-    str.gsub!(/\/(.?)/){ "::#{$1.upcase}" }
-    str.gsub!(/(?:_+|-+)([a-z])/){ $1.upcase }
-    str.gsub!(/(\A|\s)([a-z])/){ $1 + $2.upcase } if up
-    str
+    s = dup
+    s.gsub!(/\/(.?)/){ "::#{$1.upcase}" }
+    s.gsub!(/(?:_+|-+)([a-z])/){ $1.upcase }
+    s.gsub!(/(\A|\s)([a-z])/){ $1 + $2.upcase } if up
+    s
   end
     
 end

data/lib/commander/runner.rb

@@ -26,8 +26,7 @@ module Commander
     
     def initialize args = ARGV
       @args = args
-      @commands, @options = {}, {}
-      @program = { 
+      @commands, @options, @program = {}, {}, { 
         :help_formatter => Commander::HelpFormatter::Terminal,
         :int_message => "\nProcess interrupted",
       }
@@ -123,7 +122,7 @@ module Commander
     # Get a command object if available or nil.
     
     def get_command name
-      @commands[name.to_s] or raise InvalidCommandError, "Invalid command '#{name || "nil"}'", caller
+      @commands[name.to_s] or raise InvalidCommandError, "invalid command '#{ name || 'nil' }'", caller
     end
     
     ##
@@ -150,9 +149,9 @@ module Commander
     # command names. 
     
     def command_name_from_args
-      @args.delete_switches.inject do |name, arg|
+      @_command_name_from_args ||= @args.delete_switches.inject do |name, arg|
         return name if command_exists? name
-        name << " #{arg}"
+        name += " #{arg}"
       end
     end
     
@@ -162,7 +161,14 @@ module Commander
     def help_formatter
       @_help_formatter ||= @program[:help_formatter].new self
     end
-        
+    
+    ##
+    # Return arguments without the command name.
+    
+    def args_without_command
+      @args.dup.join(' ').sub(command_name_from_args, '').split
+    end
+            
     private
     
     ##
@@ -206,14 +212,13 @@ module Commander
       # Ignore invalid options since options will be further 
       # parsed by our sub commands.
     end
+    
+    ##
+    # Raises a CommandError when the program +key+ is not present, or is empty.
         
-    def ensure_program_key_set key #:nodoc:
+    def ensure_program_key_set key 
       raise CommandError, "Program #{key} required (use #program method)" if (@program[key].nil? || @program[key].empty?)
     end
     
-    def args_without_command #:nodoc:
-      @args.join(' ').sub(/^[\s]*#{active_command.name}/, '').split
-    end
-        
   end
 end

data/lib/commander/version.rb

@@ -1,7 +1,7 @@
 
 module Commander
   module VERSION #:nodoc:
-    MAJOR, MINOR, TINY = [2, 4, 2]
+    MAJOR, MINOR, TINY = [2, 4, 3]
     STRING = [MAJOR, MINOR, TINY].join '.'
   end
 end

data/spec/commander_spec.rb

@@ -210,14 +210,32 @@ describe Commander do
   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|
+    new_command_runner 'foo', 'bar', 'something', 'i', 'like', '--i-like', 'cookies', 'bar'
+    command 'foo bar something' do |c|
       c.option '--i-like WHAT'
       c.when_called { |args, opts| arguments, options = args, opts } 
     end
+    command_runner.command_name_from_args.should eql('foo bar something')
+    command_runner.args_without_command.should eql(['i', 'like', '--i-like', 'cookies', 'bar'])
     command_runner.run!
     arguments.should eql(['i', 'like', 'bar'])
     options.i_like.should eql('cookies')
   end
+  
+  it "should allow multi-word strings as command names to be called correctly, with options before command name" do
+    arguments = nil
+    options = nil
+    new_command_runner '--something', 'foo', 'bar', 'random_arg'
+    command 'foo bar' do |c|
+      c.option '--something'
+      c.when_called { |args, opts| arguments, options = args, opts } 
+    end
+    command_runner.command_name_from_args.should eql('foo bar')
+    command_runner.args_without_command.should eql(['--something', 'random_arg'])
+    command_runner.run!
+    arguments.should eql(['random_arg'])
+    options.something.should be_true
+  end
+
 
 end

data/spec/core_ext_spec.rb

@@ -0,0 +1,9 @@
+
+describe Commander do
+  describe String do
+    it "should tokenize strings" do
+      s = 'Welcome :name, enjoy your :object'.tokenize!({ :name => 'TJ', :object => 'cookie' })
+      s.should == 'Welcome TJ, enjoy your cookie'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 2.4.2
+  version: 2.4.3
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-12 00:00:00 -08:00
+date: 2009-01-15 00:00:00 -08:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - README.rdoc
 - spec/commander_spec.rb
+- spec/core_ext_spec.rb
 - spec/help_formatter_spec.rb
 - spec/spec_helper.rb
 - tasks/docs.rake