opt-simple 0.7.2 → 0.7.3

data/README

@@ -15,7 +15,9 @@ There are three methods to define command line parameters:
  argument - a mandatory command line parameter with one or more arguments
 
 Inside the blocks in flag, option, and argument a shortcut function called 'set_opt'
-can be used to set an option that will be returned in the options hash.
+can be used to set an option that will be returned in the options hash. The 'accumulate_opt'
+method can be used in the option and argument blocks to create a list of values, and in 
+the flag block to increment a counter (with verbosity being the classic example). 
 
 The number of arguments are determined by the 'arity' of the block. 
 
@@ -103,6 +105,39 @@ It is recommended to install OptSimple using RubyGems:
  puts "ARGV"
  puts ARGV
 
+=== An example that shows how to use 'accumulate_opt' on an option to create a list, and on a flag to increment a counter
+
+require 'opt_simple'
+
+verbosity = 0
+
+options,arguments = OptSimple.new.parse_opts! do 
+  option %w[-i --infile], "Infile, multiple allowed", "INFILE" do | arg |
+    accumulate_opt arg
+  end
+
+  flag %w[-v  --verbose],"Verbosity. the more you set, the more we give" do 
+    verbosity += 1
+  end
+
+  flag %w[-m --more-cow-bell], "I've got a fever" do 
+    accumulate_opt
+  end
+end
+
+puts "Options"
+puts options.inspect
+
+puts "Arguments"
+puts arguments.inspect
+
+puts "Verbosity"
+puts verbosity
+
+puts "ARGV"
+puts ARGV
+
+
 === An example that shows that you can easily set your defaults in normal Ruby variables and provide your own help.
 
  require 'opt_simple'

data/lib/opt_simple.rb

@@ -96,25 +96,36 @@ class OptSimple
 
 	# now actually parse the args, and call all the stored up blocks from the options
 	@parameters.each do | parm |
-	  intersection =  @args & parm.switches
+	  mandatory_check.delete(parm.switches)
+	  intersection = @args & parm.switches
 	  unless intersection.empty?
-	    loc = @args.index(intersection.first)
-	    
-	    # remove the flag, but skip it to put it into pieces
-	    pieces = @args.slice!(loc .. loc + parm.block.arity)[1..-1]
-	    if pieces.length < parm.block.arity or
-		pieces.any? {|p| p.start_with?('-')}
-	      raise OptSimple::MissingArgument.new "Not enough args following #{intersection.first}",self 
+	 
+	    arg_locations =  []
+	    @args.each_with_index {|arg,i| arg_locations << i if intersection.include?(arg) }
+
+	    # we want to process the args in order to provide predictable behavior
+	    # in the case of switch duplication. 
+	    # We do pull them out in reverse so that the slicing removes pieces from the end 
+	    # of @args, so we don't disrupt the other locations, but put them into 'chunks'
+	    # backwards to restore their order. 
+	    chunks = []
+	    arg_locations.sort.reverse.each do |loc|  
+	      chunks.unshift @args.slice!(loc .. loc + parm.block.arity)[1..-1]
 	    end
-	    
-	    mandatory_check.delete(parm.switches)
 
-	    begin
-	      parm.instance_exec(*pieces,&parm.block)
-	    rescue OptSimple::Error => e
-	      raise OptSimple::Error.new e.message,self
+	    chunks.each do | pieces |
+	      if pieces.length < parm.block.arity or
+		  pieces.any? {|p| p.start_with?('-')}
+		raise OptSimple::MissingArgument.new "Not enough args following #{intersection}",self 
+	      end
+	      
+	      begin
+		parm.instance_exec(*pieces,&parm.block)
+	      rescue OptSimple::Error => e
+		raise OptSimple::Error.new e.message,self
+	      end
 	    end
-
+	    
 	    @options.merge!(parm.param_options)
 	  end
 	end
@@ -286,11 +297,11 @@ class OptSimple
       @names ||= switches.map {|s| s.sub(/^-+/,'')}
     end
 
-    def switch_len
+    def switch_len #:nodoc:
       @switches.join(', ').length 
     end
 
-    def switch_str
+    def switch_str #:nodoc:
       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?('-')}
@@ -335,10 +346,18 @@ class OptSimple
   class Flag < Parameter
     def initialize(switches,help="",&block)
       super(switches,help,&block)
-      unless block_given?
+      if block_given?
+	names.each {|n| @param_options[n] = 0 }
+      else
 	@block = Proc.new { names.each {|n| @param_options[n] = true}}
       end
     end
+
+    # increment the parameter by one every time it is seen on the CL
+    def accumulate_opt
+      names.each {|n| @param_options[n] += 1}
+    end
+
   end
 
   # An optional parameter, with one or more argument following it.
@@ -354,19 +373,27 @@ class OptSimple
     def initialize(switches,help="",metavar="ARG",&block)
       super(switches,help,&block)
       @metavar = metavar
-      unless block_given?
+      if block_given?
+	names.each {|n| @param_options[n] = []}
+      else
 	@block = Proc.new {|arg| names.each {|n| @param_options[n] = arg}}
       end
     end
 
-    def switch_len
+    def switch_len #:nodoc:
       metavar_space = @metavar.empty? ? 0 : @metavar.length + 1 
       super + metavar_space
     end
 
-    def switch_str
+    def switch_str #:nodoc:
       super + " #{@metavar}"
     end
+
+    # append val to the parameter list
+    def accumulate_opt(val)
+      names.each {|n| @param_options[n] << val}
+    end
+
   end
   
   # A mandatory parameter, with one or more argument following it.

data/test/test_usage.rb

@@ -42,5 +42,40 @@ class TestHelpStatement < Test::Unit::TestCase
     assert_equal x,4
     assert_equal y,5
   end
+
+  must "accumulate lists of args when asked" do 
+    os = OptSimple.new({},%w[-i foo.bar --infile bar.in])
+    o,a = os.parse_opts! do 
+      option %w[-i --infile], "Infile, multiple allowed", "INFILE" do | arg |
+	accumulate_opt arg
+      end
+    end
+
+    assert_equal o['i'],%w[foo.bar bar.in]
+    assert_equal o['infile'],%w[foo.bar bar.in]
+  end
+
+  must "accumulate numbers of flags set when asked" do 
+    os = OptSimple.new({},%w[-v -v --verbose -v])
+    o,a = os.parse_opts! do 
+      flag %w[-v  --verbose],"Verbosity. the more you set, the more we give" do 
+	accumulate_opt
+      end
+    end
+    assert_equal o['v'],4
+    assert_equal o['verbose'],4
+  end
+
+  must "set last arg when duplicated when accumulate opt isn't used" do 
+    os = OptSimple.new({},%w[-i foo.bar --infile bar.in -i baz])
+    o,a = os.parse_opts! do 
+      option %w[-i --infile], "Infile, multiple allowed", "INFILE" do | arg |
+	set_opt arg
+      end
+    end
+
+    assert_equal o['i'],'baz'
+    assert_equal o['infile'],'baz'
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: opt-simple
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Ethan Stryker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-06 00:00:00 +00:00
+date: 2011-03-12 00:00:00 +00:00
 default_executable: 
 dependencies: []