monkeyshines 0.0.2

data/lib/monkeyshines/utils/filename_pattern.rb

@@ -0,0 +1,134 @@
+module Monkeyshines
+  module Utils
+    class FilenamePattern
+      # Memoize recognizer regexps
+      RECOGNIZER_REGEXPS = {}
+      # the filename pattern, e.g. 'ripd/:handle/:date/:handle+:timestamp-:pid-:hostname.tsv'
+      attr_accessor :pattern
+      # custom token replacements
+      attr_accessor :token_val_defaults
+      # the base regexp pattern used to recognize templated products.
+      attr_accessor :recognizer_pattern
+
+      DEFAULT_PATTERN_STR = ":dest_dir/:handle_prefix/:handle/:date/:handle+:timestamp-:pid-:hostname.tsv"
+
+      def initialize pattern, token_val_defaults={}
+        self.pattern = pattern
+        self.token_val_defaults    = token_val_defaults
+      end
+
+      #
+      # walk through pattern, replacing tokens (eg :time or :pid) with the
+      # corresponding value.
+      #
+      def make token_vals={}
+        token_vals = token_val_defaults.merge token_vals
+        token_vals[:timestamp] ||= Time.now.utc.strftime("%Y%m%d%H%M%S")
+        val = pattern.gsub(/:(\w+)/){ replace($1, token_vals)  }
+        val
+      end
+
+      def to_s token_vals={}
+        make token_vals
+      end
+
+      #
+      # walk through pattern, constructing a regexp for parsing a templated
+      # product of that pattern
+      #
+      # It's undefined if a token is repeated inconsistently, eg recognizing
+      # '20090426012345/foo-20070707070707' with ':timestamp/:handle-:timestamp'
+      # It's harmless to have a token that is repeated, but always identically.
+      #
+      def make_recognizer token_regexps={}
+        return RECOGNIZER_REGEXPS[pattern] if RECOGNIZER_REGEXPS[pattern]
+        tokens        = []
+        recognizer    = recognizer_pattern.gsub(/:(\\\{\w+\\\}|\w+)/) do
+          tok = $1.gsub(/\W/,'')
+          tokens << tok.to_sym
+          '('+recognize_replace(tok, token_regexps)+')'
+        end
+        RECOGNIZER_REGEXPS[pattern] = [Regexp.new(recognizer), tokens]
+      end
+
+      #
+      # substitute for token
+      #
+      def replace token, token_vals
+        token = token.to_sym
+        return token_vals[token] if token_vals.include? token
+        case token
+        when :pid           then pid
+        when :hostname      then hostname
+        when :handle        then token_vals[:handle] || Monkeyshines::CONFIG[:handle]
+        when :handle_prefix then token_vals[:handle].to_s[0..5]
+        when :timestamp     then token_vals[:timestamp]
+        when :date          then token_vals[:timestamp][ 0..7]
+        when :time          then token_vals[:timestamp][ 8..13]
+        when :hour          then token_vals[:timestamp][ 8..9]
+        when :min           then token_vals[:timestamp][10..11]
+        when :sec           then token_vals[:timestamp][12..13]
+        else
+          raise "Don't know how to encode token #{token} #{token_vals[token]}"
+        end
+      end
+
+      # Memoized: the hostname for the machine running this script.
+      def hostname
+        @hostname ||= ENV['HOSTNAME'] || `hostname`
+      end
+      # Memoized: the Process ID for this invocation.
+      def pid
+        @pid      ||= Process.pid
+      end
+
+      # Characters deemed safe in a filename;
+      SAFE_CHARS = 'a-zA-Z0-9_\-\.\+\/\;'
+      def self.sanitize str
+        str.gsub(%r{[^#{SAFE_CHARS}]+}, '-')
+      end
+
+      # The base regexp pattern used to recognize templated products.
+      # By default, it's just the regexp-escaped version of this pattern,
+      # rooted on the right hand side (the end of the pattern matches the end of
+      # the string)
+      def recognizer_pattern
+        @recognizer_pattern ||= Regexp.escape(pattern)+'\z'
+      end
+
+      def recognize_replace token, token_vals
+        token = token.to_sym
+        return token_vals[token] if token_vals.include? token
+        case token
+        when :pid           then '\d{1,5}'
+        when :hostname      then '[a-zA-Z][a-zA-Z0-9\-\.]*[a-zA-Z0-9]'
+        when :handle        then '[\w\-\.]+'
+        when :handle_prefix then '[\w\-\.]+'
+        when :timestamp     then '\d{14}'
+        when :date          then '\d{8}'
+        when :time          then '\d{6}'
+        when :hour          then '\d{2}'
+        when :min           then '\d{2}'
+        when :sec           then '\d{2}'
+        when :ext           then '[a-zA-Z0-9\.]+'
+        when :any_id        then '\w+'
+        else
+          raise "Don't know how to encode token #{token} #{token_vals[token]}"
+        end
+      end
+
+      def recognize str, token_regexps={}
+        recognizer, tokens = make_recognizer token_regexps
+        unless m = recognizer.match(str)
+          warn "Can't match #{recognizer} against #{str}"
+          return
+        end
+        Hash.zip(tokens, m.captures)
+      end
+
+      def unrecognize
+        RECOGNIZER_REGEXPS.delete pattern
+      end
+    end
+  end
+end

data/lib/monkeyshines/utils/logger.rb

@@ -0,0 +1,15 @@
+module Monkeyshines
+  # Common logger
+  def self.logger
+    @logger ||= Monkeyshines.default_logger
+  end
+  def self.logger= logger
+    @logger = logger
+  end
+
+  def self.default_logger dest=nil
+    require 'logger'
+    dest ||= $stderr
+    Logger.new dest
+  end
+end

data/lib/monkeyshines/utils/trollop-1.14/FAQ.txt

@@ -0,0 +1,84 @@
+Trollop FAQ
+-----------
+
+Q: Why is it called "Trollop"?
+A: No reason.
+
+Q: Why should I use Trollop?
+A: Because it will take you FEWER LINES OF CODE to do reasonable option parsing
+   than any other option parser out there.
+
+   Look at this:
+
+     opts = Trollop::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. And opts is a hash and you do whatever you want with it.
+   Trivial. You don't have to mix option processing code blocks 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. C'mon, that's hot.
+
+Q: What is the philosophy behind Trollop?
+A: Must a commandline option processor have a philosophy?
+
+Q: Seriously now. What is it?
+A: Ok, it's this: Trollop *just* does the parsing and gives you a hash table
+   of the result. So whatever fancy logic or constraints you need, you can
+   implement by operating on that hash table. Options that disable other
+   options, fancy constraints involving multiple sets of values across multiple
+   sets of options, etc. are all left for you to do manually.
+
+   (Trollop does support limited constraint setting (see #conflicts and
+   #depends), but any non-trivial program will need to get fancier.)
+
+   The result is that using Trollop is pretty simple, and whatever bizarre
+   logic you want, you can write yourself. And don't forget, you can call
+   Trollop::die to abort the program and give a fancy options-related error
+   message.
+
+Q: What happens to the other stuff on the commandline?
+A: Anything Trollop doesn't recognize as an option or as an option parameter is
+   left in ARGV for you to process.
+
+Q: Does Trollop 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 these.
+
+Q: Does Trollop 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 Trollop support subcommands?
+A: Yes. You get subcommand support by adding a call #stop_on within the options
+   block, and passing the names of the subcommands to it. (See the third
+   example on the webpage.) When Trollop encounters one of these subcommands on
+   the commandline, it stops processing and returns.
+
+   ARGV at that point will contain the subcommand followed by any subcommand
+   options, since Trollop has contained the rest. So you can consume the
+   subcommand and call Trollop.options again with the particular options set
+   for that subcommand.
+
+   If you don't know the subcommands ahead of time, you can call
+   #stop_on_unknown, which will cause Trollop 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.
+
+   It's probably easier to see the example on the webpage than to read all
+   that.
+
+Q: Why does Trollop 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., what about "-f -3".  Is that a
+   negative three parameter to -f, or two separate parameters? 
+
+   I could be very clever and detect when there are no arguments that require
+   floating-point parameters, and allow such short option names in those cases,
+   but opted for simplicity and consistency.

data/lib/monkeyshines/utils/trollop-1.14/History.txt

@@ -0,0 +1,101 @@
+== 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
+* Trollop::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.
+* Trollop::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.

data/lib/monkeyshines/utils/trollop-1.14/Manifest.txt

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

data/lib/monkeyshines/utils/trollop-1.14/README.txt

@@ -0,0 +1,40 @@
+== trollop
+
+by William Morgan (wmorgan-trollop at the masanjin dot nets or http://cs.stanford.edu/~ruby)
+
+Main page: http://trollop.rubyforge.org
+
+Release announcements and comments: http://all-thing.net/search/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)
+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, command
+subcompletion, and sensible defaults for everything you don't specify.
+
+== FEATURES/PROBLEMS
+
+- Dirt-simple usage.
+- Sensible defaults. No tweaking necessary, much tweaking possible.
+- Support for long options, short options, short option bundling,
+  and automatic type validation and conversion.
+- Support for subcommands.
+- Automatic help message generation, wrapped to current screen width.
+- Lots of unit tests.
+
+== 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.

data/lib/monkeyshines/utils/trollop-1.14/Rakefile

@@ -0,0 +1,36 @@
+# -*- 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

data/lib/monkeyshines/utils/trollop-1.14/lib/trollop.rb

@@ -0,0 +1,744 @@
+## 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
+
+require 'date'
+
+module Trollop
+
+VERSION = "1.14"
+
+## Thrown by Parser in the event of a commandline error. Not needed if
+## you're using the Trollop::options entry.
+class CommandlineError < StandardError; end
+
+## Thrown by Parser if the user passes in '-h' or '--help'. Handled
+## automatically by Trollop#options.
+class HelpNeeded < StandardError; end
+
+## Thrown by Parser if the user passes in '-h' or '--version'. Handled
+## automatically by Trollop#options.
+class VersionNeeded < StandardError; end
+
+## Regex for floating point numbers
+FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))$/
+
+## Regex for parameters
+PARAM_RE = /^-(-|\.$|[^\d\.])/
+
+## The commandline parser. In typical usage, the methods in this class
+## will be handled internally by Trollop::options. In this case, only the
+## #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.
+class Parser
+
+  ## The set of values that indicate a flag option when passed as the
+  ## +:type+ parameter of #opt.
+  FLAG_TYPES = [:flag, :bool, :boolean]
+
+  ## The set of values that indicate a single-parameter (normal) option when
+  ## passed as the +:type+ parameter of #opt.
+  ##
+  ## A value of +io+ corresponds to a readable IO resource, including
+  ## a filename, URI, or the strings 'stdin' or '-'.
+  SINGLE_ARG_TYPES = [:int, :integer, :string, :double, :float, :io, :date]
+
+  ## The set of values that indicate a multiple-parameter option (i.e., that
+  ## takes multiple space-separated values on the commandline) when passed as
+  ## the +:type+ parameter of #opt.
+  MULTI_ARG_TYPES = [:ints, :integers, :strings, :doubles, :floats, :ios, :dates]
+
+  ## The complete set of legal values for the +:type+ parameter of #opt.
+  TYPES = FLAG_TYPES + SINGLE_ARG_TYPES + MULTI_ARG_TYPES
+
+  INVALID_SHORT_ARG_REGEX = /[\d-]/ #:nodoc:
+
+  ## The values from the commandline that were not interpreted by #parse.
+  attr_reader :leftovers
+
+  ## The complete configuration hashes for each option. (Mainly useful
+  ## for testing.)
+  attr_reader :specs
+
+  ## Initializes the parser, and instance-evaluates any block given.
+  def initialize *a, &b
+    @version = nil
+    @leftovers = []
+    @specs = {}
+    @long = {}
+    @short = {}
+    @order = []
+    @constraints = []
+    @stop_words = []
+    @stop_on_unknown = false
+
+    #instance_eval(&b) if b # can't take arguments
+    cloaker(&b).bind(self).call(*a) if b
+  end
+
+  ## Define an option. +name+ is the option name, a unique identifier
+  ## for the option that you will use internally, which should be a
+  ## symbol or a string. +desc+ is a string description which will be
+  ## displayed in help messages.
+  ##
+  ## Takes the following optional arguments:
+  ##
+  ## [+:long+] Specify the long form of the argument, i.e. the form with two dashes. If unspecified, will be automatically derived based on the argument name by turning the +name+ option into a string, and replacing any _'s by -'s.
+  ## [+:short+] Specify the short form of the argument, i.e. the form with one dash. If unspecified, will be automatically derived from +name+.
+  ## [+:type+] Require that the argument take a parameter or parameters of type +type+. For a single parameter, the value can be a member of +SINGLE_ARG_TYPES+, or a corresponding Ruby class (e.g. +Integer+ for +:int+). For multiple-argument parameters, the value can be any member of +MULTI_ARG_TYPES+ constant. If unset, the default argument type is +:flag+, meaning that the argument does not take a parameter. The specification of +:type+ is not necessary if a +:default+ is given.
+  ## [+:default+] Set the default value for an argument. Without a default value, the hash returned by #parse (and thus Trollop::options) will have a +nil+ value for this key unless the argument is given on the commandline. The argument type is derived automatically from the class of the default value given, so specifying a +:type+ is not necessary if a +:default+ is given. (But see below for an important caveat when +:multi+: is specified too.) If the argument is a flag, and the default is set to +true+, then if it is specified on the the commandline the value will be +false+.
+  ## [+:required+] If set to +true+, the argument must be provided on the commandline.
+  ## [+:multi+] If set to +true+, allows multiple occurrences of the option on the commandline. Otherwise, only a single instance of the option is allowed. (Note that this is different from taking multiple parameters. See below.)
+  ##
+  ## Note that there are two types of argument multiplicity: an argument
+  ## can take multiple values, e.g. "--arg 1 2 3". An argument can also
+  ## be allowed to occur multiple times, e.g. "--arg 1 --arg 2".
+  ##
+  ## Arguments that take multiple values should have a +:type+ parameter
+  ## drawn from +MULTI_ARG_TYPES+ (e.g. +:strings+), or a +:default:+
+  ## value of an array of the correct type (e.g. [String]). The
+  ## value of this argument will be an array of the parameters on the
+  ## commandline.
+  ##
+  ## Arguments that can occur multiple times should be marked with
+  ## +:multi+ => +true+. The value of this argument will also be an array.
+  ## In contrast with regular non-multi options, if not specified on
+  ## the commandline, the default value will be [], not nil.
+  ##
+  ## These two attributes can be combined (e.g. +:type+ => +:strings+,
+  ## +:multi+ => +true+), in which case the value of the argument will be
+  ## an array of arrays.
+  ##
+  ## There's one ambiguous case to be aware of: when +:multi+: is true and a
+  ## +:default+ is set to an array (of something), it's ambiguous whether this
+  ## is a multi-value argument as well as a multi-occurrence argument.
+  ## In thise case, Trollop assumes that it's not a multi-value argument.
+  ## If you want a multi-value, multi-occurrence argument with a default
+  ## value, you must specify +:type+ as well.
+
+  def opt name, desc="", opts={}
+    raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? name
+
+    ## fill in :type
+    opts[:type] = # normalize
+      case opts[:type]
+      when :boolean, :bool; :flag
+      when :integer; :int
+      when :integers; :ints
+      when :double; :float
+      when :doubles; :floats
+      when Class
+        case opts[:type].name
+        when 'TrueClass', 'FalseClass'; :flag
+        when 'String'; :string
+        when 'Integer'; :int
+        when 'Float'; :float
+        when 'IO'; :io
+        when 'Date'; :date
+        else
+          raise ArgumentError, "unsupported argument type '#{opts[:type].class.name}'"
+        end
+      when nil; nil
+      else
+        raise ArgumentError, "unsupported argument type '#{opts[:type]}'" unless TYPES.include?(opts[:type])
+        opts[:type]
+      end
+
+    ## for options with :multi => true, an array default doesn't imply
+    ## a multi-valued argument. for that you have to specify a :type
+    ## as well. (this is how we disambiguate an ambiguous situation;
+    ## see the docs for Parser#opt for details.)
+    disambiguated_default =
+      if opts[:multi] && opts[:default].is_a?(Array) && !opts[:type]
+        opts[:default].first
+      else
+        opts[:default]
+      end
+
+    type_from_default =
+      case disambiguated_default
+      when Integer; :int
+      when Numeric; :float
+      when TrueClass, FalseClass; :flag
+      when String; :string
+      when IO; :io
+      when Date; :date
+      when Array
+        if opts[:default].empty?
+          raise ArgumentError, "multiple argument type cannot be deduced from an empty array for '#{opts[:default][0].class.name}'"
+        end
+        case opts[:default][0]    # the first element determines the types
+        when Integer; :ints
+        when Numeric; :floats
+        when String; :strings
+        when IO; :ios
+        when Date; :dates
+        else
+          raise ArgumentError, "unsupported multiple argument type '#{opts[:default][0].class.name}'"
+        end
+      when nil; nil
+      else
+        raise ArgumentError, "unsupported argument type '#{opts[:default].class.name}'"
+      end
+
+    raise ArgumentError, ":type specification and default type don't match (default type is #{type_from_default})" if opts[:type] && type_from_default && opts[:type] != type_from_default
+
+    opts[:type] = opts[:type] || type_from_default || :flag
+
+    ## fill in :long
+    opts[:long] = opts[:long] ? opts[:long].to_s : name.to_s.gsub("_", "-")
+    opts[:long] =
+      case opts[:long]
+      when /^--([^-].*)$/
+        $1
+      when /^[^-]/
+        opts[:long]
+      else
+        raise ArgumentError, "invalid long option name #{opts[:long].inspect}"
+      end
+    raise ArgumentError, "long option name #{opts[:long].inspect} is already taken; please specify a (different) :long" if @long[opts[:long]]
+
+    ## fill in :short
+    opts[:short] = opts[:short].to_s if opts[:short] unless opts[:short] == :none
+    opts[:short] = case opts[:short]
+      when /^-(.)$/; $1
+      when nil, :none, /^.$/; opts[:short]
+      else raise ArgumentError, "invalid short option name '#{opts[:short].inspect}'"
+    end
+
+    if opts[:short]
+      raise ArgumentError, "short option name #{opts[:short].inspect} is already taken; please specify a (different) :short" if @short[opts[:short]]
+      raise ArgumentError, "a short option name can't be a number or a dash" if opts[:short] =~ INVALID_SHORT_ARG_REGEX
+    end
+
+    ## fill in :default for flags
+    opts[:default] = false if opts[:type] == :flag && opts[:default].nil?
+
+    ## autobox :default for :multi (multi-occurrence) arguments
+    opts[:default] = [opts[:default]] if opts[:default] && opts[:multi] && !opts[:default].is_a?(Array)
+
+    ## fill in :multi
+    opts[:multi] ||= false
+
+    opts[:desc] ||= desc
+    @long[opts[:long]] = name
+    @short[opts[:short]] = name if opts[:short] && opts[:short] != :none
+    @specs[name] = opts
+    @order << [:opt, name]
+  end
+
+  ## Sets the version string. If set, the user can request the version
+  ## on the commandline. Should probably be of the form "<program name>
+  ## <version number>".
+  def version s=nil; @version = s if s; @version 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
+  alias :text :banner
+
+  ## Marks two (or more!) options as requiring each other. Only handles
+  ## undirected (i.e., mutual) dependencies. Directed dependencies are
+  ## better modeled with Trollop::die.
+  def depends *syms
+    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] }
+    @constraints << [:conflicts, syms]
+  end
+
+  ## Defines a set of words which cause parsing to terminate when
+  ## encountered, such that any options to the left of the word are
+  ## parsed as usual, and options to the right of the word are left
+  ## intact.
+  ##
+  ## A typical use case would be for subcommand support, where these
+  ## would be set to the list of subcommands. A subsequent Trollop
+  ## invocation would then be used to parse subcommand options, after
+  ## shifting the subcommand off of ARGV.
+  def stop_on *words
+    @stop_words = [*words].flatten
+  end
+
+  ## Similar to #stop_on, but stops on any unknown word when encountered
+  ## (unless it is a parameter for an argument). This is useful for
+  ## cases where you don't know the set of subcommands ahead of time,
+  ## i.e., without first parsing the global options.
+  def stop_on_unknown
+    @stop_on_unknown = true
+  end
+
+  ## Parses the commandline. Typically called by Trollop::options.
+  def parse cmdline=ARGV
+    vals = {}
+    required = {}
+
+    opt :version, "Print version and exit" if @version unless @specs[:version] || @long["version"]
+    opt :help, "Show this message" unless @specs[:help] || @long["help"]
+
+    @specs.each do |sym, opts|
+      required[sym] = true if opts[:required]
+      vals[sym] = opts[:default]
+      vals[sym] = [] if opts[:multi] && !opts[:default] # multi arguments default to [], not nil
+    end
+
+    resolve_default_short_options
+
+    ## resolve symbols
+    given_args = {}
+    @leftovers = each_arg cmdline do |arg, params|
+      sym = case arg
+      when /^-([^-])$/
+        @short[$1]
+      when /^--([^-]\S*)$/
+        @long[$1]
+      else
+        raise CommandlineError, "invalid argument syntax: '#{arg}'"
+      end
+      raise CommandlineError, "unknown argument '#{arg}'" unless sym
+
+      if given_args.include?(sym) && !@specs[sym][:multi]
+        raise CommandlineError, "option '#{arg}' specified multiple times"
+      end
+
+      given_args[sym] ||= {}
+
+      given_args[sym][:arg] = arg
+      given_args[sym][:params] ||= []
+
+      # The block returns the number of parameters taken.
+      num_params_taken = 0
+
+      unless params.nil?
+        if SINGLE_ARG_TYPES.include?(@specs[sym][:type])
+          given_args[sym][:params] << params[0, 1]  # take the first parameter
+          num_params_taken = 1
+        elsif MULTI_ARG_TYPES.include?(@specs[sym][:type])
+          given_args[sym][:params] << params        # take all the parameters
+          num_params_taken = params.size
+        end
+      end
+
+      num_params_taken
+    end
+
+    ## check for version and help args
+    raise VersionNeeded if given_args.include? :version
+    raise HelpNeeded if given_args.include? :help
+
+    ## check constraint satisfaction
+    @constraints.each do |type, syms|
+      constraint_sym = syms.find { |sym| given_args[sym] }
+      next unless constraint_sym
+
+      case type
+      when :depends
+        syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} requires --#{@specs[sym][:long]}" unless given_args.include? sym }
+      when :conflicts
+        syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} conflicts with --#{@specs[sym][:long]}" if given_args.include?(sym) && (sym != constraint_sym) }
+      end
+    end
+
+    required.each do |sym, val|
+      raise CommandlineError, "option '#{sym}' must be specified" unless given_args.include? sym
+    end
+
+    ## parse parameters
+    given_args.each do |sym, given_data|
+      arg = given_data[:arg]
+      params = given_data[:params]
+
+      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]
+      when :int, :ints
+        vals[sym] = params.map { |pg| pg.map { |p| parse_integer_parameter p, arg } }
+      when :float, :floats
+        vals[sym] = params.map { |pg| pg.map { |p| parse_float_parameter p, arg } }
+      when :string, :strings
+        vals[sym] = params.map { |pg| pg.map { |p| p.to_s } }
+      when :io, :ios
+        vals[sym] = params.map { |pg| pg.map { |p| parse_io_parameter p, arg } }
+      when :date, :dates
+        vals[sym] = params.map { |pg| pg.map { |p| parse_date_parameter p, arg } }
+      end
+
+      if SINGLE_ARG_TYPES.include?(opts[:type])
+        unless opts[:multi]       # single parameter
+          vals[sym] = vals[sym][0][0]
+        else                      # multiple options, each with a single parameter
+          vals[sym] = vals[sym].map { |p| p[0] }
+        end
+      elsif MULTI_ARG_TYPES.include?(opts[:type]) && !opts[:multi]
+        vals[sym] = vals[sym][0]  # single option, with multiple parameters
+      end
+      # else: multiple options, with multiple parameters
+    end
+
+    ## allow openstruct-style accessors
+    class << vals
+      def method_missing(m, *args)
+        self[m] || self[m.to_s]
+      end
+    end
+    vals
+  end
+
+  def parse_date_parameter param, arg #:nodoc:
+    begin
+      begin
+        time = Chronic.parse(param)
+      rescue NameError
+        # chronic is not available
+      end
+      time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
+    rescue ArgumentError => e
+      raise CommandlineError, "option '#{arg}' needs a date"
+    end
+  end
+
+  ## Print the help message to +stream+.
+  def educate stream=$stdout
+    width # just calculate it now; otherwise we have to be careful not to
+          # call this unless the cursor's at the beginning of a line.
+
+    left = {}
+    @specs.each do |name, spec|
+      left[name] = "--#{spec[:long]}" +
+        (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
+        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
+    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
+      stream.puts "#@version\n" if @version
+      stream.puts "Options:"
+    end
+
+    @order.each do |what, opt|
+      if what == :text
+        stream.puts wrap(opt)
+        next
+      end
+
+      spec = @specs[opt]
+      stream.printf "  %#{leftcol_width}s:   ", left[opt]
+      desc = spec[:desc] + begin
+        default_s = case spec[:default]
+        when $stdout; "<stdout>"
+        when $stdin; "<stdin>"
+        when $stderr; "<stderr>"
+        when Array
+          spec[:default].join(", ")
+        else
+          spec[:default].to_s
+        end
+
+        if spec[:default]
+          if spec[:desc] =~ /\.$/
+            " (Default: #{default_s})"
+          else
+            " (default: #{default_s})"
+          end
+        else
+          ""
+        end
+      end
+      stream.puts wrap(desc, :width => width - rightcol_start - 1, :prefix => rightcol_start)
+    end
+  end
+
+  def width #:nodoc:
+    @width ||= if $stdout.tty?
+      begin
+        require 'curses'
+        Curses::init_screen
+        x = Curses::cols
+        Curses::close_screen
+        x
+      rescue Exception
+        80
+      end
+    else
+      80
+    end
+  end
+
+  def wrap str, opts={} # :nodoc:
+    if str == ""
+      [""]
+    else
+      str.split("\n").map { |s| wrap_line s, opts }.flatten
+    end
+  end
+
+private
+
+  ## yield successive arg, parameter pairs
+  def each_arg args
+    remains = []
+    i = 0
+
+    until i >= args.length
+      if @stop_words.member? args[i]
+        remains += args[i .. -1]
+        return remains
+      end
+      case args[i]
+      when /^--$/ # arg terminator
+        remains += args[(i + 1) .. -1]
+        return remains
+      when /^--(\S+?)=(.*)$/ # long argument with equals
+        yield "--#{$1}", [$2]
+        i += 1
+      when /^--(\S+)$/ # long argument
+        params = collect_argument_parameters(args, i + 1)
+        unless params.empty?
+          num_params_taken = yield args[i], params
+          unless num_params_taken
+            if @stop_on_unknown
+              remains += args[i + 1 .. -1]
+              return remains
+            else
+              remains += params
+            end
+          end
+          i += 1 + num_params_taken
+        else # long argument no parameter
+          yield args[i], nil
+          i += 1
+        end
+      when /^-(\S+)$/ # one or more short arguments
+        shortargs = $1.split(//)
+        shortargs.each_with_index do |a, j|
+          if j == (shortargs.length - 1)
+            params = collect_argument_parameters(args, i + 1)
+            unless params.empty?
+              num_params_taken = yield "-#{a}", params
+              unless num_params_taken
+                if @stop_on_unknown
+                  remains += args[i + 1 .. -1]
+                  return remains
+                else
+                  remains += params
+                end
+              end
+              i += 1 + num_params_taken
+            else # argument no parameter
+              yield "-#{a}", nil
+              i += 1
+            end
+          else
+            yield "-#{a}", nil
+          end
+        end
+      else
+        if @stop_on_unknown
+          remains += args[i .. -1]
+          return remains
+        else
+          remains << args[i]
+          i += 1
+        end
+      end
+    end
+
+    remains
+  end
+
+  def parse_integer_parameter param, arg
+    raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^\d+$/
+    param.to_i
+  end
+
+  def parse_float_parameter param, arg
+    raise CommandlineError, "option '#{arg}' needs a floating-point number" unless param =~ FLOAT_RE
+    param.to_f
+  end
+
+  def parse_io_parameter param, arg
+    case param
+    when /^(stdin|-)$/i; $stdin
+    else
+      require 'open-uri'
+      begin
+        open param
+      rescue SystemCallError => e
+        raise CommandlineError, "file or url for option '#{arg}' cannot be opened: #{e.message}"
+      end
+    end
+  end
+
+  def collect_argument_parameters args, start_at
+    params = []
+    pos = start_at
+    while args[pos] && args[pos] !~ PARAM_RE && !@stop_words.member?(args[pos]) do
+      params << args[pos]
+      pos += 1
+    end
+    params
+  end
+
+  def resolve_default_short_options
+    @order.each do |type, name|
+      next unless type == :opt
+      opts = @specs[name]
+      next if opts[:short]
+
+      c = opts[:long].split(//).find { |d| d !~ INVALID_SHORT_ARG_REGEX && !@short.member?(d) }
+      raise ArgumentError, "can't generate a default short option name for #{opts[:long].inspect}: out of unique characters" unless c
+
+      opts[:short] = c
+      @short[c] = name
+    end
+  end
+
+  def wrap_line str, opts={}
+    prefix = opts[:prefix] || 0
+    width = opts[:width] || (self.width - 1)
+    start = 0
+    ret = []
+    until start > str.length
+      nextt =
+        if start + width >= str.length
+          str.length
+        else
+          x = str.rindex(/\s/, start + width)
+          x = str.index(/\s/, start) if x && x < start
+          x || str.length
+        end
+      ret << (ret.empty? ? "" : " " * prefix) + str[start ... nextt]
+      start = nextt + 1
+    end
+    ret
+  end
+
+  ## instance_eval but with ability to handle block arguments
+  ## thanks to why: http://redhanded.hobix.com/inspect/aBlockCostume.html
+  def cloaker &b
+    (class << self; self; end).class_eval do
+      define_method :cloaker_, &b
+      meth = instance_method :cloaker_
+      remove_method :cloaker_
+      meth
+    end
+  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 block passed in should contain zero or more calls to +opt+
+## (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'
+##   opts = Trollop::options 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
+##     opt :num_limbs, "Number of limbs", :default => 4   # an integer --num-limbs <i>, defaulting to 4
+##     opt :num_thumbs, "Number of thumbs", :type => :int # an integer --num-thumbs <i>, defaulting to nil
+##   end
+##
+##   ## 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
+  @p = Parser.new(*a, &b)
+  Trollop.do_parse_args(@p)
+end
+
+def self.do_parse_args options_parser, args = ARGV
+  @p = options_parser
+  begin
+    vals = @p.parse args
+    args.clear
+    @p.leftovers.each { |l| args << l }
+    vals
+  rescue CommandlineError => e
+    $stderr.puts "Error: #{e.message}."
+    $stderr.puts "Try --help for help."
+    exit(-1)
+  rescue HelpNeeded
+    @p.educate
+    exit
+  rescue VersionNeeded
+    puts @p.version
+    exit
+  end
+end
+
+## Informs the user that their usage of 'arg' was wrong, as detailed by
+## 'msg', and dies. Example:
+##
+##   options do
+##     opt :volume, :default => 0.0
+##   end
+##
+##   die :volume, "too loud" if opts[:volume] > 10.0
+##   die :volume, "too soft" if opts[:volume] < 0.1
+##
+## In the one-argument case, simply print that message, a notice
+## about -h, and die. Example:
+##
+##   options do
+##     opt :whatever # ...
+##   end
+##
+##   Trollop::die "need at least one filename" if ARGV.empty?
+def die arg, msg=nil
+  if msg
+    $stderr.puts "Error: argument --#{@p.specs[arg][:long]} #{msg}."
+  else
+    $stderr.puts "Error: #{arg}."
+  end
+  $stderr.puts "Try --help for help."
+  exit(-1)
+end
+
+module_function :options, :die
+
+end # module