visionmedia-commander 3.1.1 → 3.1.2

data/History.rdoc

@@ -1,4 +1,10 @@
 
+=== 3.1.2 / 2009-03-16
+
+* Added support for global options via #global_option
+* Added #call_active_command and #say to clean things up internally
+* Misc refactoring
+
 === 3.1.1 / 2009-03-13
 
 * Fixed some terminal formatter spacing issues

data/Todo.rdoc

@@ -1,6 +1,8 @@
 
 == Major
 
+* Prevent global options from overriding sub-command level options
+* Finish global --trace
 * 1.9.x compatability
 * Publish RDoc on mini page / screencasts
 
@@ -16,7 +18,6 @@
 * Add optional command to be executed when none is specified
 * Add global options... change runner implementations as well as displaying in terminal formatter, OpenStruct inherit these options?
 * Add highline paging ... clean it up because its ugly
-* Add aliasing of commands / args / options
 * Add option copying / merging capabilities
 * Change; require that users explicitly require 'commander/import' (which in turn will highlight/import as well)
 * Release to RubyForge as well
@@ -25,7 +26,6 @@
 
 == Brainstorming
 
-* Add global --trace method
 * Add global trapping of INT to end process with less ugly output
 * Add global --options switch for loading options from a filepath
 * Add argument parser / defaults

data/commander.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.1.1"
+  s.version = "3.1.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-13}
+  s.date = %q{2009-03-16}
   s.default_executable = %q{commander}
   s.description = %q{The complete solution for Ruby command-line executables}
   s.email = %q{tj@vision-media.ca}

data/lib/commander/core_ext/object.rb

@@ -16,8 +16,9 @@ class Object
   extend Forwardable
   include Commander::UI
   
-  def_delegators :$command_runner, :add_command, :command, :program, :run!, :commands, :alias_command, :default_command
   def_delegators Commander::UI::ProgressBar, :progress
+  def_delegators :$command_runner, :add_command, :command, :program, :run!,
+                 :commands, :alias_command, :default_command, :global_option
 
   ##
   # Return the current binding.

data/lib/commander/runner.rb

@@ -11,25 +11,16 @@ module Commander
     class CommandError < StandardError; end
     class InvalidCommandError < CommandError; end
     
-    ##
-    # Commands within the runner.
-    
-    attr_reader :commands
-    
-    ##
-    # Global options.
-    
-    attr_reader :options
-    
+    attr_reader :commands, :options
+
     ##
     # Initialize a new command runner. Optionally
     # supplying +args+ for mocking, or arbitrary usage.
     
     def initialize args = ARGV
-      @args, @commands, @options, @aliases = args, {}, {}, {}
+      @args, @commands, @aliases, @options = args, {}, {}, []
       @program = program_defaults
       create_default_commands
-      parse_global_options
     end
     
     ##
@@ -37,23 +28,35 @@ module Commander
     
     def run!
       require_program :name, :version, :description
-      case 
-      when options[:version] ; $terminal.say "#{program(:name)} #{program(:version)}" 
-      when options[:help]    ; command(:help).run(*@args[1..-1])
-      else
-        if alias? command_name_from_args
-          active_command.run *(@aliases[command_name_from_args.to_s] + args_without_command_name)
-        else
-          active_command.run *args_without_command_name
-        end              
-      end
+      global_option('-h', '--help') { command(:help).run *@args[1..-1]; return }
+      global_option('-v', '--version') { say version; return } 
+      parse_global_options
+      call_active_command
     rescue InvalidCommandError
-      $terminal.say 'invalid command. Use --help for more information'
+      say 'invalid command. Use --help for more information'
     rescue \
       OptionParser::InvalidOption, 
       OptionParser::InvalidArgument,
       OptionParser::MissingArgument => e
-      $terminal.say e
+      say e
+    end
+    
+    ##
+    # Return program version.
+    
+    def version
+      '%s %s' % [program(:name), program(:version)]
+    end
+    
+    ##
+    # Invoke the active command.
+    
+    def call_active_command
+      if alias? command_name_from_args
+        active_command.run *(@aliases[command_name_from_args.to_s] + args_without_command_name)
+      else
+        active_command.run *args_without_command_name
+      end      
     end
     
     ##
@@ -111,6 +114,15 @@ module Commander
       @commands[name.to_s] or raise InvalidCommandError, "invalid command '#{ name || 'nil' }'", caller
     end
     
+    ##
+    # Add a global option; follows the same syntax as
+    # Command#option. This would be used for switches such
+    # as --version, --trace, etc.
+    
+    def global_option *args, &block
+      @options << [args, block]
+    end
+    
     ##
     # Alias command +name+ with +alias_name+. Optionallry +args+ may be passed
     # as if they were being passed straight to the original command via the command-line.
@@ -212,9 +224,9 @@ module Commander
         c.example "Display help for 'foo'", 'command help foo'
         c.when_called do |args, options|
           if args.empty?
-            $terminal.say help_formatter.render 
+            say help_formatter.render 
           else
-            $terminal.say help_formatter.render_command(command(args.join(' ')))
+            say help_formatter.render_command(command(args.join(' ')))
           end
         end
       end
@@ -228,10 +240,9 @@ module Commander
     # global commands such as '--verbose'.
     
     def parse_global_options
-      opts = OptionParser.new
-      opts.on('--help') { @options[:help] = true }
-      opts.on('--version') { @options[:version] = true }
-      opts.parse! @args.dup
+      options.inject OptionParser.new do |options, (args, proc)|
+        options.on *args, &proc
+      end.parse! @args.dup
     rescue OptionParser::InvalidOption
       # Ignore invalid options since options will be further 
       # parsed by our sub commands.
@@ -246,5 +257,11 @@ module Commander
       end
     end
     
+    private
+    
+    def say *args #:nodoc: 
+      $termina.say *args
+    end
+    
   end
 end

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 end

data/spec/runner_spec.rb

@@ -52,6 +52,33 @@ describe Commander do
     end
   end
   
+  describe "#global_option" do
+    it "should be invoked when used in the args list" do
+      file = ''
+      new_command_runner 'test', '--config', 'foo' do
+        global_option('--config FILE') { |f| file = f }
+      end.run!
+      file.should == 'foo'
+    end
+  end
+  
+  # describe "--trace" do
+  #   it "should display pretty errors by default" do
+  #     new_command_runner 'test' do
+  #       raise 'cookies!'
+  #     end.run!
+  #     @output.should == 'error: cookies!. use --trace to view backtrace'
+  #   end
+  #   
+  #   it "should display callstack when using this switch" do
+  #     lambda { 
+  #       new_command_runner 'test', '--trace' do
+  #         raise 'cookies!'
+  #       end.run!
+  #     }.should raise_error
+  #   end
+  # end
+  
   describe "--version" do
     it "should output program version" do
       run('--version').should == "test 1.2.3\n"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-13 00:00:00 -07:00
+date: 2009-03-16 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency