trollop 1.10.2 → 1.11

data/History.txt

@@ -1,3 +1,7 @@
+== 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.

data/README.txt

@@ -1,8 +1,10 @@
 == trollop
 
-by William Morgan <wmorgan-trollop@masanjin.net>
+by William Morgan (wmorgan-trollop at the masanjin dot nets or http://cs.stanford.edu/~ruby)
 
-http://trollop.rubyforge.org
+Main page: http://trollop.rubyforge.org
+
+Release announcements and comments: http://all-thing.net/search/label/trollop
 
 Documentation quickstart: See Trollop::options and Trollop::Parser#opt.
 

data/Rakefile

@@ -26,10 +26,10 @@ task :upload_webpage => WWW_FILES do |t|
 end
 
 task :rdoc do |t|
-  sh "rdoc lib README.txt History.txt"
+  sh "rdoc lib README.txt History.txt -m README.txt"
 end
 
-task :upload_docs => [:rdoc] do |t|
+task :upload_docs => :rdoc do |t|
   sh "rsync -az -essh doc/* wmorgan@rubyforge.org:/var/www/gforge-projects/trollop/trollop/"
 end
 

data/lib/trollop.rb

@@ -5,7 +5,7 @@
 
 module Trollop
 
-VERSION = "1.10.2"
+VERSION = "1.11"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
@@ -431,6 +431,8 @@ class Parser
       opts = @specs[sym]
       raise CommandlineError, "option '#{arg}' needs a parameter" if params.empty? && opts[:type] != :flag
 
+      vals["#{sym}_given".intern] = true # mark argument as specified on the commandline
+
       case opts[:type]
       when :flag
         vals[sym] = !opts[:default]
@@ -628,6 +630,12 @@ end
 ## (Parser#opt), zero or more calls to +text+ (Parser#text), and
 ## probably a call to +version+ (Parser#version).
 ##
+## The returned block contains a value for every option specified with
+## +opt+.  The value will be the value given on the commandline, or the
+## default value if the option was not specified on the commandline. For
+## every option specified on the commandline, a key "<option
+## name>_given" will also be set in the hash.
+##
 ## Example:
 ##
 ##   require 'trollop'
@@ -638,7 +646,11 @@ end
 ##     opt :num_thumbs, "Number of thumbs", :type => :int # an integer --num-thumbs <i>, defaulting to nil
 ##   end
 ##
-##   p opts # returns a hash: { :monkey => false, :goat => true, :num_limbs => 4, :num_thumbs => nil }
+##   ## if called with no arguments
+##   p opts # => { :monkey => false, :goat => true, :num_limbs => 4, :num_thumbs => nil }
+##
+##   ## if called with --monkey
+##   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trollop
 version: !ruby/object:Gem::Version 
-  version: 1.10.2
+  version: "1.11"
 platform: ruby
 authors: 
 - William Morgan
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-23 00:00:00 -07:00
+date: 2009-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: == 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.  * A burning desire to write less code.  == INSTALL  * gem install trollop  == LICENSE  Copyright (c) 2008 William Morgan. Trollop is distributed under the same terms as Ruby.
+description: "Documentation quickstart: See Trollop::options and Trollop::Parser#opt.  == DESCRIPTION  == REQUIREMENTS  * A burning desire to write less code.  == INSTALL  * gem install trollop  == LICENSE  Copyright (c) 2008 William Morgan. Trollop is distributed under the same terms as Ruby."
 email: wmorgan-trollop@masanjin.net
 executables: []