optimist_xl 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d15a0ddf0d2205266ff1df22f86c3e96c9bcccfe449394840194269ff35de564
+  data.tar.gz: b84c5a820184de6941b54054d7ab3786be5c4b75b5e934d99021e21838cb1355
+SHA512:
+  metadata.gz: fbe733a8b0f74918aef616ed3a2d1d5a6f9ff7cc414de871f8bdfb33aba1186899f4d25c8e66c08bfbfe3dc2dcc87514e7d2b2e3f1859d1b96a4bddc773c2c77
+  data.tar.gz: 8de3c39ad1356af6b5e599127b0afefd78e4ccec11f5ec06b801eac94ad631a5e6fa1c266f64e94c2a0b8c11a137a6978409767c2d657266eb0643a51b688541

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.swp
+*.o
+*.a
+mkmf.log
+
+# dont checkin emacs tempfiles
+*~
+.\#*

data/.travis.yml

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

data/FAQ.txt

@@ -0,0 +1,92 @@
+Optimist FAQ
+-----------
+
+Q: Why should I use Optimist?
+A: Because it will take you fewer lines of code to parse commandline arguments
+   than anything else out there.
+
+   Like this:
+     opts = Optimist::options do
+       opt :monkey, "Use monkey mode"
+       opt :goat, "Use goat mode", :default => true
+       opt :num_limbs, "Set number of limbs", :default => 4
+     end
+
+   That's it. 'opts' will be a hash and you can do whatever you want with it.
+   You don't have to mix processing code with the declarations. You don't have
+   to make a class for every option (what is this, Java?). You don't have to
+   write more than 1 line of code per option.
+
+   Plus, you get a beautiful help screen that detects your terminal width and
+   wraps appropriately.
+
+Q: What is the philosophy behind Optimist?
+A: Optimist does the parsing and gives you a hash table of options. You then
+   write whatever fancy constraint logic you need as regular Ruby code operating
+   on that hash table.
+
+   (Optimist does support limited constraints (see #conflicts and #depends), but
+   any non-trivial program will probably need to get fancier.)
+
+   Then if you need to abort and tell the user to fix their command line at any
+   point, you can call #die and Optimist will do that for you in a pretty way.
+
+Q: What happens to the other stuff on the commandline?
+A: Anything Optimist doesn't recognize as an option or as an option parameter is
+   left in ARGV for you to process.
+
+Q: Does Optimist support multiple-value arguments?
+A: Yes. If you set the :type of an option to something plural, like ":ints",
+   ":strings", ":doubles", ":floats", ":ios", it will accept multiple arguments
+   on the commandline, and the value will be an array of the parameters.
+
+Q: Does Optimist support arguments that can be given multiple times?
+A: Yes. If you set :multi to true, then the argument can appear multiple times
+   on the commandline, and the value will be an array of the parameters.
+
+Q: Does Optimist support subcommands?
+A: Yes: you can direct Optimist to stop processing when it encounters certain
+   tokens. Then you can re-call Optimist with the subcommand-specific
+   configuration to process the rest of the commandline.
+
+   See the third example on the webpage.
+
+   (And if you don't know the subcommands ahead of time, you can call
+   #stop_on_unknown, which will cause Optimist to stop when it encounters any
+   unknown token. This might be more trouble than its worth if you're also
+   passing filenames on the commandline.)
+
+Q: Why does Optimist disallow numeric short argument names, like '-1' and '-9'?
+A: Because it's ambiguous whether these are arguments or negative integer or
+   floating-point parameters to arguments. E.g., is "-f -3" a negative floating
+   point parameter to -f, or two separate arguments?
+
+Q: What was the big change in version 2.0?
+A: The big change was boolean parameter (aka flag) handling. In pre-2.0,
+   not specifying a flag on the commandline would result in the option being set
+   to its default value; specifying it on the commandline would result in the
+   option being set to the opposite of its default value. This was weird for
+   options with a default of true:
+     opt :magic, "Use magic", default: true
+   Using --magic with the above configuration would result in a :magic => false
+   value in the options hash.
+
+   In 2.0, we introduce the GNU-style notion of a --no-x parameter. Now,
+   specifying --x will always set the option :x to true, regardless of its
+   default value, and specifying --no-x will always set the option :x to false,
+   regardless of its default value. The default value only comes into play when
+   neither form is given on the commandline.
+
+   E.g.:
+     opt :magic, "Use magic", :default => true
+
+   Using --magic will result in :magic => true, and --no-magic will result in
+   :magic => false, and neither will result in :magic => true.
+
+   There is one exception: if the option itself starts with a "no_", then you'll
+   get the opposite behavior:
+
+     opt :no_magic, "Don't use magic", :default => true
+
+   Using --magic will result in :no_magic => false, and --no-magic will result in
+   :no_magic => true, and neither will result in :no_magic => true.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gemspec
+gemspec

data/History.txt

@@ -0,0 +1,177 @@
+== [3.1.1] / 2020-01-20
+
+* The gem has been forked from optimist to optimist_xl
+* Added "native" subcommands support
+* defaulting to inexact-match of long options
+* defaulting to enabling suggestions for mistyped options
+* ability to globally prevent short-options by default
+* permitted and permitted_response keywords now available
+
+== [3.0.0] / 2018-08-24
+
+* The gem has been officially renamed to optimist
+
+== [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)
+* Various warning cleanup for ruby 2.1, 2.3, etc. (thanks @nanobowers)
+* Optimist.die can now accept an error code.
+* fixed default (thanks @nanobowers)
+* Change from ruby license to MIT license in the code.
+
+== [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
+* 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
+* 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.
+* Add Parser#ignore_invalid_options to prevent erroring on unknown options.
+* Allow flags to act as switches if they have defaults set and no value is
+  passed on the commandline
+* Parser#opt learned to accept a block or a :callback option which it will call
+  after parsing the option.
+* Add Optimist::educate which displays the help message and dies.
+* Reformat help message to be more GNUish.
+* Fix command name in help message when script has no extension.
+* Fix handling of newlines inside descriptions
+* Documentation and other fixes.
+
+== 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
+  menu. Accept both versions on the commandline.
+* Fix a spurious warning
+* Update Rakefile to 1.9
+* Minor documentation fixes
+
+== 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
+* Bugfix in Optimist::die method introduced in last release.
+
+== 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
+* 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
+* Make :multi arguments default to [], not nil, when not set on the commandline.
+* Minor commenting and error message improvements
+
+== 1.13 / 2009-03-16
+* Fix parsing of "--longarg=<value with spaces>".
+
+== 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
+* Set <opt>_given keys in the results hash for options that were specified
+  on the commandline.
+
+== 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
+* 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
+* 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
+* 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.)
+* Added a :multi option for parameters, signifying that they can be specified
+  multiple times.
+* Added :ints, :strings, :doubles, and :floats option types, which can take
+  multiple arguments.
+
+== 1.8.2 / 2008-06-25
+* Bugfix for #conflicts and #depends error messages
+
+== 1.8.1 / 2008-06-24
+* Bugfix for short option autocreation
+* More aggressive documentation
+
+== 1.8 / 2008-06-16
+* Sub-command support via Parser#stop_on
+
+== 1.7.2 / 2008-01-16
+* Ruby 1.9-ify. Apparently this means replacing :'s with ;'s.
+
+== 1.7.1 / 2008-01-07
+* Documentation improvements
+
+== 1.7 / 2007-06-17
+* Fix incorrect error message for multiple missing required arguments
+  (thanks to Neill Zero)
+
+== 1.6 / 2007-04-01
+* Don't attempt curses screen-width magic unless running on a terminal.
+
+== 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
+* Disable short options with :short => :none.
+* Minor bugfixes and error message improvements.
+
+== 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
+* Minor documentation tweaks.
+* Removed hoe dependency.
+
+== 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.
+  (A real-life use for _why's cloaker!)
+* Help display now preserves original argument order.
+* Optimist::die now also has a single string form in case death is not
+  due to a single argument.
+* Parser#text now an alias for Parser#banner, and can be called
+  multiple times, with the output being placed in the right position
+  in the help text.
+* Slightly more indicative formatting for parameterized arguments.
+
+== 1.0 / 2007-01-29
+* Initial release.
+
+[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/README.md

@@ -0,0 +1,81 @@
+# OptimistXL
+
+http://github.com/nanobowers/optimist_xl
+
+[![Build Status](https://travis-ci.org/nanobowers/optimist_xl.svg)](https://travis-ci.org/nanobowers/optimist_xl)
+
+## Documentation
+
+- Wiki: http://github.com/nanobowers/optimist_xl/wiki
+- Examples: http://github.com/nanobowers/optimist_xl/tree/master/examples
+- Code quickstart: See `OptimistXL.options` and then `OptimistXL::Parser#opt`.
+
+## 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. For that, you get a nice
+automatically-generated help page, robust option parsing, and sensible defaults
+for everything you don't specify.
+
+## Features
+
+- Dirt-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
+
+### Parser Settings
+- Automatic suggestions whens incorrect options are given
+    - disable with `suggestions: false`
+- Inexact matching of long arguments
+    - disable with `exact_match: true`
+- Available prevention of short-arguments by default
+    - enable with `explicit_short_opts: true`
+
+### Option Settings
+
+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
+
+### Subcommands
+"Native" subcommand support
+- see [example](examples/subcommands.rb)
+- ideas borrowed from https://github.com/jwliechty/trollop-subcommands
+
+## Requirements
+
+* Ruby 2.2+
+* A burning desire to write less code.
+
+## Install
+
+* `gem install optimist_xl`
+
+## Synopsis
+
+```ruby
+require 'optimist_xl'
+opts = OptimistXL::options do
+  opt :monkey, "Use monkey mode"                    # flag --monkey, default false
+  opt :name, "Monkey name", :type => :string        # string --name <s>, default nil
+  opt :num_limbs, "Number of limbs", :default => 4  # integer --num-limbs <i>, default to 4
+end
+
+p opts # a hash: { :monkey=>false, :name=>nil, :num_limbs=>4, :help=>false }
+```
+
+## License
+
+Copyright &copy; 2008-2014 [William Morgan](http://masanjin.net/).
+
+Copyright &copy; 2014 Red Hat, Inc.
+
+Copyright &copy; 2019 Ben Bowers
+
+OptimistXL is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end
+
+begin
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+rescue LoadError
+end

data/examples/a_basic_example.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  opt :monkey, "Use monkey mode"                    # flag --monkey, default false
+  opt :name, "Monkey name", :type => :string        # string --name <s>, default nil
+  opt :num_limbs, "Number of limbs", :default => 4  # integer --num-limbs <i>, default to 4
+end
+p opts
+

data/examples/banners1.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  synopsis "Overall synopsis of this program"
+  version "cool-script v0.3 (code-name: apple-cake)"
+  opt :juice, "use juice"
+  opt :milk, "use milk"
+  opt :litres, "quantity of liquid", :default => 2.0
+  opt :brand, "brand name of the liquid", :type => :string
+end

data/examples/banners2.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require_relative '../lib/optimist_xl'
+
+opts = OptimistXL::options do
+  synopsis "Overall synopsis of this program"
+  version "cool-script v0.3.1 (code-name: apple-cake)"
+  banner "My Banner"
+  opt :juice, "use juice"
+  opt :milk, "use milk"
+  opt :litres, "quantity of liquid", :default => 2.0
+  opt :brand, "brand name of the liquid", :type => :string
+end