optimist_xl 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d15a0ddf0d2205266ff1df22f86c3e96c9bcccfe449394840194269ff35de564
-  data.tar.gz: b84c5a820184de6941b54054d7ab3786be5c4b75b5e934d99021e21838cb1355
+  metadata.gz: 4f71228547d0536054a7e674aa46cedde06fc46ea310e46076f4beb19585f9f5
+  data.tar.gz: 948058a857b01c3939866fbb5b484131f5d104083c4ca4800c7072ce8eba8de7
 SHA512:
-  metadata.gz: fbe733a8b0f74918aef616ed3a2d1d5a6f9ff7cc414de871f8bdfb33aba1186899f4d25c8e66c08bfbfe3dc2dcc87514e7d2b2e3f1859d1b96a4bddc773c2c77
-  data.tar.gz: 8de3c39ad1356af6b5e599127b0afefd78e4ccec11f5ec06b801eac94ad631a5e6fa1c266f64e94c2a0b8c11a137a6978409767c2d657266eb0643a51b688541
+  metadata.gz: f8f594f3eb28c433b9b34b81ae452060d0cd2f5cb1302b6167da58358e1c2cbf3749792918ce1f96da6c02112fb9f4f30ee85c00eb38a7cfd46372387dd37446
+  data.tar.gz: 6fcabc7018c7660aa0fdc3c79d1d020a0a352b76fe22655c9d02bed4eb8556ec40503e6e349ba2bd968504e3cedf13ca54d4c9f8598b59f06c25121579f1b328

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
-sudo: false
+cache: bundler
 rvm:
-  - "2.2"
-  - "2.3.4"
-  - "2.5.1"
-  - "2.6.3"
-  - "2.7.0"
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - jruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-head
-  fast_finish: true
+#    - rvm: jruby-head
+#  fast_finish: true

data/{History.txt → History.md}

@@ -1,4 +1,9 @@
-== [3.1.1] / 2020-01-20
+# [3.2.0] / 2020-03-02
+
+* Added alternate-named long options using `:alt`
+* Added alternate-named short-options by allowing `:short` to take an Array.
+* Refactored some short/long handling code into ShortNames and LongNames classes.
+# [3.1.1] / 2020-01-20
 
 * The gem has been forked from optimist to optimist_xl
 * Added "native" subcommands support
@@ -7,11 +12,11 @@
 * ability to globally prevent short-options by default
 * permitted and permitted_response keywords now available
 
-== [3.0.0] / 2018-08-24
+# [3.0.0] / 2018-08-24
 
 * The gem has been officially renamed to optimist
 
-== [2.1.3] / 2018-07-05
+# [2.1.3] / 2018-07-05
 
 * Refactor each option type into subclasses of Option.  Define a registry for the registration of each option.  This makes the code more modular and facilitates extension by allowing additional Option subclasses. (thanks @clxy)
 * Fixed implementation of ignore_invalid_options. (thanks @metcalf)
@@ -20,18 +25,18 @@
 * fixed default (thanks @nanobowers)
 * Change from ruby license to MIT license in the code.
 
-== [2.1.2] / 2015-03-10
+# [2.1.2] / 2015-03-10
 * loosen mime-types requirements (for better ruby 1.8.7 support)
 * use io/console gem instead of curses (for better jruby support)
 * fix parsing bug when chronic gem is not available
 * allow default array to be empty if a type is specified
 * better specified license and better spec coverage
 
-== [2.1.1] / 2015-01-03
+# [2.1.1] / 2015-01-03
 * Remove curses as a hard dependency. It is optional. This can leverage the gem if it is present.
 * Fix ruby -w warnings
 
-== 2.1.0 / 2015-01-02
+# 2.1.0 / 2015-01-02
 * Integer parser now supports underscore separator.
 * Add Parser#usage and Parser#synopsis commands for creating a standard banner
   message. Using Parser#banner directly will override both of those.
@@ -46,7 +51,7 @@
 * Fix handling of newlines inside descriptions
 * Documentation and other fixes.
 
-== 2.0 / 2012-08-11
+# 2.0 / 2012-08-11
 * Change flag logic: --no-X will always be false, and --X will always be true,
   regardless of default.
 * For flags that default to true, display --no-X instead of --X in the help
@@ -55,55 +60,55 @@
 * Update Rakefile to 1.9
 * Minor documentation fixes
 
-== 1.16.2 / 2010-04-06
+# 1.16.2 / 2010-04-06
 * Bugfix in Optimist::options. Thanks to Brian C. Thomas for pointing it out.
 
-== 1.16.1 / 2010-04-05
+# 1.16.1 / 2010-04-05
 * Bugfix in Optimist::die method introduced in last release.
 
-== 1.16 / 2010-04-01
+# 1.16 / 2010-04-01
 * Add Optimist::with_standard_exception_handling method for easing the use of Parser directly.
 * Handle scientific notation in float arguments, thanks to Will Fitzgerald.
 * Drop hoe dependency.
 
-== 1.15 / 2009-09-30
+# 1.15 / 2009-09-30
 * Don't raise an exception when out of short arguments (thanks to Rafael
   Sevilla for pointing out how dumb this behavior was).
 
-== 1.14 / 2009-06-19
+# 1.14 / 2009-06-19
 * Make :multi arguments default to [], not nil, when not set on the commandline.
 * Minor commenting and error message improvements
 
-== 1.13 / 2009-03-16
+# 1.13 / 2009-03-16
 * Fix parsing of "--longarg=<value with spaces>".
 
-== 1.12 / 2009-01-30
+# 1.12 / 2009-01-30
 * Fix some unit test failures in the last release. Should be more careful.
 * Make default short options only be assigned *after* all user-specified
   short options. Now there's a little less juggling to do when you just
   want to specify a few short options.
 
-== 1.11 / 2009-01-29
+# 1.11 / 2009-01-29
 * Set <opt>_given keys in the results hash for options that were specified
   on the commandline.
 
-== 1.10.2 / 2008-10-23
+# 1.10.2 / 2008-10-23
 * No longer try `stty size` for screen size detection. Just use curses, and
   screen users will have to deal with the screen clearing.
 
-== 1.10.1 / 2008-10-22
+# 1.10.1 / 2008-10-22
 * Options hash now responds to method calls as well as standard hash lookup.
 * Default values for multi-occurrence parameters now autoboxed.
 * The relationship between multi-value, multi-occurrence, and default values
   improved and explained.
 * Documentation improvements.
 
-== 1.10 / 2008-10-21
+# 1.10 / 2008-10-21
 * Added :io type for parameters that point to IO streams (filenames, URIs, etc).
 * For screen size detection, first try `stty size` before loading Curses.
 * Improved documentation.
 
-== 1.9 / 2008-08-20
+# 1.9 / 2008-08-20
 * Added 'stop_on_unknown' command to stop parsing on any unknown argument.
   This is useful for handling sub-commands when you don't know the entire
   set of commands up front. (E.g. if the initial arguments can change it.)
@@ -112,51 +117,51 @@
 * Added :ints, :strings, :doubles, and :floats option types, which can take
   multiple arguments.
 
-== 1.8.2 / 2008-06-25
+# 1.8.2 / 2008-06-25
 * Bugfix for #conflicts and #depends error messages
 
-== 1.8.1 / 2008-06-24
+# 1.8.1 / 2008-06-24
 * Bugfix for short option autocreation
 * More aggressive documentation
 
-== 1.8 / 2008-06-16
+# 1.8 / 2008-06-16
 * Sub-command support via Parser#stop_on
 
-== 1.7.2 / 2008-01-16
+# 1.7.2 / 2008-01-16
 * Ruby 1.9-ify. Apparently this means replacing :'s with ;'s.
 
-== 1.7.1 / 2008-01-07
+# 1.7.1 / 2008-01-07
 * Documentation improvements
 
-== 1.7 / 2007-06-17
+# 1.7 / 2007-06-17
 * Fix incorrect error message for multiple missing required arguments
   (thanks to Neill Zero)
 
-== 1.6 / 2007-04-01
+# 1.6 / 2007-04-01
 * Don't attempt curses screen-width magic unless running on a terminal.
 
-== 1.5 / 2007-03-31
+# 1.5 / 2007-03-31
 * --help and --version do the right thing even if the rest of the
   command line is incorrect.
 * Added #conflicts and #depends to model dependencies and exclusivity
   between arguments.
 * Minor bugfixes.
 
-== 1.4 / 2007-03-26
+# 1.4 / 2007-03-26
 * Disable short options with :short => :none.
 * Minor bugfixes and error message improvements.
 
-== 1.3 / 2007-01-31
+# 1.3 / 2007-01-31
 * Wrap at (screen width - 1) instead of screen width.
 * User can override --help and --version.
 * Bugfix in handling of -v and -h.
 * More tests to confirm the above.
 
-== 1.2 / 2007-01-31
+# 1.2 / 2007-01-31
 * Minor documentation tweaks.
 * Removed hoe dependency.
 
-== 1.1 / 2007-01-30
+# 1.1 / 2007-01-30
 * Optimist::options now passes any arguments as block arguments. Since
   instance variables are not properly captured by the block, this
   makes it slightly less noisy to pass them in as local variables.
@@ -169,7 +174,7 @@
   in the help text.
 * Slightly more indicative formatting for parameterized arguments.
 
-== 1.0 / 2007-01-29
+# 1.0 / 2007-01-29
 * Initial release.
 
 [2.1.3]: https://github.com/ManageIQ/optimist/compare/v2.1.2...v2.1.3

data/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2008-2014 William Morgan (http://masanjin.net/).
+
+Copyright (c) 2014 Red Hat, Inc.
+
+Copyright (c) 2019 Ben Bowers
+
+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

@@ -17,15 +17,19 @@ One line of code per option is all you need to write. For that, you get a nice
 automatically-generated help page, robust option parsing, and sensible defaults
 for everything you don't specify.
 
+This code is a feature-fork of Optimist: https://github.com/ManageIQ/optimist
+
+See the **Extended Features** section below for the differences/enhancements
+
 ## Features
 
-- Dirt-simple usage.
+- Simple usage.
 - Sensible defaults. No tweaking necessary, much tweaking possible.
 - Support for long options, short options, subcommands, and automatic type validation and
   conversion.
 - Automatic help message generation, wrapped to current screen width.
 
-## Extended features
+## Extended Features
 
 ### Parser Settings
 - Automatic suggestions whens incorrect options are given
@@ -37,16 +41,30 @@ for everything you don't specify.
 
 ### Option Settings
 
+#### Permitted
+
 Permitted options allow specifying valid choices for an option using lists, ranges or regexp's 
 - `permitted:` to specify a allow lists, ranges or regexp filtering of options.
 - `permitted_response:` can be added to provide more explicit output when incorrect choices are given.
 - see [example](examples/permitted.rb)
 - concept and code via @akhoury6
 
+#### Alternate named options
+
+Short options can now take be provided as an Array of list of alternate short-option characters.
+- `opt :cat, 'desc', short: ['c', 't']`
+- Previously `short:` only accepted a single character.
+
+Long options can be given alternate names using `alt:`
+- `opt :length, 'desc', alt: ['size']`
+- Note that `long: 'othername'` still exists to _override_ the named option and can be used in addition to the alt names.
+
+See [example](examples/alt_names.rb)
+
 ### Subcommands
-"Native" subcommand support
-- see [example](examples/subcommands.rb)
-- ideas borrowed from https://github.com/jwliechty/trollop-subcommands
+"Native" subcommand support - similar to sub-commands in Git.
+- See [example](examples/subcommands.rb)
+- Ideas borrowed from https://github.com/jwliechty/trollop-subcommands
 
 ## Requirements
 

data/examples/alt_names.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  # 'short:' can now take more than one short-option character
+  #   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
+
+p opts
+

data/examples/banners1.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require_relative '../lib/optimist_xl'
 
-opts = OptimistXL::options do
+OptimistXL::options do
   synopsis "Overall synopsis of this program"
   version "cool-script v0.3 (code-name: apple-cake)"
   opt :juice, "use juice"

data/examples/banners2.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require_relative '../lib/optimist_xl'
 
-opts = OptimistXL::options do
+OptimistXL::options do
   synopsis "Overall synopsis of this program"
   version "cool-script v0.3.1 (code-name: apple-cake)"
   banner "My Banner"

data/examples/banners3.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require_relative '../lib/optimist_xl'
 
-opts = OptimistXL::options do
+OptimistXL::options do
   version "cool-script v0.3.2 (code-name: apple-cake)"
   banner self.version  ## print out the version in the banner
   banner "drinks"

data/lib/optimist_xl.rb

@@ -9,7 +9,7 @@ require 'date'
 module OptimistXL
   # note: this is duplicated in gemspec
   # please change over there too
-VERSION = "3.1.1"
+VERSION = "3.2.0"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the OptimistXL::options entry.
@@ -76,8 +76,6 @@ class Parser
     return @registry[lookup].new
   end
 
-  INVALID_SHORT_ARG_REGEX = /[\d-]/ #:nodoc:
-
   ## The values from the commandline that were not interpreted by #parse.
   attr_reader :leftovers
 
@@ -174,11 +172,18 @@ class Parser
     o = Option.create(name, desc, opts)
 
     raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? o.name
-    raise ArgumentError, "long option name #{o.long.inspect} is already taken; please specify a (different) :long" if @long[o.long]
-    raise ArgumentError, "short option name #{o.short.inspect} is already taken; please specify a (different) :short" if @short[o.short]
-    raise ArgumentError, "permitted values for option #{o.long.inspect} must be either nil, Range, Regexp or an Array;" unless o.permitted_type_valid?
-    @long[o.long] = o.name
-    @short[o.short] = o.name if o.short?
+    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
+    end
+
+    raise ArgumentError, "permitted values for option #{o.long.long.inspect} must be either nil, Range, Regexp or an Array;" unless o.permitted_type_valid?
+
+    o.short.chars.each do |short|
+      raise ArgumentError, "short option name #{short.inspect} is already taken; please specify a (different) :short" if @short[short]
+      @short[short] = o.name
+    end
+
     @specs[o.name] = o
     @order << [:opt, o.name]
   end
@@ -429,7 +434,7 @@ class Parser
       end
     end
 
-    required.each do |sym, val|
+    required.each do |sym, _val|
       raise CommandlineError, "option --#{@specs[sym].long} must be specified" unless given_args.include? sym
     end
 
@@ -586,7 +591,7 @@ class Parser
     exit(error_code || -1)
   end
 
-private
+  private
 
   ## yield successive arg, parameter pairs
   def each_arg(args)
@@ -679,11 +684,11 @@ private
   def resolve_default_short_options!
     @order.each do |type, name|
       opts = @specs[name]
-      next if type != :opt || opts.short
+      next if type != :opt || opts.doesnt_need_autogen_short
 
-      c = opts.long.split(//).find { |d| d !~ INVALID_SHORT_ARG_REGEX && !@short.member?(d) }
+      c = opts.long.long.split(//).find { |d| d !~ OptimistXL::ShortNames::INVALID_ARG_REGEX && !@short.member?(d) }
       if c # found a character to use
-        opts.short = c
+        opts.short.add c
         @short[c] = name
       end
     end
@@ -757,14 +762,84 @@ class SubcommandParser < Parser
 
 end
 
+class LongNames
+  def initialize
+    @truename = nil
+    @long = nil
+    @alts = []
+  end
+  
+  def make_valid(lopt)
+    return nil if lopt.nil?
+    case lopt.to_s
+    when /^--([^-].*)$/ then $1
+    when /^[^-]/        then lopt.to_s
+    else                     raise ArgumentError, "invalid long option name #{lopt.inspect}"
+    end
+  end
+  
+  def set(name, lopt, alts)
+    @truename = name
+    lopt = lopt ? lopt.to_s : name.to_s.gsub("_", "-")
+    @long = make_valid(lopt)
+    alts = [alts] unless alts.is_a?(Array) # box the value
+    @alts = alts.map { |alt| make_valid(alt) }.compact
+  end
+  
+  # long specified with :long has precedence over the true-name
+  def long ; @long || @truename ; end
+
+  # all valid names, including alts
+  def names
+    [long] + @alts
+  end
+  
+end
+
+class ShortNames
+
+  INVALID_ARG_REGEX = /[\d-]/ #:nodoc:
+
+  def initialize
+    @chars = []
+    @auto = true
+  end
+
+  attr_reader :chars, :auto
+  
+  def add(values)
+    values = [values] unless values.is_a?(Array) # box the value
+    values.compact.each do |val|
+      if val == :none
+        @auto = false
+        raise "Cannot set short to :none if short-chars have been defined '#{@chars}'" unless chars.empty?
+        next
+      end
+      strval = val.to_s
+      sopt = case strval
+             when /^-(.)$/ then $1
+             when /^.$/ then strval
+             else raise ArgumentError, "invalid short option name '#{val.inspect}'"
+             end
+
+      if sopt =~ INVALID_ARG_REGEX
+        raise ArgumentError, "short option name '#{sopt}' can't be a number or a dash" 
+      end
+      @chars << sopt
+    end
+  end
+  
+end
+
 class Option
 
-  attr_accessor :name, :short, :long, :default, :permitted, :permitted_response
+  attr_reader :short
+  attr_accessor :name, :long, :default, :permitted, :permitted_response
   attr_writer :multi_given
 
   def initialize
-    @long = nil
-    @short = nil
+    @long = LongNames.new
+    @short = ShortNames.new # can be an Array of one-char strings, a one-char String, nil or :none
     @name = nil
     @multi_given = false
     @hidden = false
@@ -797,7 +872,7 @@ class Option
 
   def array_default? ; self.default.kind_of?(Array) ; end
 
-  def short? ; short && short != :none ; end
+  def doesnt_need_autogen_short ; !short.auto || !short.chars.empty? ; end
 
   def callback ; opts(:callback) ; end
   def desc ; opts(:desc) ; end
@@ -812,7 +887,10 @@ class Option
   def type_format ; "" ; end
 
   def educate
-    (short? ? "-#{short}, " : "") + "--#{long}" + type_format + (flag? && default ? ", --no-#{long}" : "")
+    optionlist = []
+    optionlist.concat(short.chars.map { |o| "-#{o}" })
+    optionlist.concat(long.names.map { |o| "--#{o}" })
+    optionlist.compact.join(', ') + type_format + (flag? && default ? ", --no-#{long}" : "")
   end
 
   ## Format the educate-line description including the default and permitted value(s)
@@ -865,7 +943,7 @@ class Option
     when Array
       return "one of: " + permitted.to_a.map(&:to_s).join(', ')
     when Range
-      return "value in range of: #{permitted.to_s}"
+      return "value in range of: #{permitted}"
     when Regexp
       return "value matching: #{permitted.inspect}"
     end
@@ -916,7 +994,7 @@ class Option
   # to +OptimistXL::opt+.  This is trickier in OptimistXL, than other cmdline
   # parsers (e.g. Slop) because we allow the +default:+ to be able to
   # set the option's type.
-  def self.create(name, desc="", opts={}, settings={})
+  def self.create(name, _desc="", opts={}, _settings={})
 
     opttype = OptimistXL::Parser.registry_getopttype(opts[:type])
     opttype_from_default = get_klass_from_default(opts, opttype)
@@ -926,10 +1004,10 @@ class Option
     opt_inst = (opttype || opttype_from_default || OptimistXL::BooleanOption.new)
 
     ## fill in :long
-    opt_inst.long = handle_long_opt(opts[:long], name)
+    opt_inst.long.set(name, opts[:long], opts[:alt])
 
     ## fill in :short
-    opt_inst.short = handle_short_opt(opts[:short])
+    opt_inst.short.add opts[:short]
 
     ## fill in :multi
     multi_given = opts[:multi] || false
@@ -951,7 +1029,6 @@ class Option
     opt_inst
   end
 
-  private
 
   def self.get_type_from_disdef(optdef, opttype, disambiguated_default)
     if disambiguated_default.is_a? Array
@@ -983,28 +1060,8 @@ class Option
     return OptimistXL::Parser.registry_getopttype(type_from_default)
   end
 
-  def self.handle_long_opt(lopt, name)
-    lopt = lopt ? lopt.to_s : name.to_s.gsub("_", "-")
-    lopt = case lopt
-           when /^--([^-].*)$/ then $1
-           when /^[^-]/        then lopt
-           else                     raise ArgumentError, "invalid long option name #{lopt.inspect}"
-           end
-  end
-
-  def self.handle_short_opt(sopt)
-    sopt = sopt.to_s if sopt && sopt != :none
-    sopt = case sopt
-           when /^-(.)$/          then $1
-           when nil, :none, /^.$/ then sopt
-           else                   raise ArgumentError, "invalid short option name '#{sopt.inspect}'"
-           end
-
-    if sopt
-      raise ArgumentError, "a short option name can't be a number or a dash" if sopt =~ ::OptimistXL::Parser::INVALID_SHORT_ARG_REGEX
-    end
-    return sopt
-  end
+  private_class_method :get_type_from_disdef
+  private_class_method :get_klass_from_default
 
 end
 

data/optimist_xl.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.version       = OptimistXL::VERSION
   spec.authors       = ["William Morgan", "Keenan Brock", "Jason Frey", "Ben Bowers"]
   spec.email         = "nanobowers@gmail.com"
-  spec.summary       = "OptimistXL is a commandline option parser for Ruby that just gets out of your way."
-  spec.description   = "OptimistXL 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.
+  spec.summary       = "OptimistXL is feature fork of the Optimist commandline option parser."
+  spec.description   = "OptimistXL is feature filled but lightweight commandline option parser.
+One line of code per option is all you typically need to write.
 For that, you get a nice automatically-generated help page, robust option
 parsing, command subcompletion, and sensible defaults for everything you don't
 specify.  This gem is an enhanced-feature fork of the Optimist gem."
@@ -29,6 +29,8 @@ specify.  This gem is an enhanced-feature fork of the Optimist gem."
 
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.2'
+  
   spec.add_development_dependency "minitest", "~> 5.4.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "chronic"

data/test/optimist_xl/alt_names_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+module OptimistXL
+
+  class AlternateNamesTest < ::MiniTest::Test
+
+    def setup
+      @p = Parser.new
+    end
+
+    def get_help_string
+      err = assert_raises(OptimistXL::HelpNeeded) do
+        @p.parse(%w(--help))
+      end
+      sio = StringIO.new "w"
+      err.parser.educate sio
+      sio.string
+    end
+
+    def test_altshort
+       @p.opt :catarg, "desc", :short => ["c", "-C"]
+       opts = @p.parse %w(-c)
+       assert_equal true, opts[:catarg]
+       opts = @p.parse %w(-C)
+       assert_equal true, opts[:catarg]
+       assert_raises(CommandlineError) { @p.parse %w(-c -C) }
+       assert_raises(CommandlineError) { @p.parse %w(-cC) }
+    end
+
+    def test_altshort_with_multi
+      @p.opt :flag, "desc", :short => ["-c", "C", :x], :multi => true
+      @p.opt :num, "desc", :short => ["-n", "N"], :multi => true, type: Integer
+      @p.parse %w(-c)
+      @p.parse %w(-C -c -x)
+      @p.parse %w(-c -C)
+      @p.parse %w(-c -C -c -C)
+      opts = @p.parse %w(-ccCx)
+      assert_equal true, opts[:flag]
+      @p.parse %w(-c)
+      @p.parse %w(-N 1 -n 3)
+      @p.parse %w(-n 2 -N 4)
+      opts = @p.parse %w(-n 4 -N 3 -n 2 -N 1)
+      assert_equal [4, 3, 2, 1], opts[:num]
+    end
+
+    def test_altlong
+      @p.opt "goodarg0", "desc", :alt => "zero"
+      @p.opt "goodarg1", "desc", :long => "newone", :alt => "one"
+      @p.opt "goodarg2", "desc", :alt => "--two"
+      @p.opt "goodarg3", "desc", :alt => ["three", "--four", :five]
+
+      [%w[--goodarg0], %w[--zero]].each do |a|
+        opts = @p.parse(a)
+        assert opts.goodarg0
+      end
+      
+      [%w[--newone], %w[-n], %w[--one]].each  do |a|
+        opts = @p.parse(a)
+        assert opts.goodarg1
+      end
+
+      [%w[--two]].each  do |a|
+        opts = @p.parse(a)
+        assert opts.goodarg2
+      end
+
+      [%w[--three], %w[--four], %w[--five]].each  do |a|
+        opts = @p.parse(a)
+        assert opts.goodarg3
+      end
+
+      [%w[--goodarg1], %w[--missing], %w[-a]].each do |a|
+        assert_raises(OptimistXL::CommandlineError) { @p.parse(a) }
+      end
+
+      ["", '--', '-bad', '---threedash'].each do |altitem|
+        assert_raises(ArgumentError) { @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
+      # expect mutliple short-opts to be in the help
+      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]
+      @p.opt :fruit, 'a fruit', long: :fig, alt: ['peach', :pear, "--apple"], short: :none
+
+      outstring = get_help_string
+
+      assert_match(/^\s*-c, --cat, --feline/, outstring)
+      assert_match(/^\s*-d, --dog, --Pooch, --canine/, outstring)
+
+      # expect long-opt to shadow the actual name
+      assert_match(/^\s*--fig, --peach, --pear, --apple/, outstring)
+      
+    end
+
+    def test_alt_duplicates
+      # alt duplicates named option
+      assert_raises(ArgumentError) {
+        @p.opt :cat, 'desc', :alt => :cat
+      }
+      # alt duplicates :long 
+      assert_raises(ArgumentError) {
+        @p.opt :cat, 'desc', :long => :feline, :alt => [:feline]
+      }
+      # alt duplicates itself
+      assert_raises(ArgumentError) {
+        @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
+      assert_raises(ArgumentError) {
+        @p.opt :cat, 'desc', :alt => :fat
+      }
+
+      # :alt collision with :long option
+      assert_raises(ArgumentError) {
+        @p.opt :cat, 'desc', :alt => :rat
+      }
+
+      # :named option collision with existing :alt option
+      assert_raises(ArgumentError) {
+        @p.opt :baton, 'desc'
+      }
+
+      # :long option collision with existing :alt option
+      assert_raises(ArgumentError) {
+        @p.opt :whirl, 'desc', :long => 'twirl'
+      }
+      
+    end
+  end
+end

data/test/optimist_xl/parser_test.rb

@@ -273,10 +273,7 @@ class ParserTest < ::MiniTest::Test
   end
 
   def test_flag_with_no_defaults_and_no_args_act_as_switches_array
-    opts = nil
-
     @p.opt :argd, "desc", :type => :strings, :default => ["default_string"]
-
     opts = @p.parse(%w(--argd))
     assert_equal ["default_string"], opts[:argd]
   end
@@ -571,7 +568,11 @@ Options:
     assert_raises(ArgumentError) { @p.opt :arg, "desc", :short => "-1" }
     @p.opt :a1b, "desc"
     @p.opt :a2b, "desc"
-    assert @p.specs[:a2b].short.to_i == 0
+    @p.parse []
+    # testing private interface to ensure default
+    # short options did not become numeric
+    assert_equal @p.specs[:a1b].short.chars.first, 'a'
+    assert_equal @p.specs[:a2b].short.chars.first, 'b'
   end
 
   def test_short_options_can_be_weird
@@ -748,7 +749,7 @@ Options:
 
   def test_auto_generated_long_names_convert_underscores_to_hyphens
     @p.opt :hello_there
-    assert_equal "hello-there", @p.specs[:hello_there].long
+    assert_equal "hello-there", @p.specs[:hello_there].long.long
   end
 
   def test_arguments_passed_through_block
@@ -1305,7 +1306,7 @@ Options:
 
   def test_supports_callback_inline
     assert_raises(RuntimeError, "good") do
-      @p.opt :cb1 do |vals|
+      @p.opt :cb1 do |_vals|
         raise "good"
       end
       @p.parse(%w(--cb1))
@@ -1314,7 +1315,7 @@ Options:
 
   def test_supports_callback_param
     assert_raises(RuntimeError, "good") do
-      @p.opt :cb1, "with callback", :callback => lambda { |vals| raise "good" }
+      @p.opt :cb1, "with callback", :callback => lambda { |_vals| raise "good" }
       @p.parse(%w(--cb1))
     end
   end

data/test/optimist_xl/permitted_test.rb

@@ -13,15 +13,15 @@ class PermittedTest < ::MiniTest::Test
   end
 
   def test_permitted_invalid_value
-    err_regexp = /permitted values for option "bad" must be either nil, Range, Regexp or an Array/
-    assert_raises(ArgumentError) {
+    err_regexp = /permitted values for option "(bad|mad|sad)" must be either nil, Range, Regexp or an Array/
+    assert_raises(ArgumentError, err_regexp) {
       @p.opt 'bad', 'desc', :permitted => 1
     }
-    assert_raises(ArgumentError) {
-      @p.opt 'bad', 'desc', :permitted => "A"
+    assert_raises(ArgumentError, err_regexp) {
+      @p.opt 'mad', 'desc', :permitted => "A"
     }
     assert_raises_errmatch(ArgumentError, err_regexp) {
-      @p.opt 'bad', 'desc', :permitted => :abcd
+      @p.opt 'sad', 'desc', :permitted => :abcd
     }
   end
 

data/test/test_helper.rb

@@ -17,6 +17,6 @@ end
 
 require 'minitest/autorun'
 
-Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].sort.each { |f| require f }
 
 require 'optimist_xl'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimist_xl
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - William Morgan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -56,8 +56,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
-  OptimistXL 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.
+  OptimistXL is feature filled but lightweight commandline option parser.
+  One line of code per option is all you typically need to write.
   For that, you get a nice automatically-generated help page, robust option
   parsing, command subcompletion, and sensible defaults for everything you don't
   specify.  This gem is an enhanced-feature fork of the Optimist gem.
@@ -70,10 +70,12 @@ files:
 - ".travis.yml"
 - FAQ.txt
 - Gemfile
-- History.txt
+- History.md
+- LICENSE
 - README.md
 - Rakefile
 - examples/a_basic_example.rb
+- examples/alt_names.rb
 - examples/banners1.rb
 - examples/banners2.rb
 - examples/banners3.rb
@@ -85,6 +87,7 @@ files:
 - lib/optimist_xl.rb
 - lib/optimist_xl/chronic.rb
 - optimist_xl.gemspec
+- test/optimist_xl/alt_names_test.rb
 - test/optimist_xl/command_line_error_test.rb
 - test/optimist_xl/help_needed_test.rb
 - test/optimist_xl/parser_educate_test.rb
@@ -112,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -123,9 +126,9 @@ rubyforge_project:
 rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
-summary: OptimistXL is a commandline option parser for Ruby that just gets out of
-  your way.
+summary: OptimistXL is feature fork of the Optimist commandline option parser.
 test_files:
+- test/optimist_xl/alt_names_test.rb
 - test/optimist_xl/command_line_error_test.rb
 - test/optimist_xl/help_needed_test.rb
 - test/optimist_xl/parser_educate_test.rb