getopt 1.3.9 → 1.4.0

data/CHANGES

@@ -1,3 +1,10 @@
+== 1.4.0 - 5-Sep-2009
+* Fixed a packaging bug where the libs weren't actually being included! Gah!
+  Thanks go to Steven Hilton for the spot.
+* Other minor refactorings to the gemspec.
+* The release number does not reflect any code changes. I simply ran out
+  of numbers. :)
+
 == 1.3.9 - 29-Jul-2009
 * Now compatible with Ruby 1.9.x.
 * Gemspec updates, including a license change to Artistic 2.0.

data/README

@@ -180,6 +180,4 @@ INCREMENT
    All Rights Reserved
 
 == Author
-   Daniel J. Berger
-   djberg96 at nospam at gmail.com
-   imperator on IRC (freenode)
+   Daniel J. Berger

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the getopt package (non-gem)"
+task :install do
+   dest = File.join(Config::CONFIG['sitelibdir'], 'getopt')
+   Dir.mkdir(dest) unless File.exists? dest
+   cp 'lib/getopt/std.rb', dest, :verbose => true
+   cp 'lib/getopt/long.rb', dest, :verbose => true
+end
+
+desc "Install the getopt package as a gem"
+task :install_gem do
+   ruby 'getopt.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.warning = true
+   t.verbose = true
+end
+
+Rake::TestTask.new('test_getopt_long') do |t|
+   t.test_files = 'test/test_getopt_long.rb'
+   t.warning = true
+   t.verbose = true
+end
+
+Rake::TestTask.new('test_getopt_std') do |t|
+   t.test_files = 'test/test_getopt_std.rb'
+   t.warning = true
+   t.verbose = true
+end

data/getopt.gemspec

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |gem|
+   gem.name       = 'getopt'
+   gem.version    = '1.4.0'
+   gem.author     = 'Daniel J. Berger'
+   gem.license    = 'Artistic 2.0'
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/shards'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'Getopt::Std and Getopt::Long option parsers for Ruby'
+   gem.test_files = Dir['test/*.rb']
+   gem.has_rdoc   = true
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'shards'
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+   
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The getopt library provides two different command line option parsers.
+      They are meant as easier and more convenient replacements for the
+      command line parsers that ship as part of the Ruby standard library.
+      Please see the README for additional comments.
+   EOF
+end
+
+Gem::Builder.new(spec).build

data/lib/getopt/long.rb

@@ -0,0 +1,244 @@
+# The Getopt module serves as a namespace only
+module Getopt
+
+   REQUIRED  = 0 # Argument is required if switch is provided.
+   BOOLEAN   = 1 # Value of argument is true if provided, false otherwise.
+   OPTIONAL  = 2 # Argument is optional if switch is provided.
+   INCREMENT = 3 # Argument is incremented by 1 each time the switch appears.
+
+   # NEGATABLE = 4 # Automatically provide negative switch equivalent.
+   # INTEGER   = 5 # Argument automatically converted to integer if provided.
+   # FLOAT     = 6 # Argument automatically converted to float if provided.
+
+   # The Getopt::Long class encapsulates longhanded parameter parsing options
+   class Long
+
+      # Error raised if an illegal option or argument is passed
+      class Error < StandardError; end
+
+      # The version of the getopt library
+      VERSION = '1.4.0'
+
+      # Takes an array of switches. Each array consists of up to three
+      # elements that indicate the name and type of switch. Returns a hash
+      # containing each switch name, minus the '-', as a key. The value
+      # for each key depends on the type of switch and/or the value provided
+      # by the user.
+      #
+      # The long switch _must_ be provided. The short switch defaults to the
+      # first letter of the short switch. The default type is BOOLEAN.
+      #
+      # Example:
+      #
+      #  opts = Getopt::Long.getopts(
+      #     ['--debug'                   ],
+      #     ['--verbose', '-v'           ],
+      #     ['--level',   '-l', INCREMENT]
+      #  )
+      #
+      # See the README file for more information.
+      #
+      def self.getopts(*switches)
+         if switches.empty?
+            raise ArgumentError, 'no switches provided'
+         end
+
+         hash  = {} # Hash returned to user
+         valid = [] # Tracks valid switches
+         types = {} # Tracks argument types
+         syns  = {} # Tracks long and short arguments, or multiple shorts
+
+         # If a string is passed, split it and convert it to an array of arrays
+         if switches.first.kind_of?(String)
+            switches = switches.join.split
+            switches.map!{ |switch| switch = [switch] }
+         end
+
+         # Set our list of valid switches, and proper types for each switch
+         switches.each{ |switch|
+            valid.push(switch[0])       # Set valid long switches
+
+            # Set type for long switch, default to BOOLEAN.
+            if switch[1].kind_of?(Fixnum)
+               switch[2] = switch[1]
+               types[switch[0]] = switch[2]
+               switch[1] = switch[0][1..2]
+            else
+               switch[2] ||= BOOLEAN
+               types[switch[0]] = switch[2]
+               switch[1] ||= switch[0][1..2]
+            end
+
+            # Create synonym hash.  Default to first char of long switch for 
+            # short switch, e.g. "--verbose" creates a "-v" synonym.  The same
+            # synonym can only be used once - first one wins.
+            syns[switch[0]] = switch[1] unless syns[switch[1]]
+            syns[switch[1]] = switch[0] unless syns[switch[1]]
+
+            switch[1] = [switch[1]] if RUBY_VERSION.to_f >= 1.9
+
+            switch[1].each{ |char|      
+               types[char] = switch[2]  # Set type for short switch
+               valid.push(char)         # Set valid short switches
+            }
+         }
+
+         re_long     = /^(--\w+[-\w+]*)?$/
+         re_short    = /^(-\w)$/
+         re_long_eq  = /^(--\w+[-\w+]*)?=(.*?)$|(-\w?)=(.*?)$/
+         re_short_sq = /^(-\w)(\S+?)$/
+
+         ARGV.each_with_index{ |opt, index|
+
+            # Allow either -x -v or -xv style for single char args
+            if re_short_sq.match(opt)
+               chars = opt.split("")[1..-1].map{ |s| s = "-#{s}" }
+
+               chars.each_with_index{ |char, i|
+                  unless valid.include?(char)  
+                     raise Error, "invalid switch '#{char}'"
+                  end
+
+                  # Grab the next arg if the switch takes a required arg
+                  if types[char] == REQUIRED
+                     # Deal with a argument squished up against switch
+                     if chars[i+1]
+                        arg = chars[i+1..-1].join.tr('-', '')
+                        ARGV.push(char, arg)
+                        break
+                     else
+                        arg = ARGV.delete_at(index+1)
+                        if arg.nil? || valid.include?(arg) # Minor cheat here
+                           err = "no value provided for required argument '#{char}'"
+                           raise Error, err
+                        end
+                        ARGV.push(char, arg)
+                     end
+                  elsif types[char] == OPTIONAL
+                     if chars[i+1] && !valid.include?(chars[i+1])
+                        arg = chars[i+1..-1].join.tr("-","")
+                        ARGV.push(char, arg)
+                        break
+                     elsif
+                        if ARGV[index+1] && !valid.include?(ARGV[index+1])
+                           arg = ARGV.delete_at(index+1)
+                           ARGV.push(char, arg)
+                        end
+                     else
+                        ARGV.push(char)
+                     end
+                  else
+                     ARGV.push(char)
+                  end
+               }
+               next
+            end
+
+            if match = re_long.match(opt) || match = re_short.match(opt)
+               switch = match.captures.first
+            end
+
+            if match = re_long_eq.match(opt)
+               switch, value = match.captures.compact
+               ARGV.push(switch, value)
+               next
+            end
+
+            # Make sure that all the switches are valid.  If 'switch' isn't
+            # defined at this point, it means an option was passed without
+            # a preceding switch, e.g. --option foo bar.
+            unless valid.include?(switch)
+               switch ||= opt
+               raise Error, "invalid switch '#{switch}'"
+            end
+
+            # Required arguments
+            if types[switch] == REQUIRED
+               nextval = ARGV[index+1]
+
+               # Make sure there's a value for mandatory arguments
+               if nextval.nil?
+                  err = "no value provided for required argument '#{switch}'"
+                  raise Error, err
+               end
+
+               # If there is a value, make sure it's not another switch
+               if valid.include?(nextval)
+                  err = "cannot pass switch '#{nextval}' as an argument"
+                  raise Error, err
+               end
+
+               # If the same option appears more than once, put the values
+               # in array.
+               if hash[switch]
+                  hash[switch] = [hash[switch], nextval].flatten
+               else
+                  hash[switch] = nextval
+               end
+               ARGV.delete_at(index+1)
+            end
+
+            # For boolean arguments set the switch's value to true.
+            if types[switch] == BOOLEAN
+               if hash.has_key?(switch)
+                  raise Error, 'boolean switch already set'
+               end
+               hash[switch] = true
+            end
+
+            # For increment arguments, set the switch's value to 0, or
+            # increment it by one if it already exists.
+            if types[switch] == INCREMENT
+               if hash.has_key?(switch)
+                  hash[switch] += 1
+               else
+                  hash[switch] = 1
+               end
+            end
+
+            # For optional argument, there may be an argument.  If so, it
+            # cannot be another switch.  If not, it is set to true.
+            if types[switch] == OPTIONAL
+               nextval = ARGV[index+1]
+               if valid.include?(nextval)
+                  hash[switch] = true
+               else
+                  hash[switch] = nextval
+                  ARGV.delete_at(index+1)
+               end
+            end
+         }
+
+         # Set synonymous switches to the same value, e.g. if -t is a synonym
+         # for --test, and the user passes "--test", then set "-t" to the same
+         # value that "--test" was set to.
+         #
+         # This allows users to refer to the long or short switch and get
+         # the same value
+         hash.each{ |switch, val|
+            if syns.keys.include?(switch)
+               syns[switch] = [syns[switch]] if RUBY_VERSION.to_f >= 1.9
+               syns[switch].each{ |key|
+                  hash[key] = val   
+               }
+            end
+         }
+
+         # Get rid of leading "--" and "-" to make it easier to reference
+         hash.each{ |key, value|
+            if key =~ /^-/
+               if key[0,2] == '--'
+                  nkey = key.sub('--', '')
+               else
+                  nkey = key.sub('-', '')
+               end
+               hash.delete(key)
+               hash[nkey] = value
+            end
+         }
+
+         hash
+      end
+
+   end
+end

data/lib/getopt/std.rb

@@ -0,0 +1,108 @@
+# The Getopt module serves as a namespace only
+module Getopt
+
+   # The Getopt::Std class serves as a base class for the getopts method.
+   class Std
+
+      # The Getopt::Std::Error class is raised if there are any illegal
+      # command line arguments.
+      # 
+      class Error < StandardError; end
+
+      # The version of the getopt library
+      VERSION = '1.4.0'
+
+      # Processes single character command line options with option
+      # clustering.  This information is parsed from ARGV and returned
+      # as a hash, with the switch (minus the "-") as the key.  The value
+      # for that key is either true/false (boolean switches) or the argument
+      # that was passed to the switch.
+      #
+      # Characters followed by a ":" require an argument.  The rest are
+      # considered boolean switches.  If a switch that accepts an argument
+      # appears more than once, the value for that key becomes an array
+      # of values.
+      #
+      # Example:
+      #
+      #  # Look for -o with argument, and -I and -D boolean arguments
+      #  opt = Getopt::Std.getopts("o:ID")
+      #
+      #  if opt["I"]
+      #    # Do something if -I passed
+      #  end
+      #
+      #  if opt["D"]
+      #     # Do something if -D passed
+      #  end
+      #
+      #  if opt["o"]
+      #     case opt["o"]
+      #        # Do something
+      #     end
+      #  end
+      # 
+      def self.getopts(switches)
+         args = switches.split(/ */)
+         hash = {}
+         
+         while !ARGV.empty? && ARGV.first =~ /^-(.)(.*)/s
+            first, rest = $1, $2
+            pos = switches.index(first)
+
+            # Switches on the command line must appear among the characters
+            # declared in +switches+.
+            raise Error, "invalid option '#{first}'" unless pos
+
+            if args[pos+1] == ":"
+               ARGV.shift
+               if rest.empty?
+                  rest = ARGV.shift
+
+                  # Ensure that switches requiring arguments actually
+                  # receive a (non-switch) argument.
+                  if rest.nil? || rest.empty?
+                     raise Error, "missing argument for '-#{args[pos]}'"
+                  end
+
+                  # Do not permit switches that require arguments to be
+                  # followed immediately by another switch.
+                  temp_args = args.map{ |e| "-#{e}" }
+
+                  if temp_args.include?(rest) || temp_args.include?(rest[1..-1])
+                     err = "cannot use switch '#{rest}' as argument "
+                     err << "to another switch"
+                     raise Error, err
+                  end
+
+                  # For non boolean switches, arguments that appear multiple
+                  # times are converted to an array (or pushed onto an already
+                  # existant array).
+                  if hash.has_key?(first)
+                     hash[first] = [hash[first], rest].flatten
+                  else
+                     hash[first] = rest
+                  end
+               else
+                  # Do not permit switches that require arguments to be
+                  # followed immediately by another switch.
+                  if args.include?(rest) || args.include?(rest[1..-1])
+                     err = "cannot use switch '#{rest}' as argument "
+                     err += "to another switch"
+                     raise Error, err
+                  end
+               end
+            else
+               hash[first] = true # Boolean switch
+               if rest.empty?
+                  ARGV.shift
+               else
+                  ARGV[0] = "-#{rest}"
+               end
+            end
+         end
+
+         hash
+      end
+   end
+end

data/test/test_getopt_long.rb

@@ -17,7 +17,7 @@ class TC_Getopt_Long < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.3.9', Long::VERSION)
+      assert_equal('1.4.0', Long::VERSION)
    end
 
    def test_constants

data/test/test_getopt_std.rb

@@ -14,7 +14,7 @@ include Getopt
 class TC_Getopt_Std < Test::Unit::TestCase
 
    def test_version
-      assert_equal('1.3.9', Std::VERSION)
+      assert_equal('1.4.0', Std::VERSION)
    end
 
    def test_getopts_basic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: getopt
 version: !ruby/object:Gem::Version 
-  version: 1.3.9
+  version: 1.4.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-29 00:00:00 -06:00
+date: 2009-09-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,13 +33,17 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
+- CHANGES
 - examples/example_long.rb
 - examples/example_std.rb
+- getopt.gemspec
+- lib/getopt/long.rb
+- lib/getopt/std.rb
+- MANIFEST
+- Rakefile
+- README
 - test/test_getopt_long.rb
 - test/test_getopt_std.rb
-- README
-- CHANGES
-- MANIFEST
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
 licenses: