getopt 1.3.5 → 1.3.6

data/CHANGES

@@ -1,3 +1,10 @@
+== 8-Aug-2007 - 1.3.6
+* The Getopt::StdError class is now Getopt::Std::Error.
+* The Getopt::LongError class is now Getopt::Long::Error.
+* Added some inline rdoc documentation to the source code.
+* Added a Rakefile with tasks for installation and testing.
+* Removed the install.rb file - use the 'rake install' task instead.
+
 == 5-Jul-2006 - 1.3.5
 * Fixed a bug where multiple long switches with the same first character
   could cause invalid results.  Thanks go to Michael Campbell for the spot.

data/MANIFEST

@@ -1,15 +1,12 @@
-CHANGES
-MANIFEST
-README
-install.rb
-getopt.gemspec
-
-examples/example_std.rb
-examples/example_long.rb
-
-lib/getopt/std.rb
-lib/getopt/long.rb
-
-test/tc_getopt_std.rb
-test/tc_getopt_long.rb
-test/ts_all.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* getopt.gemspec
+* examples/example_std.rb
+* examples/example_long.rb
+* lib/getopt/std.rb
+* lib/getopt/long.rb
+* test/tc_getopt_std.rb
+* test/tc_getopt_long.rb
+* test/ts_all.rb

data/README

@@ -6,18 +6,12 @@
    Ruby 1.8.0 or later.
    
 == Installation
-=== Standard Installation
-   ruby test/ts_all.rb
-   ruby install.rb
-
-=== Gem Installation
-   ruby test/ts_all.rb
-   ruby getopt.gemspec
-   gem install getopt-x-y-z.gem # Where x-y-z is a version
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
    
 == Synopsis
 === Getopt::Std
-   require "getopt/std"
+   require 'getopt/std'
 	
    # Look for -o with argument, and -I and -D boolean arguments
    opt = Getopt::Std.getopts("o:ID")
@@ -35,7 +29,8 @@
    end
 
 === Getopt::Long
-   require "getopt/long"
+   require 'getopt/long'
+
    opt = Getopt::Long.getopts(
       ["--foo", "-f", Getopt::BOOLEAN],
       ["--bar", "-b", Getopt::REQUIRED]
@@ -181,10 +176,10 @@ INCREMENT
    Ruby's
 
 == Copyright
-   (C) 2005-2006, Daniel J. Berger
+   (C) 2005-2007, Daniel J. Berger
    All Rights Reserved
 
 == Author
    Daniel J. Berger
-   djberg96 at gmail.com
+   djberg96 at nospam at gmail.com
    imperator on IRC (freenode)

data/Rakefile

@@ -0,0 +1,23 @@
+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.libs << 'lib'
+   t.warning = true
+   t.test_files = FileList['test/ts_all.rb']
+end

data/lib/getopt/long.rb

@@ -7,12 +7,30 @@ module Getopt
    NEGATABLE = 4
    NUMERIC   = 5
 
-   class LongError < StandardError; end
-
    class Long
-      VERSION = '1.3.5'
-
-      # Takes an array of switches.  Each array consists of three elements.
+      class Error < StandardError; end
+
+      VERSION = '1.3.6'
+
+      # 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", NUMERIC]
+      # )
+      #
+      # See the README file for more information.
+      #
       def self.getopts(*switches)
          if switches.empty?
             raise ArgumentError, "no switches provided"
@@ -69,7 +87,7 @@ module Getopt
 
                chars.each_with_index{ |char, i|
                   unless valid.include?(char)  
-                     raise LongError, "invalid switch '#{char}'"
+                     raise Error, "invalid switch '#{char}'"
                   end
 
                   # Grab the next arg if the switch takes a required arg
@@ -83,7 +101,7 @@ module Getopt
                         arg = ARGV.delete_at(index+1)
                         if arg.nil? || valid.include?(arg) # Minor cheat here
                            err = "no value provided for required argument '#{char}'"
-                           raise LongError, err
+                           raise Error, err
                         end
                         ARGV.push(char, arg)
                      end
@@ -122,7 +140,7 @@ module Getopt
             # a preceding switch, e.g. --option foo bar.
             unless valid.include?(switch)
                switch ||= opt
-               raise LongError, "invalid switch '#{switch}'"
+               raise Error, "invalid switch '#{switch}'"
             end
 
             # Required arguments
@@ -132,13 +150,13 @@ module Getopt
                # Make sure there's a value for mandatory arguments
                if nextval.nil?
                   err = "no value provided for required argument '#{switch}'"
-                  raise LongError, err
+                  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 LongError, err
+                  raise Error, err
                end
 
                # If the same option appears more than once, put the values
@@ -154,7 +172,7 @@ module Getopt
             # For boolean arguments set the switch's value to true.
             if types[switch] == BOOLEAN
                if hash.has_key?(switch)
-                  raise LongError, "boolean switch already set"
+                  raise Error, "boolean switch already set"
                end
                hash[switch] = true
             end

data/lib/getopt/std.rb

@@ -1,7 +1,8 @@
 module Getopt
-   class StdError < StandardError; end
    class Std
-      VERSION = "1.3.4"
+      class Error < StandardError; end
+
+      VERSION = '1.3.6'
 
       # Processes single character command line options with option
       # clustering.  This information is parsed from ARGV and returned
@@ -24,7 +25,7 @@ module Getopt
 
             # Switches on the command line must appear among the characters
             # declared in +switches+.
-            raise StdError, "invalid option '#{first}'" unless pos
+            raise Error, "invalid option '#{first}'" unless pos
 
             if args[pos+1] == ":"
                ARGV.shift
@@ -34,7 +35,7 @@ module Getopt
                   # Ensure that switches requiring arguments actually
                   # receive a (non-switch) argument.
                   if rest.nil? || rest.empty?
-                     raise StdError, "missing argument for '-#{args[pos]}'"
+                     raise Error, "missing argument for '-#{args[pos]}'"
                   end
 
                   # Do not permit switches that require arguments to be
@@ -42,7 +43,7 @@ module Getopt
                   if args.include?(rest) || args.include?(rest[1..-1])
                      err = "cannot use switch '#{rest}' as argument "
                      err += "to another switch"
-                     raise StdError, err
+                     raise Error, err
                   end
 
                   # For non boolean switches, arguments that appear multiple
@@ -59,7 +60,7 @@ module Getopt
                   if args.include?(rest) || args.include?(rest[1..-1])
                      err = "cannot use switch '#{rest}' as argument "
                      err += "to another switch"
-                     raise StdError, err
+                     raise Error, err
                   end
                end
             else

data/test/tc_getopt_long.rb

@@ -1,18 +1,11 @@
-#######################################################
+#####################################################################
 # tc_getopt_long.rb
 #
-# Test suite for the getopt-long package.
-#######################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /getopt/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-   Dir.chdir("test") rescue nil
-end
-
-require "test/unit"
-require "getopt/long"
+# Test suite for the getopt-long package. You should run this test
+# via the 'rake test' rake task.
+#####################################################################
+require 'test/unit'
+require 'getopt/long'
 include Getopt
 
 class TC_Getopt_Long < Test::Unit::TestCase
@@ -21,7 +14,7 @@ class TC_Getopt_Long < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.3.5', Long::VERSION)
+      assert_equal('1.3.6', Long::VERSION)
    end
 
    def test_constants

data/test/tc_getopt_std.rb

@@ -1,24 +1,17 @@
-########################################################
+###################################################################
 # tc_getopt_std.rb
 #
-# Test suite for the Getopt::Std class.
-########################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /getopt/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-   Dir.chdir("test") rescue nil
-end
-
-require "test/unit"
-require "getopt/std"
+# Test suite for the Getopt::Std class. You should run this test
+# via the 'rake test' task.
+###################################################################
+require 'test/unit'
+require 'getopt/std'
 include Getopt
 
 class TC_Getopt_Std < Test::Unit::TestCase
 
    def test_version
-      assert_equal("1.3.4", Std::VERSION)
+      assert_equal('1.3.6', Std::VERSION)
    end
 
    def test_getopts_basic
@@ -56,18 +49,18 @@ class TC_Getopt_Std < Test::Unit::TestCase
 
    def test_getopts_expected_errors_missing_arg
       ARGV.push("-ID")
-      assert_raises(StdError){ Std.getopts("I:D") }
+      assert_raises(Std::Error){ Std.getopts("I:D") }
 
       ARGV.push("-ID")
-      assert_raises(StdError){ Std.getopts("ID:") }
+      assert_raises(Std::Error){ Std.getopts("ID:") }
    end
 
    def test_getopts_expected_errors_extra_arg
       ARGV.push("-I", "-D", "-X")
-      assert_raises(StdError){ Std.getopts("ID") }
+      assert_raises(Std::Error){ Std.getopts("ID") }
 
       ARGV.push("-IDX")
-      assert_raises(StdError){ Std.getopts("ID") }
+      assert_raises(Std::Error){ Std.getopts("ID") }
    end
 
    # If a switch that accepts an argument appears more than once, the values

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: getopt
 version: !ruby/object:Gem::Version 
-  version: 1.3.5
-date: 2006-07-05 00:00:00 -06:00
+  version: 1.3.6
+date: 2007-08-08 00:00:00 -06:00
 summary: Getopt::Std and Getopt::Long option parsers for Ruby
 require_paths: 
 - lib
@@ -34,6 +34,7 @@ files:
 - CHANGES
 - MANIFEST
 - README
+- Rakefile
 - test/tc_getopt_long.rb
 - test/tc_getopt_std.rb
 - test/ts_all.rb