optimist 3.0.0

data/test/optimist/version_needed_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Optimist
+  class VersionNeededTest < ::MiniTest::Test
+    def test_class
+      assert_kind_of Exception, vn("message")
+    end
+
+    def test_message
+      assert "message", vn("message").message
+    end
+
+    private
+
+    def vn(*args)
+      VersionNeeded.new(*args)
+    end
+  end
+end

data/test/optimist_test.rb

@@ -0,0 +1,190 @@
+require 'test_helper'
+
+class OptimistTest < MiniTest::Test
+  def setup
+    Optimist.send(:instance_variable_set, "@last_parser", nil)
+  end
+
+  def parser(&block)
+    Optimist::Parser.new(&block)
+  end
+
+  def test_options
+    opts = Optimist.options %w(-f) do
+      opt :f
+    end
+
+    assert_equal true, opts[:f]
+  end
+
+  def test_options_die_default
+    assert_stderr(/Error: unknown argument.*Try --help/m) do
+      assert_system_exit(-1) do
+        Optimist.options %w(-f) do
+          opt :x
+        end
+      end
+    end
+  end
+
+  def test_options_die_educate_on_error
+    assert_stderr(/Error: unknown argument.*Options/m) do
+      assert_system_exit(-1) do
+        Optimist.options %w(-f) do
+          opt :x
+          educate_on_error
+        end
+      end
+    end
+  end
+
+  def test_die_without_options_ever_run
+    assert_raises(ArgumentError) { Optimist.die 'hello' }
+  end
+
+  def test_die
+    assert_stderr(/Error: issue with parsing/) do
+      assert_system_exit(-1) do
+        Optimist.options []
+        Optimist.die "issue with parsing"
+      end
+    end
+  end
+
+  def test_die_custom_error_code
+    assert_stderr(/Error: issue with parsing/) do
+      assert_system_exit(5) do
+        Optimist.options []
+        Optimist.die "issue with parsing", nil, 5
+      end
+    end
+  end
+
+  def test_die_custom_error_code_two_args
+    assert_stderr(/Error: issue with parsing/) do
+      assert_system_exit(5) do
+        Optimist.options []
+        Optimist.die "issue with parsing", 5
+      end
+    end
+  end
+
+  def test_educate_without_options_ever_run
+    assert_raises(ArgumentError) { Optimist.educate }
+  end
+
+  def test_educate
+    assert_stdout(/Show this message/) do
+      assert_system_exit(0) do
+        Optimist.options []
+        Optimist.educate
+      end
+    end
+  end
+
+  def test_with_standard_exception_options
+    p = parser do
+      opt :f
+    end
+
+    opts = Optimist::with_standard_exception_handling p do
+      p.parse %w(-f)
+    end
+
+    assert_equal true, opts[:f]
+  end
+
+  def test_with_standard_exception_version_exception
+    p = parser do
+      version "5.5"
+    end
+
+    assert_stdout(/5\.5/) do
+      assert_system_exit(0) do
+        Optimist::with_standard_exception_handling p do
+          raise Optimist::VersionNeeded
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_version_flag
+    p = parser do
+      version "5.5"
+    end
+
+    assert_stdout(/5\.5/) do
+      assert_system_exit(0) do
+        Optimist::with_standard_exception_handling p do
+          p.parse %w(-v)
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_die_exception
+    assert_stderr(/Error: cl error/) do
+      assert_system_exit(-1) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          raise ::Optimist::CommandlineError.new('cl error')
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_die_exception_custom_error
+    assert_stderr(/Error: cl error/) do
+      assert_system_exit(5) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          raise ::Optimist::CommandlineError.new('cl error', 5)
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_die
+    assert_stderr(/Error: cl error/) do
+      assert_system_exit(-1) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          p.die 'cl error'
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_die_custom_error
+    assert_stderr(/Error: cl error/) do
+      assert_system_exit(3) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          p.die 'cl error', nil, 3
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_help_needed
+    assert_stdout(/Options/) do
+      assert_system_exit(0) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          raise Optimist::HelpNeeded
+        end
+      end
+    end
+  end
+
+  def test_with_standard_exception_help_needed_flag
+    assert_stdout(/Options/) do
+      assert_system_exit(0) do
+        p = parser
+        Optimist.with_standard_exception_handling(p) do
+          p.parse(%w(-h))
+        end
+      end
+    end
+  end
+end

data/test/support/assert_helpers.rb

@@ -0,0 +1,46 @@
+module Minitest::Assertions
+  def assert_parses_correctly(parser, commandline, expected_opts,
+                              expected_leftovers)
+    opts = parser.parse commandline
+    assert_equal expected_opts, opts
+    assert_equal expected_leftovers, parser.leftovers
+  end
+
+  def assert_stderr(str = nil, msg = nil)
+    msg = "#{msg}.\n" if msg
+
+    old_stderr, $stderr = $stderr, StringIO.new('')
+    yield
+    assert_match str, $stderr.string, msg if str
+  ensure
+    $stderr = old_stderr
+  end
+
+  def assert_stdout(str = nil, msg = nil)
+    msg = "#{msg}.\n" if msg
+
+    old_stdout, $stdout = $stdout, StringIO.new('')
+    yield
+    assert_match str, $stdout.string, msg if str
+  ensure
+    $stdout = old_stdout
+  end
+
+  # like assert raises, but if it does raise, it checks status
+  # NOTE: this does not ensure the exception is raised
+  def assert_system_exit *exp
+    msg = "#{exp.pop}.\n" if String === exp.last
+    status = exp.first
+
+    begin
+      yield
+    rescue SystemExit => e
+      assert_equal status, e.status {
+        exception_details(e, "#{msg}#{mu_pp(exp)} exception expected, not")
+      } if status
+      return true
+    end
+    flunk "#{msg}#{mu_pp(exp)} SystemExit expected but nothing was raised."
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+unless ENV['MUTANT']
+  begin
+  require "coveralls"
+  Coveralls.wear! do
+    add_filter '/test/'
+  end
+  rescue LoadError
+  end
+end
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+require 'minitest/autorun'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
+require 'optimist'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: optimist
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- William Morgan
+- Keenan Brock
+- Jason Frey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  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'
+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.
+  For that, you get a nice automatically-generated help page, robust option
+  parsing, command subcompletion, and sensible defaults for everything you don't
+  specify.
+email: keenan@thebrocks.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- FAQ.txt
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- lib/optimist.rb
+- optimist.gemspec
+- test/optimist/command_line_error_test.rb
+- test/optimist/help_needed_test.rb
+- test/optimist/parser_educate_test.rb
+- test/optimist/parser_opt_test.rb
+- test/optimist/parser_parse_test.rb
+- test/optimist/parser_test.rb
+- test/optimist/version_needed_test.rb
+- test/optimist_test.rb
+- test/support/assert_helpers.rb
+- test/test_helper.rb
+homepage: http://manageiq.github.io/optimist/
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Optimist is a commandline option parser for Ruby that just gets out of your
+  way.
+test_files:
+- test/optimist/command_line_error_test.rb
+- test/optimist/help_needed_test.rb
+- test/optimist/parser_educate_test.rb
+- test/optimist/parser_opt_test.rb
+- test/optimist/parser_parse_test.rb
+- test/optimist/parser_test.rb
+- test/optimist/version_needed_test.rb
+- test/optimist_test.rb
+- test/support/assert_helpers.rb
+- test/test_helper.rb