optparse 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3726480fe0a25a9efd1cec645f993256cda45ac050411f046dfb6fa35117414a
-  data.tar.gz: ace5491689e1e277cd9b0a37b7ff070be46e46b6cb1b3b21f19c02d4d2d792a1
+  metadata.gz: 393ddfd5f19439c98112418ff879314c8570d9955e4a26a148b6d3bd94354cda
+  data.tar.gz: 270b3538983dfd6920cae9b2fcda5d7dcb5304157ae1e323a0d56daf33a6dd60
 SHA512:
-  metadata.gz: af882a7ff3c55fc882fbbc1259d104a55dd15049b64b3022459e868c4a00ba989ac651b5f7c16a260a97c8f4992b07adc3b03ca23ad231adf46cae62be6ae8b6
-  data.tar.gz: 42d6f1e638d8fdbb43953e0ecda55a00b9460d375a1cb8175bd14dcdbbc2fd94996fae031b0b7f31881d73dc6fa2815c75d146fc2fedc2ea9551797118be22e5
+  metadata.gz: 80e82b866fccf4b8598d3b495941629255ddfa907a8686a092d9ab5135d145d1c0a83d9d3d42ededcf1d33e21bc5ea6bfbee79f40085140e29a4ac54e6b96a1d
+  data.tar.gz: 998881fc6568b9725d7874145111cdee53e2366050a63f0e5908395f183d080eda16bf6740e8d83f90fe60064cf85fb424c24cd70e4589b344ee9dc3b997d283

data/ChangeLog

@@ -1,25 +1,163 @@
 -*- coding: utf-8 -*-
 
-commit 2a1e157ae134b07b8412182502755ec4eb3af499
+commit acbf6e3e12de4d116f7215b64432f204d293da97
   Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
-  AuthorDate: 2022-12-22 17:47:34 +0900
+  AuthorDate: 2023-11-07 10:40:38 +0900
   Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
-  CommitDate: 2022-12-22 17:47:34 +0900
+  CommitDate: 2023-11-07 10:40:38 +0900
 
-    Bump version to 0.3.1
+    Bump up 0.4.0
 
-commit 766f567405a362d0e018d8411df15ce8d70573a6
+commit 38848ce4b31977d4a892c2a5573b304c77208283
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-10-05 16:17:40 +0900
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-10-05 16:26:53 +0900
+
+    Use test-unit-ruby-core gem
+
+commit a291ef5c26445d423bf0223b0cb64340df18f0cb
+  Author:     dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+  AuthorDate: 2023-09-11 03:20:53 +0000
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-09-11 14:02:17 +0900
+
+    Bump actions/checkout from 3 to 4
+
+    Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
+    - [Release notes](https://github.com/actions/checkout/releases)
+    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
+    - [Commits](https://github.com/actions/checkout/compare/v3...v4)
+
+    ---
+    updated-dependencies:
+    - dependency-name: actions/checkout
+      dependency-type: direct:production
+      update-type: version-update:semver-major
+    ...
+
+    Signed-off-by: dependabot[bot] <support@github.com>
+
+commit 2940dbb65a7df013995934a93e6906109adda766
+  Author:     BurdetteLamar <burdettelamar@yahoo.com>
+  AuthorDate: 2023-07-30 16:35:00 +0100
+  Commit:     BurdetteLamar <burdettelamar@yahoo.com>
+  CommitDate: 2023-07-30 16:35:00 +0100
+
+    [DOC] Corrections to tutorial
+
+commit e8bee0be8f52f5a3e08d0db09a13798701670391
   Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
-  AuthorDate: 2022-12-21 14:07:54 +0900
-  Commit:     GitHub <noreply@github.com>
-  CommitDate: 2022-12-21 14:07:54 +0900
+  AuthorDate: 2023-07-30 11:24:59 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2023-07-30 11:24:59 +0900
+
+    [DOC] Mark up constant and method names as code
 
-    The encoding argument of `Regexp.new` has been ignored since 1.9
+commit 3cde2178d3d1bd1c7bf9c7e2af930e89e0bad6e5
+  Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  AuthorDate: 2023-07-12 01:07:11 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2023-07-12 01:07:37 +0900
+
+    Upload according to build results
+
+commit fb91d97c109269aee4fb0f7ecc1b3826dad118d8
+  Author:     Jeremy Evans <code@jeremyevans.net>
+  AuthorDate: 2023-04-04 13:58:59 -0700
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-04-05 08:43:45 +0900
+
+    Document requires needed for Date/DateTime/Time/URI/Shellwords support
+
+    Fixes [Bug #19566]
+
+commit 5bf4fa8a72a00d0891106af21655800db1d2ceff
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-03-24 13:01:25 +0900
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-03-24 13:38:04 +0900
 
-commit 97a198673408d98686a4ec9c3457eef13088c981
-  Author:     Junichi Sato <22004610+sato11@users.noreply.github.com>
-  AuthorDate: 2022-12-07 15:02:23 +0900
+    Update test libraries from https://github.com/ruby/ruby/commit/b4e438d8aabaf4bba2b27f374c787543fae07c58
+
+commit b67cc2407e6f9b5b4c9bc0751e21fa4969da0ceb
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-02-18 16:37:54 +0900
   Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
-  CommitDate: 2022-12-08 12:11:51 +0900
+  CommitDate: 2023-02-18 16:46:18 +0900
+
+    Skip build and upload package with Windows
+
+commit fd6621a23da2e8d3d1a3ab75003dbfeb0e42e2ab
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-02-18 16:31:55 +0900
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-02-18 16:46:18 +0900
+
+    Exclude JRuby from Windows
+
+commit 426726fa170ab5a1ddba4f2ef04ae6864ed2a625
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-02-18 16:25:39 +0900
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-02-18 16:46:18 +0900
+
+    Try with Windows
+
+commit 45fade52f519f656f62eb601899e3e96d3f69fca
+  Author:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  AuthorDate: 2023-02-18 16:25:25 +0900
+  Commit:     Hiroshi SHIBATA <hsbt@ruby-lang.org>
+  CommitDate: 2023-02-18 16:46:18 +0900
+
+    Use ruby/actions/.github/workflows/ruby_versions.yml@master
+
+commit 366a6a6b569037420013e83ada92012d0c6a2f76
+  Author:     Keishi Tanaka <k-tanaka@ruby-dev.jp>
+  AuthorDate: 2023-01-21 14:09:00 +0900
+  Commit:     GitHub <noreply@github.com>
+  CommitDate: 2023-01-21 14:09:00 +0900
+
+    Migrate set-output to $GITHUB_OUTPUT (#50)
+
+    https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
+
+commit 3e63d878f895a299a6ddeee5f8c615b69edf401c
+  Author:     Junichi Ito <jit@sonicgarden.jp>
+  AuthorDate: 2022-11-29 08:07:47 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2022-12-22 19:58:43 +0900
+
+    Add symbolize_names to getopts
+
+commit 73661899ad17e1061c7fc0f88cc4ac4e66a3c9a9
+  Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  AuthorDate: 2022-12-22 19:57:30 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2022-12-22 19:57:30 +0900
+
+    bump up to 0.4.0.pre.1
+
+commit 697ea7bf8e343704e735fb2d1f7787d96b843469
+  Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  AuthorDate: 2022-12-22 19:55:51 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2022-12-22 19:55:51 +0900
+
+    Add .rdoc_options
+
+commit ab0022bd23d77e515390cbb2c165f7647400be46
+  Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  AuthorDate: 2021-09-29 11:47:47 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2022-12-22 19:53:20 +0900
+
+    Cron test
+
+commit 33663e2c50eb8496b81750976b3480c14783470d
+  Author:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  AuthorDate: 2022-12-22 19:48:22 +0900
+  Commit:     Nobuyoshi Nakada <nobu@ruby-lang.org>
+  CommitDate: 2022-12-22 19:50:16 +0900
 
-    Use GITHUB_OUTPUT instead of deprecated set-output
+    Add `helper.bump`

data/doc/optparse/argument_converters.rdoc

@@ -1,7 +1,7 @@
 == Argument Converters
 
 An option can specify that its argument is to be converted
-from the default \String to an instance of another class.
+from the default +String+ to an instance of another class.
 
 === Contents
 
@@ -27,13 +27,13 @@ from the default \String to an instance of another class.
 
 === Built-In Argument Converters
 
-\OptionParser has a number of built-in argument converters,
++OptionParser+ has a number of built-in argument converters,
 which are demonstrated below.
 
-==== \Date
+==== +Date+
 
 File +date.rb+
-defines an option whose argument is to be converted to a \Date object.
+defines an option whose argument is to be converted to a +Date+ object.
 The argument is converted by method Date#parse.
 
   :include: ruby/date.rb
@@ -47,10 +47,10 @@ Executions:
   $ ruby date.rb --date "3rd Feb 2001"
   [#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, Date]
 
-==== \DateTime
+==== +DateTime+
 
 File +datetime.rb+
-defines an option whose argument is to be converted to a \DateTime object.
+defines an option whose argument is to be converted to a +DateTime+ object.
 The argument is converted by method DateTime#parse.
 
   :include: ruby/datetime.rb
@@ -64,10 +64,10 @@ Executions:
   $ ruby datetime.rb --datetime "3rd Feb 2001 04:05:06 PM"
   [#<DateTime: 2001-02-03T16:05:06+00:00 ((2451944j,57906s,0n),+0s,2299161j)>, DateTime]
 
-==== \Time
+==== +Time+
 
 File +time.rb+
-defines an option whose argument is to be converted to a \Time object.
+defines an option whose argument is to be converted to a +Time+ object.
 The argument is converted by method Time#httpdate or Time#parse.
 
   :include: ruby/time.rb
@@ -79,10 +79,10 @@ Executions:
   $ ruby time.rb --time 2010-10-31
   [2010-10-31 00:00:00 -0500, Time]
 
-==== \URI
+==== +URI+
 
 File +uri.rb+
-defines an option whose argument is to be converted to a \URI object.
+defines an option whose argument is to be converted to a +URI+ object.
 The argument is converted by method URI#parse.
 
   :include: ruby/uri.rb
@@ -96,10 +96,10 @@ Executions:
   $ ruby uri.rb --uri file://~/var
   [#<URI::File file://~/var>, URI::File]
 
-==== \Shellwords
+==== +Shellwords+
 
 File +shellwords.rb+
-defines an option whose argument is to be converted to an \Array object by method
+defines an option whose argument is to be converted to an +Array+ object by method
 Shellwords#shellwords.
 
   :include: ruby/shellwords.rb
@@ -111,10 +111,10 @@ Executions:
   $ ruby shellwords.rb --shellwords "here are 'two words'"
   [["here", "are", "two words"], Array]
 
-==== \Integer
+==== +Integer+
 
 File +integer.rb+
-defines an option whose argument is to be converted to an \Integer object.
+defines an option whose argument is to be converted to an +Integer+ object.
 The argument is converted by method Kernel#Integer.
 
   :include: ruby/integer.rb
@@ -132,10 +132,10 @@ Executions:
   $ ruby integer.rb --integer 0b100
   [4, Integer]
 
-==== \Float
+==== +Float+
 
 File +float.rb+
-defines an option whose argument is to be converted to a \Float object.
+defines an option whose argument is to be converted to a +Float+ object.
 The argument is converted by method Kernel#Float.
 
   :include: ruby/float.rb
@@ -151,11 +151,11 @@ Executions:
   $ ruby float.rb --float 1.234E-2
   [0.01234, Float]
 
-==== \Numeric
+==== +Numeric+
 
 File +numeric.rb+
 defines an option whose argument is to be converted to an instance
-of \Rational, \Float, or \Integer.
+of +Rational+, +Float+, or +Integer+.
 The argument is converted by method Kernel#Rational,
 Kernel#Float, or Kernel#Integer.
 
@@ -170,10 +170,10 @@ Executions:
   $ ruby numeric.rb --numeric 3
   [3, Integer]
 
-==== \DecimalInteger
+==== +DecimalInteger+
 
 File +decimal_integer.rb+
-defines an option whose argument is to be converted to an \Integer object.
+defines an option whose argument is to be converted to an +Integer+ object.
 The argument is converted by method Kernel#Integer.
 
   :include: ruby/decimal_integer.rb
@@ -192,10 +192,10 @@ Executions:
   $ ruby decimal_integer.rb --decimal_integer -0100
   [-100, Integer]
 
-==== \OctalInteger
+==== +OctalInteger+
 
 File +octal_integer.rb+
-defines an option whose argument is to be converted to an \Integer object.
+defines an option whose argument is to be converted to an +Integer+ object.
 The argument is converted by method Kernel#Integer.
 
   :include: ruby/octal_integer.rb
@@ -212,10 +212,10 @@ Executions:
   $ ruby octal_integer.rb --octal_integer 0100
   [64, Integer]
 
-==== \DecimalNumeric
+==== +DecimalNumeric+
 
 File +decimal_numeric.rb+
-defines an option whose argument is to be converted to an \Integer object.
+defines an option whose argument is to be converted to an +Integer+ object.
 The argument is converted by method Kernel#Integer
 
   :include: ruby/decimal_numeric.rb
@@ -232,7 +232,7 @@ Executions:
   $ ruby decimal_numeric.rb --decimal_numeric 0100
   [64, Integer]
 
-==== \TrueClass
+==== +TrueClass+
 
 File +true_class.rb+
 defines an option whose argument is to be converted to +true+ or +false+.
@@ -259,7 +259,7 @@ Executions:
   $ ruby true_class.rb --true_class nil
   [false, FalseClass]
 
-==== \FalseClass
+==== +FalseClass+
 
 File +false_class.rb+
 defines an option whose argument is to be converted to +true+ or +false+.
@@ -286,10 +286,10 @@ Executions:
   $ ruby false_class.rb --false_class +
   [true, TrueClass]
 
-==== \Object
+==== +Object+
 
 File +object.rb+
-defines an option whose argument is not to be converted from \String.
+defines an option whose argument is not to be converted from +String+.
 
   :include: ruby/object.rb
 
@@ -300,10 +300,10 @@ Executions:
   $ ruby object.rb --object nil
   ["nil", String]
 
-==== \String
+==== +String+
 
 File +string.rb+
-defines an option whose argument is not to be converted from \String.
+defines an option whose argument is not to be converted from +String+.
 
   :include: ruby/string.rb
 
@@ -314,10 +314,10 @@ Executions:
   $ ruby string.rb --string nil
   ["nil", String]
 
-==== \Array
+==== +Array+
 
 File +array.rb+
-defines an option whose argument is to be converted from \String
+defines an option whose argument is to be converted from +String+
 to an array of strings, based on comma-separated substrings.
 
   :include: ruby/array.rb
@@ -331,10 +331,10 @@ Executions:
   $ ruby array.rb --array "foo, bar, baz"
   [["foo", " bar", " baz"], Array]
 
-==== \Regexp
+==== +Regexp+
 
 File +regexp.rb+
-defines an option whose argument is to be converted to a \Regexp object.
+defines an option whose argument is to be converted to a +Regexp+ object.
 
   :include: ruby/regexp.rb
 
@@ -352,7 +352,7 @@ To create a custom converter, call OptionParser#accept with:
 - A block that accepts the argument and returns the converted value.
 
 This custom converter accepts any argument and converts it,
-if possible, to a \Complex object.
+if possible, to a +Complex+ object.
 
   :include: ruby/custom_converter.rb
 

data/doc/optparse/option_params.rdoc

@@ -1,6 +1,6 @@
 == Parameters for New Options
 
-Option-creating methods in \OptionParser
+Option-creating methods in +OptionParser+
 accept arguments that determine the behavior of a new option:
 
 - OptionParser#on
@@ -405,7 +405,7 @@ Executions:
 === Argument Converters
 
 An option can specify that its argument is to be converted
-from the default \String to an instance of another class.
+from the default +String+ to an instance of another class.
 
 There are a number of built-in converters.
 You can also define custom converters.

data/doc/optparse/tutorial.rdoc

@@ -1,10 +1,10 @@
 == Tutorial
 
-=== Why \OptionParser?
+=== Why +OptionParser+?
 
 When a Ruby program executes, it captures its command-line arguments
 and options into variable ARGV.
-This simple program just prints its \ARGV:
+This simple program just prints its +ARGV+:
 
   :include: ruby/argv.rb
 
@@ -18,7 +18,7 @@ the command-line options.
 
 OptionParser offers methods for parsing and handling those options.
 
-With \OptionParser, you can define options so that for each option:
+With +OptionParser+, you can define options so that for each option:
 
 - The code that defines the option and code that handles that option
   are in the same place.
@@ -55,7 +55,7 @@ The class also has method #help, which displays automatically-generated help tex
 - {Argument Converters}[#label-Argument+Converters]
 - {Help}[#label-Help]
 - {Top List and Base List}[#label-Top+List+and+Base+List]
-- {Defining Options}[#label-Defining+Options]
+- {Methods for Defining Options}[#label-Methods+for+Defining+Options]
 - {Parsing}[#label-Parsing]
   - {Method parse!}[#label-Method+parse-21]
   - {Method parse}[#label-Method+parse]
@@ -66,10 +66,10 @@ The class also has method #help, which displays automatically-generated help tex
 
 === To Begin With
 
-To use \OptionParser:
+To use +OptionParser+:
 
-1. Require the \OptionParser code.
-2. Create an \OptionParser object.
+1. Require the +OptionParser+ code.
+2. Create an +OptionParser+ object.
 3. Define one or more options.
 4. Parse the command line.
 
@@ -92,9 +92,9 @@ the block defined for the option is called with the argument value.
 An invalid option raises an exception.
 
 Method #parse!, which is used most often in this tutorial,
-removes from \ARGV the options and arguments it finds,
+removes from +ARGV+ the options and arguments it finds,
 leaving other non-option arguments for the program to handle on its own.
-The method returns the possibly-reduced \ARGV array.
+The method returns the possibly-reduced +ARGV+ array.
 
 Executions:
 
@@ -115,7 +115,7 @@ Executions:
 
 === Defining Options
 
-A common way to define an option in \OptionParser
+A common way to define an option in +OptionParser+
 is with instance method OptionParser#on.
 
 The method may be called with any number of arguments
@@ -522,11 +522,11 @@ Executions:
 === Argument Converters
 
 An option can specify that its argument is to be converted
-from the default \String to an instance of another class.
+from the default +String+ to an instance of another class.
 There are a number of built-in converters.
 
 Example: File +date.rb+
-defines an option whose argument is to be converted to a \Date object.
+defines an option whose argument is to be converted to a +Date+ object.
 The argument is converted by method Date#parse.
 
   :include: ruby/date.rb
@@ -546,7 +546,7 @@ for both built-in and custom converters.
 
 === Help
 
-\OptionParser makes automatically generated help text available.
++OptionParser+ makes automatically generated help text available.
 
 The help text consists of:
 
@@ -614,49 +614,49 @@ Execution:
 
 === Top List and Base List
 
-An \OptionParser object maintains a stack of \OptionParser::List objects,
+An +OptionParser+ object maintains a stack of OptionParser::List objects,
 each of which has a collection of zero or more options.
 It is unlikely that you'll need to add or take away from that stack.
 
 The stack includes:
 
-- The <em>top list</em>, given by \OptionParser#top.
-- The <em>base list</em>, given by \OptionParser#base.
+- The <em>top list</em>, given by OptionParser#top.
+- The <em>base list</em>, given by OptionParser#base.
 
-When \OptionParser builds its help text, the options in the top list
+When +OptionParser+ builds its help text, the options in the top list
 precede those in the base list.
 
-=== Defining Options
+=== Methods for Defining Options
 
 Option-defining methods allow you to create an option, and also append/prepend it
 to the top list or append it to the base list.
 
 Each of these next three methods accepts a sequence of parameter arguments and a block,
-creates an option object using method \Option#make_switch (see below),
+creates an option object using method OptionParser#make_switch (see below),
 and returns the created option:
 
-- \Method \OptionParser#define appends the created option to the top list.
+- \Method OptionParser#define appends the created option to the top list.
 
-- \Method \OptionParser#define_head prepends the created option to the top list.
+- \Method OptionParser#define_head prepends the created option to the top list.
 
-- \Method \OptionParser#define_tail appends the created option to the base list.
+- \Method OptionParser#define_tail appends the created option to the base list.
 
 These next three methods are identical to the three above,
 except for their return values:
 
-- \Method \OptionParser#on is identical to method \OptionParser#define,
+- \Method OptionParser#on is identical to method OptionParser#define,
   except that it returns the parser object +self+.
 
-- \Method \OptionParser#on_head is identical to method \OptionParser#define_head,
+- \Method OptionParser#on_head is identical to method OptionParser#define_head,
   except that it returns the parser object +self+.
 
-- \Method \OptionParser#on_tail is identical to method \OptionParser#define_tail,
+- \Method OptionParser#on_tail is identical to method OptionParser#define_tail,
   except that it returns the parser object +self+.
 
 Though you may never need to call it directly,
 here's the core method for defining an option:
 
-- \Method \OptionParser#make_switch accepts an array of parameters and a block.
+- \Method OptionParser#make_switch accepts an array of parameters and a block.
   See {Parameters for New Options}[optparse/option_params.rdoc].
   This method is unlike others here in that it:
   - Accepts an <em>array of parameters</em>;
@@ -668,7 +668,7 @@ here's the core method for defining an option:
 
 === Parsing
 
-\OptionParser has six instance methods for parsing.
++OptionParser+ has six instance methods for parsing.
 
 Three have names ending with a "bang" (<tt>!</tt>):
 
@@ -699,9 +699,9 @@ Each of these methods:
   (see {Keyword Argument into}[#label-Keyword+Argument+into]).
 - Returns +argv+, possibly with some elements removed.
 
-==== \Method parse!
+==== \Method +parse!+
 
-\Method parse!:
+\Method +parse!+:
 
 - Accepts an optional array of string arguments +argv+;
   if not given, +argv+ defaults to the value of OptionParser#default_argv,
@@ -756,9 +756,9 @@ Processing ended by non-option found when +POSIXLY_CORRECT+ is defined:
   ["--xxx", true]
   Returned: ["input_file.txt", "output_file.txt", "-yyy", "FOO"] (Array)
 
-==== \Method parse
+==== \Method +parse+
 
-\Method parse:
+\Method +parse+:
 
 - Accepts an array of string arguments
   _or_ zero or more string arguments.
@@ -810,25 +810,25 @@ Processing ended by non-option found when +POSIXLY_CORRECT+ is defined:
   ["--xxx", true]
   Returned: ["input_file.txt", "output_file.txt", "-yyy", "FOO"] (Array)
 
-==== \Method order!
+==== \Method +order!+
 
 Calling method OptionParser#order! gives exactly the same result as
 calling method OptionParser#parse! with environment variable
 +POSIXLY_CORRECT+ defined.
 
-==== \Method order
+==== \Method +order+
 
 Calling method OptionParser#order gives exactly the same result as
 calling method OptionParser#parse with environment variable
 +POSIXLY_CORRECT+ defined.
 
-==== \Method permute!
+==== \Method +permute!+
 
 Calling method OptionParser#permute! gives exactly the same result as
 calling method OptionParser#parse! with environment variable
 +POSIXLY_CORRECT+ _not_ defined.
 
-==== \Method permute
+==== \Method +permute+
 
 Calling method OptionParser#permute gives exactly the same result as
 calling method OptionParser#parse with environment variable

data/lib/optparse.rb

@@ -48,7 +48,7 @@
 #
 # == OptionParser
 #
-# === New to \OptionParser?
+# === New to +OptionParser+?
 #
 # See the {Tutorial}[optparse/tutorial.rdoc].
 #
@@ -152,14 +152,14 @@
 # OptionParser supports the ability to coerce command line arguments
 # into objects for us.
 #
-# OptionParser comes with a few ready-to-use kinds of  type
+# OptionParser comes with a few ready-to-use kinds of type
 # coercion. They are:
 #
-# - Date  -- Anything accepted by +Date.parse+
-# - DateTime -- Anything accepted by +DateTime.parse+
-# - Time -- Anything accepted by +Time.httpdate+ or +Time.parse+
-# - URI  -- Anything accepted by +URI.parse+
-# - Shellwords -- Anything accepted by +Shellwords.shellwords+
+# - Date  -- Anything accepted by +Date.parse+ (need to require +optparse/date+)
+# - DateTime -- Anything accepted by +DateTime.parse+ (need to require +optparse/date+)
+# - Time -- Anything accepted by +Time.httpdate+ or +Time.parse+ (need to require +optparse/time+)
+# - URI  -- Anything accepted by +URI.parse+ (need to require +optparse/uri+)
+# - Shellwords -- Anything accepted by +Shellwords.shellwords+ (need to require +optparse/shellwords+)
 # - String -- Any non-empty string
 # - Integer -- Any integer. Will convert octal. (e.g. 124, -3, 040)
 # - Float -- Any float. (e.g. 10, 3.14, -100E+13)
@@ -425,7 +425,7 @@
 # If you have any questions, file a ticket at http://bugs.ruby-lang.org.
 #
 class OptionParser
-  OptionParser::Version = "0.3.1"
+  OptionParser::Version = "0.4.0"
 
   # :stopdoc:
   NoArgument = [NO_ARGUMENT = :NONE, nil].freeze
@@ -1775,7 +1775,16 @@ XXX
   #   # params["bar"] = "x"  # --bar x
   #   # params["zot"] = "z"  # --zot Z
   #
-  def getopts(*args)
+  # Option +symbolize_names+ (boolean) specifies whether returned Hash keys should be Symbols; defaults to +false+ (use Strings).
+  #
+  #   params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option", symbolize_names: true)
+  #   # params[:a] = true   # -a
+  #   # params[:b] = "1"    # -b1
+  #   # params[:foo] = "1"  # --foo
+  #   # params[:bar] = "x"  # --bar x
+  #   # params[:zot] = "z"  # --zot Z
+  #
+  def getopts(*args, symbolize_names: false)
     argv = Array === args.first ? args.shift : default_argv
     single_options, *long_options = *args
 
@@ -1804,14 +1813,14 @@ XXX
     end
 
     parse_in_order(argv, result.method(:[]=))
-    result
+    symbolize_names ? result.transform_keys(&:to_sym) : result
   end
 
   #
   # See #getopts.
   #
-  def self.getopts(*args)
-    new.getopts(*args)
+  def self.getopts(*args, symbolize_names: false)
+    new.getopts(*args, symbolize_names: symbolize_names)
   end
 
   #
@@ -2289,8 +2298,8 @@ XXX
     #   rescue OptionParser::ParseError
     #   end
     #
-    def getopts(*args)
-      options.getopts(self, *args)
+    def getopts(*args, symbolize_names: false)
+      options.getopts(self, *args, symbolize_names: symbolize_names)
     end
 
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optparse
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Nobu Nakada
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies: []
 description: OptionParser is a class for command-line option analysis.
 email:
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: OptionParser is a class for command-line option analysis.