getopt-declare 1.22 → 1.23

data/HISTORY.txt

@@ -1,3 +1,21 @@
+1.23 - * Added all samples as Ruby tests, which lead to the discovery
+	 of several bugs.
+       * Fixed silly bug with foundid that would make some parsing not
+	 work (required parameters).
+       * Fixed a silly bug when parsing from a string file, which would
+         modify the string in place
+       * Fixed a bug in that would make it not parse Rh+ and Rh- in
+	 cmdline_pvttype demo and other potential regexes.
+       * Removed 3 warnings from parsing multiple times.
+       * Fixed a bug with cluster: singles not working.
+       * Fixed a stack trace bug with optional single text arguments.
+       * Improved handling of optional integer/float arguments, leaving
+	 them as nil instead of 0 as before.
+       * Added 'used' function to allow returning the flags that are used.
+       * Made CSV demo work again, albeit I am not too happy with the regex.
+       * Made Getopt::Declare part of firebrigade.
+	      http://firebrigade.seattlerb.org/
+
 1.22 - * Fixed some nasty bugs introduced in 1.21, which would cause stack
          traces.
        * Fixed the use of /bin/env in some demos instead of /usr/bin/env.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
+require 'rake/testtask'
 
 rdoc_files = ["Declare.rdoc", 'HISTORY.txt'] + Dir.glob('lib/*/*.rb')
 
@@ -10,7 +11,7 @@ rdoc_files = ["Declare.rdoc", 'HISTORY.txt'] + Dir.glob('lib/*/*.rb')
 #
 spec = Gem::Specification.new do |spec|
   spec.name = "getopt-declare"
-  spec.version = '1.22'
+  spec.version = '1.23'
   spec.author = "Gonzalo Garramuno"
   spec.email = 'ggarra@advancedsl.com.ar, GGarramuno@aol.com'
   spec.homepage = 'http://www.rubyforge.org/projects/getoptdeclare/'
@@ -62,7 +63,40 @@ task 'upload-docs' => ['rdoc'] do
 end
 
 
+desc 'Zip directory as an archive.'
+task 'zip' => ['rdoc'] do
+  dir = File.basename(Dir.pwd)
+  zipfile = spec.name + "-" + spec.version.to_s + ".zip"
+  Dir.chdir('..')
+  File.unlink(zipfile) if File.exists?(zipfile)
+  sh "zip -9rv #{zipfile} #{dir} -x '*~' -x '#*#' -x '*docs/*' -x '*pkg/*' -x '.*'"
+  Dir.chdir(dir)
+end
+
+desc 'Run unit tests'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+  t.warning = true
+  # t.loader = :testrb  
+  # p t.methods - Object.methods
+end
+
+desc 'upload gem'
+task 'upload-gem' => ['test', 'gem'] do
+end
+
+desc 'upload zip'
+task 'upload-zip' => ['zip'] do
+end
+
+desc 'Upload gem, docs and zip file'
+task 'upload' => [ 'upload-gem', 'upload-zip', 'upload-docs' ]
+
+
+
 #
 # Main task
 #
-task :default => ['gem', 'upload-docs']
+task :default => ['upload']

data/lib/Getopt/Declare.rb

@@ -131,7 +131,7 @@ module Getopt
 	    '(?:%T[eE](?:[+-])?%D+)?|%T\.%D+(?:%T[eE](?:[+-])?%D+)?))',
 	  },
           ':s'	=> { 'pattern' => '(?:%T(?:\S|\0))+(?=\s|\0|\z)' },
-          ':qs'	=> { 'pattern' => %q{"(?:\\"|[^"])*"|'(?:\\'|[^'])*'|(?:%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%
@@ -279,12 +279,12 @@ module Getopt
 	end
 
 	c = conversion
-	c = "\n	          _VAL_ = _VAL_#{c}" if c
+	c = "\n	          _VAL_ = _VAL_#{c} if _VAL_" if c
 
 	code = <<-EOS
 	          _VAR_ = %q|<#{@name}>|
 	          _VAL_ = @@m[#{pos1}]
-	          _VAL_.tr!("\\0"," ")#{c}
+	          _VAL_.tr!("\\0"," ") if _VAL_#{c}
 EOS
 
         actions = Getopt::Declare::ScalarArg::stdactions(@type)
@@ -489,6 +489,13 @@ EOS
     @@posflagpat = nil
     @@negflagpat = nil
 
+    def Arg.clear
+      @@flags = []
+      @@nextid = 0
+      @@posflagpat  = nil
+      @@negflagpath = nil
+    end
+
     # Return string with regex that avoids all flags in declaration
     def Arg.negflagpat(*t)
       if !@@negflagpat && @@flags
@@ -601,7 +608,6 @@ EOS
 
     # Return String with code to parse this argument (ie. flag)
     def code(*t)
-
       owner = t[0]
       mod   = t[1]
 
@@ -616,7 +622,7 @@ EOS
       code += !@repeatable? "            while !_FOUND_['" + self.foundid + "']" :
                             "            while 1"
       if (flag && (clump==1 && flag !~ /\A[^a-z0-9]+[a-z0-9]\Z/i ||
-		   (clump<3 && @args )))
+		   (clump<3 && @args.size > 0 )))
 	code << " && !_lastprefix"
       end
 
@@ -657,16 +663,13 @@ EOS
 	i -= 1
       end # while i
 
-
       if @args
-	code << "\n"+'                  _args && _pos = gindex( _args, /\G'
+	code << "\n"+'                 _args && _pos = gindex( _args, /\G'
 
 	@args.each_with_index { |arg, i|
 	  code << arg.ows(arg.matcher(trailer[i]))
 	}
 
-        code << '\b'
-
 	code << '/x' + nocasei + ", _pos ) or throw(:paramout)\n"
       end # if @args
 
@@ -741,12 +744,16 @@ EOS
 
     # Return name of argument, which can be flag's name or variable's name
     def name
-      return ( @flag.empty? ? "<#{@args[0].name}>" : @flag )
+      return @flag unless @flag.empty?
+      for i in @args
+        return "<#{i.name}>" if i.respond_to?(:name)
+      end
+      raise "Unknown flag name for parameter #{self.desc}"
     end
 
     # Return foundid of argument, which can be flag's name or variable's name
     def foundid
-      return @foundid || '<#{@args[0].name}>'
+      return @foundid || "<#{self.name}>"
     end
 
   end # Arg
@@ -989,6 +996,9 @@ EOS
 
   # Constructor
   def initialize(*opts)
+    @cache = nil
+
+    Getopt::Declare::Arg::clear
 
     # HANDLE SHORT-CIRCUITS
     return if opts.size==2 && (!opts[1] || opts[1] == '-SKIP') 
@@ -1017,6 +1027,7 @@ EOS
     _strict = false
     _all_repeatable = false
     _lastdesc = nil
+    arg = nil
     Getopt::Declare::nocase = false
     Getopt::Declare::ScalarArg::_reset_stdtype
 
@@ -1134,7 +1145,13 @@ EOS
     end
 
     # Sort flags based on criteria described in docs
-    _args = _args.sort_by { |a| [a.flag.size, a.flag, a.args.size, a.id] }
+    # Sadly, this cannot be reduced to sort_by
+    _args = _args.sort() { |a,b|
+     ( b.flag.length() <=> a.flag.length() ) or
+	( b.flag == a.flag and ( b.args.length() <=> a.args.length() ) ) or
+	( a.id <=> b.id )
+    }
+    # _args = _args.sort_by { |a| [a.flag.size, a.flag, a.args.size, a.id] }
 
 
     # Handle clump
@@ -1165,8 +1182,8 @@ EOS
     end
 
     # DO THE PARSE (IF APPROPRIATE)
-    if (opts.length() == 2)
-	return nil unless parse(opts[1])
+    if opts.size == 2
+      return nil unless parse(source)
     else
       return nil unless parse()
     end
@@ -1178,7 +1195,7 @@ EOS
   # optionally eval it, too.
   def parse(*opts)
     source = opts[0]
-    _args = ()
+    _args = nil
     _get_nextline = proc { nil }
 
     if source
@@ -1200,6 +1217,8 @@ EOS
 	  _args = source.readlines.join(' ')
 	  _args.tr!('\t\n',' ')
 	end
+      when :build, :skip
+        return 0
       when Array
 	if source.length() == 1 && !source[0] ||
 	    source[0] == "-BUILD" ||
@@ -1226,10 +1245,12 @@ EOS
 	  # Bunch of files to load passed to parse()
 	  _args, source = _load_sources( _get_nextline, source )
 	end
-      else  # else/case LITERAL STRING TO PARSE
+      when String  # else/case LITERAL STRING TO PARSE
 	_args = source.dup
-	source[7] = '...' if source && source.length() > 7
+	source = source[0,7] + '...' if source && source.length() > 7
 	source = "\"#{source[0..9]}\""
+      else
+        raise "Unknown source type for Getopt::Declare::parse"
       end  # case
       return 0 unless _args
       source = " (in #{source})"
@@ -1239,7 +1260,6 @@ EOS
     end
 
     @source = source
-
     begin
       err = eval( code(@caller) )
       if $@
@@ -1267,12 +1287,19 @@ EOS
     prog = "#{$0}"
     filedate = File.stat( prog ).mtime.localtime()
     prog.sub!(%r#.*/#,'')
+    r = ''
     if defined?($VERSION)
-      puts "\n#{prog}: version #{$VERSION}  (#{filedate})\n\n"
+      r << "\n#{prog}: version #{$VERSION}  (#{filedate})\n\n"
     else
-      puts "\n#{prog}: version dated #{filedate}\n\n"
+      r << "\n#{prog}: version dated #{filedate}\n\n"
     end
-    exit t[0] if !t[0].nil?
+
+    if t.empty?
+      return r
+    else
+      puts r
+      exit t[0]
+    end 
   end
 
   # Print out usage information
@@ -1346,7 +1373,8 @@ EOS
 	end
 
 	spec =~ /\A\s*(\S+)/ and lastflag = "#$1"
-
+        
+        desc.sub!(/\s+\Z/, "\n")
 	usage += spec + ' ' * uoff + desc
 	next
       end
@@ -1364,6 +1392,7 @@ EOS
 	end
 	decfirst = 1 unless !decfirst.nil? or desc =~ /\A\s*\Z/
 	usage += desc
+        usage.rstrip!
       end
 
     end  #while
@@ -1377,31 +1406,37 @@ EOS
     usage.gsub!(/\255/,"[/") # REINSTATE ESCAPED '['s
       
     required.gsub!(/<([a-zA-Z]\w*):[^>]+>/,'<\1>')
+    required.rstrip!
     
     helpcmd = Getopt::Declare::Arg::besthelp
     versioncmd = Getopt::Declare::Arg::bestversion
     
-    pager = $stdout
       
-    #begin
-    #  eval('require "IO/Pager";')
-    #  pager = IO::Pager.new()
-    #rescue
-    #end
-
+    header = ''
     unless @source.nil?
-      version()
+      header << version()
       prog = "#{$0}"
       prog.sub!(%r#.*/#,'')
-      pager.print  "Usage: #{prog} [options]#{required}\n"
-      pager.print  "       #{prog} #{helpcmd}\n" if helpcmd
-      pager.print  "       #{prog} #{versioncmd}\n" if versioncmd
-      pager.print  "\n" unless decfirst && decfirst == 1 && usage =~ /\A[ \t]*\n/
+      header <<  "Usage: #{prog} [options]#{required}\n"
+      header <<  "       #{prog} #{helpcmd}\n" if helpcmd
+      header <<  "       #{prog} #{versioncmd}\n" if versioncmd
+      header <<  "\n" unless decfirst && decfirst == 1 && usage =~ /\A[ \t]*\n/
     end
     
-    pager.print "Options:\n" unless decfirst && decfirst == 1
-    pager.print usage
+    header << "Options:\n" unless decfirst && decfirst == 1
     
+    if opt.empty?
+      return header + usage + "\n"
+    end
+
+    pager = $stdout
+    #begin
+    #  eval('require "IO/Pager";')
+    #  pager = IO::Pager.new()
+    #rescue
+    #end
+
+    pager.puts "#{header}#{usage}"
     exit(opt[0]) if opt[0]
   end
 
@@ -1410,8 +1445,8 @@ EOS
 
   # Return list of used parameters (after parsing)
   def used
-    used = @cache.each_key { |i| [ i, @cache[i] ] }
-    return (used.map { |i| flatten(i) } ).join(' ')
+    used = @cache.keys
+    return used.join(' ')
   end
 
   @@m = []
@@ -1428,6 +1463,13 @@ EOS
 
 begin
 
+  begin
+    undef :defer
+    undef :reject
+    undef :finish
+  rescue
+  end
+
   def defer(&i)
     @_deferred.push( i )
   end
@@ -1610,7 +1652,7 @@ end
 unless _errors > 0
   for i in @_deferred
     begin
-      i.call()
+      i.call
     rescue => e
       STDERR.puts "Action in Getopt::Declare specification produced:\n#{e}"
       _errors += 1
@@ -1626,7 +1668,7 @@ end
 
 
   # Inspect cache (not the declare object)
-  def inspect()
+  def inspect
     return nil if !@cache 
     t = ''
 

data/samples/cmdline_mid.rb

@@ -29,7 +29,7 @@ args = Getopt::Declare.new(<<EOF)
 
 		=getrand [<n>]	Get a random number
 				(or, optionally, <n> of them)
-  					{ n = 1 unless !n.empty? }
+  					{ n = 1 unless n }
 
 		--		Traditionally indicates end of arguments
   					{ finish }

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: getopt-declare
 version: !ruby/object:Gem::Version 
-  version: "1.22"
-date: 2007-01-21 00:00:00 -03:00
+  version: "1.23"
+date: 2007-03-21 00:00:00 -03:00
 summary: Getopt-Declare is a command-line argument parser.
 require_paths: 
 - lib