optimist_xl 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f71228547d0536054a7e674aa46cedde06fc46ea310e46076f4beb19585f9f5
-  data.tar.gz: 948058a857b01c3939866fbb5b484131f5d104083c4ca4800c7072ce8eba8de7
+  metadata.gz: 3fe9d9828ccf8519f081c520339195ab106b579a0d09564aab1a0ea47134b00a
+  data.tar.gz: 1f60a13d38245b2d7214093843403ffeefb917d3a4466ef50b11904cdc733037
 SHA512:
-  metadata.gz: f8f594f3eb28c433b9b34b81ae452060d0cd2f5cb1302b6167da58358e1c2cbf3749792918ce1f96da6c02112fb9f4f30ee85c00eb38a7cfd46372387dd37446
-  data.tar.gz: 6fcabc7018c7660aa0fdc3c79d1d020a0a352b76fe22655c9d02bed4eb8556ec40503e6e349ba2bd968504e3cedf13ca54d4c9f8598b59f06c25121579f1b328
+  metadata.gz: ce7e01b876214a131e653a5c9a3f700aaa7388bf68b211927b8bcda2f80d65d963b0991bc323a23d356f4be3bf2a41c943dcc44219bc421e18be824d0d897bb8
+  data.tar.gz: 4f6a89f6a84d5609e84f6323e104ee535893e7f74f2ca964665d4e745292b32a640cfead9efde73d9681c2d637edc38af2fe6f68ebaa3b428e28d72d58ace39f

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

data/History.md

@@ -1,8 +1,15 @@
+# [3.3.0] / 2020-11-12
+
+* Adding new `:stringflag` option.
+* Improving documentation.
+* Removing support for Ruby 2.2
+
 # [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

data/README.md

@@ -29,13 +29,15 @@ See the **Extended Features** section below for the differences/enhancements
   conversion.
 - Automatic help message generation, wrapped to current screen width.
 
-## Extended Features
+## Extended features unavailable in the original Optimist gem
 
 ### Parser Settings
 - Automatic suggestions whens incorrect options are given
     - disable with `suggestions: false`
+    - see example below
 - Inexact matching of long arguments
     - disable with `exact_match: true`
+    - see example below
 - Available prevention of short-arguments by default
     - enable with `explicit_short_opts: true`
 
@@ -61,16 +63,144 @@ Long options can be given alternate names using `alt:`
 
 See [example](examples/alt_names.rb)
 
+### Stringflag option-type
+
+It is useful to allow an option that can be set as a string, used with a default string or unset, especialy in the case of specifying a log-file.  AFAICT this was not possible with the original Optimist.
+
+Example: 
+
+For this option definition:
+
+```ruby
+opt :log, "Specify optional logfile", :type => :stringflag, :default => "progname.log"
+```
+
+The programmer should use the value of `log_given` in conjunction with the value of `log`
+to determine whether to enable logging what what the filename should be.
+
+```sh
+$ ./examples/optional_string_arg_type.rb -h
+Options:
+  -l, --log=<s?>, --no-log    specify optional log-file path (Default: progname.log)
+  -h, --help                  Show this message
+
+# Note that when no options are given, :log_given is not set, but the default passes through.
+$ ./examples/optional_string_arg_type.rb
+{:log=>"progname.log", :help=>false}
+
+$ ./examples/optional_string_arg_type.rb -l
+{:log=>"progname.log", :help=>false, :log_given=>true}
+
+# In this case no-log can be used to force a false value into :log
+$ ./examples/optional_string_arg_type.rb --no-log
+{:log=>false, :help=>false, :log_given=>true}
+
+# Overriding the default case
+$ ./examples/optional_string_arg_type.rb --log othername.log
+{:log=>"othername.log", :help=>false, :log_given=>true}
+```
+
 ### Subcommands
 "Native" subcommand support - similar to sub-commands in Git.
 - See [example](examples/subcommands.rb)
 - Ideas borrowed from https://github.com/jwliechty/trollop-subcommands
 
+### Automatic suggestions
+
+Suggestions are formed using the DidYouMean gem, which is part of Ruby 2.3+.  It uses the JaroWinkler and Levenshtein distance to determine when unknown options are within a certain 'distance' of a known option keyword.
+
+```sh
+$ ./examples/didyoumean.rb -h
+Options:
+  -c, --cone       Ice cream cone
+  -z, --zippy      It zips
+  -a, --zapzy      It zapz
+  -b, --big-bug    Madagascar cockroach
+  -h, --help       Show this message
+
+# Suggestions for a simple misspelling
+
+$ ./examples/didyoumean.rb --bone
+Error: unknown argument '--bone'.  Did you mean: [--cone] ?.
+Try --help for help.
+
+# Letter transposition
+$ ./examples/didyoumean.rb --ocne
+Error: unknown argument '--ocne'.  Did you mean: [--cone] ?.
+Try --help for help.
+
+# Accidental plural
+
+$ ./examples/didyoumean.rb --cones
+Error: unknown argument '--cones'.  Did you mean: [--cone] ?.
+Try --help for help.
+
+# Two close matches, provide two suggestions.
+
+$ ./examples/didyoumean.rb --zipzy
+Error: unknown argument '--zipzy'.  Did you mean: [--zippy, --zapzy] ?.
+Try --help for help.
+
+# Posix-style options with '-' instead of '_' are a common mistake
+
+$ ./examples/didyoumean.rb --big_bug
+Error: unknown argument '--big_bug'.  Did you mean: [--big-bug] ?.
+Try --help for help.
+
+# Eventually the input option is too far away from 
+# anything we know about so just say we dont understand
+
+$ ./examples/didyoumean.rb --bugblatter-beast
+Error: unknown argument '--bugblatter-beast'.
+Try --help for help.
+```
+
+### Inexact Matching
+
+Similar to Perl's Getopt::Long, partially specified long-options can be used as long as they would unambiguously match a single option.
+
+```sh
+$ ./examples/partialmatch.rb -h
+Options:
+  -a, --apple          An apple
+  -p, --apple-sauce    Cooked apple puree
+  -t, --atom           Smallest unit of ordinary matter
+  -n, --anvil          Heavy metal
+  -e, --anteater       Eats ants
+  -h, --help           Show this message
+
+# Exact match for 'apple'
+$ ./examples/partialmatch.rb --apple
+{:apple=>true, :apple_sauce=>false, :atom=>false, :anvil=>false, :anteater=>false, :help=>false, :apple_given=>true}
+
+# Cannot inexact match with 'app', as it partially matches more than one known option
+$ ./examples/partialmatch.rb --app
+Error: ambiguous option '--app' matched keys (apple,apple-sauce).
+Try --help for help.
+
+# Inexact match for 'apple-sauce'
+$ ./examples/partialmatch.rb --apple-s
+{:apple=>false, :apple_sauce=>true, :atom=>false, :anvil=>false, :anteater=>false, :help=>false, :apple_sauce_given=>true}
+
+# Shortest match for 'anvil'
+$ ./examples/partialmatch.rb --anv
+{:apple=>false, :apple_sauce=>false, :atom=>false, :anvil=>true, :anteater=>false, :help=>false, :anvil_given=>true}
+
+# Cannot inexact match with 'an', as it partially matches more than one known option
+$ ./examples/partialmatch.rb --an
+Error: ambiguous option '--an' matched keys (anvil,anteater).
+Try --help for help.
+
+# Shortest match for 'atom'
+$ ./examples/partialmatch.rb --at
+{:apple=>false, :apple_sauce=>false, :atom=>true, :anvil=>false, :anteater=>false, :help=>false, :atom_given=>true}
+```
+
 ## Requirements
 
-* Ruby 2.2+
 * A burning desire to write less code.
-
+* Ruby 2.3+
+    
 ## Install
 
 * `gem install optimist_xl`
@@ -94,6 +224,6 @@ Copyright &copy; 2008-2014 [William Morgan](http://masanjin.net/).
 
 Copyright &copy; 2014 Red Hat, Inc.
 
-Copyright &copy; 2019 Ben Bowers
+Copyright &copy; 2019-2020 Ben Bowers
 
 OptimistXL is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/examples/didyoumean.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  opt :cone, "Ice cream cone"
+  opt :zippy, "It zips"
+  opt :zapzy, "It zapz"
+  opt :big_bug, "Madagascar cockroach"
+end
+p opts
+

data/examples/optional_string_arg_type.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+#module OptimistXL
+
+opts = OptimistXL::options do
+  opt :log, "specify optional log-file path", :type => :stringflag, :default => "progname.log"
+end
+p opts
+

data/examples/partialmatch.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  opt :apple, "An apple"
+  opt :apple_sauce, "Cooked apple puree"
+  opt :atom, "Smallest unit of ordinary matter"
+  opt :anvil, "Heavy metal"
+  opt :anteater, "Eats ants"
+end
+p opts

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.2.0"
+VERSION = "3.3.0"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the OptimistXL::options entry.
@@ -402,15 +402,34 @@ class Parser
       # The block returns the number of parameters taken.
       num_params_taken = 0
 
-      unless params.empty?
-        if @specs[sym].single_arg?
-          given_args[sym][:params] << params[0, 1]  # take the first parameter
-          num_params_taken = 1
-        elsif @specs[sym].multi_arg?
-          given_args[sym][:params] << params        # take all the parameters
+      #DEBUG# puts "\nparams:#{params} npt:#{num_params_taken},ps:#{params.size}"
+
+      #if params.size > 0
+      #  if @specs[sym].min_args == 1 && @specs[sym].max_args == 1
+      #    given_args[sym][:params] << params[0, 1]  # take the first parameter
+      #    num_params_taken = 1
+      #  elsif @specs[sym].max_args > 1
+      #    given_args[sym][:params] << params        # take all the parameters
+      #    num_params_taken = params.size
+      #  end
+      #end
+
+      if params.size == 0
+        if @specs[sym].min_args == 0
+          given_args[sym][:params] << [ @specs[sym].default || true]
+        end
+      elsif params.size > 0
+        if params.size >= @specs[sym].max_args
+          # take smaller of the two sizes to determine how many parameters to take
+          num_params_taken = [params.size, @specs[sym].max_args].min
+          given_args[sym][:params] << params[0, num_params_taken]
+        else
+          # take all the parameters
+          given_args[sym][:params] << params        
           num_params_taken = params.size
         end
       end
+      
 
       num_params_taken
     end
@@ -443,7 +462,8 @@ class Parser
       arg, params, negative_given = given_data.values_at :arg, :params, :negative_given
 
       opts = @specs[sym]
-      if params.empty? && !opts.flag?
+
+      if params.size < opts.min_args
         raise CommandlineError, "option '#{arg}' needs a parameter" unless opts.default
         params << (opts.array_default? ? opts.default.clone : [opts.default])
       end
@@ -458,13 +478,19 @@ class Parser
 
       vals[sym] = opts.parse(params, negative_given)
 
-      if opts.single_arg?
+      if opts.min_args==0 && opts.max_args==1
+        if opts.multi?
+          vals[sym] = vals[sym].map { |p| p[0] }
+        else
+          vals[sym] = vals[sym][0][0]
+        end
+      elsif opts.min_args==1 && opts.max_args==1
         if opts.multi?        # multiple options, each with a single parameter
           vals[sym] = vals[sym].map { |p| p[0] }
         else                  # single parameter
           vals[sym] = vals[sym][0][0]
         end
-      elsif opts.multi_arg? && !opts.multi?
+      elsif opts.max_args>1 && !opts.multi?
         vals[sym] = vals[sym][0]  # single option, with multiple parameters
       end
       # else: multiple options, with multiple parameters
@@ -847,6 +873,17 @@ class Option
     @permitted = nil
     @permitted_response = "option '%{arg}' only accepts %{valid_string}"
     @optshash = Hash.new()
+    @min_args = 1
+    @max_args = 1
+    # maximum max_args is likely ~~ 128*1024, as linux MAX_ARG_STRLEN is 128kiB
+  end
+
+  
+  # Check that an option is compatible with another option.
+  # By default, checking that they are the same class, but we
+  # can override this in the subclass as needed.
+  def compatible_with?(other_option)
+    self.is_a? other_option.class
   end
 
   def opts(key)
@@ -857,24 +894,24 @@ class Option
     @optshash = o
   end
 
-  ## Indicates a flag option, which is an option without an argument
-  def flag? ; false ; end
-  def single_arg?
-    !self.multi_arg? && !self.flag?
-  end
 
   def multi ; @multi_given ; end
   alias multi? multi
 
-  ## Indicates that this is a multivalued (Array type) argument
-  def multi_arg? ; false ; end
-  ## note: Option-Types with both multi_arg? and flag? false are single-parameter (normal) options.
-
+  attr_reader :min_args, :max_args
+  # |@min_args | @max_args |
+  # +----------+-----------+
+  # | 0        | 0         | formerly flag?==true (option without any arguments)
+  # | 1        | 1         | formerly single_arg?==true (single-parameter/normal option)
+  # | 1        | >1        | formerly multi_arg?==true 
+  # | ?        | ?         | presumably illegal condition. untested.
+  
   def array_default? ; self.default.kind_of?(Array) ; end
 
   def doesnt_need_autogen_short ; !short.auto || !short.chars.empty? ; end
 
   def callback ; opts(:callback) ; end
+  
   def desc ; opts(:desc) ; end
 
   def required? ; opts(:required) ; end
@@ -890,7 +927,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 + (min_args==0 && default ? ", --no-#{long}" : "")
   end
 
   ## Format the educate-line description including the default and permitted value(s)
@@ -998,9 +1035,11 @@ class Option
 
     opttype = OptimistXL::Parser.registry_getopttype(opts[:type])
     opttype_from_default = get_klass_from_default(opts, opttype)
-
-    raise ArgumentError, ":type specification and default type don't match (default type is #{opttype_from_default.class})" if opttype && opttype_from_default && (opttype.class != opttype_from_default.class)
-
+    #DEBUG# puts "\nopt:#{opttype||'nil'} ofd:#{opttype_from_default}"  if opttype_from_default
+    if opttype && opttype_from_default && !opttype.compatible_with?(opttype_from_default) # opttype.is_a? opttype_from_default.class
+      raise ArgumentError, ":type specification (#{opttype.class}) and default type don't match (default type is #{opttype_from_default.class})" 
+    end
+    
     opt_inst = (opttype || opttype_from_default || OptimistXL::BooleanOption.new)
 
     ## fill in :long
@@ -1034,7 +1073,7 @@ class Option
     if disambiguated_default.is_a? Array
       return(optdef.first.class.name.downcase + "s") if !optdef.empty?
       if opttype
-        raise ArgumentError, "multiple argument type must be plural" unless opttype.multi_arg?
+        raise ArgumentError, "multiple argument type must be plural" unless opttype.max_args > 1
         return nil
       else
         raise ArgumentError, "multiple argument type cannot be deduced from an empty array"
@@ -1063,16 +1102,42 @@ class Option
   private_class_method :get_type_from_disdef
   private_class_method :get_klass_from_default
 
+  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
+  
 end
 
 # Flag option.  Has no arguments. Can be negated with "no-".
 class BooleanOption < Option
   register_alias :flag, :bool, :boolean, :trueclass, :falseclass
+
   def initialize
     super()
     @default = false
+    @min_args = 0
+    @max_args = 0
   end
-  def flag? ; true ; end
+  
   def parse(_paramlist, neg_given)
     return(self.name.to_s =~ /^no_/ ? neg_given : !neg_given)
   end
@@ -1139,6 +1204,38 @@ class StringOption < Option
   end
 end
 
+# 
+class StringFlagOption < StringOption
+  register_alias :stringflag
+  def type_format ; "=<s?>" ; end
+  def parse(paramlist, neg_given)
+    paramlist.map do |plist|
+      plist.map do |pg|
+        neg_given ? false : pg
+        #case pg
+        #when FalseClass then () ? neg_given : !neg_given
+        #when TrueClass then (self.name.to_s =~ /^no_/) ? neg_given : !neg_given
+        #else pg
+        #end
+      end
+    end
+  end
+
+  def initialize
+    super
+    @default = false
+    @min_args = 0
+    @max_args = 1
+  end
+  
+  def compatible_with?(other_option)
+    self.is_a?(other_option.class) ||
+      other_option.is_a?(BooleanOption) ||
+      other_option.is_a?(StringArrayOption)
+  end
+
+end
+
 # Option for dates.  No longer uses Chronic if available.
 # If chronic style dates are needed, then you may
 # require 'optimist_xl/chronic'
@@ -1169,35 +1266,35 @@ end
 class IntegerArrayOption < IntegerOption
   register_alias :fixnums, :ints, :integers
   def type_format ; "=<i+>" ; end
-  def multi_arg? ; true ; end
+  def initialize ; super ; @max_args = 999 ; end
 end
 
 # Option class for handling multiple Floats
 class FloatArrayOption < FloatOption
   register_alias :doubles, :floats
   def type_format ; "=<f+>" ; end
-  def multi_arg? ; true ; end
+  def initialize ; super ; @max_args = 999 ; end
 end
 
 # Option class for handling multiple Strings
 class StringArrayOption < StringOption
   register_alias :strings
   def type_format ; "=<s+>" ; end
-  def multi_arg? ; true ; end
+  def initialize ; super ; @max_args = 999 ; end
 end
 
 # Option class for handling multiple dates
 class DateArrayOption < DateOption
   register_alias :dates
   def type_format ; "=<date+>" ; end
-  def multi_arg? ; true ; end
+  def initialize ; super ; @max_args = 999 ; end
 end
 
 # Option class for handling Files/URLs via 'open'
 class IOArrayOption < IOOption
   register_alias :ios
   def type_format ; "=<filename/uri+>" ; end
-  def multi_arg? ; true ; end
+  def initialize ; super ; @max_args = 999 ; end
 end
 
 ## The easy, syntactic-sugary entry method into OptimistXL. Creates a Parser,
@@ -1342,13 +1439,3 @@ end
 
 module_function :options, :die, :educate, :with_standard_exception_handling
 end # module
-
-
-# @global_parser.stop_on(subcommands)
-#        @global_parser.stop_on_unknown
-#        Trollop::with_standard_exception_handling(@global_parser) do
-#          global_options = @global_parser.parse(args)
-#          cmd = parse_subcommand(args)
-#          cmd_options = parse_subcommand_options(args, cmd)
-#          Result.new(global_options, cmd, cmd_options)
-#        end

data/optimist_xl.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = "nanobowers@gmail.com"
   spec.summary       = "OptimistXL is feature fork of the Optimist commandline option parser."
   spec.description   = "OptimistXL is feature filled but lightweight commandline option parser.
+It contains all of the features of the Optimist gem, plus lots of additional features you didnt know you needed.
 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
@@ -32,6 +33,6 @@ specify.  This gem is an enhanced-feature fork of the Optimist gem."
   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 "rake", ">= 12.3.3"
   spec.add_development_dependency "chronic"
 end

data/test/optimist_xl/stringflag_test.rb

@@ -0,0 +1,158 @@
+require 'stringio'
+require 'test_helper'
+
+module OptimistXL
+  class StringFlagParserTest < ::MiniTest::Test
+    def setup
+      @p = Parser.new
+    end
+
+    # in this case, the stringflag should return false
+    def test_stringflag_unset
+      @p.opt :xyz, "desc", :type => :stringflag
+      @p.opt :abc, "desc", :type => :flag
+      opts = @p.parse %w()
+      assert_equal false, opts[:xyz]
+      assert_equal false, opts[:abc]
+      opts = @p.parse %w(--abc)
+      assert_equal false, opts[:xyz]
+      assert_equal true, opts[:abc]
+    end
+
+    # in this case, the stringflag should return true
+    def test_stringflag_as_flag
+      @p.opt :xyz, "desc", :type => :stringflag
+      @p.opt :abc, "desc", :type => :flag
+      opts = @p.parse %w(--xyz )
+      assert_equal true, opts[:xyz_given]
+      assert_equal true, opts[:xyz]
+      assert_equal false, opts[:abc]
+      opts = @p.parse %w(--xyz --abc)
+      assert_equal true, opts[:xyz_given]
+      assert_equal true, opts[:xyz]
+      assert_equal true, opts[:abc]
+    end
+
+    # in this case, the stringflag should return a string
+    def test_stringflag_as_string
+      @p.opt :xyz, "desc", :type => :stringflag
+      @p.opt :abc, "desc", :type => :flag
+      opts = @p.parse %w(--xyz abcd)
+      assert_equal true, opts[:xyz_given]
+      assert_equal "abcd", opts[:xyz]
+      assert_equal false, opts[:abc]
+      opts = @p.parse %w(--xyz abcd --abc)
+      assert_equal true, opts[:xyz_given]
+      assert_equal "abcd", opts[:xyz]
+      assert_equal true, opts[:abc]
+    end
+
+    def test_stringflag_with_string_default
+      @p.opt :log, "desc", :type => :stringflag, default: "output.log"
+      opts = @p.parse []
+      assert_nil opts[:log_given]
+      assert_equal "output.log", opts[:log]
+
+      opts = @p.parse %w(--no-log)
+      assert_equal true, opts[:log_given]
+      assert_equal false, opts[:log]
+
+      opts = @p.parse %w(--log)
+      assert_equal true, opts[:log_given]
+      assert_equal "output.log", opts[:log]
+
+      opts = @p.parse %w(--log other.log)
+      assert_equal true, opts[:log_given]
+      assert_equal "other.log", opts[:log]
+    end
+
+    # should be same as with no default, but making sure.
+    def test_stringflag_with_false_default
+      @p.opt :log, "desc", :type => :stringflag, default: false
+      opts = @p.parse []
+      assert_nil opts[:log_given]
+      assert_equal false, opts[:log]
+
+      opts = @p.parse %w(--no-log)
+      assert_equal true, opts[:log_given]
+      assert_equal false, opts[:log]
+
+      opts = @p.parse %w(--log)
+      assert_equal true, opts[:log_given]
+      assert_equal true, opts[:log]
+
+      opts = @p.parse %w(--log other.log)
+      assert_equal true, opts[:log_given]
+      assert_equal "other.log", opts[:log]
+    end
+    
+    def test_stringflag_with_no_defaults
+      @p.opt :log, "desc", :type => :stringflag
+        
+      opts = @p.parse []
+      assert_nil opts[:log_given]
+      assert_equal false, opts[:log]
+
+      opts = @p.parse %w(--no-log)
+      assert_equal true, opts[:log_given]
+      assert_equal false, opts[:log]
+
+      opts = @p.parse %w(--log)
+      assert_equal true, opts[:log_given]
+      assert_equal true, opts[:log]
+
+      opts = @p.parse %w(--log other.log)
+      assert_equal true, opts[:log_given]
+      assert_equal "other.log", opts[:log]
+      
+    end
+  end
+
+  class MultiStringFlagParserTest < ::MiniTest::Test
+    def setup
+      @p = Parser.new
+      @p.opt :xyz, "desc", :type => :stringflag, :multi => true
+      @p.opt :ghi, "desc", :type => :stringflag, :multi => true, default: ["gg","hh"]
+      @p.opt :abc, "desc", :type => :string, :multi => true
+    end
+
+    # in this case, the stringflag should return multiple strings
+    def test_multi_stringflag_as_strings
+      opts = @p.parse %w(--xyz dog --xyz cat)
+      assert_equal true, opts[:xyz_given]
+      assert_equal ["dog","cat"], opts[:xyz]
+      assert_equal [], opts[:abc] # note, multi-args default to empty array
+      assert_nil opts[:ghi_given]
+      assert_equal ["gg","hh"], opts[:ghi]
+    end
+
+    def test_multi_stringflag_as_flags
+      opts = @p.parse %w(--xyz --xyz --xyz)
+      assert_equal true, opts[:xyz_given]
+      assert_equal [true, true, true], opts[:xyz]
+    end
+
+    def test_multi_stringflag_as_mix1
+      opts = @p.parse %w(--xyz --xyz dog --xyz cat)
+      assert_equal true, opts[:xyz_given]
+      assert_equal [true, "dog", "cat"], opts[:xyz]
+    end
+
+    def test_multi_stringflag_as_mix2
+      opts = @p.parse %w(--xyz dog --xyz cat --xyz --abc letters)
+      assert_equal true, opts[:xyz_given]
+      assert_equal ["dog", "cat", true], opts[:xyz]
+      assert_equal ["letters"], opts[:abc]
+    end
+
+    def test_multi_stringflag_override_array_default
+      opts = @p.parse %w(--xyz --ghi yy --ghi zz)
+      assert_equal true, opts[:xyz_given]
+      assert_equal true, opts[:ghi_given]
+      assert_equal ["yy","zz"], opts[:ghi]
+    end
+
+  end
+    
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimist_xl
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - William Morgan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -31,16 +31,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +57,7 @@ dependencies:
         version: '0'
 description: |-
   OptimistXL is feature filled but lightweight commandline option parser.
+  It contains all of the features of the Optimist gem, plus lots of additional features you didnt know you needed.
   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
@@ -79,7 +80,10 @@ files:
 - examples/banners1.rb
 - examples/banners2.rb
 - examples/banners3.rb
+- examples/didyoumean.rb
 - examples/medium_example.rb
+- examples/optional_string_arg_type.rb
+- examples/partialmatch.rb
 - examples/permitted.rb
 - examples/subcommands.rb
 - examples/types.rb
@@ -95,6 +99,7 @@ files:
 - test/optimist_xl/parser_parse_test.rb
 - test/optimist_xl/parser_test.rb
 - test/optimist_xl/permitted_test.rb
+- test/optimist_xl/stringflag_test.rb
 - test/optimist_xl/subcommands_test.rb
 - test/optimist_xl/version_needed_test.rb
 - test/optimist_xl_test.rb
@@ -122,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: OptimistXL is feature fork of the Optimist commandline option parser.
@@ -136,6 +140,7 @@ test_files:
 - test/optimist_xl/parser_parse_test.rb
 - test/optimist_xl/parser_test.rb
 - test/optimist_xl/permitted_test.rb
+- test/optimist_xl/stringflag_test.rb
 - test/optimist_xl/subcommands_test.rb
 - test/optimist_xl/version_needed_test.rb
 - test/optimist_xl_test.rb