trollop 1.7.2 → 1.8

data/README.txt

@@ -24,6 +24,7 @@ Trollop: getting you 90% of the way there with only 10% of the effort.
 - 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.
 
@@ -61,63 +62,21 @@ Trollop: getting you 90% of the way there with only 10% of the effort.
   Trollop::die :volume, "must be non-negative" if opts[:volume] < 0
   Trollop::die :file, "must exist" unless File.exist?(opts[:file]) if opts[:file]
 
-  ###### real-life ######
+  ##### sub-command support ######
 
   require 'trollop'
-  opts = Trollop::options do
-    version "sup-sync (sup #{Redwood::VERSION})"
-    banner <<EOS
-  Synchronizes the Sup index with one or more message sources by adding
-  messages, deleting messages, or changing message state in the index as
-  appropriate.
-
-  [...]
-  
-  Usage:
-    sup-sync [options] <source>*
-  
-  where <source>* is zero or more source URIs. If no sources are given,
-  sync from all usual sources. Supported source URI schemes can be seen
-  by running "sup-add --help".
-  
-  Options controlling WHICH messages sup-sync operates on:
-  EOS
-    opt :new, "Operate on new messages only. Don't scan over the entire source. (Default.)", :short => :none
-    opt :changed, "Scan over the entire source for messages that have been deleted, altered, or moved from another source. (In the case of mbox sources, this includes all messages AFTER an altered message.)"
-    opt :restored, "Operate only on those messages included in a dump file as specified by --restore which have changed state."
-    opt :all, "Operate on all messages in the source, regardless of newness or changedness."
-    opt :start_at, "For --changed and --all, start at a particular offset.", :type => :int
-  
-  text <<EOS
-  
-  Options controlling HOW message state is altered:
-  EOS
-    opt :asis, "If the message is already in the index, preserve its state. Otherwise, use default source state. (Default.)", :short => :none
-    opt :restore, "Restore message state from a dump file created with sup-dump. If a message is not in this dumpfile, act as --asis.", :type => String, :short => :none
-    opt :discard, "Discard any message state in the index and use the default source state. Dangerous!", :short => :none
-    opt :archive, "When using the default source state, mark messages as archived.", :short => "-x"
-    opt :read, "When using the default source state, mark messages as read."
-    opt :extra_labels, "When using the default source state, also apply these user-defined labels. Should be a comma-separated list.", :type => String, :short => :none
-  
-  text <<EOS
-  
-  Other options:
-  EOS
-    opt :verbose, "Print message ids as they're processed."
-    opt :optimize, "As the final operation, optimize the index."
-    opt :all_sources, "Scan over all sources.", :short => :none
-    opt :dry_run, "Don't actually modify the index. Probably only useful with --verbose.", :short => "-n"
-    opt :version, "Show version information", :short => :none
-  
-    conflicts :changed, :all, :new, :restored
-    conflicts :asis, :restore, :discard
+  global_opts = Trollop::options do
+    opt :global_option, "This is a global option"
+    stop_on %w(sub-command-1 sub-command-2)
   end
-  Trollop::die :restored, "requires --restore" if opts[:restored] unless opts[:restore]
-  if opts[:start_at]
-    Trollop::die :start_at, "must be non-negative" if opts[:start_at] < 0
-    Trollop::die :start_at, "requires either --changed or --all" unless opts[:changed] || opts[:all]
+
+  cmd = ARGV.shift
+  cmd_opts = Trollop::options do
+    opt :cmd_option, "This is an option only for the subcommand"
   end
 
+  puts "global: #{global_opts.inspect}, cmd: #{cmd.inspect}, cmd options: #{cmd_opts.inspect}"
+
 == REQUIREMENTS
 
 * none!

data/lib/trollop.rb

@@ -5,7 +5,7 @@
 
 module Trollop
 
-VERSION = "1.7.2"
+VERSION = "1.8"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
@@ -49,6 +49,7 @@ class Parser
     @short = {}
     @order = []
     @constraints = []
+    @stop_words = []
 
     #instance_eval(&b) if b # can't take arguments
     cloaker(&b).bind(self).call(*a) if b
@@ -186,12 +187,27 @@ class Parser
     @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.
+  def stop_on *words
+    @stop_words = [*words].flatten
+  end
+
   ## yield successive arg, parameter pairs
   def each_arg args # :nodoc:
     remains = []
     i = 0
 
     until i >= args.length
+      if @stop_words.member? args[i]
+        remains += args[i .. -1]
+        break
+      end
       case args[i]
       when /^--$/ # arg terminator
         remains += args[(i + 1) .. -1]
@@ -200,7 +216,7 @@ class Parser
         yield "--#{$1}", $2
         i += 1
       when /^--(\S+)$/ # long argument
-        if args[i + 1] && args[i + 1] !~ PARAM_RE
+        if args[i + 1] && args[i + 1] !~ PARAM_RE && !@stop_words.member?(args[i + 1])
           remains << args[i + 1] unless yield args[i], args[i + 1]
           i += 2
         else # long argument no parameter
@@ -210,7 +226,7 @@ class Parser
       when /^-(\S+)$/ # one or more short arguments
         shortargs = $1.split(//)
         shortargs.each_with_index do |a, j|
-          if j == (shortargs.length - 1) && args[i + 1] && args[i + 1] !~ PARAM_RE
+          if j == (shortargs.length - 1) && args[i + 1] && args[i + 1] !~ PARAM_RE && !@stop_words.member?(args[i + 1])
             remains << args[i + 1] unless yield "-#{a}", args[i + 1]
             i += 1 # once more below
           else

data/test/test_trollop.rb

@@ -463,6 +463,81 @@ EOM
 
     assert_nothing_raised { @p.parse(%w(--arg1 --arg2)) }
   end
+
+  def test_stopwords_mixed
+    @p.opt "arg1", :default => false
+    @p.opt "arg2", :default => false
+    @p.stop_on %w(happy sad)
+
+    opts = @p.parse %w(--arg1 happy --arg2)
+    assert_equal true, opts["arg1"]
+    assert_equal false, opts["arg2"]
+
+    ## restart parsing
+    @p.leftovers.shift
+    opts = @p.parse @p.leftovers
+    assert_equal false, opts["arg1"]
+    assert_equal true, opts["arg2"]
+  end
+
+  def test_stopwords_no_stopwords
+    @p.opt "arg1", :default => false
+    @p.opt "arg2", :default => false
+    @p.stop_on %w(happy sad)
+
+    opts = @p.parse %w(--arg1 --arg2)
+    assert_equal true, opts["arg1"]
+    assert_equal true, opts["arg2"]
+
+    ## restart parsing
+    @p.leftovers.shift
+    opts = @p.parse @p.leftovers
+    assert_equal false, opts["arg1"]
+    assert_equal false, opts["arg2"]
+  end
+
+  def test_stopwords_multiple_stopwords
+    @p.opt "arg1", :default => false
+    @p.opt "arg2", :default => false
+    @p.stop_on %w(happy sad)
+
+    opts = @p.parse %w(happy sad --arg1 --arg2)
+    assert_equal false, opts["arg1"]
+    assert_equal false, opts["arg2"]
+
+    ## restart parsing
+    @p.leftovers.shift
+    opts = @p.parse @p.leftovers
+    assert_equal false, opts["arg1"]
+    assert_equal false, opts["arg2"]
+
+    ## restart parsing again
+    @p.leftovers.shift
+    opts = @p.parse @p.leftovers
+    assert_equal true, opts["arg1"]
+    assert_equal true, opts["arg2"]
+  end
+
+  def test_stopwords_with_short_args
+    @p.opt :global_option, "This is a global option", :short => "-g"
+    @p.stop_on %w(sub-command-1 sub-command-2)
+
+    global_opts = @p.parse %w(-g sub-command-1 -c)
+    cmd = @p.leftovers.shift
+
+    @q = Parser.new
+    @q.opt :cmd_option, "This is an option only for the subcommand", :short => "-c"
+    cmd_opts = @q.parse @p.leftovers
+
+    assert_equal true, global_opts[:global_option]
+    assert_nil global_opts[:cmd_option]
+
+    assert_equal true, cmd_opts[:cmd_option]
+    assert_nil cmd_opts[:global_option]
+
+    assert_equal cmd, "sub-command-1"
+    assert_equal @q.leftovers, []
+  end
 end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trollop
 version: !ruby/object:Gem::Version 
-  version: 1.7.2
+  version: "1.8"
 platform: ruby
 authors: 
 - William Morgan
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-16 00:00:00 -08:00
+date: 2008-06-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: "== DESCRIPTION  Trollop is YAFCLAP --- yet another fine commandline argument processor for Ruby. Trollop is designed to provide the maximal amount of GNU-style argument processing in the minimum number of lines of code (for you, the programmer).  - 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. - Automatic help message generation, wrapped to current screen width. - Lots of unit tests.  Synopsis  ###### simple ######  require 'trollop' 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  p opts  ###### medium ######  require 'trollop' opts = Trollop::options do version \"test 1.2.3 (c) 2007 William Morgan\" banner <<-EOS Test is an awesome program that does something very, very important.  Usage: test [options] <filenames>+ where [options] are: EOS  opt :ignore, \"Ignore incorrect values\" opt :file, \"Extra data filename to read in, with a very long option description like this one\", :type => String opt :volume, \"Volume level\", :default => 3.0 opt :iters, \"Number of iterations\", :default => 5 end Trollop::die :volume, \"must be non-negative\" if opts[:volume] < 0 Trollop::die :file, \"must exist\" unless File.exist?(opts[:file]) if opts[:file]  ###### real-life ######"
+description: "== DESCRIPTION  Trollop is YAFCLAP --- yet another fine commandline argument processor for Ruby. Trollop is designed to provide the maximal amount of GNU-style argument processing in the minimum number of lines of code (for you, the programmer).  - 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.  Synopsis  ###### simple ######  require 'trollop' 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  p opts  ###### medium ######  require 'trollop' opts = Trollop::options do version \"test 1.2.3 (c) 2007 William Morgan\" banner <<-EOS Test is an awesome program that does something very, very important.  Usage: test [options] <filenames>+ where [options] are: EOS  opt :ignore, \"Ignore incorrect values\" opt :file, \"Extra data filename to read in, with a very long option description like this one\", :type => String opt :volume, \"Volume level\", :default => 3.0 opt :iters, \"Number of iterations\", :default => 5 end Trollop::die :volume, \"must be non-negative\" if opts[:volume] < 0 Trollop::die :file, \"must exist\" unless File.exist?(opts[:file]) if opts[:file]  ##### sub-command support ######"
 email: wmorgan-trollop@masanjin.net
 executables: []