getopt 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca47de7a2b707c120f664cddb09b52ea83437da650968259b2bca08bded4b9d6
-  data.tar.gz: 0afa07ce4a5c65753fcb9cc9e1b878b1b83cb7cdce590fbe01dda585c19e923f
+  metadata.gz: 8fb3a945490a612eaf1e604f83dea2a0e1adecd5b3469c83e214bcb99eacd076
+  data.tar.gz: 13521ceb0616ee5e34e6434e6b2c94dc12be959eec7ca210977c1b5ce903c723
 SHA512:
-  metadata.gz: c1e31f007d67944148636e8db0b0700fd9c62399ca1b7961af769a4ccc7fa9deed32c49ba9e73daf3df099e647ede6480fe5951ff9a8ea63561c02a40e79fc78
-  data.tar.gz: f5ed551262c5e84c5b30a7c445174933081866394db9b448ac2ded94a2001597383aa1f0ebbfc699f5b9c16964b6ba2604d0801b8bcb5b566d50e0f755579474
+  metadata.gz: 528a9e0c5f0c7aed85fc510e8f823b75b9b40b8f5142a8373474a4f643005ce1ab497f42657802f30dc8b0f002a6154ada4b246a93fa2ee9cc84c197f7621140
+  data.tar.gz: 2ff2aaf442063fbb69d5a96eff5e098b2e10d7472922263424ee9fd3d0539916d08201b04635de80b3abec9a8b40ebe24732eb9ef5ddd705c488d4209b198865

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,40 +1,44 @@
-== 1.5.1 - 23-Mar-2020
+## 1.6.0 - 2-Mar-2021
+* Switch from test-unit to rspec, and update the Rakefile and gemspec accordingly.
+* Added a Gemfile.
+
+## 1.5.1 - 23-Mar-2020
 * Properly add a LICENSE file since the Apache-2.0 license requires it.
 * Added explicit .rdoc extensions to the README, CHANGES and MANIFEST files,
   mostly so they look nicer on github.
 
-== 1.5.0 - 25-Jan-2019
+## 1.5.0 - 25-Jan-2019
 * Changed license to Apache-2.0.
 
-== 1.4.4 - 24-Mar-2018
+## 1.4.4 - 24-Mar-2018
 * Fixed a deprecation warning.
 * Now requires Ruby 2.2 or later.
 * Added metadata to the gemspec.
 * Updated the cert.
 
-== 1.4.3 - 7-Jan-2016
+## 1.4.3 - 7-Jan-2016
 * This gem is now signed.
 * The gem related tasks in the Rakefile now assume Rubygems 2.x.
 * Added getopt.rb, getopt-std.rb and getopt-long.rb files for convenience.
 
-== 1.4.2 - 12-Oct-2014
+## 1.4.2 - 12-Oct-2014
 * Updated Rakefile, README and gemspec.
 * Minor updates to the test file and examples.
 
-== 1.4.1 - 17-Jul-2011
+## 1.4.1 - 17-Jul-2011
 * Now works with Ruby 1.9.x. Thanks go to Shura for the patch.
 * Refactored the gemspec. Gem building code is now handled by Rake tasks.
 * Refactored the Rakefile. Added a default task, removed the old install
   task, and namespaced the gem related tasks.
 
-== 1.4.0 - 5-Sep-2009
+## 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
+## 1.3.9 - 29-Jul-2009
 * Now compatible with Ruby 1.9.x.
 * Gemspec updates, including a license change to Artistic 2.0.
 * Added individual rake tasks for testing Getopt::Long and Getopt::Std.
@@ -42,7 +46,7 @@
 * The test-unit library was switched from a standard dependency to a
   development dependency.
 
-== 1.3.8 - 6-Jan-2008
+## 1.3.8 - 6-Jan-2008
 * Fixed RF bug #23477 - Getopt::Std inadvertently raises an error if you
   pass a letter (without a hyphen) as an argument to a switch that matches
   that letter, e.g. "-a a" should be legal. Thanks go to an anonymous user
@@ -50,7 +54,7 @@
 * Added tests for RF bug #23477.
 * Added Test::Unit 2.x as a prerequisite.
 
-== 1.3.7 - 27-Jul-2008
+## 1.3.7 - 27-Jul-2008
 * Fixed a potential infinite hash recursion bug in ARGV processing. This
   was smoked out as the result of the alternate hash implementations in
   JRuby and Ruby 1.9.
@@ -58,41 +62,41 @@
 * Removed the ts_all.rb file, and renamed the other test files. The Rakefile
   test task was updated accordingly.
 
-== 1.3.6 - 8-Aug-2007
+## 1.3.6 - 8-Aug-2007
 * 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.
 
-== 1.3.5 - 5-Jul-2006
+## 1.3.5 - 5-Jul-2006
 * Fixed a bug where multiple long switches with the same first character
   could cause invalid results.  Thanks go to Michael Campbell for the spot.
 * Added documentation to the README file that explains what happens if you
   specify multiple long switches with the same first character and no short
   switch alias.
 
-== 1.3.4 - 7-Mar-2006
+## 1.3.4 - 7-Mar-2006
 * Fixed Getopt::Long so that it can handle embedded hyphens in the long
   form, e.g. --foo-bar.  Thanks go to Mark Meves for the spot.
 * Corresponding test suite additions.
 * Added example to the 'example_long.rb' file that uses long form with
   embedded hyphens.
 
-== 1.3.3 - 22-Feb-2006
+## 1.3.3 - 22-Feb-2006
 * Bug fix for the two argument form of Getopt::Long.getopts.
 * Corresponding test suite additions.
 
-== 1.3.2 - 13-Feb-2006
+## 1.3.2 - 13-Feb-2006
 * Improved error message if an option is passed without a preceding switch.
 * Minor documentation fixes and clarifications.
 
-== 1.3.1 - 18-Nov-2005
+## 1.3.1 - 18-Nov-2005
 * Added support for compressed switches with getopt/long.
 * More tests.
 * Fixed a bug in the gemspec.
 
-== 1.3.0 - 4-Nov-2005
+## 1.3.0 - 4-Nov-2005
 * Added the Getopt::Long class (long.rb). This is a complete revamp of the
   old getoptlong package, with ideas tossed in from Perl's Getopt::Long
   package. See the README and example script for more detail.
@@ -100,14 +104,14 @@
 * Added lots of documentation to the README file.
 * Updated the MANIFEST, test suite, etc.
 
-== 1.2.0 - 24-Oct-2005
+## 1.2.0 - 24-Oct-2005
 * Altered the way multiple occurrences of the same switch are handled, for
   those switches that accept arguments.
 
-== 1.1.0 - 7-Oct-2005
+## 1.1.0 - 7-Oct-2005
 * Changed parser, added a bit stricter enforcement
 * Now handles squished arguments properly, e.g. "-ID" as well as "-I -D"
 * Some test suite changes
 
-== 1.0.0 - 5-Oct-2005
+## 1.0.0 - 5-Oct-2005
 * Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org' do
+  gemspec
+end

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,7 +1,8 @@
-* CHANGES.rdoc
+* CHANGES.md
 * LICENSE
-* MANIFEST.rdoc
-* README.rdoc
+* MANIFEST.md
+* README.md
+* Gemfile
 * Rakefile
 * getopt.gemspec
 * certs/djberg96_pub.pem

data/{README.rdoc → README.md}

@@ -1,71 +1,74 @@
-= Description
+## Description
+The getopt Ruby library is a simple command line parsing library. It implements
+a `Getopt::Std` class for basic command line parsing, as well as a `Getopt::Long`
+class for more advanced command line parsing.
 
-Implements a simple Getopt::Std class for command line parsing, as well
-as a Getopt::Long class for more advanced command line parsing.
-
-= Installation
-
-  gem install getopt
+## Installation
+`gem install getopt`
    
-= Synopsis
-== Getopt::Std
-
-  require 'getopt/std'
-	
-  # 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
-		
-  if opt["D"]
-    # Do something if -D passed
-		
-  if opt["o"]
-    case opt["o"]
-      # blah, blah, blah
-    end
+## Synopsis
+### Getopt::Std
+```ruby
+require 'getopt/std'
+
+# 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
+  
+if opt["D"]
+  # Do something if -D passed
+  
+if opt["o"]
+  case opt["o"]
+    # blah, blah, blah
   end
-
-== Getopt::Long
-
-  require 'getopt/long'
-
-  opt = Getopt::Long.getopts(
-    ["--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
-
-  if opt["b"]
-    # Do something if --bar or -b passed
-
-= Class Methods
-
-  Std.getopts(switches)
+end
+```
+
+### Getopt::Long
+```ruby
+require 'getopt/long'
+
+opt = Getopt::Long.getopts(
+  ["--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
+end
+
+if opt["b"]
+  # Do something if --bar or -b passed
+end
+```
+
+## Singleton Methods
+`Std.getopts(switches)`
 
 Takes a series of single character switches that can be accepted on the
-command line.  Those characters followed by a ':' require an argument. The
-rest are considered boolean switches.  Returns a hash, with the switches
-as the key (sans the leading '-').  For boolean switches, the value is
-either true or false.  Switches that were not passed on the command line
-do not appear in the hash.
+command line. Any characters followed by a ":" require an argument. The
+rest are considered boolean switches.
 
-In the event that a switch that accepts an argument appears multiple times
+The method returns a hash, with the switches as the key (minus the leading '-').
+For boolean switches, the value is either true or false. Switches that were
+not passed on the command line do not appear in the hash.
+
+In the event that a switch which accepts an argument appears multiple times
 the value for that key becomes an array of values.
 
-  Long.getopts(switches)
+`Long.getopts(switches)`
 
 Takes an array of switches beginning with "--" followed by one or more
 alphanumeric or hyphen characters, or "-" followed by a single character.
@@ -74,12 +77,14 @@ REQUIRED or INCREMENT.
 
 The array should be in the form:
 
-  # long form, short form (alias), option type
-  ["--long", "-l", Getopt::OPTION]
+```
+# long form, short form (alias), option type
+["--long", "-l", Getopt::OPTION]
+```
 
-Note that only the long form is required.  If the short form is not
+Note that only the long form is required. If the short form is not
 specified, it will automatically be set to the first letter of the long
-switch.  If multiple long switches with the same first character are
+switch. If multiple long switches with the same first character are
 listed without short switches, only the first long switch gets the short
 switch alias.
 
@@ -90,34 +95,33 @@ no short switches or argument types).
 
 See the 'examples' directory for more examples.
 
-= Getopt::Long argument types
-
-REQUIRED
+## Getopt::Long argument types
+`REQUIRED`
 
 If the option is specified on the command line, it must be followed by
 a non-blank argument. This argument cannot be another switch. If this
 switch appears multiple times, the values are collected into an array.
 
-BOOLEAN
+`BOOLEAN`
 
 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.
 
-OPTIONAL
+`OPTIONAL`
 
 If the option is specified on the command line, it may or may not accept
 an argument, excluding other valid switches. If an argument is present,
 it's value is set to that argument.  If an argument is not present, it's
 value is set to nil.
 
-INCREMENT
+`INCREMENT`
 
 If the option is specified on the command line, its value is incremented
 by one for each appearance on the command line, or set to 1 if it appears
 only once.
 
-= Future Plans
+## Future Plans
 
 * Add support for negatable options so that you can do "--no-foo", for example.
 
@@ -127,40 +131,38 @@ only once.
 * Allow shortcut characters for the option types, e.g. "?" for BOOLEAN, "+"
   for INCREMENT, etc.
 
-= Known Issues
-
-== Getopt::Std
+## Known Issues
 
+### Getopt::Std
 You cannot squish switches that require arguments with the argument itself.
-For example, if you do Getopt::Std.getopts("o:ID"), it will not parse
+For example, if you do `Getopt::Std.getopts("o:ID")`, it will not parse
 "-IDohello" properly. Instead, you must do "-IDo hello". Or, you can just
 separate the argument, e.g. "-I -D -o hello".
 
-== Getopt::Long
-
+### Getopt::Long
 If you mix and match compressed switches with separate, optional switches
 the optional switch will be set to true instead of nil if it separated
 from the compressed switches.
    
-== Reporting Issues
+## Reporting Issues
 
 If you find any other issues, please log them on the project
 page at https://github.com/djberg96/getopt.
 
-= Other Stuff
-
-Neither class attempts to be POSIX compliant in any way, shape or form. And I don't care!
+## Other Stuff
+Neither class attempts to be POSIX compliant in any way, shape or form.
 
-= Notes From the Author
+And I don't care!
 
-My main gripe with the getoptlong library currently in the standard library
+## Notes From the Author
+My main gripe with the `getoptlong` library currently in the standard library
 is that it doesn't return a hash, yet gives you partial hash behavior. This
 was both confusing and annoying, since the first thing I do (along with
 everyone else) is collect the results into a hash for later processing.
 
-My main gripe with the optparse library (also in the standard library) is
+My main gripe with the `optparse` library (also in the standard library) is
 that it treats command line processing like event processing. It's too
-complex, when 90% of the time all you want to do is slurp the command line
+complex, when most of the time all you want to do is slurp the command line
 options into a hash.
 
 So, I did something utterly novel with this library. I collected the command
@@ -177,23 +179,19 @@ 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' gem.
-
-= Warranty
+switches, consider Jim Freeze's `commandline` gem.
 
+## Warranty
 This package is provided "as is" and without any express or
 implied warranties, including, without limitation, the implied
 warranties of merchantability and fitness for a particular purpose.
 
-= License
-
+## License
 Apache-2.0
 
-= Copyright
-
-(C) 2005-2020, Daniel J. Berger
+## Copyright
+(C) 2005-2021, Daniel J. Berger
 All Rights Reserved
 
-= Author
-
+## Author
 Daniel J. Berger

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 CLEAN.include("**/*.gem", "**/*.rbc")
 
@@ -10,7 +10,7 @@ namespace :gem do
     require 'rubygems/package'
     spec = eval(IO.read('getopt.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the getopt gem"
@@ -20,23 +20,18 @@ namespace :gem do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
-end
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all) do |t|
+    t.pattern = FileList['spec/*_spec.rb']
+  end
 
-namespace :test do
-  Rake::TestTask.new('getopt_long') do |t|
-    t.test_files = 'test/test_getopt_long.rb'
-    t.warning = true
-    t.verbose = true
+  RSpec::Core::RakeTask.new(:getopt_long) do |t|
+    t.pattern = FileList['spec/*long_spec.rb']
   end
 
-  Rake::TestTask.new('getopt_std') do |t|
-    t.test_files = 'test/test_getopt_std.rb'
-    t.warning = true
-    t.verbose = true
+  RSpec::Core::RakeTask.new(:getopt_std) do |t|
+    t.pattern = FileList['spec/*std_spec.rb']
   end
 end
 
-task :default => :test
+task :default => 'spec:all'