visionmedia-commander 3.1.2 → 3.1.4

data/History.rdoc

@@ -1,4 +1,19 @@
 
+=== 3.1.4 / 2009-03-20
+
+* Gemspec typo
+
+=== 3.1.3 / 2009-03-20
+
+* Added #remove_global_options
+* Added core global option descriptions
+* Added display of global options
+* Removed small core switches (-v, -h) because they are implicitly set
+* Fixed issue with option switchs failing when named as common methods like --send, or --password
+* Fixed bug causing InvalidOption error when global options do not abort the process.
+  This was due to these options remaining in the arguments array, in turn being parsed
+  by the sub-command's option parser, issuing the error. This is fixed by #remove_global_options.
+
 === 3.1.2 / 2009-03-16
 
 * Added support for global options via #global_option

data/Manifest

@@ -1,6 +1,7 @@
 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

data/README.rdoc

@@ -211,6 +211,16 @@ Which will output the rest of the help doc, along with:
 
     TJ Holowaychuk <tj@vision-media.ca>
 
+=== Global Options
+
+Although most switches will be at the sub-command level, several are available
+by default at the global level, such as --version, and --help. Using #global_option
+you can add additional global options:
+
+  global_option('-c', '--config FILE', 'Load config data for your commands to use') { |file| ... }
+
+This method accepts the same syntax as Commander::Command#option so check it out for documentation.
+
 == ASCII Tables
 
 For feature rich ASCII tables for your terminal app check out visionmedia's terminal-table gem at
@@ -222,9 +232,14 @@ http://github.com/visionmedia/terminal-table
    |          |       |    |        | get it while its hot! |
    +----------+-------+----+--------+-----------------------+
 
+== Contrib
+
+Feel free to fork and request a pull, or submit a ticket
+http://visionmedia.lighthouseapp.com/projects/27643-commander
+
 == Known Issues
   
-* none
+* None
 
 == License
 

data/Rakefile

@@ -1,12 +1,16 @@
 
-%w( rubygems rake echoe ./lib/commander.rb ).each { |lib| require lib }
+$:.unshift 'lib'
+require 'commander'
+require 'rubygems'
+require 'rake'
+require 'echoe'
 
-Echoe.new("commander", Commander::VERSION) do |p|
+Echoe.new "commander", Commander::VERSION do |p|
   p.author = "TJ Holowaychuk"
   p.email = "tj@vision-media.ca"
   p.summary = "The complete solution for Ruby command-line executables"
-  p.url = "http://github.com/visionmedia/commander"
-  p.runtime_dependencies = ["highline >=1.5.0"]
+  p.url = "http://visionmedia.github.com/commander"
+  p.runtime_dependencies << "highline >=1.5.0"
 end
 
 Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -1,13 +1,13 @@
 
 == Major
 
-* Prevent global options from overriding sub-command level options
 * Finish global --trace
 * 1.9.x compatability
 * Publish RDoc on mini page / screencasts
 
 == Minor
 
+* Prevent global options from overriding sub-command level options
 * Add arbitrary help blocks to sub-commands as well
 * Spec for changing out formatters (mock formatter)
 * Add optional default command when none is present

data/commander.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.1.2"
+  s.version = "3.1.4"
 
   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-16}
+  s.date = %q{2009-03-20}
   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/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_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/ui", "Todo.rdoc"]
+  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/ui", "Todo.rdoc"]
   s.has_rdoc = true
-  s.homepage = %q{http://github.com/visionmedia/commander}
+  s.homepage = %q{http://visionmedia.github.com/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{commander}

data/lib/commander.rb

@@ -21,11 +21,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-$:.unshift File.dirname(__FILE__)
-
-require 'rubygems'
 require 'highline/import'
 require 'commander/version'
+require 'commander/blank'
 require 'commander/user_interaction'
 require 'commander/core_ext'
 require 'commander/runner'

data/lib/commander/blank.rb

@@ -0,0 +1,6 @@
+
+# TODO: remove when 1.9.x compatible, utilize BasicObject conditionally 
+
+class BlankSlate
+  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+end

data/lib/commander/command.rb

@@ -1,6 +1,5 @@
 
 require 'optparse'
-require 'ostruct'
 
 module Commander
   class Command
@@ -10,11 +9,20 @@ module Commander
     
     ##
     # Options struct.
-    
-    class Options < OpenStruct
+
+    class Options < BlankSlate
+      def method_missing meth, *args, &block
+        if meth.to_s =~ /=$/
+          metaclass = class << self; self end
+          metaclass.send :define_method, meth.to_s.chop do
+            args.first
+          end
+        end
+      end
+      
       def default defaults = {}
         defaults.each do |key, value|
-          send "#{key}=", value if send(key).nil?
+          __send__ :"#{key}=", value if __send__(key).nil?
         end
       end
     end
@@ -195,7 +203,7 @@ module Commander
     
     def proxy_option_struct
       @proxy_options.inject Options.new do |options, (option, value)|
-        options.send :"#{option}=", value if option
+        options.__send__ :"#{option}=", value
         options
       end
     end

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

@@ -17,6 +17,12 @@
   <%= $terminal.color "ALIASES", :bold %>:
   <% @aliases.each do |alias_name, args| %>
     <%= "%-20s %s %s" % [alias_name, command(alias_name).name, args.join(' ')] -%>
+  <% end %>
+<% end %>
+<% unless @options.empty? -%>
+  <%= $terminal.color "GLOBAL OPTIONS", :bold %>:
+  <% @options.each do |(args, proc)| %>
+    <%= "%-20s %s" % [args.shift, args.last.is_a?(String) ? args.last : ''] -%>
   <% end -%>
 <% end %>
 <% if program :help -%>

data/lib/commander/runner.rb

@@ -11,7 +11,15 @@ module Commander
     class CommandError < StandardError; end
     class InvalidCommandError < CommandError; end
     
-    attr_reader :commands, :options
+    ##
+    # Array of commands.
+    
+    attr_reader :commands
+    
+    ##
+    # Global options.
+    
+    attr_reader :options
 
     ##
     # Initialize a new command runner. Optionally
@@ -28,9 +36,10 @@ module Commander
     
     def run!
       require_program :name, :version, :description
-      global_option('-h', '--help') { command(:help).run *@args[1..-1]; return }
-      global_option('-v', '--version') { say version; return } 
+      global_option('--help', 'Display help documentation') { command(:help).run *@args[1..-1]; return }
+      global_option('--version', 'Display version information') { say version; return } 
       parse_global_options
+      remove_global_options
       call_active_command
     rescue InvalidCommandError
       say 'invalid command. Use --help for more information'
@@ -231,13 +240,33 @@ module Commander
         end
       end
     end
+    
+    ##
+    # Removes global options from args. This prevents an invalid
+    # option error from ocurring when options are parsed
+    # again for the sub-command.
+    
+    def remove_global_options
+      # TODO: refactor with flipflop
+      options.each do |(args, proc)|
+        switch, has_arg = args.first.split
+        past_switch, arg_removed = false, false
+        @args.delete_if do |arg|
+          if arg == switch
+            past_switch, arg_removed = true, false
+            true
+          elsif past_switch && !arg_removed && arg !~ /^-/ 
+            arg_removed = true
+          else
+            arg_removed = true
+            false
+          end
+        end
+      end
+    end
             
     ##
     # Parse global command options.
-    #
-    # These options are used by commander itself 
-    # as well as allowing your program to specify 
-    # global commands such as '--verbose'.
     
     def parse_global_options
       options.inject OptionParser.new do |options, (args, proc)|

data/lib/commander/user_interaction.rb

@@ -78,24 +78,24 @@ module Commander
       #
       # === Options:
       #    
-      #    :title              Title, defaults to "Progress"
-      #    :width              Width of :progress_bar
-      #    :progress_str       Progress string, defaults to "="
-      #    :incomplete_str     Incomplete bar string, defaults to '.'
-      #    :format             Defaults to ":title |:progress_bar| :percent_complete% complete "
-      #    :tokens             Additional tokens replaced within the format string
-      #    :complete_message   Defaults to "Process complete"
+      #   :title              Title, defaults to "Progress"
+      #   :width              Width of :progress_bar
+      #   :progress_str       Progress string, defaults to "="
+      #   :incomplete_str     Incomplete bar string, defaults to '.'
+      #   :format             Defaults to ":title |:progress_bar| :percent_complete% complete "
+      #   :tokens             Additional tokens replaced within the format string
+      #   :complete_message   Defaults to "Process complete"
       #
       # === Tokens:
       #
-      #    :title 
-      #    :percent_complete
-      #    :progress_bar
-      #    :step
-      #    :steps_remaining
-      #    :total_steps
-      #    :time_elapsed
-      #    :time_remaining
+      #   :title 
+      #   :percent_complete
+      #   :progress_bar
+      #   :step
+      #   :steps_remaining
+      #   :total_steps
+      #   :time_elapsed
+      #   :time_remaining
       #
 
       def initialize total, options = {}
@@ -212,10 +212,10 @@ module Commander
       #
       # === Example:
       #
-      #    uris = %w( http://vision-media.ca http://google.com )
-      #    ProgressBar.progress uris, :format => "Remaining: :time_remaining" do |uri|
-      #      res = open uri
-      #    end
+      #   uris = %w( http://vision-media.ca http://google.com )
+      #   ProgressBar.progress uris, :format => "Remaining: :time_remaining" do |uri|
+      #     res = open uri
+      #   end
       #
       # === See:
       #

data/lib/commander/version.rb

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

data/spec/command_spec.rb

@@ -6,6 +6,24 @@ describe Commander::Command do
     create_test_command
   end
   
+  describe 'Options' do
+    before :each do
+      @options = Commander::Command::Options.new  
+    end
+    
+    it "should act like an open struct" do
+      @options.send = 'mail'
+      @options.password = 'foobar'
+      @options.send.should == 'mail'
+      @options.password.should == 'foobar'
+    end
+    
+    it "should allow __send__ to function as always" do
+      @options.send = 'foo'
+      @options.__send__(:send).should == 'foo'
+    end
+  end
+  
   describe "#seperate_switches_from_description" do
     it "should seperate switches and description returning both" do
       switches, description = *@command.seperate_switches_from_description('-h', '--help', 'display help')
@@ -23,6 +41,12 @@ describe Commander::Command do
       @command.option('--recursive') { |recursive| recursive.should be_true }
       @command.run '--recursive'
     end
+    
+    it "should allow usage of common method names" do
+      @command.option '--password STRING'
+      @command.when_called { |_, options| options.password.should == 'foo' }  
+      @command.run '--password', 'foo'
+    end
   end
     
   describe "#options" do
@@ -53,14 +77,14 @@ describe Commander::Command do
       
       it "calling the #call method by default when an object is called" do
         object = mock 'Object'
-        object.should_receive(:call).with(an_instance_of(Array), an_instance_of(Commander::Command::Options)).once
+        object.should_receive(:call).once
         @command.when_called object
         @command.run 'foo'        
       end
             
       it "calling an arbitrary method when an object is called" do
         object = mock 'Object'
-        object.should_receive(:foo).with(an_instance_of(Array), an_instance_of(Commander::Command::Options)).once
+        object.should_receive(:foo).once
         @command.when_called object, :foo
         @command.run 'foo'        
       end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 
+require 'rubygems'
 require 'commander'
 require 'stringio'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.1.2
+  version: 3.1.4
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 -07:00
+date: 2009-03-20 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,7 @@ extensions: []
 
 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
@@ -52,6 +53,7 @@ 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
@@ -85,7 +87,7 @@ files:
 - test/ui
 - Todo.rdoc
 has_rdoc: true
-homepage: http://github.com/visionmedia/commander
+homepage: http://visionmedia.github.com/commander
 post_install_message: 
 rdoc_options: 
 - --line-numbers