visionmedia-commander 3.2.0 → 3.2.2

data/History.rdoc

@@ -1,4 +1,13 @@
 
+=== 3.2.2 / 2009-04-01
+
+* Github's gem builder timed out ? ...
+
+=== 3.2.1 / 2009-04-01
+
+* Added Commander::HelpFormatter::TerminalCompact
+* Fix; updated gemspec / manifest removing test/* causing issue [#26]
+
 === 3.2.0 / 2009-03-26
 
 * Added implied small switches so they appear in help (-h, -v, etc)

data/Manifest

@@ -11,6 +11,9 @@ 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/terminal_compact/command_help.erb
+lib/commander/help_formatters/terminal_compact/help.erb
+lib/commander/help_formatters/terminal_compact.rb
 lib/commander/help_formatters.rb
 lib/commander/runner.rb
 lib/commander/user_interaction.rb
@@ -30,7 +33,3 @@ spec/spec_helper.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
-test/foo
-test/pbar
-test/re
-test/ui

data/README.rdoc

@@ -12,11 +12,15 @@ features, and an elegant API.
 * Parses options using OptionParser
 * Auto-populates struct with options ( no more { |v| options[:recursive] = v } )
 * Auto-generates help documentation via pluggable help formatters
+* Packaged with two help formatters (Terminal, TerminalCompact)
 * Imports the highline gem for interacting with the terminal
 * Adds additional user interaction functionality
 * Highly customizable progress bar with intuative, simple usage
 * Multi-word command name support such as 'drupal module install MOD', rather than 'drupal module_install MOD'
 * Use the 'commander' executable to initialize a commander driven program
+* Optional default sub-command when none is present
+* Global / Sub-command level options
+* Sub-command aliasing (very powerful, as both switches and arguments can be used)
 
 == Example
 
@@ -239,11 +243,21 @@ You may:
     say 'foo' if options.verbose
   ...
 
+=== Formatters
+
+Two core formatters are currently available, the default Terminal formatter as well
+as TerminalCompact. To utilize a different formatter simply use :help_formatter like below:
+
+  program :help_formatter, Commander::HelpFormatter::TerminalCompact
+
+This abstraction could be utilized to generate HTML documentation for your executable.
+
 == Tips
 
 When adding a global or sub-command option, OptionParser implicitly adds a small
 switch even when not explicitly created, for example -c will be the same as --config
-in both examples:
+in both examples, however '-c' will only appear in the documentation when explicitly
+assigning it.
 
   global_option '-c', '--config FILE'
   global_option '--config FILE'

data/commander.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.2.0"
+  s.version = "3.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-03-26}
+  s.date = %q{2009-04-01}
   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/blank.rb", "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/blank.rb", "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/foo", "test/pbar", "test/re", "test/ui"]
+  s.extra_rdoc_files = ["bin/commander", "lib/commander/blank.rb", "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/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.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/blank.rb", "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/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.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"]
   s.has_rdoc = true
   s.homepage = %q{http://visionmedia.github.com/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]

data/lib/commander/help_formatters.rb

@@ -4,5 +4,6 @@ require 'commander/help_formatters/base'
 module Commander
   module HelpFormatter
     autoload :Terminal, 'commander/help_formatters/terminal'
+    autoload :TerminalCompact, 'commander/help_formatters/terminal_compact'
   end
 end

data/lib/commander/help_formatters/terminal.rb

@@ -1,6 +1,4 @@
 
-require 'erb'
-
 module Commander
   module HelpFormatter
     class Terminal < Base
@@ -13,7 +11,7 @@ module Commander
       end
       
       def template name
-        ERB.new(File.read(File.expand_path(File.dirname(__FILE__)) + "/terminal/#{name}.erb"), nil, '-')
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal', "#{name}.erb")), nil, '-')
       end
     end
   end

data/lib/commander/help_formatters/terminal/command_help.erb

@@ -17,7 +17,7 @@
 <% unless @examples.empty? -%>
 
   <%= $terminal.color "EXAMPLES", :bold %>:
-	<% @examples.each do |description, command| -%>
+	<% for description, command in @examples -%>
 
     # <%= description %>
     <%= command %>
@@ -26,7 +26,7 @@
 <% unless @options.empty? -%>
 
   <%= $terminal.color "OPTIONS", :bold %>:
-	<% @options.each do |option| -%>
+	<% for option in @options -%>
 
     <%= option[:switches].join ', ' %> 
         <%= option[:description] %>

data/lib/commander/help_formatters/terminal/help.erb

@@ -8,27 +8,27 @@
     <%= program :description %>
 
   <%= $terminal.color "SUB-COMMANDS", :bold %>:
-<% @commands.each_pair do |name, command| -%>
+<% for name, command in @commands -%>
 	<% unless alias? name %>
     <%= "%-20s %s" % [command.name, command.summary || command.description] -%>
 	<% end -%>
 <% end %>
 <% unless @aliases.empty? %>
   <%= $terminal.color "ALIASES", :bold %>:
-  <% @aliases.each do |alias_name, args| %>
+  <% for alias_name, args in @aliases %>
     <%= "%-20s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] -%>
   <% end %>
 <% end %>
 <% unless @options.empty? -%>
   <%= $terminal.color "GLOBAL OPTIONS", :bold %>:
-	<% @options.each do |option| -%>
+	<% for option in @options -%>
 
     <%= option[:switches].join ', ' %> 
         <%= option[:description] %>
 	<% end -%>
 <% end -%>
 <% if program :help -%>
-  <% program(:help).each_pair do |title, body| %>
+  <% for title, body in program(:help) %>
   <%= $terminal.color title.to_s.upcase, :bold %>:
 
     <%= body %>

data/lib/commander/help_formatters/terminal_compact.rb

@@ -0,0 +1,12 @@
+
+require 'erb'
+
+module Commander
+  module HelpFormatter
+    class TerminalCompact < Terminal
+      def template name
+        ERB.new(File.read(File.join(File.dirname(__FILE__), 'terminal_compact', "#{name}.erb")), nil, '-')
+      end
+    end
+  end
+end

data/lib/commander/help_formatters/terminal_compact/command_help.erb

@@ -0,0 +1,27 @@
+
+  <%= @name %>
+<% if @description || @summary -%>
+
+  <%= @description || @summary %>
+<% end -%>
+<% if @syntax -%>
+
+  Usage: <%= @syntax %>
+<% end -%>
+<% unless @examples.empty? -%>
+
+  Examples:
+	<% for description, command in @examples -%>
+
+    # <%= description %>
+    <%= command %>
+	<% end -%>
+<% end -%>
+<% unless @options.empty? -%>
+
+  Options:
+<% for option in @options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] %> 
+<% end -%>
+<% end -%>
+

data/lib/commander/help_formatters/terminal_compact/help.erb

@@ -0,0 +1,30 @@
+
+  <%= program :name %>
+
+  <%= program :description %>
+
+  Sub-Commands:
+<% for name, command in @commands -%>
+<% unless alias? name -%>
+    <%= "%-20s %s" % [command.name, command.summary || command.description] %>
+<% end -%>
+<% end -%>
+<% unless @aliases.empty? %>
+  Aliases:
+<% for alias_name, args in @aliases -%>
+    <%= "%-20s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] %>
+<% end -%>
+<% end %>
+<% unless @options.empty? -%>
+  Global Options:
+<% for option in @options -%>
+    <%= "%-20s %s" % [option[:switches].join(', '), option[:description]] -%> 
+<% end -%>
+<% end -%>
+<% if program :help -%>
+  <% for title, body in program(:help) %>
+  <%= title %>:
+    <%= body %>
+  <% end %>
+<% end -%>
+

data/lib/commander/runner.rb

@@ -98,9 +98,9 @@ module Commander
     #
     # === Keys:
     #
-    #   :name            (required) Program name
     #   :version         (required) Program version triple, ex: '0.0.1'
     #   :description     (required) Program description
+    #   :name            Program name, defaults to basename of executable
     #   :help_formatter  Defaults to Commander::HelpFormatter::Terminal
     #   :help            Allows addition of arbitrary global help blocks
     #   :int_message     Message to display when interrupted (CTRL + C)

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.2.0'
+  VERSION = '3.2.2'
 end

data/spec/runner_spec.rb

@@ -277,27 +277,27 @@ describe Commander do
     end
     
     it "when using multi-word commands" do
-      new_command_runner '--trace', 'my', 'command', 'something', 'foo', 'bar' do
-        command('my command') {}
+      new_command_runner '--verbose', 'my', 'command', 'something', 'foo', 'bar' do
+        command('my command') { |c| c.option('--verbose') }
         command_runner.command_name_from_args.should == 'my command'
-        command_runner.args_without_command_name.should == ['--trace', 'something', 'foo', 'bar']
+        command_runner.args_without_command_name.should == ['--verbose', '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') {}
+      new_command_runner '--verbose', 'my', 'command', 'something', 'my', 'command' do
+        command('my command') { |c| c.option('--verbose') }
         command_runner.command_name_from_args.should == 'my command'
-        command_runner.args_without_command_name.should == ['--trace', 'something', 'my', 'command']
+        command_runner.args_without_command_name.should == ['--verbose', 'something', 'my', 'command']
       end.run!
     end
     
     it "when using multi-word commands with other commands using the same words" do
-      new_command_runner '--trace', 'my', 'command', 'something', 'my', 'command' do
+      new_command_runner '--verbose', 'my', 'command', 'something', 'my', 'command' do
         command('my command') {}
-        command('my command something') {}
+        command('my command something') { |c| c.option('--verbose') }
         command_runner.command_name_from_args.should == 'my command something'
-        command_runner.args_without_command_name.should == ['--trace', 'my', 'command']
+        command_runner.args_without_command_name.should == ['--verbose', 'my', 'command']
       end.run!
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.2.0
+  version: 3.2.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-26 00:00:00 -07:00
+date: 2009-04-01 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,9 @@ extra_rdoc_files:
 - 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/terminal_compact/command_help.erb
+- lib/commander/help_formatters/terminal_compact/help.erb
+- lib/commander/help_formatters/terminal_compact.rb
 - lib/commander/help_formatters.rb
 - lib/commander/runner.rb
 - lib/commander/user_interaction.rb
@@ -63,6 +66,9 @@ files:
 - 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/terminal_compact/command_help.erb
+- lib/commander/help_formatters/terminal_compact/help.erb
+- lib/commander/help_formatters/terminal_compact.rb
 - lib/commander/help_formatters.rb
 - lib/commander/runner.rb
 - lib/commander/user_interaction.rb
@@ -82,10 +88,6 @@ files:
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
-- test/foo
-- test/pbar
-- test/re
-- test/ui
 has_rdoc: true
 homepage: http://visionmedia.github.com/commander
 post_install_message: