optimist 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 416ba2a0bcc410fa9e8a746b73335cff35b550634d4f26a7c1c17547db2ba61b
-  data.tar.gz: 1a2b555e3a7ec6eef5af0976d660454151888052e9492695ac5d932090e858ee
+  metadata.gz: 3d29d64e512655a994c2f2665c6b0be52194f64624a442509eaf49373efe0d23
+  data.tar.gz: c48da179e2d0dfa451e5eb2efd4ae62efafb6148dfdc18342c8c78f1faceb5b9
 SHA512:
-  metadata.gz: 0ce87d7db57a7840f84cb9be3c0aad95e9dd227becbf873309ea7256175be969b937742ca781b0f5345e71ca73a6cc508e5d1e0953d03391fb44e5efa43e681c
-  data.tar.gz: a760065b4b8e4477e9fd90644b92e7b802eff249cc6f742d83cb8f891e1d35b9cbfbc9380a2fb6fc6f75f69cd2a1741336ee900a61b6e4abae23d82005b75b06
+  metadata.gz: be8c02eb87bc55221dfb42dfeb347026651a945617fbfda12892e4960cba9762a02a224927f05c54a7a186778f646c5435508ea9e9d7a7c19573dcaa2b3869e1
+  data.tar.gz: fcb56bc996d0016e9c521f2d696cdc90338579060e745656c4e5cd0493390d94f57ecfe2d94864fb7b67b0c9f652dd2a29502d23af8ab182acd4a26486fc39a9

data/.github/workflows/ci.yaml

@@ -13,15 +13,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version:
-        - '2.4'
-        - '2.5'
-        - '2.6'
         - '2.7'
         - '3.0'
         - '3.1'
         - '3.2'
         - '3.3'
-        - jruby-9.3
+        - '3.4'
+        - jruby-9.4
         - ruby-head
         - jruby-head
     steps:
@@ -33,4 +31,3 @@ jobs:
         bundler-cache: true
     - name: Run tests
       run: bundle exec rake
-      continue-on-error: ${{ matrix.ruby-version == 'ruby-head' }}

data/CHANGELOG.md

@@ -4,6 +4,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.2.1] - 2025-03-19
+### Added
+- Added testing of jruby-9.4 ([#172](https://github.com/ManageIQ/optimist/pull/172) - thanks @Fryguy)
+- Added testing of Ruby 3.4 ([#173](https://github.com/ManageIQ/optimist/pull/173) - thanks @Fryguy)
+
+### Removed
+- Drop testing of Ruby <2.7, jruby-9.3 ([#172](https://github.com/ManageIQ/optimist/pull/172) - thanks @Fryguy)
+
+### Fixed
+- Fix issue where negative boolean flags were output incorrectly ([#179](https://github.com/ManageIQ/optimist/pull/179) - thanks @Fryguy)
+- Fix issues with frozen strings which fail jruby-head (JRuby 10) ([#180](https://github.com/ManageIQ/optimist/pull/180) - thanks @Fryguy)
+
 ## [3.2.0] - 2024-11-11
 ### Added
 - Align the short and long forms into their own columns in the help output ([#145](https://github.com/ManageIQ/optimist/pull/145) - thanks @akhoury6)
@@ -222,7 +234,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release.
 
-[Unreleased]: https://github.com/ManageIQ/optimist/compare/v3.2.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/optimist/compare/v3.2.1...HEAD
+[3.2.1]: https://github.com/ManageIQ/optimist/compare/v3.2.0...v3.2.1
 [3.2.0]: https://github.com/ManageIQ/optimist/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/ManageIQ/optimist/compare/v3.0.1...v3.1.0
 [3.0.1]: https://github.com/ManageIQ/optimist/compare/v3.0.0...v3.0.1

data/examples/a_basic_example.rb

@@ -7,4 +7,3 @@ opts = Optimist::options do
   opt :num_limbs, "Number of limbs", :default => 4  # integer --num-limbs <i>, default to 4
 end
 p opts
-

data/examples/alt_names.rb

@@ -6,7 +6,7 @@ opts = Optimist::options do
   #   you can specify 'short:' as a string/symbol or an array of strings/symbols
   # 'alt:' adds additional long-opt choices (over the original name or the long: name)
   #   you can specify 'alt:' as a string/symbol or an array of strings/symbols.
-  # 
+  #
   opt :concat, 'concatenate flag', short: ['-C', 'A'], alt: ['cat', '--append']
   opt :array_len, 'set Array length', long: 'size', alt: 'length', type: Integer
 end

data/examples/boolean.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist'
+
+opts = Optimist::options do
+  opt :default_false, "Boolean flag with false default", :default => false, :short => "f"
+  opt :default_true, "Boolean flag with true default", :default => true, :short => "t"
+end
+
+puts opts

data/examples/types_custom.rb

@@ -27,7 +27,7 @@ class ZipCodeOption < Optimist::Option
 end
 
 opts = Optimist::options do
-  opt :zipcode, "United states postal code", :type => :zipcode 
+  opt :zipcode, "United states postal code", :type => :zipcode
 end
 
 p opts[:zipcode]

data/lib/optimist.rb

@@ -8,7 +8,7 @@
 require 'date'
 
 module Optimist
-VERSION = "3.2.0"
+VERSION = "3.2.1"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Optimist::options entry.
@@ -208,7 +208,7 @@ class Parser
     o = Option.create(name, desc, opts)
 
     raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? o.name
-    
+
     o.long.names.each do |lng|
       raise ArgumentError, "long option name #{lng.inspect} is already taken; please specify a (different) :long/:alt" if @long[lng]
       @long[lng] = o.name
@@ -754,7 +754,7 @@ class ShortNames
              end
 
       if sopt =~ INVALID_ARG_REGEX
-        raise ArgumentError, "short option name '#{sopt}' can't be a number or a dash" 
+        raise ArgumentError, "short option name '#{sopt}' can't be a number or a dash"
       end
       @chars << sopt
     end
@@ -820,7 +820,7 @@ class Option
     optionlist = []
     optionlist.concat(short.chars.map { |o| "-#{o}" })
     optionlist.concat(long.names.map { |o| "--#{o}" })
-    optionlist.compact.join(', ') + type_format + (flag? && default ? ", --no-#{long}" : "")
+    optionlist.compact.join(', ') + type_format + (flag? && default ? ", --no-#{long.long}" : "")
   end
 
   ## Format the educate-line description including the default and permitted value(s)
@@ -880,7 +880,7 @@ class Option
     end
     true
   end
-  
+
   # incoming values from the command-line should be strings, so we should
   # stringify any permitted types as the basis of comparison.
   def permitted_value?(val)

data/optimist.gemspec

@@ -30,7 +30,7 @@ specify."
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "chronic"
-  spec.add_development_dependency "manageiq-style"
-  spec.add_development_dependency "minitest",      "~> 5.4.3"
-  spec.add_development_dependency "rake",          ">= 10.0"
+  spec.add_development_dependency "manageiq-style", ">= 1.5.3"
+  spec.add_development_dependency "minitest",       "~> 5.25"
+  spec.add_development_dependency "rake",           ">= 10.0"
 end

data/renovate.json

@@ -1,6 +1,5 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:recommended"
-  ]
+  "inheritConfig": true,
+  "inheritConfigRepoName": "manageiq/renovate-config"
 }

data/test/optimist/alt_names_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
 
@@ -12,7 +12,7 @@ module Optimist
       assert_raises(Optimist::HelpNeeded) do
         @p.parse(%w(--help))
       end
-      sio = StringIO.new "w"
+      sio = StringIO.new
       @p.educate sio
       sio.string
     end
@@ -67,7 +67,7 @@ module Optimist
         opts = @p.parse(a)
         assert opts.goodarg0
       end
-      
+
       [%w[--newone], %w[-n], %w[--one]].each  do |a|
         opts = @p.parse(a)
         assert opts.goodarg1
@@ -91,7 +91,7 @@ module Optimist
         assert_raises_errmatch(ArgumentError, /invalid long option name/) { @p.opt "badarg", "desc", :alt => altitem }
       end
     end
-    
+
     def test_altshort_help
       @p.opt :cat, 'cat', short: ['c','C','a','T']
       outstring = get_help_string
@@ -99,7 +99,7 @@ module Optimist
       assert_match(/-c, -C, -a, -T, --cat/, outstring)
     end
 
-    
+
     def test_altlong_help
       @p.opt :cat, 'a cat', alt: :feline
       @p.opt :dog, 'a dog', alt: ['Pooch', :canine]
@@ -113,56 +113,56 @@ module Optimist
       # expect long-opt to shadow the actual name
       assert_match(/^\s*--fig, --peach, --pear, --apple/, outstring)
       assert_match(/^\s*-g, --gemuse, --groente/, outstring)
-      
+
     end
 
     def test_alt_duplicates
       # alt duplicates named option
-      err_regex = /long option name "cat" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "cat" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :cat, 'desc', :alt => :cat
       }
-      # alt duplicates :long 
-      err_regex = /long option name "feline" is already taken; please specify a \(different\) :long\/:alt/ 
+      # alt duplicates :long
+      err_regex = /long option name "feline" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :cat, 'desc', :long => :feline, :alt => [:feline]
       }
       # alt duplicates itself
-      err_regex = /long option name "aaa" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "aaa" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :abc, 'desc', :alt => [:aaa, :aaa]
       }
     end
-    
+
     def test_altlong_collisions
       @p.opt :fat, 'desc'
       @p.opt :raton, 'desc', :long => :rat
       @p.opt :bat, 'desc', :alt => [:baton, :twirl]
 
       # :alt collision with named option
-      err_regex = /long option name "fat" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "fat" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :cat, 'desc', :alt => :fat
       }
 
       # :alt collision with :long option
-      err_regex = /long option name "cat" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "cat" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :cat, 'desc', :alt => :rat
       }
 
       # :named option collision with existing :alt option
-      err_regex = /long option name "baton" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "baton" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :baton, 'desc'
       }
 
       # :long option collision with existing :alt option
-      err_regex = /long option name "twirl" is already taken; please specify a \(different\) :long\/:alt/ 
+      err_regex = /long option name "twirl" is already taken; please specify a \(different\) :long\/:alt/
       assert_raises_errmatch(ArgumentError, err_regex) {
         @p.opt :whirl, 'desc', :long => 'twirl'
       }
-      
+
     end
   end
 end

data/test/optimist/command_line_error_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
   class CommandlineErrorTest < ::Minitest::Test

data/test/optimist/help_needed_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
   class HelpNeededTest < ::Minitest::Test

data/test/optimist/parser_constraint_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
 
@@ -138,4 +138,4 @@ class ParserConstraintTest < ::Minitest::Test
     assert_raises_errmatch(CommandlineError, err_regex) { @p.parse %w(--two) }
   end
 end
-end
+end

data/test/optimist/parser_educate_test.rb

@@ -1,5 +1,5 @@
 require 'stringio'
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
   class ParserEduateTest < ::Minitest::Test
@@ -40,7 +40,7 @@ module Optimist
 # pulled out of optimist_test for now
   def test_help_has_default_banner
     @p = Parser.new
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -49,7 +49,7 @@ module Optimist
 
     @p = Parser.new
     @p.version "my version"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -58,7 +58,7 @@ module Optimist
 
     @p = Parser.new
     @p.banner "my own banner"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -67,7 +67,7 @@ module Optimist
 
     @p = Parser.new
     @p.text "my own text banner"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -78,7 +78,7 @@ module Optimist
   def test_help_has_optional_usage
     @p = Parser.new
     @p.usage "OPTIONS FILES"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -89,7 +89,7 @@ module Optimist
   def test_help_has_optional_synopsis
     @p = Parser.new
     @p.synopsis "About this program"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -101,7 +101,7 @@ module Optimist
     @p = Parser.new
     @p.usage "OPTIONS FILES"
     @p.synopsis "About this program"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.parse []
     @p.educate sio
     help = sio.string.split "\n"
@@ -113,7 +113,7 @@ module Optimist
   def test_help_preserves_positions
     parser.opt :zzz, "zzz"
     parser.opt :aaa, "aaa"
-    sio = StringIO.new "w"
+    sio = StringIO.new
     parser.educate sio
 
     help = sio.string.split "\n"
@@ -132,7 +132,7 @@ module Optimist
     parser.opt :arg8, 'arg', :type => :ios
     parser.opt :arg9, 'arg', :type => :date
     parser.opt :arg10, 'arg', :type => :dates
-    sio = StringIO.new "w"
+    sio = StringIO.new
     parser.educate sio
 
     help = sio.string.split "\n"
@@ -148,10 +148,22 @@ module Optimist
     assert help[10] =~ /<date\+>/
   end
 
+  def test_help_handles_boolean_flags
+    parser.opt :default_false, 'default-false', :default => false
+    parser.opt :default_true, 'default-true', :default => true
+    sio = StringIO.new
+    parser.educate sio
+
+    help = sio.string.split "\n"
+    assert help[1] =~ /--default-false/
+    assert help[2] =~ /--default-true, --no-default-true/
+    assert help[2] =~ /\(default: true\)/
+  end
+
   def test_help_has_grammatical_default_text
     parser.opt :arg1, 'description with period.', :default => 'hello'
     parser.opt :arg2, 'description without period', :default => 'world'
-    sio = StringIO.new 'w'
+    sio = StringIO.new
     parser.educate sio
 
     help = sio.string.split "\n"
@@ -162,7 +174,7 @@ module Optimist
   def test_help_has_grammatical_permitted_text
     parser.opt :arg1, 'description with period.', :type => :strings, :permitted => %w(foo bar)
     parser.opt :arg2, 'description without period', :type => :strings, :permitted => %w(foo bar)
-    sio = StringIO.new 'w'
+    sio = StringIO.new
     parser.educate sio
 
     help = sio.string.split "\n"
@@ -173,7 +185,7 @@ module Optimist
   def test_help_with_permitted_range
     parser.opt :rating, 'rating', permitted: 1..5
     parser.opt :hex, 'hexadecimal', permitted: /^[0-9a-f]/i
-    sio = StringIO.new 'w'
+    sio = StringIO.new
     parser.educate sio
     help = sio.string.split "\n"
     assert_match %r{rating \(permitted: 1\.\.5\)}, help[1]

data/test/optimist/parser_opt_test.rb

@@ -1,5 +1,5 @@
 require 'stringio'
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
 

data/test/optimist/parser_parse_test.rb

@@ -1,5 +1,5 @@
 require 'stringio'
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
   class ParserParseTest < ::Minitest::Test

data/test/optimist/parser_permitted_test.rb

@@ -1,5 +1,5 @@
 require 'stringio'
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
 
@@ -38,8 +38,8 @@ class ParserPermittedTest < ::Minitest::Test
   end
   def test_permitted_with_symbol_array
     @p.opt 'fiz', 'desc', :type => 'string', :permitted => %i[dog cat]
-    @p.parse(%w(--fiz dog)) 
-    @p.parse(%w(--fiz cat)) 
+    @p.parse(%w(--fiz dog))
+    @p.parse(%w(--fiz cat))
     assert_raises_errmatch(CommandlineError, /option '--fiz' only accepts one of: dog, cat/) {
       @p.parse(%w(--fiz rat))
     }
@@ -47,8 +47,8 @@ class ParserPermittedTest < ::Minitest::Test
 
   def test_permitted_with_numeric_array
     @p.opt 'mynum', 'desc', :type => Integer, :permitted => [1,2,4]
-    @p.parse(%w(--mynum 1)) 
-    @p.parse(%w(--mynum 4)) 
+    @p.parse(%w(--mynum 1))
+    @p.parse(%w(--mynum 4))
     assert_raises_errmatch(CommandlineError, /option '--mynum' only accepts one of: 1, 2, 4/) {
       @p.parse(%w(--mynum 3))
     }

data/test/optimist/parser_test.rb

@@ -1,5 +1,5 @@
 require 'stringio'
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
 
@@ -142,7 +142,7 @@ class ParserTest < ::Minitest::Test
   ## flags that require args of a specific type refuse args of other
   ## types
   def test_typed_args_refuse_args_of_other_types
-    @p.opt "goodarg", "desc", :type => :int    
+    @p.opt "goodarg", "desc", :type => :int
     err_regex = %r/Unsupported argument type 'asdf', registry lookup 'asdf'/
     assert_raises_errmatch(ArgumentError, err_regex) { @p.opt "badarg", "desc", :type => :asdf }
 
@@ -368,7 +368,7 @@ class ParserTest < ::Minitest::Test
     @p.opt "arg", "desc", :short => :none
     @p.parse []
 
-    sio = StringIO.new "w"
+    sio = StringIO.new
     @p.educate sio
     assert sio.string =~ /--arg\s+desc/
 
@@ -991,10 +991,10 @@ Options:
 
     opts = @p.parse %w(--arg3 stdin)
     assert_equal $stdin, opts[:arg3]
-    
+
     err_regex = %r/file or url for option 'arg' cannot be opened: No such file or directory/
     assert_raises_errmatch(CommandlineError, err_regex) {
-      opts = @p.parse %w(--arg /fdasfasef/fessafef/asdfasdfa/fesasf) 
+      opts = @p.parse %w(--arg /fdasfasef/fessafef/asdfasdfa/fesasf)
     }
   end
 

data/test/optimist/version_needed_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Optimist
   class VersionNeededTest < ::Minitest::Test

data/test/optimist_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 class OptimistTest < Minitest::Test
   def setup

data/test/support/assert_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minitest::Assertions
   def assert_parses_correctly(parser, commandline, expected_opts,
                               expected_leftovers)
@@ -9,7 +11,7 @@ module Minitest::Assertions
   def assert_stderr(str = nil, msg = nil)
     msg = "#{msg}.\n" if msg
 
-    old_stderr, $stderr = $stderr, StringIO.new('')
+    old_stderr, $stderr = $stderr, StringIO.new
     yield
     assert_match str, $stderr.string, msg if str
   ensure
@@ -19,7 +21,7 @@ module Minitest::Assertions
   def assert_stdout(str = nil, msg = nil)
     msg = "#{msg}.\n" if msg
 
-    old_stdout, $stdout = $stdout, StringIO.new('')
+    old_stdout, $stdout = $stdout, StringIO.new
     yield
     assert_match str, $stdout.string, msg if str
   ensure
@@ -49,4 +51,3 @@ module Minitest::Assertions
     assert_match(err_regexp, err.message)
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimist
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - William Morgan
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -32,28 +32,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.3
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.3
+        version: '5.25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +97,7 @@ files:
 - examples/banners1.rb
 - examples/banners2.rb
 - examples/banners3.rb
+- examples/boolean.rb
 - examples/constraints.rb
 - examples/didyoumean.rb
 - examples/medium_example.rb
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Optimist is a commandline option parser for Ruby that just gets out of your