getopt 1.4.2 → 1.6.0

data/spec/getopt_std_spec.rb

@@ -0,0 +1,122 @@
+###################################################################
+# test_getopt_std.rb
+#
+# Test suite for the Getopt::Std class. You should run this test
+# via the 'rake test' task.
+###################################################################
+require 'rspec'
+require 'getopt/std'
+include Getopt
+
+RSpec.describe Getopt::Std do
+  example "version" do
+    expect(Std::VERSION).to eq('1.6.0')
+    expect(Std::VERSION).to be_frozen
+  end
+
+  example "getopts basic functionality" do
+    expect(Std).to respond_to(:getopts)
+    expect{ Std.getopts("ID") }.not_to raise_error
+    expect(Std.getopts("ID")).to be_kind_of(Hash)
+  end
+
+  example "getopts with separated switches" do
+    ARGV.push("-I", "-D")
+    expect(Std.getopts("ID")).to eq({"I"=>true, "D"=>true})
+  end
+
+  # Inspired by RF bug #23477
+  example "getopts with arguments that match switch are ok" do
+    ARGV.push("-d", "d")
+    expect(Std.getopts("d:")).to eq({"d" => "d"})
+
+    ARGV.push("-d", "ad")
+    expect(Std.getopts("d:")).to eq({"d" => "ad"})
+
+    ARGV.push("-a", "ad")
+    expect(Std.getopts("d:a:")).to eq({"a" => "ad"})
+
+    ARGV.push("-a", "da")
+    expect(Std.getopts("d:a:")).to eq({"a" => "da"})
+
+    ARGV.push("-a", "d")
+    expect(Std.getopts("d:a:")).to eq({"a" => "d"})
+
+    ARGV.push("-a", "dad")
+    expect(Std.getopts("d:a:")).to eq({"a" => "dad"})
+
+    ARGV.push("-d", "d", "-a", "a")
+    expect(Std.getopts("d:a:")).to eq({"d" => "d", "a" => "a"})
+  end
+
+  example "getopts with joined switches" do
+    ARGV.push("-ID")
+    expect(Std.getopts("ID")).to eq({"I"=>true, "D"=>true})
+  end
+
+  example "getopts with separated switches and mandatory argument" do
+    ARGV.push("-o", "hello", "-I", "-D")
+    expect(Std.getopts("o:ID")).to eq({"o"=>"hello", "I"=>true, "D"=>true})
+  end
+
+  example "getopts with joined switches and mandatory argument" do
+    ARGV.push("-IDo", "hello")
+    expect( Std.getopts("o:ID")).to eq({"o"=>"hello", "I"=>true, "D"=>true})
+  end
+
+  example "getopts with no arguments" do
+    expect{ Std.getopts("ID") }.not_to raise_error
+    expect(Std.getopts("ID")).to eq({})
+    expect(Std.getopts("ID")["I"]).to be_nil
+    expect(Std.getopts("ID")["D"]).to be_nil
+  end
+
+  # If a switch that accepts an argument appears more than once, the values
+  # are rolled into an array.
+  example "getopts with switch repeated" do
+    ARGV.push("-I", "-I", "-o", "hello", "-o", "world")
+    expect( Std.getopts("o:ID")).to eq({"o" => ["hello","world"], "I"=>true})
+  end
+
+  # EXPECTED ERRORS
+
+  example "getopts raises expected errors when passing a switch to another switch" do
+    ARGV.push("-d", "-d")
+    expect{ Std.getopts("d:a:") }.to raise_error(Getopt::Std::Error)
+
+    ARGV.push("-d", "-a")
+    expect{ Std.getopts("d:a:") }.to raise_error(Getopt::Std::Error)
+
+    ARGV.push("-a", "-d")
+    expect{ Std.getopts("d:a:") }.to raise_error(Getopt::Std::Error)
+
+    ARGV.push("-d", "-d")
+    expect{ Std.getopts("d:a:") }.to raise_error(Getopt::Std::Error, "cannot use switch '-d' as argument to another switch")
+  end
+
+  example "getopts raises expected errors if argument is missing" do
+    ARGV.push("-ID")
+    expect{ Std.getopts("I:D") }.to raise_error(Std::Error)
+
+    ARGV.push("-ID")
+    expect{ Std.getopts("ID:") }.to raise_error(Std::Error)
+  end
+
+  example "getopts raises expected errors if there are extra arguments" do
+    ARGV.push("-I", "-D", "-X")
+    expect{ Std.getopts("ID") }.to raise_error(Std::Error)
+
+    ARGV.push("-IDX")
+    expect{ Std.getopts("ID") }.to raise_error(Std::Error, "invalid option 'X'")
+  end
+
+  example "getopts raises expected errors with invalid or no arguments" do
+    expect{ Std.getopts }.to raise_error(ArgumentError)
+    expect{ Std.getopts(0) }.to raise_error(NoMethodError)
+    expect{ Std.getopts(nil) }.to raise_error(NoMethodError)
+  end
+
+  after do
+    ARGV.clear
+  end
+end

metadata

@@ -1,29 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: getopt
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 description: |2
       The getopt library provides two different command line option parsers.
       They are meant as easier and more convenient replacements for the
@@ -32,27 +73,37 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
-- MANIFEST
-- README
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
 - Rakefile
+- certs/djberg96_pub.pem
 - examples/example_long.rb
 - examples/example_std.rb
 - getopt.gemspec
+- lib/getopt-long.rb
+- lib/getopt-std.rb
+- lib/getopt.rb
 - lib/getopt/long.rb
 - lib/getopt/std.rb
-- test/test_getopt_long.rb
-- test/test_getopt_std.rb
+- lib/getopt/version.rb
+- spec/getopt_long_spec.rb
+- spec/getopt_std_spec.rb
 homepage: https://github.com/djberg96/getopt
 licenses:
-- Artistic 2.0
-metadata: {}
-post_install_message: 
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/djberg96/getopt
+  bug_tracker_uri: https://github.com/djberg96/getopt/issues
+  changelog_uri: https://github.com/djberg96/getopt/blob/master/CHANGES
+  documentation_uri: https://github.com/djberg96/getopt/wiki
+  source_code_uri: https://github.com/djberg96/getopt
+  wiki_uri: https://github.com/djberg96/getopt/wiki
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,11 +118,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Getopt::Std and Getopt::Long option parsers for Ruby
 test_files:
-- test/test_getopt_long.rb
-- test/test_getopt_std.rb
+- spec/getopt_std_spec.rb
+- spec/getopt_long_spec.rb

data/README

@@ -1,191 +0,0 @@
-= Description
-  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
-   
-= 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
-  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)
-
-  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.
-
-  In the event that a switch that 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 90% 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
-  Artistic 2.0
-
-= Copyright
-  (C) 2005-2014, Daniel J. Berger
-  All Rights Reserved
-
-= Author
-  Daniel J. Berger