getopt-declare 1.09.7 → 1.12

data/HISTORY.txt

@@ -0,0 +1,10 @@
+
+1.12 - Fixed bug with :+i, :+n, :0+i options not being cast appropiately
+       when used in pvttypes.
+       Added [debug] option to argument description to turn on debugging.
+
+       NOTE: there is a known bug when using [] within pvttype regex
+       definitions.  Problem seems to be related to DelimScanner/strscan.
+
+1.11 - Fixed a pretty bug that was parsing -flags inappropiately and leading
+       to slower parsing.

data/getoptdeclare.gemspec

@@ -0,0 +1,22 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |spec|
+	spec.name = "getopt-declare"
+	spec.version = '1.12'
+	spec.author = "Gonzalo Garramuno" 
+	spec.email = 'GGarramuno@aol.com'
+	spec.homepage = 'http://www.rubyforge.org/projects/getoptdeclare/'
+	spec.summary = 'Getopt-Declare is a command-line argument parser.'
+	spec.require_path = "lib"
+	spec.autorequire = "Getopt/Declare"
+	spec.files = ["lib/Getopt/Declare.rb", "lib/Getopt/DelimScanner.rb"]
+	spec.description = <<-EOF
+    Comprehensive and easy to use command-line parser library using
+    regular expressions.  Port of Conway's Perl Getopt-Declare.
+EOF
+	spec.extra_rdoc_files = ["Declare.rdoc", "HISTORY.txt", "getoptdeclare.gemspec"]
+	spec.has_rdoc = false
+	spec.test_files = Dir.glob('samples/*.rb')
+	spec.rubyforge_project = 'getoptdeclare'
+	spec.required_ruby_version = '>= 1.6.8'
+end

data/lib/Getopt/Declare.rb

@@ -1,11 +1,11 @@
 #
 #  Getopt::Declare - Declaratively Expressed Command-Line Arguments via Regular Expressions
 #
-#  Ruby port of Perl's Getopt::Declare, version 1.09, 
+#  Ruby port of Perl's Getopt::Declare, version 1.12, 
 #  released May 21, 1999.
 #
-#   	$Release Version: 1.10 $
-#       $Date: 2004/01/25 07:02:48 $
+#   	$Release Version: 1.12 $
+#       $Date: 2004/01/15 10:53:09 $
 #   	by Gonzalo Garramu�o
 #
 #  For detailed instructions, see Declare.rdoc file
@@ -61,7 +61,7 @@ end
 
 # Regex for removing bracket directives
 BracketDirectives = 
-  /\[(?:ditto|tight|repeatable|required|mutex:.*|implies:.*|excludes:.*|requires:.*)\]/
+  /\[(?:ditto|tight|strict|repeatable|debug|required|mutex:.*|implies:.*|excludes:.*|requires:.*)\]/
 
 
 module Getopt
@@ -69,10 +69,10 @@ module Getopt
   # Main Class
   class Declare
 
-    VERSION = '1.09.7'
+    VERSION = '1.12'
 
-    # For debugging, set to 1 and it will output the ruby code as .CODE.rb
-    @@Declare_debug = 0
+    # For debugging, use [debug] and it will output the ruby code as .CODE.rb
+    @@debug = nil
 
     # Class used to handle the beginning of options
     class StartOpt
@@ -97,7 +97,7 @@ module Getopt
 	nil
       end
 
-      # Helps build regex that matches parameters of flags 
+     # Helps build regex that matches parameters of flags 
       def ows(g)	      
 	g
       end
@@ -123,7 +123,7 @@ module Getopt
 	@@stdtype = {
 	  ':i'	=> { 'pattern' => '(?:(?:%T[+-]?)%D+)' },
 	  ':n'	=> { 'pattern' => '(?:(?:%T[+-]?)(?:%D+(?:%T\.%D*)?' +
-	    '(?:%T[eE]%D+)?|%T\.%D+(?:%T[eE]%D+)?))'
+	    '(?:%T[eE]%D+)?|%T\.%D+(?:%T[eE]%D+)?))',
 	  },
 	  ':s'	=> { 'pattern' => '(?:%T(?:\S|\0))+' },
 	  ':qs'	=> { 'pattern' => %q#"(?:\\"|[^"])*"|'(?:\\'|[^"])*|(?:%T(?:\S|\0))+#
@@ -154,7 +154,7 @@ module Getopt
 	  },
 
 	  ':+n'	=> { 'pattern' => ':n',
-	    'action' => %q%reject( _VAL_ <= 0.0), 
+	    'action' => %q%reject( _VAL_ <= 0.0, 
                                    "in parameter '#{_PARAM_}' (#{_VAL_} must be a number greater than zero)")%,
 	    'ind' => 1
 	  },
@@ -178,7 +178,7 @@ module Getopt
 
       # Given a standard type name, return the corresponding regex
       # pattern or nil
-      def stdtype(name)
+      def ScalarArg.stdtype(name)
 	seen = {}
 	while (!seen[name] && @@stdtype[name] && @@stdtype[name]['ind'])
 	  seen[name] = 1; name = @@stdtype[name]['pattern']
@@ -188,6 +188,10 @@ module Getopt
 	@@stdtype[name]['pattern']
       end
 
+      def stdtype(name)
+	ScalarArg.stdtype(name)
+      end
+
 
       # Given the name of a type, return its corresponding action(s)
       def ScalarArg.stdactions(name)
@@ -264,7 +268,6 @@ module Getopt
 
       # Return string with code to process parameter
       def code(*t)
-	
 	if t[0]
 	  pos1 = t[0].to_s()
 	else
@@ -272,14 +275,12 @@ module Getopt
 	end
 
 	c = conversion
-	if !c.empty?
-	  c = "\n	          _VAL_ = _VAL_#{c}\n"
-	end
+	c = "\n	          _VAL_ = _VAL_#{c}" if not c.empty?
 
 	code = <<-EOS
 	          _VAR_ = %q|<#{@name}>|
 	          _VAL_ = @@m[#{pos1}]
-		  _VAL_.tr!("\\0"," ") if _VAL_#{c}
+	          _VAL_.tr!("\\0"," ")#{c}
 EOS
 
         actions = Getopt::Declare::ScalarArg::stdactions(@type)
@@ -299,14 +300,16 @@ EOS
 
      # Based on parameter type, default conversion to apply
      def conversion
-       case @type
-       when /^\:(0)?(\+)?i$/
-	   '.to_i'
-       when /^\:(0)?(\+)?n$/
-	   '.to_f'
-       else
-	 ''
-       end
+       pat = @@stdtype[@type] ? @@stdtype[@type]['pattern'] : ''
+       [ @type, pat ].each { |t|
+	 case t
+	 when /^\:0?(\+)?i$/
+	   return '.to_i'
+	 when /^\:0?(\+)?n$/
+	   return '.to_f'
+	 end
+       }
+       return ''
      end
 
      # Return string with code to cache argument in Getopt::Declare's cache
@@ -362,7 +365,7 @@ EOS
 
        # Handle conversion to proper type
        c = conversion
-       if !c.empty?
+       if not c.empty?
 	 code << "		  #{@name}.map! { |i| i#{c} }\n"
        end
 
@@ -622,16 +625,22 @@ EOS
                   _PUNCT_ = {}
               '
 
-      if flag
+      if flag != ''
+        # This boundary is to handle -- option, so that if user uses
+        # --foo and --foo is not a flag, it does not become
+        # --  and unused: 'foo', but an error saying flag '--foo' not defined.
+        boundary = ''
+        boundary = '(\s+|\Z)' if flag =~ /^(--|-|\+|\+\+)$/
+
 	code << '
                   _args && _pos = gindex( _args, /\G(?:\s|\0)*' + 
-	  Regexp::quote(flag) + '/' + nocase + ", _pos) or throw(:paramout) 
+	  Regexp::quote(flag) + boundary + '/' + nocase + ", _pos) or throw(:paramout) 
                   unless @_errormsg
 		    @_errormsg = %q|incorrect specification of '" + flag + "' parameter|
                   end
 "
-      elsif ( ScalarArg::stdtype(@args[0]['type'])||'') !~ /\%F/
-	code << %q%\n                  throw(:paramout) if @_errormsg\n%
+      elsif ( ScalarArg::stdtype(@args[0].type)||'') !~ /\%F/
+	code << "\n                  throw(:paramout) if @_errormsg\n"
       end
 
 
@@ -907,8 +916,8 @@ EOS
     action = action[1..-2]
 
     raise "Error: bad type directive (expected closing ']' but found " +
-      "'#$1' instead): [pvtype: $name " + (pat ? "/$#{pat}/" : '') +
-      " $#{action} #$1#$2....\n" if desc =~ /\A\s*([^\] \t\n])(\S*)/
+      "'#$1' instead): [pvtype: #{name} " + (pat ? "/#{pat}/" : '') +
+      " action:#{action} #$1#$2....\n" if desc =~ /\A\s*([^\] \t\n])(\S*)/
     
     
     Getopt::Declare::ScalarArg::addtype(name,pat,action,ind=~/:/)
@@ -993,6 +1002,7 @@ EOS
       # COMMENT:
       i.sub!(/\A[ \t]*#.*\n/,"") and next
 
+
       # TYPE DIRECTIVE:
       se  = DelimScanner::new( i )
 
@@ -1012,7 +1022,6 @@ EOS
 	'{'     => '}',
       }
 
-
       _action = se.extractCodeblock(codeblockDelimiters)
       if _action
 	i.sub!( Regexp::quote(_action ).to_re, "" )
@@ -1036,6 +1045,7 @@ EOS
 	      "\t(did you forget a closing '}'?)\n"
       end
 
+
       # ARG + DESC:
       if i.sub!(/\A(.*?\S.*?)(\t.*\n)/,"")
 	spec = "#$1"
@@ -1062,6 +1072,7 @@ EOS
       _infer(decorator, nil, _mutex)
 
       _all_repeatable = true if decorator =~ /\[repeatable\]/
+      @@debug = true if decorator =~ /\[debug\]/
 
     end # while i.length
 
@@ -1107,7 +1118,7 @@ EOS
     @caller  = caller()
 
     # VESTIGAL DEBUGGING CODE
-    if @@Declare_debug > 0
+    if @@debug
       f = File.new(".CODE.rb","w") and
 	f.puts( code() ) and
 	f.close() 
@@ -1193,7 +1204,7 @@ EOS
       err = eval( code(@caller) )
       if $@
 	# oops, something wrong... exit
-	puts "#{$!} #{$@}"
+	puts "#{$!}: #{$@.inspect}"
 	exit(1)
       end
       if !err
@@ -1393,9 +1404,11 @@ begin
     end
   end
 
-  def finish(i)
-    if !i || i[0]
-      @_finished = 1
+  def finish(*i)
+    if i.size
+      @_finished = i
+    else
+      @_finished = true
     end
   end
 
@@ -1526,7 +1539,7 @@ end
 	  code << %q%
 #################### Add unused arguments
 if _args && _nextpos > 0 && _args.length() > 0
-    @unused.push( _args[_nextpos..-1].split(' ' ) )
+    @unused.replace( @unused + _args[_nextpos..-1].split(' ') )
 end
 
 for i in @unused
@@ -1564,7 +1577,8 @@ unless _errors > 0
     begin
       i.call()
     rescue => e
-      raise "Error: action in Getopt::Declare specification produced:\n" + e
+      STDERR.puts "Action in Getopt::Declare specification produced:\n#{e}"
+      _errors += 1
     end
   end
 end

data/lib/Getopt/DelimScanner.rb

@@ -22,7 +22,7 @@
 # 
 # == Version
 #
-#  $Id: DelimScanner.rb,v 1.1.1.1 2004/01/25 07:02:48 gga Exp $
+#  $Id: DelimScanner.rb,v 1.2 2003/01/12 20:56:51 deveiant Exp $
 # 
 # == History
 #
@@ -73,8 +73,8 @@ class DelimScanner
 
 
     ### Class constants
-    Version = /([\d\.]+)/.match( %q{$Revision: 1.1.1.1 $} )[1]
-    Rcsid = %q$Id: DelimScanner.rb,v 1.1.1.1 2004/01/25 07:02:48 gga Exp $
+    Version = /([\d\.]+)/.match( %q{$Revision: 1.2 $} )[1]
+    Rcsid = %q$Id: DelimScanner.rb,v 1.2 2003/01/12 20:56:51 deveiant Exp $
 
     # Pattern to match a valid XML name
     XmlName = '[a-zA-Z_:][a-zA-Z0-9:.-]*'

data/samples/cmdline_array.rb

@@ -1,25 +1,26 @@
-#! /usr/bin/ruby
-
-require "Getopt/Declare"
-
-args = Getopt::Declare.new( %q{
-
-  		-v <value> [etc]	One or more values
-  		<infile>		Input file [required]
-  		-o <outfiles>...	Output files
-  	} )
-
-if args['-v']
-  print  "Using value: ", args['-v']['<value>']
-  print  " (etcetera)" if args['-v']['etc']
-  print  "\n"
-end
-
-infile = File.new( args['<infile>'] )
-data = infile
-
-for outfile in args['-o']
-  #outfile = File.new(outfile,'w')
-  print "processed ",outfile
-  #outfile.close
-end
+#!/usr/bin/env ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new( %q{
+
+  		-v <value> [etc]	One or more values
+  		<infile:if>		Input file [required]
+  		-o <outfiles>...	Output files
+  	} )
+
+if args['-v']
+  print  "Using value: ", args['-v']['<value>']
+  print  " (etcetera)" if args['-v']['etc']
+  print  "\n"
+end
+
+
+infile = File.new( args['<infile>'] )
+data = infile
+
+for outfile in args['-o']
+  #outfile = File.new(outfile,'w')
+  print "processed ",outfile
+  #outfile.close
+end

data/samples/cmdline_basic.rb

@@ -1,31 +1,31 @@
-#!/usr/bin/ruby
-
-require "Getopt/Declare"
-
-args = Getopt::Declare.new(<<'EOPARAM')
-
-   ============================================================
-   Required parameter:
-
-   -in <infile>		Input file [required]
-
-   ------------------------------------------------------------
-
-   Optional parameters:
-
-   (The first two are mutually exclusive) [mutex: -r -p]
-
-   -r[and[om]]		Output in random order
-   -p[erm[ute]]		Output all permutations
-
-   ---------------------------------------------------
-
-   -out <outfile>	Optional output file
-
-   ------------------------------------------------------------
-   Note: this program is known to run very slowly of files with
-   long individual lines.
-   ============================================================
-EOPARAM
-
-print args.inspect
+#!/bin/env ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM')
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>	Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+print args.inspect

data/samples/cmdline_code.rb

@@ -1,31 +1,31 @@
-#!/usr/bin/ruby
-
-require "Getopt/Declare"
-
-args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
-
-   ============================================================
-   Required parameter:
-
-   -in <infile>		Input file [required]
-
-   ------------------------------------------------------------
-
-   Optional parameters:
-
-   (The first two are mutually exclusive) [mutex: -r -p]
-
-   -r[and[om]]		Output in random order
-   -p[erm[ute]]		Output all permutations
-
-   ---------------------------------------------------
-
-   -out <outfile>		Optional output file
-
-   ------------------------------------------------------------
-   Note: this program is known to run very slowly of files with
-   long individual lines.
-   ============================================================
-EOPARAM
-
-puts args.code()
+#!/bin/env ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>		Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+puts args.code()

data/samples/cmdline_defer.rb

@@ -1,23 +1,23 @@
-#! /usr/bin/ruby
-
-require "Getopt/Declare"
-
-
-#  With the next specification, the <tt>-rev</tt> and/or <tt>-rand</tt> flags
-#  can be specified _after_ the list of files, but still affect the processing
-#  of those files. Moreover, if the command-line parsing fails for some reason
-#  (perhaps due to an unrecognized argument), the deferred processing will
-#  not be performed.
-args = Getopt::Declare.new( %q{
-
-  	<files>...	Files to be processed
-  			    { defer { files.each { |i| 
-                                                   puts i, " ",$ordered } } }
-
-  	-rev[erse]	Process in reverse order
-  			    { $ordered = -1; }
-
-  	-rand[om]	Process in random order
-  			    { $ordered = 0; }
-  	} )
-
+#!/bin/env ruby
+
+require "Getopt/Declare"
+
+
+#  With the next specification, the <tt>-rev</tt> and/or <tt>-rand</tt> flags
+#  can be specified _after_ the list of files, but still affect the processing
+#  of those files. Moreover, if the command-line parsing fails for some reason
+#  (perhaps due to an unrecognized argument), the deferred processing will
+#  not be performed.
+args = Getopt::Declare.new( %q{
+
+  	<files>...	Files to be processed
+  			    { defer { files.each { |i| 
+                                                   puts i, " ",$ordered } } }
+
+  	-rev[erse]	Process in reverse order
+  			    { $ordered = -1; }
+
+  	-rand[om]	Process in random order
+  			    { $ordered = 0; }
+  	} )
+

data/samples/cmdline_file.rb

@@ -1,38 +1,38 @@
-#!/usr/bin/ruby
-
-require "Getopt/Declare"
-
-args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
-
-   ============================================================
-   Required parameter:
-
-   -in <infile>		Input file [required]
-
-   ------------------------------------------------------------
-
-   Optional parameters:
-
-   (The first two are mutually exclusive) [mutex: -r -p]
-
-   -r[and[om]]		Output in random order
-   -p[erm[ute]]		Output all permutations
-
-   ---------------------------------------------------
-
-   -out <outfile>		Optional output file
-
-   ------------------------------------------------------------
-   Note: this program is known to run very slowly of files with
-   long individual lines.
-   ============================================================
-EOPARAM
-
-
-# TRY STANDARD CONFIG FILES
-args.parse(['-CONFIG'])
-#args.parse('/usr/local/config/.demo_rc')
-
-#args.parse() or raise "cannot parse";
-
-print args.inspect
+#!/bin/env ruby
+
+require "Getopt/Declare"
+
+args = Getopt::Declare.new(<<'EOPARAM', ['-BUILD'])
+
+   ============================================================
+   Required parameter:
+
+   -in <infile>		Input file [required]
+
+   ------------------------------------------------------------
+
+   Optional parameters:
+
+   (The first two are mutually exclusive) [mutex: -r -p]
+
+   -r[and[om]]		Output in random order
+   -p[erm[ute]]		Output all permutations
+
+   ---------------------------------------------------
+
+   -out <outfile>		Optional output file
+
+   ------------------------------------------------------------
+   Note: this program is known to run very slowly of files with
+   long individual lines.
+   ============================================================
+EOPARAM
+
+
+# TRY STANDARD CONFIG FILES
+args.parse(['-CONFIG'])
+#args.parse('/usr/local/config/.demo_rc')
+
+#args.parse() or raise "cannot parse";
+
+print args.inspect

data/samples/cmdline_finish.rb

@@ -0,0 +1,14 @@
+#!/bin/env ruby
+
+require "Getopt/Declare"
+
+argspec = %q{
+        [strict]
+        --verbose		Print verbose info
+        --			Traditional argument list terminator
+                                                { finish }
+}
+
+args = Getopt::Declare.new(argspec)
+
+p args