getopt-declare 1.27 → 1.28

data/HISTORY.txt

@@ -1,3 +1,14 @@
+== 1.28
+       * Fixed a minor issue where help lines were not being compacted
+         properly.
+       * Fixed a minor inconsistency in pvtype regex in usage description.
+       * Fixed GNU style parameter matching to not get confused with
+         multiple spaces before parameters.
+       * Sped up matching of default rules a tad due to use of symbols
+         instead of strings.
+       * Fixed required matches not working for some cases due to change
+         in 1.27.
+
 == 1.27
        * Fixed a bug with the sorting of arguments, which could sometimes
          lead to strange parsing.

data/Manifest.txt

@@ -38,3 +38,4 @@ test/test_cmdline_regex.rb
 test/test_demo_csv.rb
 test/test_cluster_singles.rb
 test/test_cmdline_array.rb
+test/test_cmdline_require.rb

data/lib/Getopt/Declare.rb

@@ -4,7 +4,7 @@
 #  Ruby port of Perl's Getopt::Declare, version 1.21, 
 #  released May 21, 1999.
 #
-#   	$Release Version: 1.27 $
+#   	$Release Version: 1.28 $
 #       $Date: 2007/01/15 10:53:09 $
 #   	by Gonzalo Garramu�o
 #
@@ -70,14 +70,14 @@ module Getopt
   # Main Class
   class Declare
 
-    VERSION = '1.27'
+    VERSION = '1.28'
 
     # For debugging, use [debug] and it will output the ruby code as .CODE.rb
     @@debug = false
 
     # Main separator used to distinguish arguments in Getopt/Declare spec.
     # By default, one or more tabs or 3 spaces or more.
-    @@separator = '(?:\t+| {3})'
+    @@separator = '(?:\t+| {3}[^<])'
 
     # Class used to handle the beginning of options
     class StartOpt
@@ -126,54 +126,60 @@ module Getopt
       # (re)set standard types
       def ScalarArg._reset_stdtype
 	@@stdtype = {
-	  ':i'	=> { 'pattern' => '(?:(?:%T[+-]?)%D+)' },
-	  ':n'	=> { 'pattern' => '(?:(?:%T[+-]?)(?:%D+(?:%T\.%D*)?' +
+	  ':i'	=> { :pattern => '(?:(?:%T[+-]?)%D+)' },
+	  ':n'	=> { :pattern => '(?:(?:%T[+-]?)(?:%D+(?:%T\.%D*)?' +
 	    '(?:%T[eE](?:[+-])?%D+)?|%T\.%D+(?:%T[eE](?:[+-])?%D+)?))',
 	  },
-          ':s'	=> { 'pattern' => '(?:%T(?:\S|\0))+(?=\s|\0|\z)' },
-          ':qs'	=> { 'pattern' => %q{"(?:\\"|[^"])*"|'(?:\\'|[^'])*'|(?:%T(?:\S|\0))+} },
-	  ':id'	=> { 'pattern' => '%T[a-zA-Z_](?:%T\w)*(?=\s|\0|\z)' },
-	  ':d'	=> { 'pattern' => '(?:%T(?:\S|\0))+',
-	    'action' => %q%
+          ':s'	=> { :pattern => '(?:%T(?:\S|\0))+(?=\s|\0|\z)' },
+          ':qs'	=> { :pattern => %q{"(?:\\"|[^"])*"|'(?:\\'|[^'])*'|(?:%T(?:\S|\0))+} },
+	  ':id'	=> { :pattern => '%T[a-zA-Z_](?:%T\w)*(?=\s|\0|\z)' },
+	  ':d'	=> { 
+            :pattern => '(?:%T(?:\S|\0))+',
+	    :action => %q%
               reject( (_VAL_.nil? || !test(?d, _VAL_) ),
                "in parameter '#{_PARAM_}' (\"#{_VAL_}\" is not a directory)")%
 	  },
-	  ':if'	=> { 'pattern' => '%F(?:%T(?:\S|\0))+(?=\s|\0|\z)',
-	    'action' => %q%
+	  ':if'	=> { 
+            :pattern => '%F(?:%T(?:\S|\0))+(?=\s|\0|\z)',
+	    :action => %q%
               reject( (_VAL_.nil? || _VAL_ != "-" && !test(?r, _VAL_) ),
                "in parameter '#{_PARAM_}' (file \"#{_VAL_}\" is not readable)")%
 	  },
-	  ':of'	=> { 'pattern' => '%F(?:%T(?:\S|\0))+(?=\s|\0|\z)',
-	    'action' => %q%
+	  ':of'	=> { 
+            :pattern => '%F(?:%T(?:\S|\0))+(?=\s|\0|\z)',
+	    :action => %q%
             reject( (_VAL_.nil? || _VAL_ != "-" && 
                      test(?r, _VAL_) && !test(?w, _VAL_)), 
               "in parameter '#{_PARAM_}' (file \"#{_VAL_}\" is not writable)")%
 	  },
-	  ''	=> { 'pattern' => ':s', 'ind' => 1 },
+	  ''	=> { :pattern => ':s', :ind => 1 },
 
-	  ':+i'	=> { 'pattern' => ':i',
-	    'action' => %q%reject( _VAL_ <= 0, 
+	  ':+i'	=> { 
+            :pattern => ':i',
+	    :action => %q%reject( _VAL_ <= 0, 
                                    "in parameter '#{_PARAM_}' (#{_VAL_} must be an integer greater than zero)")%,
-	    'ind' => 1
+	    :ind => 1
 	  },
 
-	  ':+n'	=> { 'pattern' => ':n',
-	    'action' => %q%reject( _VAL_ <= 0.0, 
+	  ':+n'	=> { 
+            :pattern => ':n',
+	    :action => %q%reject( _VAL_ <= 0.0, 
                                    "in parameter '#{_PARAM_}' (#{_VAL_} must be a number greater than zero)")%,
-	    'ind' => 1
+	    :ind => 1
 	  },
 
-	  ':0+i'	=> { 'pattern' => ':i',
-	    'action' => %q%reject( _VAL_ < 0, 
+	  ':0+i' => { 
+            :pattern => ':i',
+	    :action => %q%reject( _VAL_ < 0, 
                                    "in parameter '#{_PARAM_}' (#{_VAL_} must be an positive integer)")%,
-	    'ind'  => 1
+	    :ind  => 1
 	  },
 	  
-	  ':0+n'	=> { 
-	    'pattern' => ':n',
-	    'action' => %q%reject( _VAL_ < 0, 
+	  ':0+n' => { 
+	    :pattern => ':n',
+	    :action => %q%reject( _VAL_ < 0, 
                                    "in parameter '#{_PARAM_}' (#{_VAL_} must be an positive number)")%,
-	    'ind' => 1
+	    :ind => 1
 	  },
 	}
 
@@ -184,12 +190,12 @@ module Getopt
       # pattern or nil
       def ScalarArg.stdtype(name)
 	seen = {}
-	while (!seen[name] && @@stdtype[name] && @@stdtype[name]['ind'])
-	  seen[name] = 1; name = @@stdtype[name]['pattern']
+	while (!seen[name] && @@stdtype[name] && @@stdtype[name][:ind])
+	  seen[name] = 1; name = @@stdtype[name][:pattern]
 	end
 
 	return nil if seen[name] || !@@stdtype[name]
-	@@stdtype[name]['pattern']
+	@@stdtype[name][:pattern]
       end
 
       def stdtype(name)
@@ -201,16 +207,16 @@ module Getopt
       def ScalarArg.stdactions(name)
 	seen = {}
 	actions = []
-	while (!seen[name] && @@stdtype[name] && @@stdtype[name]['ind'])
+	while (!seen[name] && @@stdtype[name] && @@stdtype[name][:ind])
 	  seen[name] = 1
-	  if @@stdtype[name]['action']
-	    actions.push( @@stdtype[name]['action'] )
+	  if @@stdtype[name][:action]
+	    actions.push( @@stdtype[name][:action] )
 	  end
-	  name = @@stdtype[name]['pattern']
+	  name = @@stdtype[name][:pattern]
 	end
 
-	if @@stdtype[name] && @@stdtype[name]['action']
-	  actions.push( @@stdtype[name]['action'] )
+	if @@stdtype[name] && @@stdtype[name][:action]
+	  actions.push( @@stdtype[name][:action] )
 	end
 
 	return actions
@@ -226,10 +232,10 @@ module Getopt
 	end
 	
 	@@stdtype[typeid] = {}
-	@@stdtype[typeid]['pattern'] = "(?:#{pattern})" if pattern && !ref
-	@@stdtype[typeid]['pattern'] = ":#{pattern}" if pattern && ref
-	@@stdtype[typeid]['action']  = action if action
-	@@stdtype[typeid]['ind']     = ref
+	@@stdtype[typeid][:pattern] = "(?:#{pattern})" if pattern && !ref
+	@@stdtype[typeid][:pattern] = ":#{pattern}" if pattern && ref
+	@@stdtype[typeid][:action]  = action if action
+	@@stdtype[typeid][:ind]     = ref
 
       end
 
@@ -304,7 +310,7 @@ EOS
 
      # Based on parameter type, default conversion to apply
      def conversion
-       pat = @@stdtype[@type] ? @@stdtype[@type]['pattern'] : ''
+       pat = @@stdtype[@type] ? @@stdtype[@type][:pattern] : ''
        [ @type, pat ].each { |t|
 	 case t
 	 when /^\:0?(\+)?i$/
@@ -518,13 +524,13 @@ EOS
 
     attr_accessor :flag, :args, :actions, :ditto, :nocase
     attr_accessor :required, :id, :repeatable, :desc
-    attr_writer   :requires
+    attr_accessor :requires
 
 
     #
-    def _enfound(original)
-      expr = original.gsub(/((?:&&|\|\|)?\s*(?:[!(]\s*)*)([^ \t\n|&\)]+)/x,
-                           '\1_FOUND_[\'\2\']')
+    def found_requires
+      expr = @requires.gsub(/((?:&&|\|\|)?\s*(?:[!(]\s*)*)([^ \t\n|&\)]+)/x,
+                            '\1_FOUND_[\'\2\']')
       
       if !valid_syntax?( expr )
         raise "Error: bad condition in [requires: #{original}]\n"
@@ -532,10 +538,6 @@ EOS
       expr
     end
 
-    def requires
-      return nil unless @requires
-      _enfound(@requires)
-    end
 
     # Constructor
     def initialize(spec, desc, dittoflag)
@@ -635,9 +637,6 @@ EOS
       nocasei = ((Getopt::Declare::nocase || @nocase) ? 'i' : '')
 
       code << "          catch(:paramout) do\n            while "
-      if @requires
-        code << requires << ' and '
-      end
       code += !@repeatable? "!_FOUND_['" + self.foundid + "']" : "true"
 
       if (flag && (clump==1 && flag !~ /\A[^a-z0-9]+[a-z0-9]\Z/i ||
@@ -645,12 +644,12 @@ EOS
 	code << ' and !_lastprefix'
       end
 
-      code << '
+      code <<'
               begin
                 catch(:param) do
                   _pos = _nextpos if _args
                   _PUNCT_ = {}
-              '
+             '
 
       if flag != ''
         # This boundary is to handle -- option, so that if user uses
@@ -883,7 +882,7 @@ EOS
 	_exclude(mutex, arg.name, ("#$1".split(' ')))
       end
 
-      if desc =~ /.*\[\s*requires:\s*(.*?)\]/i
+      if desc =~ /.*\[\s*requires:\s*(.*?)\s*\]/i
 	arg.requires = "#$1"
       end
 
@@ -1102,7 +1101,7 @@ EOS
 
         # Check for GNU spec line like:  -d, --debug
         arg = nil
-        if spec =~ /(-[\w_\d]+),\s+(--[\w_\d]+)(\s+.*)?/
+        if spec =~ /(-[\w_\d]+),\s+(--?[\w_\d]+)(\s+.*)?/
           specs = ["#$1#$3", "#$2#$3"]
           specs.each { |spec|
             arg = Arg.new(spec,desc,ditto)
@@ -1318,7 +1317,7 @@ EOS
     lastdesc = nil
     usage = ''
 
-    while t.length() > 0
+    while !t.empty?
 
       # COMMENT:
       t.sub!(/\A[ \t]*#.*\n/,".") and next
@@ -1326,7 +1325,7 @@ EOS
       # TYPE DIRECTIVE:
       se  = DelimScanner::new( t )
 
-      if t =~ /\A\s*\[pvtype:/
+      if t =~ /\A\s*\[\s*pvtype:/
 	if action = se.extractBracketed("[")
 	  t.sub!(Regexp::quote( action ).to_re,'')
 	  t.sub!(/\A[ \t]*\n/,"")  
@@ -1389,7 +1388,7 @@ EOS
       
 
       # OTHERWISE, DECORATION
-      if t.sub!(/((?:(?!\[pvtype:).)*)(\n|(?=\[pvtype:))/,"")
+      if t.sub!(/((?:(?!\[\s*pvtype:).)*)(\n|(?=\[\s*pvtype:))/,"")
 	desc = "#$1"+("#$2"||'')
 	#desc.gsub!(/^(\s*\[.*?\])+\s*\n/m,'')
 	#desc.gsub!(/\[.*?\]/,'')  # eliminates anything in brackets
@@ -1431,7 +1430,7 @@ EOS
     
     header << "Options:\n" unless decfirst && decfirst == 1
     
-    usage.sub!(/[\s\n]+$/, '')
+    usage.sub!(/[\s\n]+\Z/m, '')
 
     if opt.empty?
       return header + usage + "\n"
@@ -1613,7 +1612,7 @@ end
 	    next unless arg.requires
 
 	    code << %q%
-if _FOUND_['% + arg.name + %q%'] && !(% + arg.requires +
+if _FOUND_['% + arg.name + %q%'] && !(% + arg.found_requires +
 	      %q%)
    $stderr.puts "Error#{@source}: parameter '% + arg.name + %q%' can only be specified with '% + arg.requires + %q%'"
    _errors += 1
@@ -1735,9 +1734,3 @@ end
  end # class Declare
 
 end # module Getopt
-
-
-
-
-__END__
-

data/test/test_cmdline_require.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+#
+# Put script description here.
+#
+# Author::    
+# Copyright:: 
+# License::   Ruby
+#
+
+require 'Getopt/Declare'
+
+
+require 'test/unit'
+require "Getopt/Declare"
+
+# to avoid getopt from exiting...
+def exit(args)
+end
+
+
+class TC_Require < Test::Unit::TestCase
+
+  def setup
+    @args = Getopt::Declare.new(<<EOF, :build)
+	-i <iterations:+i>	iteration count	
+	-q	add new task [ requires: -i ]	
+EOF
+  end
+
+  def test_q_without_i
+    begin
+      @args.parse('-q')
+      assert_equal( nil, "Parsing of -q did not fail" )
+    rescue
+    end
+  end
+
+  def test_i_without_q
+    begin
+      @args.parse('-i 5')
+    rescue
+    end
+    assert_equal( 5, @args['-i'] )
+  end
+
+  def test_i_with_q
+    begin
+      @args.parse('-i 5 -q')
+    rescue
+    end
+    assert_equal( 5, @args['-i'] )
+    assert_equal( '-q', @args['-q'] )
+  end
+
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: getopt-declare
 version: !ruby/object:Gem::Version 
-  version: "1.27"
-date: 2007-06-23 00:00:00 -03:00
+  version: "1.28"
+date: 2007-07-09 00:00:00 -03:00
 summary: Getopt-Declare is a command-line argument parser.
 require_paths: 
 - lib
@@ -69,6 +69,7 @@ files:
 - test/test_demo_csv.rb
 - test/test_cluster_singles.rb
 - test/test_cmdline_array.rb
+- test/test_cmdline_require.rb
 test_files: 
 - test/test_cmdline_cmdline.rb
 - test/test_cmdline_basic.rb
@@ -79,6 +80,7 @@ test_files:
 - test/test_cmdline_pvtype.rb
 - test/test_cmdline_regex.rb
 - test/test_demo_csv.rb
+- test/test_cmdline_require.rb
 - test/test_cluster_singles.rb
 - test/test_cmdline_array.rb
 rdoc_options: