opt-simple 0.9.10 → 0.9.11

data/README

@@ -18,7 +18,8 @@ can be used to set an option that will be returned in the Result. The 'accumulat
 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. 
+The number of arguments are determined by the 'arity' of the block, or a variable
+number if the splat operator is used. 
 
 The order in which the parameters are defined dictate their order on the command line.
 
@@ -62,12 +63,18 @@ It is recommended to install OptSimple using RubyGems:
  
    option %w[-p --pattern --glob-pattern], "glob pattern","PATTERN"
  
+   # this block has arity 2, so it expects to args to follow
    option "--range", "range: min,max (both >0)" do | arg1,arg2 |
      min,max = [arg1.to_i,arg2.to_i]
      set_opt [min,max]
       
      error "max must be greater than min" unless max > min
      error "both must be >=0" if min < 0
+   end  
+
+   # this block says that there are a variable number of arguments allowed
+   option %w[-t --things],"Some things - variable number allowed","THINGS" do | *args |
+     args.each {|a| accumulate_opt a }
    end
  end
  
@@ -94,7 +101,9 @@ It is recommended to install OptSimple using RubyGems:
 
  # Here, range was set to an Array. 
  puts "Range: #{opts.range.first} #{opts.range.last}"
- 
+
+ puts "Things: #{opts.things.inspect}"
+
 Which prints out an automatic usage statement:
  Usage: opt_ex.rb [options]
  
@@ -111,7 +120,9 @@ Which prints out an automatic usage statement:
      -p, --pattern, --glob-pattern PATTERN       glob pattern (default is '*')
  
          --range ARG                             range: min,max (both >0) (default is '[5, 10]')
- 
+
+         -t, --things THINGS                         Some things - variable number allowed 
+
      -h, --help                                  (for this help message)
 
 === A very simple example with no error checking. Use at your own risk!

data/lib/opt_simple.rb

@@ -127,13 +127,27 @@ class OptSimple
 	  # 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]
+
+	  arg_locations.sort.reverse.each do |loc| 
+	    # use the block's arity (Proc.new {|a,b| ...} has arity 2)
+	    # to determine how many args to slice off
+	    num_to_get = parm.block.arity 
+	    
+	    # but blocks with arity of -1 take a variable number of args
+	    # e.g. Proc.new {|*args| } has arity -1 (splat)
+	    if num_to_get == -1
+	      # so either go to the next switch, or if there is no switch, to the end of the @args list
+	      num_to_get = @args[loc + 1 ..-1].index {|a| a.start_with?('-')} || @args[loc + 1 ..-1].length
+	    end
+
+	    end_loc = loc + num_to_get
+	    chunks.unshift @args.slice!(loc .. end_loc)[1..-1]
 	  end
 	  
 	  chunks.each do | pieces |
-	    if pieces.length < parm.block.arity or
-		pieces.any? {|p| p.start_with?('-')}
+	    if parm.block.arity > 0 and 
+		(pieces.length < parm.block.arity or
+		 pieces.any? {|p| p.start_with?('-')})
 	      raise OptSimple::ParameterUsageError.new "Not enough args following #{intersection}",self 
 	    end
 	    
@@ -394,7 +408,8 @@ class OptSimple
       if block_given?
 	@param_options[names.first] = false
       else
-	@block = Proc.new { @param_options[names.first] = true}
+	#@block = Proc.new { @param_options[names.first] = true}
+	@block = Proc.new { set_opt true }
       end
     end
     
@@ -424,7 +439,8 @@ class OptSimple
       super(switches,help,&block)
       @metavar = metavar
       unless block_given?
-	@block = Proc.new {|arg| @param_options[names.first] = arg}
+	#@block = Proc.new {|arg| @param_options[names.first] = arg}
+	@block = Proc.new {|arg| set_opt arg}
       end
       @first_call = true # use this so we can accumulate non-defaults
     end

data/test/test_usage.rb

@@ -26,6 +26,15 @@ class TestHelpStatement < Test::Unit::TestCase
 	end
       end
     end
+
+    os = OptSimple.new({},%w[--range 5])
+    assert_raise(OptSimple::ParameterUsageError) do
+      os.parse_opts! do
+	argument '--range' do |min,max| 
+	  nil
+	end
+      end
+    end
   end
   
   must "raise error when unknown option is given" do 
@@ -135,5 +144,56 @@ class TestHelpStatement < Test::Unit::TestCase
 
     assert_equal o.some_stuff, %w[foo bar]
   end
+
+  must "successfully pull out two options following a switch when desired" do 
+    o = OptSimple.new(nil,%w[--range 4 9]).parse_opts! do 
+      argument "--range","min,max" do | arg1, arg2 |
+	set_opt [arg1.to_i,arg2.to_i]
+      end
+    end
+    
+    assert_equal o.range.first, 4
+    assert_equal o.range.last, 9
+  end
+
+
+  must "allow for a variable number of options following a switch when a splat is used" do 
+
+    arg_lists = [%w[--things foo --whatever],
+      %w[--things foo bar --whatever],
+      %w[--whatever --things foo bar baz]]
+    
+    arg_lists.each do |args | 
+      # Gotta account for  '--whatever and --things switch in there'
+      expected_len = args.length - 2
+      os = OptSimple.new(nil,args).parse_opts! do  
+	argument "--things" do | *arg |
+	  arg.each do |a|
+	    accumulate_opt a
+	  end
+	end
+
+	flag '--whatever'
+	
+      end
+      assert_equal  expected_len, os.things.length
+    end
+    
+  end
+
+  # Hmm ... just want to be flexible here. perhaps not necessary
+  # Note you still gotta initialize things to an empty list to make it not nil
+  must "allow for no options following an option defined with a splat" do
+    os = OptSimple.new({:things => [] },%w[--whatever --things]).parse_opts! do  
+      option "--things" do | *arg |
+	arg.each do |a|
+	  accumulate_opt a
+	end
+      end
+      flag '--whatever'
+    end
+    # Note that without the defaults, things is nil, but os still includes it
+    assert os.things.empty?
+  end
 end
 

metadata

@@ -2,7 +2,7 @@
 name: opt-simple
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.10
+  version: 0.9.11
 platform: ruby
 authors: 
 - Ethan Stryker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 +01:00
+date: 2011-11-20 00:00:00 +00:00
 default_executable: 
 dependencies: []