opt-simple 0.7.1 → 0.7.2

data/README

@@ -55,13 +55,13 @@ It is recommended to install OptSimple using RubyGems:
  puts ARGV
  
  
-=== An example that provides error checking on ARGV, using all default behavior
+=== An example that provides error checking on ARGV, using all default behavior and how to specify a 'metavar'
  
  require 'opt_simple'
  
  options,arguments = OptSimple.new.parse_opts! do 
-   argument "-i","inFile" 
-   option %w[-p --pattern --glob-pattern], "glob pattern"
+   argument "-i","inFile","FILE"
+   option %w[-p --pattern --glob-pattern], "glob pattern","PATTERN"
    flag "-v","Verbose"
    flag "-whatever"
  end

data/lib/opt_simple.rb

@@ -70,7 +70,7 @@ class OptSimple
 	# actually get parsed. 
 	
 	# add the help option at the end
-	option %w[-h --help] ,"(for this help message)"
+	flag %w[-h --help] ,"(for this help message)"
 	
 	# first look for a call for help
 	unless (%w[-h --help] & @args).empty?
@@ -85,6 +85,15 @@ class OptSimple
 	  @positional_arguments += @args.slice!(loc..-1)[1..-1] 
 	end
 	
+	# Handle the case where a user specifies --foo=bar, or --foo=bar,baz
+	equal_args = @args.find_all {|arg| arg.include?('=') }
+	@args.delete_if {|arg| arg.include?('=') }
+	equal_args.each do | e |
+	  switch,list = e.split('=')
+	  @args << switch
+	  list.split(',').each {|val| @args << val }
+	end
+
 	# now actually parse the args, and call all the stored up blocks from the options
 	@parameters.each do | parm |
 	  intersection =  @args & parm.switches
@@ -174,24 +183,26 @@ class OptSimple
 
   # Registers an optional parameter, with one or more argument following it.
   # 'switches' can be a String or an Array of Strings, and specifies the switches expected on the CL.
-  # 'help' provides a description of the parameter
+  # 'help' provides a description of the parameter, and 'metavar' will be used in the
+  # usage statement.
   # and an optional block can do parameter validation/transformation.
   # If no block is given, then the strings specified (after the 
   # leading '-'s removed) will be used as keys in the options hash 
   # and the values set to the arg following the switch in the args array.
-  def option(switches,help="",&block)
-    add_parameter(Option.new(switches,help,&block))
+  def option(switches,help="",metavar="ARG",&block)
+    add_parameter(Option.new(switches,help,metavar,&block))
   end
 
   # Registers a mandatory parameter, with one or more argument following it.
   # 'switches' can be a String or an Array of Strings, and specifies the switches expected on the CL.
-  # 'help' provides a description of the parameter
+  # 'help' provides a description of the parameter, and 'metavar' will be used in the
+  # usage statement.
   # and an optional block can do parameter validation/transformation.
   # If no block is given, then the strings specified (after the 
   # leading '-'s removed) will be used as keys in the options hash 
   # and the values set to the arg following the switch the args array.
-  def argument(switches,help="",&block)
-    add_parameter(Argument.new(switches,help,&block))
+  def argument(switches,help="",metavar="ARG",&block)
+    add_parameter(Argument.new(switches,help,metavar,&block))
   end
 
   # A shortcut for raising an OptSimple::Error exception
@@ -232,8 +243,8 @@ class OptSimple
   # You probably don't want to call this method. 
   # A lower level function that adds a Flag, Option, or Argument,
   def add_parameter(parm)
-    total_switch_len = parm.switches.join(', ').length
-    @longest_switch_len = total_switch_len if total_switch_len > @longest_switch_len
+    
+    @longest_switch_len = parm.switch_len if parm.switch_len > @longest_switch_len
 
     parm.names.each do | n |
       if @param_names.has_key?(n)
@@ -252,7 +263,7 @@ class OptSimple
   # Option and Argument are derived. Provides documentation methods, 
   # an 'error method', and the 'set_opt' utility funciton. 
   class Parameter
-    attr_reader :switches,:param_options,:block
+    attr_reader :switches,:param_options,:metavar,:block
 
     # 'switches' can be a String or an Array of Strings, and specifies the switches expected on the CL.
     # 'help' provides a description of the parameter
@@ -275,8 +286,11 @@ class OptSimple
       @names ||= switches.map {|s| s.sub(/^-+/,'')}
     end
 
-    # a single line that will be put in the overall usage string
-    def help_str(switch_len)
+    def switch_len
+      @switches.join(', ').length 
+    end
+
+    def switch_str
       short_parms = @switches.find_all {|st| st.start_with?('-') and st.length == 2 and st[1] != '-'} 
       long_parms = @switches.find_all {|st| st.start_with?('--') or (st.start_with?('-') and st.length > 2)} 
       other_parms = @switches.find_all {|st| not st.start_with?('-')}
@@ -284,8 +298,13 @@ class OptSimple
       sh_str = short_parms.empty? ?  " " * 4 : short_parms.first
       long_str = long_parms.join(', ') + other_parms.join(', ')
       sh_str << ', ' unless sh_str =~/^\s+$/ or long_str.empty?
-      
-      "    %-#{switch_len}s" % (sh_str + long_str) + " \t#{@help}"
+
+      sh_str + long_str
+    end
+
+    # a single line that will be put in the overall usage string
+    def help_str(switch_len)
+      "    %-#{switch_len}s"  % self.switch_str + " \t#{@help}"
     end
 
     # A shortcut for raising an OptSimple::Error exception
@@ -324,23 +343,36 @@ class OptSimple
 
   # An optional parameter, with one or more argument following it.
   # 'switches' can be a String or an Array of Strings, and specifies the switches expected on the CL.
-  # 'help' provides a description of the parameter
+  # 'help' provides a description of the parameter, and 'metavar' will be used in the
+  # usage statement.
   # and an optional block can do parameter validation/transformation.
   # If no block is given, then the strings specified (after the 
   # leading '-'s removed) will be used as keys in the options hash 
   # and the values set to the arg following the switch in the args array.
   class Option < Parameter
-    def initialize(switches,help="",&block)
+    attr_reader = :metavar
+    def initialize(switches,help="",metavar="ARG",&block)
       super(switches,help,&block)
+      @metavar = metavar
       unless block_given?
 	@block = Proc.new {|arg| names.each {|n| @param_options[n] = arg}}
       end
     end
+
+    def switch_len
+      metavar_space = @metavar.empty? ? 0 : @metavar.length + 1 
+      super + metavar_space
+    end
+
+    def switch_str
+      super + " #{@metavar}"
+    end
   end
   
   # A mandatory parameter, with one or more argument following it.
   # 'switches' can be a String or an Array of Strings, and specifies the switches expected on the CL.
-  # 'help' provides a description of the parameter
+  # 'help' provides a description of the parameter, and 'metavar' will be used in the
+  # usage statement.
   # and an optional block can do parameter validation/transformation.
   # If no block is given, then the strings specified (after the 
   # leading '-'s removed) will be used as keys in the options hash 

data/test/test_help.rb

@@ -42,4 +42,10 @@ class TestHelpStatement < Test::Unit::TestCase
     os.summary "My summary"
     assert os.to_s.match(Regexp.new("My summary",Regexp::MULTILINE))
   end
+
+  must "add metavars to help statement" do 
+    os = OptSimple.new({},['-h'])
+    os.add_parameter(OptSimple::Option.new '-a',"some help","THING")
+    assert os.to_s.match(Regexp.new("\-a.*THING.*some help",Regexp::MULTILINE))
+  end
 end

data/test/test_usage.rb

@@ -24,5 +24,23 @@ class TestHelpStatement < Test::Unit::TestCase
     end
   end
 
+  must "handle arguments with equals and commas" do
+    os = OptSimple.new({},['-a=2','--foo=4,5'])
+    x = nil
+    y = nil
+    opts, args = os.parse_opts! do
+      option '-a' do |arg| 
+	set_opt arg.to_i
+      end
+      option "--foo" do |a,b|
+	x = a.to_i
+	y = b.to_i
+      end
+    end
+
+    assert_equal opts['a'],2
+    assert_equal x,4
+    assert_equal y,5
+  end
 end
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: opt-simple
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  hash: 7
+  prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Ethan Stryker
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 +00:00
+date: 2011-03-06 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -40,21 +46,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: opt-simple
-rubygems_version: 1.3.5
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: A simple and elegant command line option parser.