subcommand 1.0.4 → 1.0.5

data/CHANGELOG.rdoc

@@ -0,0 +1,9 @@
+= subcommand 1.0.4 2010-06-24 15:51 
+* text for subcommands was being processed always before execution, so the
+point of lazy loading was lost. I've moved it away so it's only processed if
+actually printing help.
+
+Howeve, this means that if you are relying on OptionParser's implicit --help,
+that won't print subcommands. So i've added a method add_help_option which
+adds a correct help option, to print subcommands. This way, command help and
+command --help print identical output.

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.5

data/lib/subcommand.rb

@@ -90,6 +90,48 @@ module Subcommands
       yield @global
     end
   end
+  def print_actions
+    cmdtext = "Commands are:"
+    @commands.each_pair do |c, opt| 
+      #puts "inside opt.call loop"
+      desc = opt.call.description
+      cmdtext << "\n   #{c} : #{desc}"
+    end
+
+    # print aliases
+    unless @aliases.empty?
+      cmdtext << "\n\nAliases: \n" 
+      @aliases.each_pair { |name, val| cmdtext << "   #{name} - #{val}\n"  }
+    end
+
+    cmdtext << "\n\nSee '#{$0} help COMMAND' for more information on a specific command."
+  end
+  ## add text of subcommands in help and --help option
+  def add_subcommand_help
+    # user has defined some, but lets add subcommand information
+
+    cmdtext = print_actions
+
+    global_options do |opts|
+      # lets add the description user gave into banner
+      opts.banner << "\n#{opts.description}\n" if opts.description
+      opts.separator ""
+      opts.separator cmdtext
+    end
+  end
+  # this is so that on pressing --help he gets same subcommand help as when doing help.
+  # This is to be added in your main program, after defining global options
+  # if you want detailed help on --help. This is since optionparser's default
+  # --help will not print your actions/commands
+  def add_help_option
+    global_options do |opts|
+      opts.on("-h", "--help", "Print this help") do |v|
+        add_subcommand_help
+        puts @global
+        exit
+      end
+    end
+  end
   # first parse global optinos
   # then parse subcommand options if valid subcommand
   # special case of "help command" so we print help of command - git style (3)
@@ -104,34 +146,14 @@ module Subcommands
         opts.separator ""
         opts.separator "Global options are:"
         opts.on("-h", "--help", "Print this help") do |v|
+          add_subcommand_help
           puts @global
           exit
         end
         opts.separator ""
-        opts.separator subtext
+        #opts.separator subtext # FIXME: no such variable supposed to have subcommand help
       end
     else
-      # user has defined some, but lets add subcommand information
-      cmdtext = "Commands are:"
-      @commands.each_pair do |c, opt| 
-        desc = opt.call.description
-        cmdtext << "\n   #{c} : #{desc}"
-      end
-      
-      # print aliases
-      unless @aliases.empty?
-        cmdtext << "\n\nAliases: \n" 
-        @aliases.each_pair { |name, val| cmdtext << "   #{name} - #{val}\n"  }
-      end
-
-      cmdtext << "\n\nSee '#{$0} help COMMAND' for more information on a specific command."
-
-      global_options do |opts|
-        # lets add the description user gave into banner
-        opts.banner << "\n#{opts.description}\n" if opts.description
-        opts.separator ""
-        opts.separator cmdtext
-      end
     end
     @global.order!
     cmd = ARGV.shift
@@ -163,11 +185,13 @@ module Subcommands
           else 
             # no help for this command XXX check for alias
             puts "Invalid command: #{cmd}."
+            add_subcommand_help
             puts @global
           end
         else
           # invalid command 
           puts "Invalid command: #{cmd}" unless cmd == "help"
+          add_subcommand_help
           puts @global 
         end
         exit 0
@@ -211,6 +235,7 @@ if __FILE__ == $PROGRAM_NAME
       options[:verbose] = v
     end
   end
+  add_help_option
   # define a command
   command :foo, :goo do |opts|
     opts.banner = "Usage: foo [options]"

data/subcommand.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{subcommand}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rahul Kumar"]
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "Makefile",
      "README.rdoc",
@@ -40,7 +41,9 @@ Gem::Specification.new do |s|
      "tests/t0006-goo_opt.sh",
      "tests/t0007-bar_baz.sh",
      "tests/t0008-boo_zoo.sh",
-     "tests/test-lib.sh"
+     "tests/test-lib.sh",
+     "tests/test.rb",
+     "tests/test1.rb"
   ]
   s.homepage = %q{http://github.com/rkumar/subcommand}
   s.rdoc_options = ["--charset=UTF-8"]

data/tests/recreate.sh

@@ -24,10 +24,12 @@ echo "Using suffix:$str"
 read -p "press enter "
 grep '^>>> ' "$oldfile" | sed 's/^>>> //' 
 read -p "press enter "
+cp serial_numbers serial_numbers.xxx
 grep '^>>> ' "$oldfile" | sed 's/^>>> //' | ./rtest2.sh $LOADSTR "$str"
 
 echo
 echo renaming old file with O prefix
 mv "$oldfile" O$oldfile
+cp serial_numbers.xxx serial_numbers
 echo "If you don't find a test case, then rename transcript.txt to $oldfile"
 echo "cp transcript.txt $oldfile"

data/tests/t0001-main.sh

@@ -12,6 +12,7 @@ Stupid program that does something
 
 Global options are:
     -v, --[no-]verbose               Run verbosely
+    -h, --help                       Print this help
 
 Commands are:
    foo : desc for foo
@@ -26,12 +27,15 @@ Aliases:
 
 See 'bin/subcommand.rb help COMMAND' for more information on a specific command.
 >>> end
+>>> end
+>>> end
 >>> ruby bin/subcommand.rb --help
 Usage: subcommand.rb [options] [subcommand [options]]
 Stupid program that does something
 
 Global options are:
     -v, --[no-]verbose               Run verbosely
+    -h, --help                       Print this help
 
 Commands are:
    foo : desc for foo
@@ -46,6 +50,8 @@ Aliases:
 
 See 'bin/subcommand.rb help COMMAND' for more information on a specific command.
 >>> end
+>>> end
+>>> end
 
 EOF
 test_done

data/tests/t0003-inv_comm.sh

@@ -13,6 +13,7 @@ Stupid program that does something
 
 Global options are:
     -v, --[no-]verbose               Run verbosely
+    -h, --help                       Print this help
 
 Commands are:
    foo : desc for foo
@@ -27,6 +28,8 @@ Aliases:
 
 See 'bin/subcommand.rb help COMMAND' for more information on a specific command.
 >>> end
+>>> end
+>>> end
 >>> ruby bin/subcommand.rb fxxx --help
 Invalid command: fxxx
 Usage: subcommand.rb [options] [subcommand [options]]
@@ -34,6 +37,7 @@ Stupid program that does something
 
 Global options are:
     -v, --[no-]verbose               Run verbosely
+    -h, --help                       Print this help
 
 Commands are:
    foo : desc for foo
@@ -48,6 +52,8 @@ Aliases:
 
 See 'bin/subcommand.rb help COMMAND' for more information on a specific command.
 >>> end
+>>> end
+>>> end
 
 EOF
 test_done

data/tests/test.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby -w
+require 'subcommand'
+
+if __FILE__ == $PROGRAM_NAME
+  include Subcommands
+  options = {}
+  appname = File.basename($0)
+  # global is optional
+  #global_options do |opts|
+    #opts.banner = "Usage: #{appname} [options] [subcommand [options]]"
+    #opts.description = "Stupid program that does something"
+    #opts.separator ""
+    #opts.separator "Global options are:"
+    #opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      #options[:verbose] = v
+    #end
+  #end
+  # define a command
+  command :foo, :goo do |opts|
+    opts.banner = "Usage: foo [options]"
+    opts.description = "desc for foo"
+    opts.on("-f", "--[no-]force", "force verbosely") do |v|
+      options[:force] = v
+    end
+  end
+  command :baz do |opts|
+    opts.banner = "Usage: baz [options]"
+    opts.description = "desc for baz"
+    opts.on("-q", "--[no-]quiet", "quietly run ") do |v|
+      options[:quiet] = v
+    end
+  end
+  alias_command :bar, 'baz'
+  alias_command :boo, 'foo', '--force'
+  alias_command :zoo, 'foo', 'ruby'
+
+  # do the parsing.
+  cmd = opt_parse()
+
+  puts "cmd: #{cmd}"
+  puts "options ......"
+  p options
+  puts "ARGV:"
+  p ARGV
+end

data/tests/test1.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby -w
+######################################
+require 'subcommand'
+
+if __FILE__ == $PROGRAM_NAME
+  include Subcommands
+  options = {}
+  appname = File.basename($0)
+  # global is optional
+  global_options do |opts|
+    opts.banner = "Usage: #{appname} [options] [subcommand [options]]"
+    opts.description = "Stupid program that does something"
+    opts.separator ""
+    opts.separator "Global options are:"
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      options[:verbose] = v
+    end
+  end
+  add_help_option
+  # define a command
+  command :foo, :goo do |opts|
+    opts.banner = "Usage: foo [options]"
+    opts.description = "desc for foo"
+    opts.on("-f", "--[no-]force", "force verbosely") do |v|
+      options[:force] = v
+    end
+  end
+  command :baz do |opts|
+    opts.banner = "Usage: baz [options]"
+    opts.description = "desc for baz"
+    opts.on("-q", "--[no-]quiet", "quietly run ") do |v|
+      options[:quiet] = v
+    end
+  end
+  alias_command :bar, 'baz'
+  alias_command :boo, 'foo', '--force'
+  alias_command :zoo, 'foo', 'ruby'
+
+  # do the parsing.
+  cmd = opt_parse()
+
+  puts "cmd: #{cmd}"
+  puts "options ......"
+  p options
+  puts "ARGV:"
+  p ARGV
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - Rahul Kumar
@@ -42,6 +42,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - Makefile
 - README.rdoc
@@ -63,6 +64,8 @@ files:
 - tests/t0007-bar_baz.sh
 - tests/t0008-boo_zoo.sh
 - tests/test-lib.sh
+- tests/test.rb
+- tests/test1.rb
 - TODO
 has_rdoc: true
 homepage: http://github.com/rkumar/subcommand