trollop 1.11 → 1.12

data/History.txt

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

data/lib/trollop.rb

@@ -5,7 +5,7 @@
 
 module Trollop
 
-VERSION = "1.11"
+VERSION = "1.12"
 
 ## Thrown by Parser in the event of a commandline error. Not needed if
 ## you're using the Trollop::options entry.
@@ -197,21 +197,12 @@ class Parser
 
     ## fill in :short
     opts[:short] = opts[:short].to_s if opts[:short] unless opts[:short] == :none
-    opts[:short] =
-      case opts[:short]
-      when nil
-        c = opts[:long].split(//).find { |c| c !~ INVALID_SHORT_ARG_REGEX && !@short.member?(c) }
-        raise ArgumentError, "can't generate a short option name for #{opts[:long].inspect}: out of unique characters" unless c
-        c
-      when /^-(.)$/
-        $1
-      when /^.$/
-        opts[:short]
-      when :none
-        nil
-      else
-        raise ArgumentError, "invalid short option name '#{opts[:short].inspect}'"
-      end
+    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
@@ -228,7 +219,7 @@ class Parser
 
     opts[:desc] ||= desc
     @long[opts[:long]] = name
-    @short[opts[:short]] = name if opts[:short]
+    @short[opts[:short]] = name if opts[:short] && opts[:short] != :none
     @specs[name] = opts
     @order << [:opt, name]
   end
@@ -278,78 +269,6 @@ class Parser
     @stop_on_unknown = true
   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]
-        return remains
-      end
-      case args[i]
-      when /^--$/ # arg terminator
-        remains += args[(i + 1) .. -1]
-        return remains
-      when /^--(\S+?)=(\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
-
   ## Parses the commandline. Typically called by Trollop::options.
   def parse cmdline=ARGV
     vals = {}
@@ -363,6 +282,8 @@ class Parser
       vals[sym] = opts[:default]
     end
 
+    resolve_default_short_options
+
     ## resolve symbols
     given_args = {}
     @leftovers = each_arg cmdline do |arg, params|
@@ -467,56 +388,6 @@ class Parser
     vals
   end
 
-  def parse_integer_parameter param, arg #:nodoc:
-    raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^\d+$/
-    param.to_i
-  end
-
-  def parse_float_parameter param, arg #:nodoc:
-    raise CommandlineError, "option '#{arg}' needs a floating-point number" unless param =~ FLOAT_RE
-    param.to_f
-  end
-
-  def parse_io_parameter param, arg #:nodoc:
-    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 #:nodoc:
-    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 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
-
   ## Print the help message to +stream+.
   def educate stream=$stdout
     width # just calculate it now; otherwise we have to be careful not to
@@ -525,7 +396,7 @@ class Parser
     left = {}
     @specs.each do |name, spec| 
       left[name] = "--#{spec[:long]}" +
-        (spec[:short] ? ", -#{spec[:short]}" : "") +
+        (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
         case spec[:type]
         when :flag; ""
         when :int; " <i>"
@@ -580,7 +451,152 @@ class Parser
     end
   end
 
-  def wrap_line str, opts={} # :nodoc:
+  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+?)=(\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 { |c| c !~ INVALID_SHORT_ARG_REGEX && !@short.member?(c) }
+      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
@@ -600,17 +616,9 @@ class Parser
     ret
   end
 
-  def wrap str, opts={} # :nodoc:
-    if str == ""
-      [""]
-    else
-      str.split("\n").map { |s| wrap_line s, opts }.flatten
-    end
-  end
-
   ## instance_eval but with ability to handle block arguments
   ## thanks to why: http://redhanded.hobix.com/inspect/aBlockCostume.html
-  def cloaker &b #:nodoc:
+  def cloaker &b
     (class << self; self; end).class_eval do
       define_method :cloaker_, &b
       meth = instance_method :cloaker_
@@ -704,4 +712,3 @@ end
 module_function :options, :die
 
 end # module
-

data/test/test_trollop.rb

@@ -173,7 +173,6 @@ class Trollop < ::Test::Unit::TestCase
     @p.opt "arg"
     @p.opt "arg2"
     @p.opt "arg3"
-    assert_raise(ArgumentError) { @p.opt "gra" }
     opts = @p.parse %w(-a -g)
     assert_equal true, opts["arg"]
     assert_equal false, opts["arg2"]
@@ -199,8 +198,8 @@ class Trollop < ::Test::Unit::TestCase
     @p.opt :arg1 # auto: a
     @p.opt :arg2 # auto: r
     @p.opt :arg3 # auto: g
-    assert_raises(ArgumentError) { @p.opt :arg4 }
-    assert_nothing_raised { @p.opt :argf }
+    @p.opt :arg4 # auto: uh oh!
+    assert_raises(ArgumentError) { @p.parse [] }
   end
 
   def test_short_can_be_nothing
@@ -839,7 +838,7 @@ EOM
     @p.opt :global_param, "Global parameter", :short => "-p", :default => 5
     @p.stop_on_unknown
 
-    expected_opts = { :global_flag =>true, :help =>false, :global_param =>5 }
+    expected_opts = { :global_flag => true, :help => false, :global_param => 5, :global_flag_given => true }
     expected_leftovers = [ "my_subcommand", "-c" ]
 
     assert_parses_correctly @p, %w(--global-flag my_subcommand -c), \
@@ -847,7 +846,7 @@ EOM
     assert_parses_correctly @p, %w(-g my_subcommand -c), \
       expected_opts, expected_leftovers
 
-    expected_opts = { :global_flag =>false, :help =>false, :global_param =>5 }
+    expected_opts = { :global_flag => false, :help => false, :global_param => 5, :global_param_given => true }
     expected_leftovers = [ "my_subcommand", "-c" ]
 
     assert_parses_correctly @p, %w(-p 5 my_subcommand -c), \
@@ -951,6 +950,46 @@ EOM
     opts = @p.parse %w()
     assert_equal ["potato", "rhubarb"], opts[:arg4]
   end
+
+  def test_given_keys
+    @p.opt :arg1
+    @p.opt :arg2
+
+    opts = @p.parse %w(--arg1)
+    assert opts[:arg1_given]
+    assert !opts[:arg2_given]
+
+    opts = @p.parse %w(--arg2)
+    assert !opts[:arg1_given]
+    assert opts[:arg2_given]
+
+    opts = @p.parse []
+    assert !opts[:arg1_given]
+    assert !opts[:arg2_given]
+
+    opts = @p.parse %w(--arg1 --arg2)
+    assert opts[:arg1_given]
+    assert opts[:arg2_given]
+  end
+
+  def test_default_shorts_assigned_only_after_user_shorts
+    @p.opt :aab, "aaa" # should be assigned to -b
+    @p.opt :ccd, "bbb" # should be assigned to -d
+    @p.opt :user1, "user1", :short => 'a'
+    @p.opt :user2, "user2", :short => 'c'
+
+    opts = @p.parse %w(-a -b)
+    assert opts[:user1]
+    assert !opts[:user2]
+    assert opts[:aab]
+    assert !opts[:ccd]
+
+    opts = @p.parse %w(-c -d)
+    assert !opts[:user1]
+    assert opts[:user2]
+    assert !opts[:aab]
+    assert opts[:ccd]
+  end
 end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trollop
 version: !ruby/object:Gem::Version 
-  version: "1.11"
+  version: "1.12"
 platform: ruby
 authors: 
 - William Morgan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-01-30 00:00:00 -08:00
 default_executable: 
 dependencies: []