trollop 2.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be70256e210067fa6547103ba32b51a4242a6382
+  data.tar.gz: 958ed3d139b74b319cf793208d7482c634663fbc
+SHA512:
+  metadata.gz: 36ba799aa516cf9160cfce8809c45939bdfef580dac0f30f8c8bac85f6e1e1a13bd0f786eb7b8da79006a4f4677bd2e8bb036262a917db9ab5714c2910f5789c
+  data.tar.gz: 6ffcdcf7434e5182eb8aca04cf1fbcdfd63d65e5af5a9b360e80a72c7a18ff39f45a7afe4fa429796ba6d1f297d28b1abbc32caf360f8a7a73643c06b7d84fb5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.swp
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0"
+  - "2.1"

data/FAQ.txt

@@ -93,6 +93,3 @@ A: The big change was boolean parameter (aka flag) handling. In pre-2.0,
 
    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 trollop.gemspec
+gemspec

data/History.txt

@@ -1,3 +1,18 @@
+== 2.1.0 / 2014-12-23
+* 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 Trollop::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.

data/README.md

@@ -0,0 +1,57 @@
+# trollop
+
+http://manageiq.github.io/trollop/
+
+[![Gem Version](https://badge.fury.io/rb/trollop.svg)](http://badge.fury.io/rb/trollop)
+[![Build Status](https://travis-ci.org/ManageIQ/trollop.svg)](https://travis-ci.org/ManageIQ/trollop)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/trollop/badges/gpa.svg)](https://codeclimate.com/github/ManageIQ/trollop)
+[![Coverage Status](http://img.shields.io/coveralls/ManageIQ/trollop.svg)](https://coveralls.io/r/ManageIQ/trollop)
+[![Dependency Status](https://gemnasium.com/ManageIQ/trollop.svg)](https://gemnasium.com/ManageIQ/trollop)
+
+Documentation quickstart: See Trollop.options and then Trollop::Parser#opt.
+Also see the examples at http://manageiq.github.io/trollop/.
+
+## Description
+
+Trollop 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.
+- Single file. Throw it in lib/ if you don't want to make it a Rubygem dependency.
+- 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.
+
+## Requirements
+
+* A burning desire to write less code.
+
+## Install
+
+* gem install trollop
+
+## Synopsis
+
+```ruby
+require 'trollop'
+opts = Trollop::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.
+
+Trollop is licensed under the same terms as Ruby.

data/Rakefile

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

data/lib/trollop.rb

@@ -1,13 +1,12 @@
-## lib/trollop.rb -- trollop command-line processing library
-## Author::    William Morgan (mailto: wmorgan-trollop@masanjin.net)
-## Copyright:: Copyright 2007 William Morgan
-## License::   the same terms as ruby itself
+# lib/trollop.rb -- trollop command-line processing library
+# Copyright (c) 2008-2014 William Morgan.
+# Copyright (c) 2014 Red Hat, Inc.
+# trollop is licensed under the same terms as Ruby.
 
 require 'date'
 
 module Trollop
-
-VERSION = "2.0"
+VERSION = "2.1.0"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
@@ -17,7 +16,7 @@ class CommandlineError < StandardError; end
 ## automatically by Trollop#options.
 class HelpNeeded < StandardError; end
 
-## Thrown by Parser if the user passes in '-h' or '--version'. Handled
+## Thrown by Parser if the user passes in '-v' or '--version'. Handled
 ## automatically by Trollop#options.
 class VersionNeeded < StandardError; end
 
@@ -66,6 +65,11 @@ class Parser
   ## for testing.)
   attr_reader :specs
 
+  ## A flag that determines whether or not to raise an error if the parser is passed one or more
+  ##  options that were not registered ahead of time.  If 'true', then the parser will simply
+  ##  ignore options that it does not recognize.
+  attr_accessor :ignore_invalid_options
+
   ## Initializes the parser, and instance-evaluates any block given.
   def initialize *a, &b
     @version = nil
@@ -122,7 +126,7 @@ class Parser
   ## If you want a multi-value, multi-occurrence argument with a default
   ## value, you must specify +:type+ as well.
 
-  def opt name, desc="", opts={}
+  def opt name, desc="", opts={}, &b
     raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? name
 
     ## fill in :type
@@ -220,7 +224,7 @@ class Parser
 
     ## fill in :multi
     opts[:multi] ||= false
-
+    opts[:callback] ||= b if block_given?
     opts[:desc] ||= desc
     @long[opts[:long]] = name
     @short[opts[:short]] = name if opts[:short] && opts[:short] != :none
@@ -233,6 +237,20 @@ class Parser
   ## <version number>".
   def version s=nil; @version = s if s; @version end
 
+  ## Sets the usage string. If set the message will be printed as the
+  ## first line in the help (educate) output and ending in two new
+  ## lines.
+  def usage s=nil; @usage = s if s; @usage end
+
+  ## Sets the usage string. If set the message will be printed as the
+  ## first line in the help (educate) output and ending in two new
+  ## lines.
+  def usage s=nil; @usage = s if s; @usage end
+
+  ## Adds a synopsis (command summary description) right below the
+  ## usage line, or as the first line if usage isn't specified.
+  def synopsis s=nil; @synopsis = s if s; @synopsis end
+
   ## Adds text to the help display. Can be interspersed with calls to
   ## #opt to build a multi-section help page.
   def banner s; @order << [:text, s] end
@@ -245,7 +263,7 @@ class Parser
     syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
     @constraints << [:depends, syms]
   end
-  
+
   ## Marks two (or more!) options as conflicting.
   def conflicts *syms
     syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
@@ -310,7 +328,10 @@ class Parser
 
       sym = nil if arg =~ /--no-/ # explicitly invalidate --no-no- arguments
 
-      raise CommandlineError, "unknown argument '#{arg}'" unless sym
+      unless sym
+        next 0 if ignore_invalid_options
+        raise CommandlineError, "unknown argument '#{arg}'" unless sym
+      end
 
       if given_args.include?(sym) && !@specs[sym][:multi]
         raise CommandlineError, "option '#{arg}' specified multiple times"
@@ -363,7 +384,10 @@ class Parser
       arg, params, negative_given = given_data.values_at :arg, :params, :negative_given
 
       opts = @specs[sym]
-      raise CommandlineError, "option '#{arg}' needs a parameter" if params.empty? && opts[:type] != :flag
+      if params.empty? && opts[:type] != :flag
+        raise CommandlineError, "option '#{arg}' needs a parameter" unless opts[:default]
+        params << [opts[:default]]
+      end
 
       vals["#{sym}_given".intern] = true # mark argument as specified on the commandline
 
@@ -392,6 +416,8 @@ class Parser
         vals[sym] = vals[sym][0]  # single option, with multiple parameters
       end
       # else: multiple options, with multiple parameters
+
+      opts[:callback].call(vals[sym]) if opts.has_key?(:callback)
     end
 
     ## modify input in place with only those
@@ -411,6 +437,7 @@ class Parser
   def parse_date_parameter param, arg #:nodoc:
     begin
       begin
+        require 'chronic'
         time = Chronic.parse(param)
       rescue NameError
         # chronic is not available
@@ -427,28 +454,33 @@ class Parser
           # call this unless the cursor's at the beginning of a line.
     left = {}
     @specs.each do |name, spec|
-      left[name] = "--#{spec[:long]}" +
-        (spec[:type] == :flag && spec[:default] ? ", --no-#{spec[:long]}" : "") +
-        (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
+      left[name] =
+        (spec[:short] && spec[:short] != :none ? "-#{spec[:short]}" : "") +
+        (spec[:short] && spec[:short] != :none ? ", " : "") + "--#{spec[:long]}" +
         case spec[:type]
         when :flag; ""
-        when :int; " <i>"
-        when :ints; " <i+>"
-        when :string; " <s>"
-        when :strings; " <s+>"
-        when :float; " <f>"
-        when :floats; " <f+>"
-        when :io; " <filename/uri>"
-        when :ios; " <filename/uri+>"
-        when :date; " <date>"
-        when :dates; " <date+>"
-        end
+        when :int; "=<i>"
+        when :ints; "=<i+>"
+        when :string; "=<s>"
+        when :strings; "=<s+>"
+        when :float; "=<f>"
+        when :floats; "=<f+>"
+        when :io; "=<filename/uri>"
+        when :ios; "=<filename/uri+>"
+        when :date; "=<date>"
+        when :dates; "=<date+>"
+        end +
+        (spec[:type] == :flag && spec[:default] ? ", --no-#{spec[:long]}" : "")
     end
 
     leftcol_width = left.values.map { |s| s.length }.max || 0
     rightcol_start = leftcol_width + 6 # spaces
 
     unless @order.size > 0 && @order.first.first == :text
+      command_name = File.basename($0).gsub /\.[^.]+$/, ''
+      stream.puts "Usage: #{command_name} #@usage\n" if @usage
+      stream.puts "#@synopsis\n" if @synopsis
+      stream.puts if @usage or @synopsis
       stream.puts "#@version\n" if @version
       stream.puts "Options:"
     end
@@ -460,7 +492,7 @@ class Parser
       end
 
       spec = @specs[opt]
-      stream.printf "  %#{leftcol_width}s:   ", left[opt]
+      stream.printf "  %-#{leftcol_width}s    ", left[opt]
       desc = spec[:desc] + begin
         default_s = case spec[:default]
         when $stdout; "<stdout>"
@@ -506,7 +538,12 @@ class Parser
     if str == ""
       [""]
     else
-      str.split("\n").map { |s| wrap_line s, opts }.flatten
+      inner = false
+      str.split("\n").map do |s|
+        line = wrap_line s, opts.merge(:inner => inner)
+        inner = true
+        line
+      end.flatten
     end
   end
 
@@ -596,7 +633,7 @@ private
   end
 
   def parse_integer_parameter param, arg
-    raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^\d+$/
+    raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^-?[\d_]+$/
     param.to_i
   end
 
@@ -648,7 +685,7 @@ private
     start = 0
     ret = []
     until start > str.length
-      nextt = 
+      nextt =
         if start + width >= str.length
           str.length
         else
@@ -656,7 +693,7 @@ private
           x = str.index(/\s/, start) if x && x < start
           x || str.length
         end
-      ret << (ret.empty? ? "" : " " * prefix) + str[start ... nextt]
+      ret << ((ret.empty? && !opts[:inner]) ? "" : " " * prefix) + str[start ... nextt]
       start = nextt + 1
     end
     ret
@@ -777,6 +814,27 @@ def die arg, msg=nil
   end
 end
 
-module_function :options, :die, :with_standard_exception_handling
+## Displays the help message and dies. Example:
+##
+##   options do
+##     opt :volume, :default => 0.0
+##     banner <<-EOS
+##   Usage:
+##          #$0 [options] <name>
+##   where [options] are:
+##   EOS
+##   end
+##
+##   Trollop::educate if ARGV.empty?
+def educate
+  if @last_parser
+    @last_parser.educate
+    exit
+  else
+    raise ArgumentError, "Trollop::educate can only be called after Trollop::options"
+  end
+end
+
+module_function :options, :die, :educate, :with_standard_exception_handling
 
 end # module

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+unless ENV['MUTANT']
+  require "coveralls"
+  require "simplecov"
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    Coveralls::SimpleCov::Formatter,
+    SimpleCov::Formatter::HTMLFormatter,
+  ]
+
+end
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+require 'test/unit'
+
+SimpleCov.start unless ENV['MUTANT']
+
+require 'trollop'

data/test/test_trollop.rb

@@ -1,12 +1,5 @@
-## test/test_trollop.rb -- unit tests for trollop
-## Author::    William Morgan (mailto: wmorgan-trollop@masanjin.net)
-## Copyright:: Copyright 2007 William Morgan
-## License::   GNU GPL version 2
-
-require 'rubygems'
-require 'test/unit'
 require 'stringio'
-require 'trollop'
+require_relative 'test_helper'
 
 module Trollop
 module Test
@@ -16,6 +9,11 @@ class Trollop < ::Test::Unit::TestCase
     @p = Parser.new
   end
 
+  def test_die_without_options_ever_run
+    ::Trollop.send(:instance_variable_set, "@last_parser", nil)
+    assert_raise(ArgumentError) { ::Trollop.die 'hello' }
+  end
+
   def test_unknown_arguments
     assert_raise(CommandlineError) { @p.parse(%w(--arg)) }
     @p.opt "arg"
@@ -78,6 +76,8 @@ class Trollop < ::Test::Unit::TestCase
   ## type is correctly derived from :default
   def test_type_correctly_derived_from_default
     assert_raise(ArgumentError) { @p.opt "badarg", "desc", :default => [] }
+    assert_raise(ArgumentError) { @p.opt "badarg3", "desc", :default => [{1 => 2}] }
+    assert_raise(ArgumentError) { @p.opt "badarg4", "desc", :default => Hash.new }
 
     opts = nil
 
@@ -87,6 +87,11 @@ class Trollop < ::Test::Unit::TestCase
     assert_equal 0, opts["argsi"]
     assert_nothing_raised { opts = @p.parse(%w(--argsi 4)) }
     assert_equal 4, opts["argsi"]
+    assert_nothing_raised { opts = @p.parse(%w(--argsi=4)) }
+    assert_equal 4, opts["argsi"]
+    assert_nothing_raised { opts = @p.parse(%w(--argsi=-4)) }
+    assert_equal -4, opts["argsi"]
+
     assert_raise(CommandlineError) { @p.parse(%w(--argsi 4.2)) }
     assert_raise(CommandlineError) { @p.parse(%w(--argsi hello)) }
 
@@ -156,7 +161,7 @@ class Trollop < ::Test::Unit::TestCase
     assert_equal ["3.4"], opts["argmst"]
     assert_nothing_raised { opts = @p.parse(%w(--argmst goodbye)) }
     assert_equal ["goodbye"], opts["argmst"]
-  end    
+  end
 
   ## :type and :default must match if both are specified
   def test_type_and_default_must_match
@@ -175,6 +180,26 @@ class Trollop < ::Test::Unit::TestCase
     assert_nothing_raised { @p.opt "argmst", "desc", :type => :strings, :default => ["yo"] }
   end
 
+  ##
+  def test_flags_with_defaults_and_no_args_act_as_switches
+    opts = nil
+
+    @p.opt :argd, "desc", :default => "default_string"
+
+    opts = @p.parse(%w(--))
+    assert !opts[:argd_given]
+    assert_equal "default_string", opts[:argd]
+
+    opts = @p.parse(%w( --argd ))
+    assert opts[:argd_given]
+    assert_equal "default_string", opts[:argd]
+
+    opts = @p.parse(%w(--argd different_string))
+    assert opts[:argd_given]
+    assert_equal "different_string", opts[:argd]
+
+  end
+
   def test_long_detects_bad_names
     assert_nothing_raised { @p.opt "goodarg", "desc", :long => "none" }
     assert_nothing_raised { @p.opt "goodarg2", "desc", :long => "--two" }
@@ -233,7 +258,7 @@ class Trollop < ::Test::Unit::TestCase
 
     sio = StringIO.new "w"
     @p.educate sio
-    assert sio.string =~ /--arg:\s+desc/
+    assert sio.string =~ /--arg\s+desc/
 
     assert_raise(CommandlineError) { @p.parse %w(-a) }
   end
@@ -387,6 +412,20 @@ where [options] are:
 EOM
   end
 
+  def test_multi_line_description
+    out = StringIO.new
+    @p.opt :arg, <<-EOM, :type => :int
+This is an arg
+with a multi-line description
+    EOM
+    @p.educate(out)
+    assert_equal <<-EOM, out.string
+Options:
+  --arg=<i>    This is an arg
+               with a multi-line description
+    EOM
+  end
+
   def test_floating_point_formatting
     @p.opt :arg, "desc", :type => :float, :short => "f"
     opts = nil
@@ -422,13 +461,8 @@ EOM
     opts = nil
     assert_nothing_raised { opts = @p.parse(['-d', 'Jan 4, 2007']) }
     assert_equal Date.civil(2007, 1, 4), opts[:arg]
-    begin
-      require 'chronic'
-      assert_nothing_raised { opts = @p.parse(['-d', 'today']) }
-      assert_equal Date.today, opts[:arg]
-    rescue LoadError
-      # chronic is not available
-    end
+    assert_nothing_raised { opts = @p.parse(['-d', 'today']) }
+    assert_equal Date.today, opts[:arg]
   end
 
   def test_short_options_cant_be_numeric
@@ -471,7 +505,7 @@ EOM
     assert_equal [], @p.leftovers
   end
 
-  def short_options_with_multiple_options_does_not_affect_flags_type
+  def test_short_options_with_multiple_options_does_not_affect_flags_type
     opts = nil
 
     assert_nothing_raised do
@@ -674,6 +708,41 @@ EOM
     assert_equal 2, help.length # banner, -h
   end
 
+  def test_help_has_optional_usage
+    @p = Parser.new
+    @p.usage "OPTIONS FILES"
+    sio = StringIO.new "w"
+    @p.parse []
+    @p.educate sio
+    help = sio.string.split "\n"
+    assert help[0] =~ /OPTIONS FILES/i
+    assert_equal 4, help.length # line break, options, then -h
+  end
+
+  def test_help_has_optional_synopsis
+    @p = Parser.new
+    @p.synopsis "About this program"
+    sio = StringIO.new "w"
+    @p.parse []
+    @p.educate sio
+    help = sio.string.split "\n"
+    assert help[0] =~ /About this program/i
+    assert_equal 4, help.length # line break, options, then -h
+  end
+
+  def test_help_has_specific_order_for_usage_and_synopsis
+    @p = Parser.new
+    @p.usage "OPTIONS FILES"
+    @p.synopsis "About this program"
+    sio = StringIO.new "w"
+    @p.parse []
+    @p.educate sio
+    help = sio.string.split "\n"
+    assert help[0] =~ /OPTIONS FILES/i
+    assert help[1] =~ /About this program/i
+    assert_equal 5, help.length # line break, options, then -h
+  end
+
   def test_help_preserves_positions
     @p.opt :zzz, "zzz"
     @p.opt :aaa, "aaa"
@@ -685,6 +754,44 @@ EOM
     assert help[2] =~ /aaa/
   end
 
+  def test_help_includes_option_types
+    @p.opt :arg1, 'arg', :type => :int
+    @p.opt :arg2, 'arg', :type => :ints
+    @p.opt :arg3, 'arg', :type => :string
+    @p.opt :arg4, 'arg', :type => :strings
+    @p.opt :arg5, 'arg', :type => :float
+    @p.opt :arg6, 'arg', :type => :floats
+    @p.opt :arg7, 'arg', :type => :io
+    @p.opt :arg8, 'arg', :type => :ios
+    @p.opt :arg9, 'arg', :type => :date
+    @p.opt :arg10, 'arg', :type => :dates
+    sio = StringIO.new "w"
+    @p.educate sio
+
+    help = sio.string.split "\n"
+    assert help[1] =~ /<i>/
+    assert help[2] =~ /<i\+>/
+    assert help[3] =~ /<s>/
+    assert help[4] =~ /<s\+>/
+    assert help[5] =~ /<f>/
+    assert help[6] =~ /<f\+>/
+    assert help[7] =~ /<filename\/uri>/
+    assert help[8] =~ /<filename\/uri\+>/
+    assert help[9] =~ /<date>/
+    assert help[10] =~ /<date\+>/
+  end
+
+  def test_help_has_grammatical_default_text
+    @p.opt :arg1, 'description with period.', :default => 'hello'
+    @p.opt :arg2, 'description without period', :default => 'world'
+    sio = StringIO.new 'w'
+    @p.educate sio
+
+    help = sio.string.split "\n"
+    assert help[1] =~ /Default/
+    assert help[2] =~ /default/
+  end
+
   def test_version_and_help_short_args_can_be_overridden
     @p.opt :verbose, "desc", :short => "-v"
     @p.opt :hello, "desc", :short => "-h"
@@ -951,6 +1058,31 @@ EOM
     end
   end
 
+  def test_date_arg_type
+    temp = Date.new
+    @p.opt :arg, 'desc', :type => :date
+    @p.opt :arg2, 'desc', :type => Date
+    @p.opt :arg3, 'desc', :default => temp
+
+    opts = nil
+    assert_nothing_raised { opts = @p.parse }
+    assert_equal temp, opts[:arg3]
+
+    assert_nothing_raised { opts = @p.parse %w(--arg 5/1/2010) }
+    assert_kind_of Date, opts[:arg]
+    assert_equal Date.new(2010, 5, 1), opts[:arg]
+
+    assert_nothing_raised { opts = @p.parse %w(--arg2 5/1/2010) }
+    assert_kind_of Date, opts[:arg2]
+    assert_equal Date.new(2010, 5, 1), opts[:arg2]
+  end
+
+  def test_unknown_arg_class_type
+    assert_raise ArgumentError do
+      @p.opt :arg, 'desc', :type => Hash
+    end
+  end
+
   def test_io_arg_type
     @p.opt :arg, "desc", :type => :io
     @p.opt :arg2, "desc", :type => IO
@@ -1124,12 +1256,52 @@ EOM
   end
 
   def test_simple_interface_handles_die
+    old_stderr, $stderr = $stderr, StringIO.new('w')
     ARGV.clear
     ARGV.unshift "--potato"
     ::Trollop::options do
       opt :potato
     end
     assert_raises(SystemExit) { ::Trollop::die :potato, "is invalid" }
+  ensure
+    $stderr = old_stderr
+  end
+
+  def test_simple_interface_handles_die_without_message
+    old_stderr, $stderr = $stderr, StringIO.new('w')
+    ARGV.clear
+    ARGV.unshift "--potato"
+    opts = ::Trollop::options do
+      opt :potato
+    end
+    assert_raises(SystemExit) { ::Trollop::die :potato }
+    assert $stderr.string =~ /Error:/
+  ensure
+    $stderr = old_stderr
+  end
+
+  def test_with_standard_exception_handling
+    assert_raise(SystemExit) do
+      ::Trollop.with_standard_exception_handling(@p) do
+        raise ::Trollop::CommandlineError.new('cl error')
+      end
+    end
+  end
+
+  def test_supports_callback_inline
+    assert_raises(RuntimeError, "good") do
+      @p.opt :cb1 do |vals|
+        raise "good"
+      end
+      @p.parse(%w(--cb1))
+    end
+  end
+
+  def test_supports_callback_param
+    assert_raises(RuntimeError, "good") do
+      @p.opt :cb1, "with callback", :callback => lambda { |vals| raise "good" }
+      @p.parse(%w(--cb1))
+    end
   end
 end
 

data/trollop.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trollop'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trollop"
+  spec.version       = Trollop::VERSION
+  spec.authors       = ["William Morgan", "Keenan Brock"]
+  spec.email         = "keenan@thebrocks.net"
+  spec.summary       = "Trollop is a commandline option parser for Ruby that just gets out of your way."
+  spec.description   = "Trollop 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."
+  spec.homepage      = "http://manageiq.github.io/trollop/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_runtime_dependency 'curses'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 4.7.3"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "chronic"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -1,59 +1,162 @@
 --- !ruby/object:Gem::Specification
 name: trollop
 version: !ruby/object:Gem::Version
-  version: '2.0'
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - William Morgan
+- Keenan Brock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
-dependencies: []
-description: ! 'Trollop is a commandline option parser for Ruby that just
-
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: |-
+  Trollop 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: wmorgan-trollop@masanjin.net
+  parsing, command subcompletion, and sensible defaults for everything you don't
+  specify.
+email: keenan@thebrocks.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/trollop.rb
-- test/test_trollop.rb
+- ".gitignore"
+- ".travis.yml"
 - FAQ.txt
+- Gemfile
 - History.txt
+- README.md
+- Rakefile
+- lib/trollop.rb
 - release-script.txt
-- README.txt
-homepage: http://trollop.rubyforge.org
-licenses: []
+- test/test_helper.rb
+- test/test_trollop.rb
+- trollop.gemspec
+homepage: http://manageiq.github.io/trollop/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: trollop
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Trollop is a commandline option parser for Ruby that just gets out of your
   way.
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/test_trollop.rb

data/README.txt

@@ -1,50 +0,0 @@
-== trollop
-
-by William Morgan (http://masanjin.net/)
-
-Main page: http://trollop.rubyforge.org
-
-Release announcements and comments: http://masanjin.net/blog/label/trollop/.
-
-Documentation quickstart: See Trollop.options and then Trollop::Parser#opt.
-Also see the examples at http://trollop.rubyforge.org/.
-
-== DESCRIPTION
-
-Trollop 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.
-- Single file. Throw it in lib/ if you don't want to make it a Rubygem dependency.
-- 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.
-
-== REQUIREMENTS
-
-* A burning desire to write less code.
-
-== INSTALL
-
-* gem install trollop
-
-== SYNOPSIS
-
-  require 'trollop'
-  opts = Trollop::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 (c) 2008--2012 William Morgan. Trollop is distributed under the same
-terms as Ruby.