choice 0.1.3 → 0.1.4

data/README

@@ -68,13 +68,15 @@ programs utilizing the library have been placed.  Here's a snippet:
     end
   end
 
-  puts 'port: ' + Choice.choices[:port]
+  puts 'port: ' + Choice[:port]
 
 Notice the last line.  For free, you will be given a <tt>Choice.choices</tt> 
-hash which contain, at runtime, the options found and their values.
+hash which contain, at runtime, the options found and their values. 
+
+<tt>Choice[:key]</tt> is a shortcut for <tt>Choice.choices[:key]</tt>.
 
 Because we gave option <tt>:port</tt> a default of 21, 
-<tt>Choice.choices[:port]</tt> should be 21 if we run ftpd.rb with no options.  
+<tt>Choice[:port]</tt> should be 21 if we run ftpd.rb with no options.  
 Let's see.
 
  $ ruby ftpd.rb
@@ -89,7 +91,7 @@ Alright.  And, of course, there is the hard way of doing things.
 
  $ ruby ftpd.rb --port=2100
  port: 2100
- 
+
 That <tt>:version</tt> option looks pretty interesting, huh?  I wonder what it 
 does...
  

data/lib/choice.rb

@@ -36,26 +36,36 @@ module Choice
       @@options << [name.to_s, option]
     end
   end
+  
+  # Return an array representing the rest of the command line arguments
+  def rest
+    @@rest
+  end
 
   # Returns a hash representing options passed in via the command line.
   def choices
     @@choices
   end
 
+  # Shortcut access to Choice.choices
+  def [](choice)
+    choices[choice]
+  end
+
   # Defines an option.
   def option(opt, options = {}, &block)
     # Notice: options is maintained as an array of arrays, the first element
     # the option name and the second the option object.
     @@options << [opt.to_s, Option.new(options, &block)]
   end
-  
+
   # Separators are text displayed by --help within the options block.
   def separator(str)
-    # We store separators as simple strings in the options array to maintain 
+    # We store separators as simple strings in the options array to maintain
     # order.  They are ignored by the parser.
     @@options << str
   end
-  
+
   # Define the banner, header, footer methods.  All are just getters/setters
   # of class variables.
   %w[banner header footer].each do |method|
@@ -80,7 +90,8 @@ module Choice
       begin
         # Delegate parsing to our parser class, passing it our defined 
         # options and the passed arguments.
-        @@choices = LazyHash.new(Parser.parse(@@options, @@args))
+        @@choices, @@rest = Parser.parse(@@options, @@args)
+        @@choices = LazyHash.new(@@choices)
       rescue Choice::Parser::ParseError
         # If we get an expected exception, show the help file.
         help

data/lib/choice/parser.rb

@@ -18,6 +18,9 @@ module Choice
       # Return empty hash if the parsing adventure would be fruitless.
       return {} if options.nil? || !options || args.nil? || !args.is_a?(Array)
       
+      # Operate on a copy of the inputs
+      args = args.dup
+      
       # If we are passed an array, make the best of it by converting it
       # to a hash.
       options = options.inject({}) do |hash, value|
@@ -83,53 +86,53 @@ module Choice
         # is definitely required.
         required[name] = true if obj['valid']
       end
-
+      
+      rest = []
+      
       # Go through the arguments and try to figure out whom they belong to
       # at this point.
-      args.each_with_index do |arg, i|
+      while arg = args.shift
         if hashes['shorts'].value?(arg)
           # Set the value to the next element in the args array since
           # this is a short.
-          value = args[i+1]
 
-          # If the next element doesn't exist or starts with a -, make this
-          # value true.
-          value = true if !value || value =~ /^-/
+          # If the next argument isn't a value, set this value to true
+          if args.empty? || args.first.match(/^-/)
+            value = true
+          else
+            value = args.shift
+          end
 
           # Add this value to the choices hash with the key of the option's
           # name.  If we expect an array, tack this argument on.
           name = hashes['shorts'].index(arg)
           if arrayed[name]
             choices[name] ||= []
-            choices[name]  += arrayize_arguments(name, args[i+1..-1])
+            choices[name] << value unless value.nil?
+            choices[name]  += arrayize_arguments(args)
           else
             choices[name] = value
           end
 
-        elsif /^(--[^=]+)=?/ =~ arg && longs.value?($1)
+        elsif (m = arg.match(/^(--[^=]+)=?/)) && longs.value?(m[1])
           # The joke here is we always accept both --long=VALUE and --long VALUE.
           
           # Grab values from --long=VALUE format
-          if arg =~ /=/ && longs.value?((longed = arg.split('=')).first)
-            name  = longs.index(longed.shift)
-            value = longed * '='
-            # For the arrayed options.
-            potential_args = args[i+1..-1]
-          else
+          name, value = arg.split('=', 2)
+          name = longs.index(name)
+          
+          if value.nil? && args.first !~ /^-/
             # Grab value otherwise if not in --long=VALUE format.  Assume --long VALUE.
-            name = longs.index(arg)
             # Value is nil if we don't have a = and the next argument is no good
-            value = args[i+1] =~ /^-/ ? nil : args[i+1] 
-            # For the arrayed options.
-            potential_args = args[i+2..-1]
+            value = args.shift
           end
 
           # If we expect an array, tack this argument on.
-          if arrayed[name] && !value.nil?
+          if arrayed[name]
             # If this is arrayed and the value isn't nil, set it.
             choices[name] ||= []
-            choices[name] << value
-            choices[name] += arrayize_arguments(name, potential_args)
+            choices[name] << value unless value.nil?
+            choices[name] += arrayize_arguments(args)
           else
             # If we set the value to nil, that means nothing was set and we
             # need to set the value to true.  We'll find out later if that's 
@@ -139,7 +142,11 @@ module Choice
 
         else
           # If we're here, we have no idea what the passed argument is.  Die.
-          raise UnknownOption if arg =~ /^-/
+          if arg =~ /^-/
+            raise UnknownOption 
+          else
+            rest << arg
+          end
         end
       end
 
@@ -159,10 +166,10 @@ module Choice
 
         # Make sure the argument is valid
         raise InvalidArgument unless value.to_a.all? { |v| hashes['valids'][name].include?(v) } if hashes['valids'][name] 
-        
+
         # Cast the argument using the method defined in the constant hash.
         value = value.send(CAST_METHODS[hashes['casts'][name]]) if hashes['casts'].include?(name)
-        
+
         # Run the value through a filter and re-set it with the return.
         value = hashes['filters'][name].call(value) if hashes['filters'].include?(name)
 
@@ -186,19 +193,18 @@ module Choice
         choices[name] = value unless choices[name]
       end
       
-      # Return the choices hash.
-      choices
+      # Return the choices hash and the rest of the args
+      [ choices, rest ]
     end
 
   private
     # Turns trailing command line arguments into an array for an arrayed value
-    def arrayize_arguments(name, args)
+    def arrayize_arguments(args)
       # Go through trailing arguments and suck them in if they don't seem
       # to have an owner.
       array = []
-      potential_args = args.dup 
-      until (arg = potential_args.shift) =~ /^-/ || arg.nil?
-        array << arg
+      until args.empty? || args.first.match(/^-/)
+        array << args.shift
       end
       array
     end

data/lib/choice/version.rb

@@ -2,7 +2,7 @@ module Choice
   module Version #:nodoc:
     MAJOR  = 0
     MINOR  = 1
-    TINY   = 3
+    TINY   = 4
     STRING = [MAJOR, MINOR, TINY] * '.'
   end
 end

data/test/test_choice.rb

@@ -32,27 +32,30 @@ class TestChoice < Test::Unit::TestCase
       footer ""
       footer "--help This message"
     end
-    
+
     band = 'LedZeppelin'
     animal = 'Reindeer'
-    
+
     args = ['-b', band, "--animal=#{animal}"]
     Choice.args = args
-    
+
     assert_equal band, Choice.choices['band']
     assert_equal animal, Choice.choices[:animal]
     assert_equal ["Tell me about yourself?", ""], Choice.header
     assert_equal ["", "--help This message"], Choice.footer
+
+    assert_equal Choice.choices['band'], Choice['band']
+    assert_equal Choice.choices[:animal], Choice[:animal]
   end
-  
+
   def test_failed_parse
     assert Hash.new, Choice.parse
   end
-  
+
   HELP_STRING = ''
   def test_help
     Choice.output_to(HELP_STRING)
-    
+
     Choice.options do
       banner "Usage: choice [-mu]"
       header ""

data/test/test_parser.rb

@@ -7,7 +7,7 @@ class TestParser < Test::Unit::TestCase
   def setup
     @options = {}
   end
-  
+
   def test_parse_options
     @options['band'] = Choice::Option.new do
       short '-b'
@@ -20,36 +20,36 @@ class TestParser < Test::Unit::TestCase
       long '--animal=ANIMAL'
       cast String
       desc 'Your favorite animal.'
-    end      
+    end
     band = 'Led Zeppelin'
     animal = 'Reindeer'
-    
+
     args = ['-b', band, "--animal=#{animal}"]
-          
-    choices = Choice::Parser.parse(@options, args)
-    
+
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal band, choices['band']
     assert_equal animal, choices['animal']
   end
-  
+
   def test_parse_no_options
     assert_equal Hash.new, Choice::Parser.parse(nil, nil)
   end
-  
+
   def test_parse_default
     @options['soda'] = Choice::Option.new do
       short '-s'
       long '--soda=SODA'
       default 'PibbJr'
     end
-    
+
     args = []
-    
-    choices = Choice::Parser.parse(@options, args)
-    
+
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal 'PibbJr', choices['soda']
   end
-  
+
   def test_parse_options_with_filters
     @options['host'] = Choice::Option.new do
       short '-h'
@@ -57,27 +57,27 @@ class TestParser < Test::Unit::TestCase
         opt.gsub!(/[^\w]/, '')
         opt = opt.sub(/k/, 'c')
       end
-    end     
+    end
     host = 'de.fun.kt'
     args = ['-h', host]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal 'defunct', choices['host']
-  end 
-  
+  end
+
   def test_casting
     @options['port'] = Choice::Option.new do
       short '-p'
       cast Integer
     end
-    
+
     port = '3000'
     args = ['-p', port]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal port.to_i, choices['port']
   end
-  
+
   def test_text_required
     @options['name'] = Choice::Option.new do
       short '-n'
@@ -88,29 +88,29 @@ class TestParser < Test::Unit::TestCase
       long 'age[=AGE]'
       cast Integer
     end
-    
+
     args = ['-n', '-a', '21']
-    
+
     assert_raise(Choice::Parser::ArgumentRequired) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
   end
-  
+
   def test_text_optional
     @options['color'] = Choice::Option.new do
       short '-c'
       long '--color[=COLOR]'
     end
-    
+
     args = ['-c']
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert choices['color']
-    
+
     color = 'ladyblue'
     args = ['-c', color]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal color, choices['color']
   end
 
@@ -119,38 +119,38 @@ class TestParser < Test::Unit::TestCase
       short '-c'
       long '--color=[COLOR]'
     end
-    
+
     args = ['-c']
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert choices['color']
-    
+
     color = 'ladyblue'
     args = ['-c', color]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal color, choices['color']
   end
-  
+
   def test_ignore_separator
     options = []
     options << ['keyboard', Choice::Option.new do
       short '-k'
       long '--keyboard=BOARD'
     end]
-    
+
     options << ['mouse', Choice::Option.new do
       short '-m'
       long '--mouse=MOUSE'
     end]
-    
+
     args = ['-m', 'onebutton']
-    choices = Choice::Parser.parse([options.first, '----', options.last], args)
-    
+    choices, rest = Choice::Parser.parse([options.first, '----', options.last], args)
+
     assert choices['mouse']
     assert_equal 1, choices.size
   end
-  
+
   def test_long_as_switch
     @options['chunky'] = Choice::Option.new do
       short '-b'
@@ -158,11 +158,11 @@ class TestParser < Test::Unit::TestCase
     end
 
     args = ['--bacon']
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert choices['chunky']
   end
-  
+
   def test_validate_regexp
     @options['email'] = Choice::Option.new do
       short '-e'
@@ -171,20 +171,20 @@ class TestParser < Test::Unit::TestCase
       validate /^[a-z0-9_.-]+@[a-z0-9_.-]+\.[a-z]{2,4}$/i
     end
 
-    email_bad = 'this will@neverwork'    
+    email_bad = 'this will@neverwork'
     email_good = 'chris@ozmm.org'
-    
+
     args = ['-e', email_bad]
     assert_raise(Choice::Parser::ArgumentValidationFails) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
 
     args = ['-e', email_good]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal email_good, choices['email']
   end
-  
+
   def test_validate_block
     @options['file'] = Choice::Option.new do
       short '-f'
@@ -197,15 +197,15 @@ class TestParser < Test::Unit::TestCase
 
     file_bad = 'not_a_file.rb'
     file_good = __FILE__
-    
+
     args = ['-f', file_bad]
     assert_raise(Choice::Parser::ArgumentValidationFails) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
 
     args = ['-f', file_good]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal file_good, choices['file']
   end
 
@@ -215,10 +215,10 @@ class TestParser < Test::Unit::TestCase
       long '--cd=CD'
       desc 'A CD you like.'
     end
-  
+
     args = ['-c', 'BestOfYanni', '--grace']
     assert_raise(Choice::Parser::UnknownOption) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
   end
 
@@ -232,15 +232,15 @@ class TestParser < Test::Unit::TestCase
 
     suit_good = 'club'
     suit_bad = 'joker'
-    
+
     args = ['-s', suit_bad]
     assert_raise(Choice::Parser::InvalidArgument) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
 
     args = ['-s', suit_good]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal suit_good, choices['suit']
   end
 
@@ -251,10 +251,10 @@ class TestParser < Test::Unit::TestCase
       valid %w[jeans slacks trunks boxers]
       desc "Your preferred type of pants."
     end
-    
+
     args = ['-p']
     assert_raise(Choice::Parser::ArgumentRequiredWithValid) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
   end
 
@@ -268,19 +268,19 @@ class TestParser < Test::Unit::TestCase
     mediums = %w[canvas stone steel]
 
     args = ['-m', mediums.first, '-m',  mediums[1], '-m', mediums.last]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal mediums, choices['medium']
 
     args = ['-m', mediums.first, mediums[1], mediums.last]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal mediums, choices['medium']
 
     args = ["--medium=#{mediums.first}", "--medium=#{mediums[1]}", "--medium=#{mediums.last}"]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal mediums, choices['medium']
 
     args = ["--medium=#{mediums.first}", mediums[1], mediums.last]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal mediums, choices['medium']
   end
 
@@ -293,14 +293,15 @@ class TestParser < Test::Unit::TestCase
 
     instruments = %w[xylophone guitar piano]
 
-    args = ["--instruments=#{instruments.first}", "--instruments=#{instruments[1]}", 
+    args = ["--instruments=#{instruments.first}",
+            "--instruments=#{instruments[1]}",
             "--instruments=#{instruments.last}"]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal instruments, choices['instruments']
 
     args = %w[--instruments]
-    choices = Choice::Parser.parse(@options, args)
-    assert_equal true, choices['instruments']
+    choices, rest = Choice::Parser.parse(@options, args)
+    assert_equal [], choices['instruments']
   end
 
   def test_long_as_array_with_valid
@@ -314,13 +315,13 @@ class TestParser < Test::Unit::TestCase
     suits = %w[spade heart]
 
     args = ['-s', suits.first, suits.last]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal suits, choices['suits']
-    
+
     args = ['-s', suits.first, 'notasuit']
     assert_raise(Choice::Parser::InvalidArgument) do
-      choices = Choice::Parser.parse(@options, args)
+      choices, rest = Choice::Parser.parse(@options, args)
     end
   end
 
@@ -334,8 +335,8 @@ class TestParser < Test::Unit::TestCase
     donut = 'long-john'
 
     args = ['--donut', donut]
-    choices = Choice::Parser.parse(@options, args)
-    
+    choices, rest = Choice::Parser.parse(@options, args)
+
     assert_equal donut, choices['donut']
   end
 
@@ -349,11 +350,11 @@ class TestParser < Test::Unit::TestCase
     donut = 'chocolate'
 
     args = ['--donut', donut]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal donut, choices['donut']
 
     args = ['--donut']
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal true, choices['donut']
   end
 
@@ -367,7 +368,22 @@ class TestParser < Test::Unit::TestCase
     donuts = %w[glazed cream-filled]
 
     args = ['--donuts', donuts.first, donuts.last]
-    choices = Choice::Parser.parse(@options, args)
+    choices, rest = Choice::Parser.parse(@options, args)
     assert_equal donuts, choices['donuts']
   end
+
+  def test_long_with_rest
+    @options['donut'] = Choice::Option.new do
+      short '-d'
+      long '--donut [DONUT]'
+      desc "Your favorite donut style."
+    end
+
+    donut = 'chocolate'
+
+    args = ['eat', '--donut', donut]
+    choices, rest = Choice::Parser.parse(@options, args)
+    assert_equal donut, choices['donut']
+    assert_equal ['eat'], rest
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: choice
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire: choice
 bindir: bin
 cert_chain: []
 
-date: 2009-02-19 00:00:00 -07:00
+date: 2009-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,7 +25,6 @@ files:
 - README
 - CHANGELOG
 - LICENSE
-- lib/choice
 - lib/choice/lazyhash.rb
 - lib/choice/option.rb
 - lib/choice/parser.rb
@@ -39,8 +38,10 @@ files:
 - test/test_writer.rb
 - examples/ftpd.rb
 - examples/gamble.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://choice.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -61,9 +62,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Choice is a command line option parser.
 test_files: []