trollop 1.15 → 1.16

data/History.txt

@@ -1,3 +1,8 @@
+== 1.16 / 2010-04-01
+* Add Trollop::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).

data/README.txt

@@ -4,7 +4,7 @@ by William Morgan (http://masanjin.net/)
 
 Main page: http://trollop.rubyforge.org
 
-Release announcements and comments: http://all-thing.net/search/label/trollop
+Release announcements and comments: http://all-thing.net/label/trollop
 
 Documentation quickstart: See Trollop::options (for some reason rdoc isn't
 linking that; it's in the top right of the screen if you're browsing online)

data/lib/trollop.rb

@@ -1,13 +1,13 @@
 ## lib/trollop.rb -- trollop command-line processing library
 ## Author::    William Morgan (mailto: wmorgan-trollop@masanjin.net)
 ## Copyright:: Copyright 2007 William Morgan
-## License::   GNU GPL version 2
+## License::   the same terms as ruby itself
 
 require 'date'
 
 module Trollop
 
-VERSION = "1.15"
+VERSION = "1.16"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
@@ -22,7 +22,7 @@ class HelpNeeded < StandardError; end
 class VersionNeeded < StandardError; end
 
 ## Regex for floating point numbers
-FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))$/
+FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))([eE][-+]?[\d]+)?$/
 
 ## Regex for parameters
 PARAM_RE = /^-(-|\.$|[^\d\.])/
@@ -32,9 +32,10 @@ PARAM_RE = /^-(-|\.$|[^\d\.])/
 ## #opt, #banner and #version, #depends, and #conflicts methods will
 ## typically be called.
 ##
-## If it's necessary to instantiate this class (for more complicated
-## argument-parsing situations), be sure to call #parse to actually
-## produce the output hash.
+## If you want to instantiate this class yourself (for more complicated
+## argument-parsing logic), call #parse to actually produce the output hash,
+## and consider calling it from within
+## Trollop::with_standard_exception_handling.
 class Parser
 
   ## The set of values that indicate a flag option when passed as the
@@ -277,7 +278,10 @@ class Parser
     @stop_on_unknown = true
   end
 
-  ## Parses the commandline. Typically called by Trollop::options.
+  ## Parses the commandline. Typically called by Trollop::options,
+  ## but you can call it directly if you need more control.
+  ##
+  ## throws CommandlineError, HelpNeeded, and VersionNeeded exceptions.
   def parse cmdline=ARGV
     vals = {}
     required = {}
@@ -349,7 +353,7 @@ class Parser
     end
 
     required.each do |sym, val|
-      raise CommandlineError, "option '#{sym}' must be specified" unless given_args.include? sym
+      raise CommandlineError, "option --#{@specs[sym][:long]} must be specified" unless given_args.include? sym
     end
 
     ## parse parameters
@@ -389,6 +393,11 @@ class Parser
       # else: multiple options, with multiple parameters
     end
 
+    ## modify input in place with only those
+    ## arguments we didn't process
+    cmdline.clear
+    @leftovers.each { |l| cmdline << l }
+
     ## allow openstruct-style accessors
     class << vals
       def method_missing(m, *args)
@@ -653,11 +662,10 @@ private
   end
 end
 
-## The top-level entry method into Trollop. Creates a Parser object,
-## passes the block to it, then parses +args+ with it, handling any
-## errors or requests for help or version information appropriately (and
-## then exiting). Modifies +args+ in place. Returns a hash of option
-## values.
+## The easy, syntactic-sugary entry method into Trollop. Creates a Parser,
+## passes the block to it, then parses +args+ with it, handling any errors or
+## requests for help or version information appropriately (and then exiting).
+## Modifies +args+ in place. Returns a hash of option values.
 ##
 ## The block passed in should contain zero or more calls to +opt+
 ## (Parser#opt), zero or more calls to +text+ (Parser#text), and
@@ -686,22 +694,47 @@ end
 ##   p opts # => {:monkey_given=>true, :monkey=>true, :goat=>true, :num_limbs=>4, :help=>false, :num_thumbs=>nil}
 ##
 ## See more examples at http://trollop.rubyforge.org.
-def options args = ARGV, *a, &b
-  @p = Parser.new(*a, &b)
+def options args=ARGV, *a, &b
+  p = Parser.new(*a, &b)
+  with_standard_exception_handling(p) { p.parse args }
+end
+
+## If Trollop::options doesn't do quite what you want, you can create a Parser
+## object and call Parser#parse on it. That method will throw CommandlineError,
+## HelpNeeded and VersionNeeded exceptions when necessary; if you want to
+## have these handled for you in the standard manner (e.g. show the help
+## and then exit upon an HelpNeeded exception), call your code from within
+## a block passed to this method.
+##
+## Note that this method will call System#exit after handling an exception!
+##
+## Usage example:
+##
+##   require 'trollop'
+##   p = Trollop::Parser.new do
+##     opt :monkey, "Use monkey mode"                     # a flag --monkey, defaulting to false
+##     opt :goat, "Use goat mode", :default => true       # a flag --goat, defaulting to true
+##   end
+##
+##   opts = Trollop::with_standard_exception_handling p do
+##     p.parse ARGV
+##     raise Trollop::HelpNeeded if ARGV.empty? # show help screen
+##   end
+##
+## Requires passing in the parser object.
+
+def with_standard_exception_handling parser
   begin
-    vals = @p.parse args
-    args.clear
-    @p.leftovers.each { |l| args << l }
-    vals
+    yield
   rescue CommandlineError => e
     $stderr.puts "Error: #{e.message}."
     $stderr.puts "Try --help for help."
     exit(-1)
   rescue HelpNeeded
-    @p.educate
+    parser.educate
     exit
   rescue VersionNeeded
-    puts @p.version
+    puts parser.version
     exit
   end
 end
@@ -734,6 +767,6 @@ def die arg, msg=nil
   exit(-1)
 end
 
-module_function :options, :die
+module_function :options, :die, :with_standard_exception_handling
 
 end # module

data/release-script.txt

@@ -0,0 +1,15 @@
+Just a few simple steps to make a new release.
+
+vi History.txt    # and describe changes
+git-rank-contributors -o -h >> www/index.html
+vi www/index.html # and integrate contributors
+## git add, git commit, etc
+vi lib/trollop.rb # and bump version number
+git commit -a -m "bump to..."
+git tag release-<releasename>
+rake gem
+rake tarball
+gem push pkg/<gem name>
+git push
+git push --tags
+rake upload_webpage

data/test/test_trollop.rb

@@ -82,7 +82,7 @@ class Trollop < ::Test::Unit::TestCase
 
     # single arg: int
     assert_nothing_raised { @p.opt "argsi", "desc", :default => 0 }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal 0, opts["argsi"]
     assert_nothing_raised { opts = @p.parse(%w(--argsi 4)) }
     assert_equal 4, opts["argsi"]
@@ -91,18 +91,20 @@ class Trollop < ::Test::Unit::TestCase
 
     # single arg: float
     assert_nothing_raised { @p.opt "argsf", "desc", :default => 3.14 }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal 3.14, opts["argsf"]
     assert_nothing_raised { opts = @p.parse(%w(--argsf 2.41)) }
     assert_equal 2.41, opts["argsf"]
     assert_nothing_raised { opts = @p.parse(%w(--argsf 2)) }
     assert_equal 2, opts["argsf"]
+    assert_nothing_raised { opts = @p.parse(%w(--argsf 1.0e-2)) }
+    assert_equal 1.0e-2, opts["argsf"]
     assert_raise(CommandlineError) { @p.parse(%w(--argsf hello)) }
 
     # single arg: date
     date = Date.today
     assert_nothing_raised { @p.opt "argsd", "desc", :default => date }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal Date.today, opts["argsd"]
     assert_nothing_raised { opts = @p.parse(['--argsd', 'Jan 4, 2007']) }
     assert_equal Date.civil(2007, 1, 4), opts["argsd"]
@@ -110,7 +112,7 @@ class Trollop < ::Test::Unit::TestCase
 
     # single arg: string
     assert_nothing_raised { @p.opt "argss", "desc", :default => "foobar" }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal "foobar", opts["argss"]
     assert_nothing_raised { opts = @p.parse(%w(--argss 2.41)) }
     assert_equal "2.41", opts["argss"]
@@ -119,7 +121,7 @@ class Trollop < ::Test::Unit::TestCase
 
     # multi args: ints
     assert_nothing_raised { @p.opt "argmi", "desc", :default => [3, 5] }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal [3, 5], opts["argmi"]
     assert_nothing_raised { opts = @p.parse(%w(--argmi 4)) }
     assert_equal [4], opts["argmi"]
@@ -128,7 +130,7 @@ class Trollop < ::Test::Unit::TestCase
 
     # multi args: floats
     assert_nothing_raised { @p.opt "argmf", "desc", :default => [3.34, 5.21] }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal [3.34, 5.21], opts["argmf"]
     assert_nothing_raised { opts = @p.parse(%w(--argmf 2)) }
     assert_equal [2], opts["argmf"]
@@ -139,7 +141,7 @@ class Trollop < ::Test::Unit::TestCase
     # multi args: dates
     dates = [Date.today, Date.civil(2007, 1, 4)]
     assert_nothing_raised { @p.opt "argmd", "desc", :default => dates }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal dates, opts["argmd"]
     assert_nothing_raised { opts = @p.parse(['--argmd', 'Jan 4, 2007']) }
     assert_equal [Date.civil(2007, 1, 4)], opts["argmd"]
@@ -147,7 +149,7 @@ class Trollop < ::Test::Unit::TestCase
 
     # multi args: strings
     assert_nothing_raised { @p.opt "argmst", "desc", :default => %w(hello world) }
-    assert_nothing_raised { opts = @p.parse("--") }
+    assert_nothing_raised { opts = @p.parse(%w(--)) }
     assert_equal %w(hello world), opts["argmst"]
     assert_nothing_raised { opts = @p.parse(%w(--argmst 3.4)) }
     assert_equal ["3.4"], opts["argmst"]
@@ -1039,7 +1041,7 @@ EOM
 
   def test_multi_args_default_to_empty_array
     @p.opt :arg1, "arg", :multi => true
-    opts = @p.parse ""
+    opts = @p.parse []
     assert_equal [], opts[:arg1]
   end
 end

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: trollop
 version: !ruby/object:Gem::Version 
-  version: "1.15"
+  prerelease: false
+  segments: 
+  - 1
+  - 16
+  version: "1.16"
 platform: ruby
 authors: 
 - William Morgan
@@ -9,78 +13,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-30 00:00:00 -04:00
+date: 2010-04-01 16:46:01 -04:00
 default_executable: 
 dependencies: []
 
-description: |+
-  Documentation quickstart: See Trollop::options (for some reason rdoc isn't
-  linking that; it's in the top right of the screen if you're browsing online)
-  and then Trollop::Parser#opt. Also see the examples at
-  http://trollop.rubyforge.org/.
-  
-  == DESCRIPTION
-  
-  == REQUIREMENTS
-  
-  * A burning desire to write less code.
-  
-  == INSTALL
-  
-  * gem install trollop
-  
-  == LICENSE
-  
-  Copyright (c) 2008--2009 William Morgan. Trollop is distributed under the same
-  terms as Ruby.
-  
-  
+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
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- FAQ.txt
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
-- FAQ.txt
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
 - lib/trollop.rb
 - test/test_trollop.rb
+- README.txt
+- release-script.txt
+- FAQ.txt
+- History.txt
 has_rdoc: true
 homepage: http://trollop.rubyforge.org
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: trollop
-rubygems_version: 1.3.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: 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.
-test_files: 
-- test/test_trollop.rb
+summary: Trollop is a commandline option parser for Ruby that just gets out of your way.
+test_files: []
+

data/Manifest.txt

@@ -1,7 +0,0 @@
-FAQ.txt
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/trollop.rb
-test/test_trollop.rb

data/Rakefile

@@ -1,36 +0,0 @@
-# -*- ruby -*-
-
-require 'rubygems'
-require 'hoe'
-
-$:.unshift "lib"
-require 'trollop'
-
-class Hoe
-  def extra_dev_deps; @extra_dev_deps.reject { |x| x[0] == "hoe" } end
-end
-
-Hoe.new('trollop', Trollop::VERSION) do |p|
-  p.rubyforge_name = 'trollop'
-  p.author = "William Morgan"
-  p.summary = "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."
-  p.description = p.paragraphs_of('README.txt', 4..5, 9..18).join("\n\n").gsub(/== SYNOPSIS/, "Synopsis")
-  p.url = "http://trollop.rubyforge.org"
-  p.changes = p.paragraphs_of('History.txt', 0..0).join("\n\n")
-  p.email = "wmorgan-trollop@masanjin.net"
-end
-
-WWW_FILES = FileList["www/*"] + %w(README.txt FAQ.txt)
-task :upload_webpage => WWW_FILES do |t|
-  sh "rsync -Paz -essh #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/trollop/"
-end
-
-task :rdoc do |t|
-  sh "rdoc lib README.txt History.txt -m README.txt"
-end
-
-task :upload_docs => :rdoc do |t|
-  sh "rsync -az -essh doc/* wmorgan@rubyforge.org:/var/www/gforge-projects/trollop/trollop/"
-end
-
-# vim: syntax=ruby