getopt 1.5.1 → 1.6.0

data/getopt.gemspec

@@ -2,20 +2,18 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'getopt'
-  spec.version    = '1.5.1'
+  spec.version    = '1.6.0'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/getopt'
   spec.summary    = 'Getopt::Std and Getopt::Long option parsers for Ruby'
-  spec.test_files = Dir['test/*.rb']
+  spec.test_files = Dir['spec/*_spec.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files  = ['README.rdoc', 'CHANGES.rdoc', 'MANIFEST.rdoc']
-   
-  spec.add_development_dependency('test-unit', '>= 2.5.0')
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/getopt',

data/lib/getopt/version.rb

@@ -1,6 +1,6 @@
 module Getopt
   module Version
     # The version of the getopt library
-    VERSION = '1.5.1'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

data/spec/getopt_long_spec.rb

@@ -0,0 +1,279 @@
+#####################################################################
+# getopt_long_spec.rb
+#
+# Specs for the getopt-long library. You should run this test
+# via the 'rake spec:getopt_long' rake task.
+#####################################################################
+require 'rspec'
+require 'getopt/long'
+
+RSpec.describe Getopt::Long do
+  before do
+    @opts = nil
+  end
+
+  example "version" do
+    expect(Getopt::Long::VERSION).to eq('1.6.0')
+    expect(Getopt::Long::VERSION).to be_frozen
+  end
+
+  example "constants" do
+    expect(Getopt::BOOLEAN).not_to be_nil
+    expect(Getopt::OPTIONAL).not_to be_nil
+    expect(Getopt::REQUIRED).not_to be_nil
+    expect(Getopt::INCREMENT).not_to be_nil
+  end
+
+  example "getopts long basic functionality" do
+    expect(Getopt::Long).to respond_to(:getopts)
+
+    expect{ Getopt::Long.getopts(["--test"],["--help"],["--foo"]) }.not_to raise_error
+    expect{ Getopt::Long.getopts(["--test", "-x"],["--help", "-y"],["--foo", "-z"]) }.not_to raise_error
+
+    expect{
+      Getopt::Long.getopts(
+        ["--test", "-x", Getopt::BOOLEAN],
+        ["--help", "-y", Getopt::REQUIRED],
+        ["--foo",  "-z", Getopt::OPTIONAL],
+        ["--more", "-m", Getopt::INCREMENT]
+      )
+    }.not_to raise_error
+
+    expect(Getopt::Long.getopts("--test")).to be_kind_of(Hash)
+  end
+
+  example "getopts long using equals sign works as expected" do
+    ARGV.push("--foo=hello","-b","world")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--foo", "-f", Getopt::REQUIRED],
+        ["--bar", "-b", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts["foo"]).to eq("hello")
+    expect(@opts["f"]).to eq("hello")
+    expect(@opts["bar"]).to eq("world")
+    expect(@opts["b"]).to eq("world")
+  end
+
+  example "getopts long with embedded hyphens works as expected" do
+    ARGV.push('--foo-bar', 'hello', '--test1-test2-test3', 'world')
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ['--foo-bar', '-f', Getopt::REQUIRED],
+        ['--test1-test2-test3', '-t', Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts['foo-bar']).to eq('hello')
+    expect(@opts['f']).to eq('hello')
+    expect(@opts['test1-test2-test3']).to eq('world')
+    expect(@opts['t']).to eq('world')
+  end
+
+  example "getopts long embedded hyphens using equals sign works as expected" do
+    ARGV.push('--foo-bar=hello', '--test1-test2-test3=world')
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ['--foo-bar', '-f', Getopt::REQUIRED],
+        ['--test1-test2-test3', '-t', Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts['foo-bar']).to eq('hello')
+    expect(@opts['f']).to eq('hello')
+    expect(@opts['test1-test2-test3']).to eq('world')
+    expect(@opts['t']).to eq('world')
+  end
+
+  example "getopts long with short switch squished works as expected" do
+    ARGV.push("-f", "hello", "-bworld")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--foo", "-f", Getopt::REQUIRED],
+        ["--bar", "-b", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts["f"]).to eq("hello")
+    expect(@opts["b"]).to eq("world")
+  end
+
+  example "getopts long increment type works as expected" do
+    ARGV.push("-m","-m")
+
+    expect{ @opts = Getopt::Long.getopts(["--more", "-m", Getopt::INCREMENT]) }.not_to raise_error
+
+    expect(@opts["more"]).to eq(2)
+    expect(@opts["m"]).to eq(2)
+  end
+
+  example "switches are set as expected" do
+    ARGV.push("--verbose","--test","--foo")
+    expect{ @opts = Getopt::Long.getopts("--verbose --test --foo") }.not_to raise_error
+    expect( @opts.has_key?("verbose")).to eq(true)
+    expect( @opts.has_key?("test")).to eq(true)
+    expect( @opts.has_key?("foo")).to eq(true)
+  end
+
+  example "short switch synonyms work as expected" do
+    ARGV.push("--verbose","--test","--foo")
+    expect{ @opts = Getopt::Long.getopts("--verbose --test --foo") }.not_to raise_error
+    expect(@opts.has_key?("v")).to eq(true)
+    expect(@opts.has_key?("t")).to eq(true)
+    expect(@opts.has_key?("f")).to eq(true)
+  end
+
+  example "short_switch_synonyms_with_explicit_types" do
+    ARGV.push("--verbose", "--test", "hello", "--foo")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--verbose", Getopt::BOOLEAN],
+        ["--test", Getopt::REQUIRED],
+        ["--foo", Getopt::BOOLEAN]
+      )
+    }.not_to raise_error
+
+    expect(@opts.has_key?("v")).to be(true)
+    expect(@opts.has_key?("t")).to be(true)
+    expect(@opts.has_key?("f")).to be(true)
+  end
+
+  example "switches with required arguments" do
+    ARGV.push("--foo","1","--bar","hello")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--foo", "-f", Getopt::REQUIRED],
+        ["--bar", "-b", Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"foo"=>"1", "bar"=>"hello", "f"=>"1", "b"=>"hello"})
+  end
+
+  example "compressed switches work as expected" do
+    ARGV.push("-fb")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--foo", "-f", Getopt::BOOLEAN],
+        ["--bar", "-b", Getopt::BOOLEAN]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"foo"=>true, "f"=>true, "b"=>true, "bar"=>true})
+  end
+
+  example "compress switches with required argument works as expected" do
+    ARGV.push("-xf", "foo.txt")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"x"=>true, "expand"=>true, "f"=>"foo.txt", "file"=>"foo.txt"})
+  end
+
+  example "compress switches with argument that is compressed works as expected" do
+    ARGV.push("-xffoo.txt")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"x"=>true, "expand"=>true, "f"=>"foo.txt", "file"=>"foo.txt"})
+  end
+
+  example "compress switches with optional argument not defined works as expected" do
+    ARGV.push("-xf")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"x"=>true, "expand"=>true, "f"=>nil, "file"=>nil})
+  end
+
+  example "compress switches with optional argument works as expected" do
+    ARGV.push("-xf", "boo.txt")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"x"=>true, "expand"=>true, "f"=>"boo.txt", "file"=>"boo.txt"})
+  end
+
+  example "compress switches with compressed optional argument works as expected" do
+    ARGV.push("-xfboo.txt")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({"x"=>true, "expand"=>true, "f"=>"boo.txt", "file"=>"boo.txt"})
+  end
+
+  example "compressed_short_and_long_mixed" do
+    ARGV.push("-xb", "--file", "boo.txt", "-v")
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--expand", "-x", Getopt::BOOLEAN],
+        ["--verbose", "-v", Getopt::BOOLEAN],
+        ["--file", "-f", Getopt::REQUIRED],
+        ["--bar", "-b", Getopt::OPTIONAL]
+      )
+    }.not_to raise_error
+
+    expect(@opts).to eq({
+      "x"=>true, "expand"=>true,
+      "v"=>true, "verbose"=>true,
+      "f"=>"boo.txt", "file"=>"boo.txt",
+      "b"=>nil, "bar"=>nil
+    })
+  end
+
+  example "multiple similar long switches with no short switches works as expected" do
+    ARGV.push('--to','1','--too','2','--tooo','3')
+
+    expect{
+      @opts = Getopt::Long.getopts(
+        ["--to",  Getopt::REQUIRED],
+        ["--too", Getopt::REQUIRED],
+        ["--tooo", Getopt::REQUIRED]
+      )
+    }.not_to raise_error
+
+    expect(@opts['to']).to eq('1')
+    expect(@opts['too']).to eq('2')
+    expect(@opts['tooo']).to eq('3')
+  end
+
+  after do
+    @opts = nil
+    ARGV.clear
+  end
+end

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,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: getopt
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,22 +35,36 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+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
@@ -59,33 +73,26 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
-- CHANGES.rdoc
-- MANIFEST.rdoc
+extra_rdoc_files: []
 files:
+- CHANGES.md
+- Gemfile
 - LICENSE
-- test
-- test/test_getopt_long.rb
-- test/test_getopt_std.rb
+- MANIFEST.md
+- README.md
 - Rakefile
-- certs
 - certs/djberg96_pub.pem
-- examples
-- examples/example_std.rb
 - examples/example_long.rb
-- lib
+- examples/example_std.rb
+- getopt.gemspec
+- lib/getopt-long.rb
+- lib/getopt-std.rb
 - lib/getopt.rb
-- lib/getopt
 - lib/getopt/long.rb
 - lib/getopt/std.rb
 - lib/getopt/version.rb
-- lib/getopt-long.rb
-- lib/getopt-std.rb
-- CHANGES.rdoc
-- MANIFEST.rdoc
-- getopt.gemspec
-- README.rdoc
+- spec/getopt_long_spec.rb
+- spec/getopt_std_spec.rb
 homepage: https://github.com/djberg96/getopt
 licenses:
 - Apache-2.0
@@ -96,7 +103,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,17 +111,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-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