optimist 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 335830b11859ca8643cd5fe74d6444f147ab2873
-  data.tar.gz: 9a483cf4a178eaf83c6093ea177e29cc0cf63c32
+SHA256:
+  metadata.gz: 87e142709336212fa484755022a85b8d833de889579b69a1b2fc35933bac88fd
+  data.tar.gz: 4ac2b33acae583f3ce444c105112c144a32affc52a8ab52980ab9772a107f8c3
 SHA512:
-  metadata.gz: 7f18e81587cb3f617d7dfc26183c1d821a058891a638560c60c85202237fb084e57c77ffdc7b5a245a81e378769852b9e51827e8b41329298c7b7f0a3cb2f395
-  data.tar.gz: c6f2d0245b46cb58470b4ff6f31ac7df483c8d7f48c1d0da27cdcd3681fef55dced81a2765dc33035b808e7c7ba9519363019bd486f3496a74ebaa11f011f219
+  metadata.gz: 7ccadd2b388b3877e3a075e224b7b9f1ed3b48a4dd68a72a6ca7f8ca9120c999a366d0619bf1cfcec0018fd80baeab83fd8e686e35f91109668c4d0210e08ddd
+  data.tar.gz: '0312801235dc1952812a79d01d68b71cff4db8187040cbc74f299bb519d926dc01fed15f0c656ca7d09e18dcd18289b1d951917cc31c8a8e1bfaa1377cbcde99'

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
+    path: styles/base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
+    path: styles/cc_base.yml
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"
+    channel: rubocop-0-82
+version: '2'

data/.github/workflows/ci.yaml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 0 * * 0'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+        - '2.4'
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - '3.2'
+        - jruby-9.3
+        - ruby-head
+        - jruby-head
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"
+inherit_from:
+- ".rubocop_local.yml"

data/.rubocop_cc.yml

@@ -0,0 +1,4 @@
+inherit_from:
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [3.1.0] - 2023-07-24
+### Added
+- Implement `either` command ([#130](https://github.com/ManageIQ/optimist/pull/130))
+
+[Unreleased]: https://github.com/ManageIQ/optimist/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/ManageIQ/optimist/compare/v3.0.1...v3.1.0

data/History.txt

@@ -1,3 +1,8 @@
+== [3.0.1] / 2020-04-20
+
+* Add a LICENSE.txt file to the released package
+* Test fixes (thanks @aried3r, @neontapir, @npras)
+
 == [3.0.0] / 2018-08-24
 
 * The gem has been officially renamed to optimist
@@ -163,6 +168,8 @@
 == 1.0 / 2007-01-29
 * Initial release.
 
+[3.0.1]: https://github.com/ManageIQ/optimist/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/ManageIQ/optimist/compare/v2.1.3...v3.0.0
 [2.1.3]: https://github.com/ManageIQ/optimist/compare/v2.1.2...v2.1.3
 [2.1.2]: https://github.com/ManageIQ/optimist/compare/v2.1.1...v2.1.2
 [2.1.1]: https://github.com/ManageIQ/optimist/compare/v2.1.0...v2.1.1

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2008-2014 William Morgan
+Copyright (c) 2014 Red Hat, Inc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -3,10 +3,9 @@
 http://manageiq.github.io/optimist/
 
 [![Gem Version](https://badge.fury.io/rb/optimist.svg)](http://badge.fury.io/rb/optimist)
-[![Build Status](https://travis-ci.org/ManageIQ/optimist.svg)](https://travis-ci.org/ManageIQ/optimist)
-[![Code Climate](https://codeclimate.com/github/ManageIQ/optimist/badges/gpa.svg)](https://codeclimate.com/github/ManageIQ/optimist)
+[![CI](https://github.com/ManageIQ/optimist/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/optimist/actions/workflows/ci.yaml)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/optimist.svg)](https://codeclimate.com/github/ManageIQ/optimist)
 [![Coverage Status](http://img.shields.io/coveralls/ManageIQ/optimist.svg)](https://coveralls.io/r/ManageIQ/optimist)
-[![Dependency Status](https://gemnasium.com/ManageIQ/optimist.svg)](https://gemnasium.com/ManageIQ/optimist)
 
 ## Documentation
 

data/lib/optimist.rb

@@ -6,9 +6,7 @@
 require 'date'
 
 module Optimist
-  # note: this is duplicated in gemspec
-  # please change over there too
-VERSION = "3.0.0"
+VERSION = "3.1.0"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Optimist::options entry.
@@ -199,6 +197,13 @@ class Parser
     @constraints << [:conflicts, syms]
   end
 
+  ## Marks two (or more!) options as required but mutually exclusive.
+  def either(*syms)
+    syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
+    @constraints << [:conflicts, syms]
+    @constraints << [:either, syms]
+  end
+
   ## Defines a set of words which cause parsing to terminate when
   ## encountered, such that any options to the left of the word are
   ## parsed as usual, and options to the right of the word are left
@@ -298,13 +303,16 @@ class Parser
     ## check constraint satisfaction
     @constraints.each do |type, syms|
       constraint_sym = syms.find { |sym| given_args[sym] }
-      next unless constraint_sym
 
       case type
       when :depends
+        next unless constraint_sym
         syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym].long} requires --#{@specs[sym].long}" unless given_args.include? sym }
       when :conflicts
+        next unless constraint_sym
         syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym].long} conflicts with --#{@specs[sym].long}" if given_args.include?(sym) && (sym != constraint_sym) }
+      when :either
+        raise CommandlineError, "one of #{syms.map { |sym| "--#{@specs[sym].long}" }.join(', ') } is required" if (syms & given_args.keys).size != 1
       end
     end
 
@@ -590,11 +598,11 @@ class Option
     @optshash = Hash.new()
   end
 
-  def opts (key)
+  def opts(key)
     @optshash[key]
   end
 
-  def opts= (o)
+  def opts=(o)
     @optshash = o
   end
 
@@ -620,7 +628,7 @@ class Option
 
   def required? ; opts(:required) ; end
 
-  def parse (_paramlist, _neg_given)
+  def parse(_paramlist, _neg_given)
     raise NotImplementedError, "parse must be overridden for newly registered type"
   end
 

data/optimist.gemspec

@@ -29,7 +29,8 @@ specify."
 
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "minitest", "~> 5.4.3"
-  spec.add_development_dependency "rake", "~> 10.0"
   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"
 end

data/test/optimist/parser_test.rb

@@ -253,6 +253,8 @@ class ParserTest < ::MiniTest::Test
   def test_long_detects_bad_names
     @p.opt "goodarg", "desc", :long => "none"
     @p.opt "goodarg2", "desc", :long => "--two"
+    @p.opt "goodarg3", "desc", :long => "arg-3"
+    @p.opt "goodarg4", "desc", :long => "--good-arg-four"
     assert_raises(ArgumentError) { @p.opt "badarg", "desc", :long => "" }
     assert_raises(ArgumentError) { @p.opt "badarg2", "desc", :long => "--" }
     assert_raises(ArgumentError) { @p.opt "badarg3", "desc", :long => "-one" }
@@ -347,6 +349,14 @@ class ParserTest < ::MiniTest::Test
     assert_equal true, opts[:defaultfalse]
     assert_equal true, opts[:defaulttrue]
 
+    ## using short form turns them all on, regardless of default
+    #
+    # (matches positve "non-no" long form)
+    opts = @p.parse %w(-d -e -f)
+    assert_equal true, opts[:defaultnone]
+    assert_equal true, opts[:defaultfalse]
+    assert_equal true, opts[:defaulttrue]
+
     ## using --no- form turns them off, regardless of default
     opts = @p.parse %w(--no-defaultfalse --no-defaulttrue --no-defaultnone)
     assert_equal false, opts[:defaultnone]
@@ -378,6 +388,14 @@ class ParserTest < ::MiniTest::Test
     assert_equal false, opts[:no_default_false]
     assert_equal false, opts[:no_default_true]
 
+    ## using short form turns them all off, regardless of default
+    #
+    # (matches positve "non-no" long form)
+    opts = @p.parse %w(-n -o -d)
+    assert_equal false, opts[:no_default_none]
+    assert_equal false, opts[:no_default_false]
+    assert_equal false, opts[:no_default_true]
+
     ## disallow double negatives for reasons of sanity preservation
     assert_raises(CommandlineError) { @p.parse %w(--no-no-default-true) }
   end
@@ -390,12 +408,12 @@ class ParserTest < ::MiniTest::Test
     opts = @p.parse %w(-a -b)
     assert_equal true, opts[:arg1]
     assert_equal true, opts[:arg2]
-    assert_equal nil, opts[:arg3]
+    assert_nil opts[:arg3]
 
     opts = @p.parse %w(-ab)
     assert_equal true, opts[:arg1]
     assert_equal true, opts[:arg2]
-    assert_equal nil, opts[:arg3]
+    assert_nil opts[:arg3]
 
     opts = @p.parse %w(-ac 4 -b)
     assert_equal true, opts[:arg1]
@@ -464,7 +482,7 @@ Options:
     assert_equal 5, opts[:arg]
   end
 
-  def test_integer_formatting
+  def test_integer_formatting_default
     @p.opt :arg, "desc", :type => :integer, :short => "i", :default => 3
     opts = @p.parse %w(-i)
     assert_equal 3, opts[:arg]
@@ -745,6 +763,34 @@ Options:
     assert_raises(CommandlineError) { @p.parse %w(--one --mellow --two --jello) }
   end
 
+  def test_either
+    @p.opt :one
+    assert_raises(ArgumentError) { @p.either :one, :two }
+    @p.opt :two
+    @p.either :one, :two
+    @p.parse %w(--one)
+    @p.parse %w(--two)
+    assert_raises(CommandlineError) { @p.parse %w(--one --two) }
+    assert_raises(CommandlineError) { @p.parse %w() }
+
+    @p.opt :hello
+    @p.opt :yellow
+    @p.opt :mellow
+    @p.opt :jello
+    @p.either :hello, :yellow, :mellow, :jello
+    assert_raises(CommandlineError) { @p.parse %w(--hello --yellow --mellow --jello) }
+    assert_raises(CommandlineError) { @p.parse %w(--hello --mellow --jello) }
+    assert_raises(CommandlineError) { @p.parse %w(--hello --jello) }
+
+    @p.parse %w(--hello --one)
+    @p.parse %w(--jello --two)
+    @p.parse %w(--mellow --one)
+    @p.parse %w(--mellow --two)
+
+    assert_raises(CommandlineError) { @p.parse %w(--mellow --two --jello) }
+    assert_raises(CommandlineError) { @p.parse %w(--one --mellow --two --jello) }
+  end
+
   def test_conflict_error_messages
     @p.opt :one
     @p.opt "two"

metadata

@@ -1,59 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: optimist
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - William Morgan
 - Keenan Brock
 - Jason Frey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: chronic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.4.3
 - !ruby/object:Gem::Dependency
-  name: chronic
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: |-
   Optimist is a commandline option parser for Ruby that just
   gets out of your way. One line of code per option is all you need to write.
@@ -65,11 +79,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_cc.yml"
+- ".rubocop_local.yml"
+- ".whitesource"
+- CHANGELOG.md
 - FAQ.txt
 - Gemfile
 - History.txt
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/optimist.rb
@@ -91,7 +112,7 @@ metadata:
   changelog_uri: https://github.com/ManageIQ/optimist/blob/master/History.txt
   source_code_uri: https://github.com/ManageIQ/optimist/
   bug_tracker_uri: https://github.com/ManageIQ/optimist/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,9 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Optimist is a commandline option parser for Ruby that just gets out of your
   way.

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - "2.2"
-  - "2.3.4"
-  - "2.5.1"
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-  fast_finish: true