trad-getopt 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 477c3ba1fa3b783d818c18c3a6ded9a1af536059
-  data.tar.gz: 68170ced8654712a2fb5dbe196293c7e5fe961f9
+SHA256:
+  metadata.gz: 38d82a3905311e9231690786b724538d2701406265862291124d9b16cbd7e980
+  data.tar.gz: 7a4e1c88210f75a9363296ff6a62139ef8ca0c6c0c58faeb11d6d1602a264388
 SHA512:
-  metadata.gz: ebf8446087fcbe516a85dbf93f0fd564f7bb2ab562061ee18459e24ff9e1bdbf0f17ce13d9ef3e6de86700e7f2bec844c6ec3d78538283cb643f61afab137b6d
-  data.tar.gz: 5bb3b2bfe2ad16f387874e4ccb8125995fb10bf4e42d443f7a356459668f1e243ed7867f29be5b1ac13a702dee795daccd12bda996c732dd9fe5f3199776eb72
+  metadata.gz: 37acd030e56c0040730efa270001cf71eee98efe293164700a12658ac00988f6042af636f0294c052907b2f9f5d917b324283e33d5187a1065b2ab2f1d9f69b7
+  data.tar.gz: db1ecf6e8daac1c477def3d23f4a519de128da70fd53c720194a1dec7c05a380cc4c0c5a4b0474f440e66a1481283879935806c42a3945e92d59d0572be04bf8

data/Rakefile

@@ -1,12 +1,13 @@
-require 'rake/clean'
+require "rake/testtask"
 require "rubygems/package_task"
+require "rake/clean"
 
-require "./trad-getopt.rb"	# Getopt::VERSION
+require_relative "trad-getopt.rb"	# Getopt::VERSION
 
 task :default => :gem
 
 task :gem
-spec = Gem::Specification.new { |s|
+spec = Gem::Specification.new {|s|
   s.name = "trad-getopt"
   s.version = Getopt::VERSION
   s.author = "NOZAWA Hiromasa"
@@ -22,17 +23,12 @@ spec = Gem::Specification.new { |s|
   ]
   s.require_path = "."
 }
-Gem::PackageTask.new(spec) { |pkg|
+
+Gem::PackageTask.new(spec) {|pkg|
   pkg.need_tar_gz = true
-  pkg.need_tar_bz2 = true
   pkg.need_zip = true
 }
 
-# require "rake/testtask"
-# Rake::TestTask.new { |t|
-#   t.test_files = FileList["test.rb"]
-# }
-desc "do unit test"
-task :test {
-  ruby "-w", "test.rb"
+Rake::TestTask.new {|t|
+  t.test_files = FileList[ "test.rb" ]
 }

data/test.rb

@@ -1,29 +1,40 @@
 require "test/unit"
-require "./trad-getopt.rb"
+require_relative "trad-getopt.rb"
 
 class Test_getopt < Test::Unit::TestCase
 
+  myname = File.basename $0
+  # "test.rb"
+  # "rake_test_loader.rb" via rake test
+
+  # empty
+
   test "empty argv" do
     av = []
     assert_equal nil, getopt(av, "a")
     assert_equal [], av
   end
+
   test "empty opts" do
     av = [ "a" ]
     assert_equal nil, getopt(av, "")
     assert_equal [ "a" ], av
   end
+
   test "nil opts" do
     av = [ "a" ]
     assert_equal nil, getopt(av, nil)
     assert_equal [ "a" ], av
   end
 
+  # non-option
+
   test "stop at non option" do
     av = ["foo"]
     assert_equal nil, getopt(av, "-a")
     assert_equal ["foo"], av
   end
+
   test "unknown error" do
     av = [ "-x" ]
     $stderr = StringIO.new
@@ -31,10 +42,12 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [:unknown_option, "x"], got
-    assert_equal "test.rb: unknown option - x\n", msg
+    assert_equal "#{myname}: unknown option -x\n", msg
     assert_equal [], av
   end
 
+  # short
+
   test "short noarg" do
     av = [ "-a", "foo" ]
     assert_equal ["a"], getopt(av, "a")
@@ -46,6 +59,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal ["a", "foo"], getopt(av, "a:")
     assert_equal [], av
   end
+
   test "short reqarg. error" do
     av = [ "-a" ]
     $stderr = StringIO.new
@@ -53,7 +67,7 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [:argument_required, "a"], got
-    assert_equal "test.rb: option requires an argument - a\n", msg
+    assert_equal "#{myname}: option requires an argument -a\n", msg
     assert_equal [], av
   end
 
@@ -62,16 +76,19 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal ["a", "foo"], getopt(av, "a::")
     assert_equal [], av
   end
+
   test "short optarg, no arg" do
     av = [ "-a", "foo" ]
     assert_equal [ "a", nil ], getopt(av, "a::")
     assert_equal [ "foo" ], av
   end
+
   test "short optarg, no arg, at tail" do
     av = [ "-a" ]
     assert_equal [ "a", nil ], getopt(av, "a::")
     assert_equal [], av
   end
+
   test "short optarg, disabled" do
     av = [ "-a" ]
     $stderr = StringIO.new
@@ -80,7 +97,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [ :argument_required, "a"],  got
   end
 
-  ### concatenation
+  # concatenation
 
   test "concat, noarg + noarg" do
     av = [ "-ab" ]
@@ -88,6 +105,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal ["a"], getopt(av, opts)
     assert_equal ["b"], getopt(av, opts)
   end
+
   test "concat, noarg + reqarg + arg" do
     av = [ "-abfoo" ]
     opts = "ab:"
@@ -95,13 +113,14 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal ["b", "foo"], getopt(av, opts)
   end
 
-  ### special chars
+  # special chars
 
   test "single `-'" do
     av = [ "-" ]
     assert_equal nil, getopt(av, "a")
     assert_equal ["-"], av
   end
+
   test "stop by `--'" do
     av = [ "--" ]
     assert_equal nil, getopt(av, "a")
@@ -120,6 +139,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal ["-"], getopt(av, opts)
     assert_equal [], av
   end
+
   test "hyphen in concat, not as option" do
     av = [ "-a-" ]
     opts = "a"
@@ -129,7 +149,7 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [:unknown_option, "-"],  got
-    assert_equal "test.rb: unknown option - -\n", msg
+    assert_equal "#{myname}: unknown option --\n", msg
     assert_equal [], av
   end
 
@@ -137,6 +157,7 @@ class Test_getopt < Test::Unit::TestCase
     av = [ "-:" ]
     assert_equal [":"],  getopt(av, ":a")
   end
+
   test "colon not as option" do
     av = [ "-:" ]
     $stderr = StringIO.new
@@ -144,11 +165,11 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [:unknown_option, ":"],  got
-    assert_equal "test.rb: unknown option - :\n", msg
+    assert_equal "#{myname}: unknown option -:\n", msg
     assert_equal [], av
   end
 
-  ### keywords
+  # keywords
 
   test "program_name" do
     av = [ "-x" ]
@@ -156,7 +177,7 @@ class Test_getopt < Test::Unit::TestCase
     getopt(av, "a", error_message:true, program_name:"foo")
     msg = $stderr.string
     $stderr = STDERR
-    assert_equal "foo: unknown option - x\n", msg
+    assert_equal "foo: unknown option -x\n", msg
   end
 
   test "error_message" do
@@ -178,6 +199,7 @@ class Test_getopt < Test::Unit::TestCase
       assert_equal "unknown option", ex.message
     end
   end
+
   test "use_exception, Getopt::ArgumentRequiredError" do
     av = [ "-a" ]
     begin
@@ -189,6 +211,8 @@ class Test_getopt < Test::Unit::TestCase
     end
   end
 
+  # permute
+
   test "permute" do
     av = [ "foo", "-a", "bar" ]
     opts = "a"
@@ -196,6 +220,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal nil, getopt(av, opts, permute:true)
     assert_equal ["foo", "bar"], av
   end
+
   test "permute, reqarg" do
     av = [ "foo", "-a", "bar", "baz" ]
     opts = "a:"
@@ -211,6 +236,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [:argument_required, "a"],  getopt(av, opts, allow_empty_optarg:false)
     $stderr = STDERR
   end
+
   test "allow_empty_optarg. long" do
     av = [ "--foo=" ]
     longopts = { "foo" => :required_argument }
@@ -218,6 +244,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [:argument_required, "foo"],  getopt(av, "", longopts, allow_empty_optarg:false)
     $stderr = STDERR
   end
+
   test "allow_empty_optarg. long 2" do
     av = [ "--foo", "" ]
     longopts = { "foo" => :required_argument }
@@ -225,6 +252,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [:argument_required, "foo"],  getopt(av, "", longopts, allow_empty_optarg:false)
     $stderr = STDERR
   end
+
   test "allow_empty_optarg. optional long" do
     av = [ "--foo=" ]
     longopts = { "foo" => :optional_argument }
@@ -233,7 +261,7 @@ class Test_getopt < Test::Unit::TestCase
     $stderr = STDERR
   end
 
-  ### short context
+  # short context
 
   test "short context" do
     av = [ "-a-" ]
@@ -243,6 +271,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [ :unknown_option, "-" ], getopt(av, opts)
     $stderr = STDERR
   end
+
   test "short context, not long option" do
     av = [ "-a-foo" ]
     opts = "afo-"
@@ -253,6 +282,7 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [ "-" ], getopt(av, opts, lopts)
     assert_equal [ "f" ], getopt(av, opts, lopts)
   end
+
   test "short context, not long option, error" do
     av = [ "-a-foo" ]
     opts = "a-"
@@ -266,7 +296,7 @@ class Test_getopt < Test::Unit::TestCase
     $stderr = STDERR
   end
 
-  ### long option
+  # long
 
   test "long option" do
     av = [ "--foo" ]
@@ -300,6 +330,7 @@ class Test_getopt < Test::Unit::TestCase
       assert_equal [ "--foo" ], av
     end
   end
+
   test "wrong long option type, permute" do
     av = [ "a", "--foo", "b" ]
     lopts = {
@@ -323,7 +354,7 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [ :unknown_option, "bar" ], got
-    assert_equal "test.rb: unknown option - bar\n", msg
+    assert_equal "#{myname}: unknown option --bar\n", msg
   end
 
   test "no_argument" do
@@ -333,6 +364,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo" ], getopt(av, "", lopts)
   end
+
   test "no_argument, error" do
     av = [ "--foo=bar" ]
     lopts = {
@@ -343,8 +375,9 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [ :argument_given, "foo" ], got
-    assert_equal "test.rb: option doesn't take an argument - foo\n", msg
+    assert_equal "#{myname}: option doesn't take an argument --foo\n", msg
   end
+
   test "no_argument, exception" do
     av = [ "--foo=bar" ]
     lopts = {
@@ -366,6 +399,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", "bar" ], getopt(av, "", lopts)
   end
+
   test "required_argument, split" do
     av = [ "--foo", "bar" ]
     lopts = {
@@ -373,6 +407,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", "bar" ], getopt(av, "", lopts)
   end
+
   test "required_argument, empty arg" do
     av = [ "--foo=" ]
     lopts = {
@@ -380,6 +415,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", "" ], getopt(av, "", lopts)
   end
+
   test "required_argument, error" do
     av = [ "--foo" ]
     lopts = {
@@ -390,8 +426,9 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [ :argument_required, "foo" ], got
-    assert_equal "test.rb: option requires an argument - foo\n", msg
+    assert_equal "#{myname}: option requires an argument --foo\n", msg
   end
+
   test "required_argument, exception" do
     av = [ "--foo" ]
     lopts = {
@@ -413,6 +450,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", "bar" ], getopt(av, "", lopts)
   end
+
   test "optional_argument, empty arg" do
     av = [ "--foo=" ]
     lopts = {
@@ -420,6 +458,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", "" ], getopt(av, "", lopts)
   end
+
   test "optional_argument, no arg" do
     av = [ "--foo", "bar" ]
     lopts = {
@@ -427,6 +466,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo", nil ], getopt(av, "", lopts)
   end
+
   test "optional_argument, no arg, at tail" do
     av = [ "--foo" ]
     lopts = {
@@ -435,6 +475,8 @@ class Test_getopt < Test::Unit::TestCase
     assert_equal [ "foo", nil ], getopt(av, "", lopts)
   end
 
+  # abbrev
+
   test "unique abbrev, no candidates" do
     av = [ "--fo" ]
     lopts = {
@@ -442,6 +484,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo" ], getopt(av, "", lopts)
   end
+
   test "unique abbrev" do
     av = [ "--foo-" ]
     lopts = {
@@ -450,6 +493,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo-bar" ], getopt(av, "", lopts)
   end
+
   test "abbrev, exact match" do
     av = [ "--foo" ]
     lopts = {
@@ -458,6 +502,7 @@ class Test_getopt < Test::Unit::TestCase
     }
     assert_equal [ "foo" ], getopt(av, "", lopts)
   end
+
   test "abbrev, ambiguous" do
     av = [ "--foo" ]
     lopts = {
@@ -469,8 +514,9 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [ :ambiguous_option, "foo", ["foo1", "foo2"] ], got
-    assert_equal "test.rb: ambiguos option (--foo1 --foo2) - foo\n", msg
+    assert_equal "#{myname}: ambiguos option (--foo1 --foo2) --foo\n", msg
   end
+
   test "abbrev, ambiguous, exception" do
     av = [ "--foo" ]
     lopts = {
@@ -496,6 +542,6 @@ class Test_getopt < Test::Unit::TestCase
     msg = $stderr.string
     $stderr = STDERR
     assert_equal [ :unknown_option, "fo" ], got
-    assert_equal "test.rb: unknown option - fo\n", msg
+    assert_equal "#{myname}: unknown option --fo\n", msg
   end
 end

data/trad-getopt.rb

@@ -1,7 +1,8 @@
 # rather traditional getopt for Ruby
 
 module Getopt
-  VERSION = "1.1.0"
+
+  VERSION = "1.2.1"
 
   class GetoptError < StandardError
     def initialize option, message
@@ -63,7 +64,7 @@ def getopt(argv, opts, longopts = nil,
   end
 
   opts ||= ""
-  program_name ||= $0
+  program_name ||= File.basename $0
 
   arg = argv.shift
   return nil if arg.nil?
@@ -141,7 +142,7 @@ def getopt(argv, opts, longopts = nil,
 
   optopt = arg[1]
   arg = arg[2 .. -1]
-  pos = opts.split("").find_index(optopt)
+  pos = opts.index optopt
   if pos.nil? || (optopt == ":" && pos != 0)
     argv.unshift "-#{arg}" unless arg.empty?
     # keep short option context on error
@@ -173,7 +174,15 @@ def getopt(argv, opts, longopts = nil,
 
 rescue Getopt::GetoptError => ex
   raise if use_exception
-  warn "#{program_name}: #{ex.message} - #{ex.option}" if error_message
+
+  if error_message
+    if ex.option.length == 1
+      warn "#{program_name}: #{ex.message} -#{ex.option}"
+    else
+      warn "#{program_name}: #{ex.message} --#{ex.option}"
+    end
+  end
+
   case ex
   when Getopt::UnknownOptionError
     return [ :unknown_option, ex.option ]
@@ -187,62 +196,3 @@ rescue Getopt::GetoptError => ex
 end
 
 Kernel.define_singleton_method "getopt", method(:getopt)
-
-if __FILE__ == $0
-
-def usage
-  puts <<EOD
-usage: #{$0} [-hVp] [-Llongopt] opts ...
-  -h    print this
-  -V    print revision
-  -L    define long option like -Lfoo, -Lfoo: or -Lfoo::
-  -p    permute
-  opts  define short options
-EOD
-end
-
-longopts = {}
-permute = false
-
-while op = getopt(ARGV, "hL:pV")
-  op, oparg = op
-  exit 1 if op.is_a? Symbol
-  case op
-  when "h"
-    usage
-    exit
-  when "V"
-    puts "trad-getopt rev.#{Getopt::VERSION}"
-    exit
-  when "p"
-    permute = true
-  when "L"
-    if oparg[-1] == ":"
-      if oparg[-2] == ":"
-        v = :optional_argument
-        oparg[-2] = ""
-      else
-        v = :required_argument
-      end
-      oparg[-1] = ""
-    else
-      v = :no_argument
-    end
-    longopts[oparg] = v
-  else
-    break
-  end
-end
-
-opts = ARGV.shift
-unless opts
-  puts "argument required"
-  exit 1
-end
-
-while op = getopt(ARGV, opts, longopts, permute:permute)
-  puts "option #{op} ARGV #{ARGV}"
-end
-puts "ARGV #{ARGV}"
-
-end

data/trad-getopt.txt

@@ -123,7 +123,7 @@ longopts にはキーをオプション名、値をシンボルとするハッ
 
 - program_name => nil
   エラーメッセージに出すプログラム名文字列を指定する。デフォルトは nil
-  で $0 を使う。
+  で $0 のベース名を使う。
 
 - stop_by_double_hyphen => true
   偽にすると `--' を特別扱いしなくなり、`-' を普通のショートオプション

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trad-getopt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - NOZAWA Hiromasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2019-04-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -40,8 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: rather traditional getopt()