getopt 1.4.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f54f1e6653d0a5c7be3fe5980cd54dbadb36ee6a
-  data.tar.gz: 18ee08f16d15ad19931458fbd3146257adeb84aa
+SHA256:
+  metadata.gz: 8fb3a945490a612eaf1e604f83dea2a0e1adecd5b3469c83e214bcb99eacd076
+  data.tar.gz: 13521ceb0616ee5e34e6434e6b2c94dc12be959eec7ca210977c1b5ce903c723
 SHA512:
-  metadata.gz: 450e1d25c05e828390a3b333e5d39eb474ab2c63b26643b8cddf71efa9ff548498d7340115c651099fc84b545dffd10902279e8013671fccc91df38bb4b9fe14
-  data.tar.gz: cccc37509314d516557763cd97615f8562afca023311374ca704c0a03f3690dc00a23a83cd3d83f3e74f1c0ef975f2df2ed4dd11550a871cf4073f007c1cbeee
+  metadata.gz: 528a9e0c5f0c7aed85fc510e8f823b75b9b40b8f5142a8373474a4f643005ce1ab497f42657802f30dc8b0f002a6154ada4b246a93fa2ee9cc84c197f7621140
+  data.tar.gz: 2ff2aaf442063fbb69d5a96eff5e098b2e10d7472922263424ee9fd3d0539916d08201b04635de80b3abec9a8b40ebe24732eb9ef5ddd705c488d4209b198865

data/{CHANGES → CHANGES.md}

@@ -1,21 +1,44 @@
-== 1.4.2 - 12-Oct-2014
+## 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
+* Changed license to Apache-2.0.
+
+## 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
+* 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
 * 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.
@@ -23,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
@@ -31,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.
@@ -39,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.
@@ -81,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/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

@@ -1,11 +1,18 @@
-* CHANGES
-* MANIFEST
-* README
+* CHANGES.md
+* LICENSE
+* MANIFEST.md
+* README.md
+* Gemfile
 * Rakefile
 * getopt.gemspec
+* certs/djberg96_pub.pem
 * examples/example_std.rb
 * examples/example_long.rb
-* lib/getopt/std.rb
+* lib/getopt.rb
+* lib/getopt-long.rb
+* lib/getopt-std.rb
 * lib/getopt/long.rb
-* test/test_getopt_std.rb
+* lib/getopt/std.rb
+* lib/getopt/version.rb
 * test/test_getopt_long.rb
+* test/test_getopt_std.rb

data/README.md

@@ -0,0 +1,197 @@
+## 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.
+
+## Installation
+`gem install getopt`
+   
+## 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
+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. Any characters followed by a ":" require an argument. The
+rest are considered boolean switches.
+
+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)`
+
+Takes an array of switches beginning with "--" followed by one or more
+alphanumeric or hyphen characters, or "-" followed by a single character.
+The type of argument, if any, can be specified as BOOLEAN, OPTIONAL,
+REQUIRED or INCREMENT.
+
+The array should be in the form:
+
+```
+# 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
+specified, it will automatically be set to the first letter of the long
+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.
+
+If the argument type is not specified, the default is BOOLEAN.
+
+For the truly lazy, you can also pass a string of long switches (with
+no short switches or argument types). 
+
+See the 'examples' directory for more examples.
+
+## 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`
+
+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`
+
+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`
+
+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
+
+* Add support for negatable options so that you can do "--no-foo", for example.
+
+* Add support for numeric types, so that you don't have to manually convert
+  strings to numbers.
+
+* Allow shortcut characters for the option types, e.g. "?" for BOOLEAN, "+"
+  for INCREMENT, etc.
+
+## 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
+"-IDohello" properly. Instead, you must do "-IDo hello". Or, you can just
+separate the argument, e.g. "-I -D -o hello".
+
+### 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
+
+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!
+
+## 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
+that it treats command line processing like event processing. It's too
+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
+line options ... (wait for it) ... into a hash! Then I give that hash to
+you, aliases and all. I did get some ideas from Perl's Getopt::Long library,
+but this is in no way a port of that module (which supports POSIX parsing, GNU
+parsing, more option types, etc). My goal was to provide the functionality
+that I felt would cover the vast majority of common cases, yet still provide
+a little extra spice with switch types (REQUIRED, OPTIONAL, etc).
+
+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` 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
+Apache-2.0
+
+## Copyright
+(C) 2005-2021, Daniel J. Berger
+All Rights Reserved
+
+## Author
+Daniel J. Berger