getopt 1.3.1 → 1.3.2

data/CHANGES

@@ -1,6 +1,11 @@
+== 13-Feb-2006 - 1.3.2
+* Improved error message if an option is passed without a preceding switch.
+* Minor documentation fixes and clarifications.
+
 == 18-Nov-2005 - 1.3.1
 * Added support for compressed switches with getopt/long.
 * More tests.
+* Fixed a bug in the gemspec.
 
 == 4-Nov-2005 - 1.3.0
 * Added the Getopt::Long class (long.rb).  This is a complete revamp of the

data/README

@@ -37,9 +37,18 @@
 === Getopt::Long
    require "getopt/long"
    opt = Getopt::Long.getopts(
-      ["--foo", "-f", BOOLEAN],
-      ["--bar", "-b", REQUIRED]
+      ["--foo", "-f", Getopt::BOOLEAN],
+      ["--bar", "-b", Getopt::REQUIRED]
    )
+   
+   # Or, to save your fingers some typing:
+   #
+   # require "getopt/long"
+   # include Getopt
+   # opt = Long.getopts(
+   #    ["--foo", "-f", BOOLEAN],
+   #    ["--bar", "-b", REQUIRED]
+   # )
 
    if opt["foo"]
       # Do something if --foo or -f passed
@@ -66,7 +75,7 @@ Long.getopts(switches)
 
    The array should be in the form:
 
-   ["--long", "-l", OPTION]
+   ["--long", "-l", Getopt::OPTION]
 
    Note that only the long form is required.  If the short switch is not
    specified, it will automatically be set to the first letter of the long
@@ -86,7 +95,7 @@ REQUIRED
    switch appears multiple times, the values are collected into an array.
 
 BOOLEAN
-   If the option is specified on the command line, it's value is set to true.
+   If the option is specified on the command line, its value is set to true.
    It must not be followed by a non-blank argument, excluding other switches.
    Attempting to pass a boolean switch more than once will raise an error.
 
@@ -153,6 +162,11 @@ INCREMENT
    There are a few extra things I plan to add (see the 'Future Plans' above) but
    I do not plan on this library ever becoming as feature rich as, say, Perl's
    Getopt::Long module.
+   
+   If you plan to write a full fledged command line application, e.g. you plan
+   on implementing a full help system, gobs of command line options and tons of
+   switches, consider Jim Freeze's 'commandline' package, available on
+   RubyForge.
 
 == Warranty
    This package is provided "as is" and without any express or
@@ -163,7 +177,7 @@ INCREMENT
    Ruby's
 
 == Copyright
-   (C) 2005, Daniel J. Berger
+   (C) 2005-2006, Daniel J. Berger
    All Rights Reserved
 
 == Author

data/lib/getopt/long.rb

@@ -9,19 +9,19 @@ module Getopt
    class LongError < StandardError; end
 
    class Long
-      VERSION = "1.3.1"
+      VERSION = "1.3.2"
 
-      # takes an array of switches.  Each array consists of three elements.
+      # Takes an array of switches.  Each array consists of three elements.
       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 switches.empty?
-            raise ArgumentError, "no switches provided"
-         end
-
          # 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
@@ -56,7 +56,7 @@ module Getopt
 
          ARGV.each_with_index{ |opt, index|
 
-            # Allow either -x -v or -xv style for sing char args
+            # 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}" }
 
@@ -110,8 +110,11 @@ module Getopt
                next
             end
 
-            # Make sure that all the switches are valid
+            # 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 LongError, "invalid switch '#{switch}'"
             end
 

data/lib/getopt/std.rb

@@ -1,7 +1,7 @@
 module Getopt
    class StdError < StandardError; end
    class Std
-      VERSION = "1.3.0"
+      VERSION = "1.3.2"
 
       # Processes single character command line options with option
       # clustering.  This information is parsed from ARGV and returned

data/test/tc_getopt_long.rb

@@ -21,7 +21,7 @@ class TC_Getopt_Long < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.3.1", Long::VERSION)
+      assert_equal("1.3.2", Long::VERSION)
    end
 
    def test_constants

data/test/tc_getopt_std.rb

@@ -18,7 +18,7 @@ include Getopt
 class TC_Getopt_Std < Test::Unit::TestCase
 
    def test_version
-      assert_equal("1.3.0", Std::VERSION)
+      assert_equal("1.3.2", Std::VERSION)
    end
 
    def test_getopts_basic

metadata

@@ -3,11 +3,11 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: getopt
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
-date: 2005-11-18 00:00:00 -07:00
+  version: 1.3.2
+date: 2006-02-13 00:00:00 -07:00
 summary: Getopt::Std for Ruby
 require_paths: 
-  - lib
+- lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
@@ -18,34 +18,36 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Daniel J. Berger
+- Daniel J. Berger
 files: 
-  - lib/getopt/long.rb
-  - lib/getopt/std.rb
-  - CHANGES
-  - MANIFEST
-  - README
-  - CVS
-  - test/tc_getopt_long.rb
-  - test/tc_getopt_std.rb
-  - test/ts_all.rb
-  - test/CVS
+- lib/getopt/long.rb
+- lib/getopt/std.rb
+- CHANGES
+- MANIFEST
+- README
+- test/tc_getopt_long.rb
+- test/tc_getopt_std.rb
+- test/ts_all.rb
 test_files: 
-  - test/ts_all.rb
+- test/ts_all.rb
 rdoc_options: []
+
 extra_rdoc_files: 
-  - README
-  - CHANGES
+- README
+- CHANGES
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+