subcommander 1.0.3 → 1.0.4

data/README.markdown

@@ -1,4 +1,4 @@
-Subcommander is a wrapper around Ruby's OptionParser class that allows you to have sub-commands like we see in Git and other tools. To get help for your tool, just type in the tool name with no sub-command (or the word "help" as a sub-command).  To get help for a sub-command type:
+Subcommander is a wrapper around Ruby's OptionParser class that allows you to have sub-commands like we see in Git and other tools. Subcommands can be nested so your subcommands can have subcommands. To get help for your tool, just type in the tool name with no sub-command (or the word "help" as a sub-command).  To get help for a sub-command type:
 
     your-tool help sub-command
 
@@ -6,7 +6,7 @@ More description coming... this is basically a placeholder for now.
 
 ### Simple Example:
 
-    require 'subcommander'
+		%w[rubygems subcommander].each { |m| require m }
     include Subcommander
     
     subcommander.version = '1.0.0'
@@ -26,16 +26,50 @@ More description coming... this is basically a placeholder for now.
     
     subcommander.go!
 
+### Nested Subcommands Example:
+
+		%w[rubygems subcommander].each { |m| require m }
+		include Subcommander
+
+		subcommander.version = '1.0.0'
+		subcommander.desc = "ComplexTool is ephemeral and only here to demonstrate Subcommander."
+
+		subcommand :run, "Commands for running the complex tool" do |run|
+		  run.subcommand 'on-foot', "Run down the street" do |sc|
+		    sc.usage = "complextool run on-foot [-f | -s]"
+				sc.opt :fast, '-f', '--fast', "Run fast!"
+				sc.opt :slow, '-s', '--slow', "Run slow."
+				sc.exec {
+					speed = "at a normal pace"
+					if sc[:fast]
+						speed = 'fast'
+					elsif sc[:slow]
+					  speed = 'slow'
+					end
+					puts "We're running #{speed}"
+				}
+		  end
+		  run.subcommand 'an-app', "Run an app" do |sc|
+		    sc.arity = 1
+		    sc.usage = "complextool run an-app NAME"
+				sc.exec {
+					app = sc[:remaining_args][0]
+					puts "Running #{app}"
+				}
+		  end
+		end
+
+		subcommander.go!
+
 ---------------------------
 
 # subcommander #
 
 Properties you can set:
 
-__version__ - The version of the tool you're making.  It's printed at the bottom of help.
-
 __desc__ - A description of the tool you're using.  It's printed at the beginning of help.
 
+__version__ - The version of the tool you're making.  It's printed at the bottom of help.
 
 ---------------------------
 # subcommand #
@@ -44,11 +78,13 @@ Properties you can set:
 
 __arity__ - This says how many arguemnts are expected to be passed to this sub-command, excluding options and their arguemnts.
 
-__help__ - Help that shows up when the user asks for help about the sub-command
+__exec__ - The implementation for your sub-command should be in a block that's passed to this method.
 
-__usage__ - The typical usage pattern like "simple-tool [options] args"
+__help__ - Help that shows up when the user asks for help about the sub-command
 
 __opt__ - These are exactly the same as OptionParser opt.on() argument lists except the first argument is a token.  When the option is invoked, it will put any option arguemnts that were passed into the subcommand keyed by that token.  So subcommand[:yoursymbol] is where you'll find it when you're looking for it in your exec block.
 
-__exec__ - The implementation for your sub-command should be in a block that's passed to this method.
+__subcommand__ - Allows your subcommand to have it's own subcommands.
+
+__usage__ - The typical usage pattern like "simple-tool [options] args"
 

data/lib/subcommander.rb

@@ -141,7 +141,7 @@ module Subcommander
     def subcommand name, desc, &block
       unless @sub_cmdr
         @sub_cmdr = Subcommander.new(@args.clone())
-        @sub_cmdr.desc = lambda { @help }
+        @sub_cmdr.desc = lambda { @help ? @help : @desc }
       end
       @sub_cmdr.subcommand(name, desc, &block)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: subcommander
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Tom Santos
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-17 00:00:00 -07:00
+date: 2011-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: []