slop 3.3.2 → 3.3.3

data/CHANGES.md

@@ -1,3 +1,10 @@
+3.3.3 (2012-08-29)
+------------------
+
+* Ensure autocreate arguments are not created as options (#77)
+* Ensure options are not swallowed when using short options with argument
+  included (#74)
+
 3.3.2 (2012-06-26)
 ------------------
 

data/lib/slop.rb

@@ -4,7 +4,7 @@ require 'slop/commands'
 class Slop
   include Enumerable
 
-  VERSION = '3.3.2'
+  VERSION = '3.3.3'
 
   # The main Error class, all Exception classes inherit from this class.
   class Error < StandardError; end
@@ -433,7 +433,7 @@ class Slop
       elsif option.accepts_optional_argument?
         argument ||= items.at(index + 1)
 
-        if argument && argument =~ /\A([^-\-?]|-\d)+/
+        if argument && argument =~ /\A([^\-?]|-\d)+/
           execute_option(option, argument, index, item)
         else
           option.call(nil)
@@ -467,7 +467,9 @@ class Slop
     end
 
     if argument
-      @trash << index + 1 unless item && item.end_with?("=#{argument}")
+      unless item && item.end_with?("=#{argument}")
+        @trash << index + 1 unless option.argument_in_value
+      end
       option.value = argument
     else
       option.value = option.count > 0
@@ -511,6 +513,7 @@ class Slop
       case flag
       when /\A--?([^=]+)=(.+)\z/, /\A-([a-zA-Z])(.+)\z/, /\A--no-(.+)\z/
         option, argument = fetch_option($1), ($2 || false)
+        option.argument_in_value = true if option
       end
     end
 
@@ -525,7 +528,7 @@ class Slop
   # Returns nothing.
   def autocreate(items, index)
     flag = items[index]
-    unless present?(flag)
+    if !fetch_option(flag) && !@trash.include?(index)
       option = build_option(Array(flag))
       argument = items[index + 1]
       option.config[:argument] = (argument && argument !~ /\A--?/)

data/lib/slop/commands.rb

@@ -2,7 +2,7 @@ class Slop
   class Commands
     include Enumerable
 
-    attr_reader :config, :commands
+    attr_reader :config, :commands, :arguments
     attr_writer :banner
 
     # Create a new instance of Slop::Commands and optionally build
@@ -37,6 +37,7 @@ class Slop
       @config = config
       @commands = {}
       @banner = nil
+      @triggered_command = nil
 
       if block_given?
         block.arity == 1 ? yield(self) : instance_eval(&block)
@@ -94,6 +95,19 @@ class Slop
     end
     alias get []
 
+    # Check for a command presence.
+    #
+    # Examples:
+    #
+    #   cmds.parse %w( foo )
+    #   cmds.present?(:foo) #=> true
+    #   cmds.present?(:bar) #=> false
+    #
+    # Returns true if the given key is present in the parsed arguments.
+    def present?(key)
+      key.to_s == @triggered_command
+    end
+
     # Parse a list of items.
     #
     # items - The Array of items to parse.
@@ -149,7 +163,8 @@ class Slop
     # Returns the Array of items (with options removed if bang == true).
     def parse_items(items, bang = false)
       if opts = commands[items[0].to_s]
-        items.shift
+        @triggered_command = items.shift
+        execute_arguments(items, bang)
         bang ? opts.parse!(items) : opts.parse(items)
         execute_global_opts(items, bang)
       else
@@ -165,6 +180,13 @@ class Slop
       items
     end
 
+    # Returns nothing.
+    def execute_arguments(items, bang)
+      @arguments = items.take_while { |arg| !arg.start_with?('-') }
+      items.shift(@arguments.size) if bang
+    end
+
+    # Returns nothing.
     def execute_global_opts(items, bang)
       if global_opts = commands['global']
         bang ? global_opts.parse!(items) : global_opts.parse(items)

data/lib/slop/option.rb

@@ -18,8 +18,7 @@ class Slop
     }
 
     attr_reader :short, :long, :description, :config, :types
-    attr_accessor :count
-    attr_writer :value
+    attr_accessor :count, :argument_in_value
 
     # Incapsulate internal option information, mainly used to store
     # option specific configuration data, most of the meat of this
@@ -39,13 +38,13 @@ class Slop
       @config = DEFAULT_OPTIONS.merge(config)
       @count = 0
       @callback = block_given? ? block : config[:callback]
+      @value = nil
 
       @types = {
         :string  => proc { |v| v.to_s },
         :symbol  => proc { |v| v.to_sym },
         :integer => proc { |v| value_to_integer(v) },
         :float   => proc { |v| value_to_float(v) },
-        :array   => proc { |v| v.split(@config[:delimiter], @config[:limit]) },
         :range   => proc { |v| value_to_range(v) },
         :count   => proc { |v| @count }
       }
@@ -55,7 +54,10 @@ class Slop
       end
 
       @config.each_key do |key|
-        self.class.send(:define_method, "#{key}?") { !!@config[key] }
+        predicate = :"#{key}?"
+        unless self.class.method_defined? predicate
+          self.class.send(:define_method, predicate) { !!@config[key] }
+        end
       end
     end
 
@@ -81,6 +83,23 @@ class Slop
       @callback.call(*objects) if @callback.respond_to?(:call)
     end
 
+    # Set the new argument value for this option.
+    #
+    # We use this setter method to handle concatenating lists. That is,
+    # when an array type is specified and used more than once, values from
+    # both options will be grouped together and flattened into a single array.
+    def value=(new_value)
+      if config[:as].to_s.downcase == 'array'
+        @value ||= []
+
+        if new_value.respond_to?(:split)
+          @value.concat new_value.split(config[:delimiter], config[:limit])
+        end
+      else
+        @value = new_value
+      end
+    end
+
     # Fetch the argument value for this option.
     #
     # Returns the Object once any type conversions have taken place.

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'slop'
-  s.version     = '3.3.2'
+  s.version     = '3.3.3'
   s.summary     = 'Option gathering made easy'
   s.description = 'A simple DSL for gathering options and parsing the command line'
   s.author      = 'Lee Jarvis'

data/test/commands_test.rb

@@ -27,6 +27,12 @@ class CommandsTest < TestCase
     assert_equal 'Force creation', @commands[:new].fetch_option(:force).description
   end
 
+  test "checking for a command presence" do
+    @commands.parse %w( new --force )
+    assert @commands.present?(:new)
+    refute @commands.present?(:version)
+  end
+
   test "to_hash" do
     assert_equal({
       :new => { :force => nil, :outdir => nil },
@@ -77,14 +83,20 @@ class CommandsTest < TestCase
     items = %w( foo bar baz )
     assert_equal items, @commands.parse(items)
 
-    items = %w( new --force )
+    items = %w( new file --force )
     assert_equal items, @commands.parse(items)
   end
 
   test "parse! removes options/arguments" do
-    items = %w( new --outdir foo )
+    items = %w( new file --outdir foo )
     @commands.parse!(items)
     assert_equal [], items
   end
 
-end
+  test "command arguments" do
+    items = %w( new file1 file2 --outdir foo )
+    @commands.parse(items)
+    assert_equal %w( file1 file2 ), @commands.arguments
+  end
+
+end

data/test/helper.rb

@@ -1,3 +1,5 @@
+$VERBOSE = true
+
 unless Object.const_defined? 'Slop'
   $:.unshift File.expand_path('../../lib', __FILE__)
   require 'slop'

data/test/option_test.rb

@@ -71,14 +71,14 @@ class OptionTest < TestCase
   end
 
   test "range type cast" do
-    assert_equal (1..10), option_value(%w/-r 1..10/, :r=, :as => Range)
-    assert_equal (1..10), option_value(%w/-r 1-10/, :r=, :as => Range)
-    assert_equal (1..10), option_value(%w/-r 1,10/, :r=, :as => Range)
-    assert_equal (1...10), option_value(%w/-r 1...10/, :r=, :as => Range)
-    assert_equal (-1..10), option_value(%w/-r -1..10/, :r=, :as => Range)
-    assert_equal (1..-10), option_value(%w/-r 1..-10/, :r=, :as => Range)
-    assert_equal (1..1), option_value(%w/-r 1/, :r=, :as => Range)
-    assert_equal (-1..10), option_value(%w/-r -1..10/, :r, :as => Range, :optional_argument => true)
+    assert_equal((1..10), option_value(%w/-r 1..10/, :r=, :as => Range))
+    assert_equal((1..10), option_value(%w/-r 1-10/, :r=, :as => Range))
+    assert_equal((1..10), option_value(%w/-r 1,10/, :r=, :as => Range))
+    assert_equal((1...10), option_value(%w/-r 1...10/, :r=, :as => Range))
+    assert_equal((-1..10), option_value(%w/-r -1..10/, :r=, :as => Range))
+    assert_equal((1..-10), option_value(%w/-r 1..-10/, :r=, :as => Range))
+    assert_equal((1..1), option_value(%w/-r 1/, :r=, :as => Range))
+    assert_equal((-1..10), option_value(%w/-r -1..10/, :r, :as => Range, :optional_argument => true))
 
     opts = Slop.new(:strict => true) { on :r=, :as => Range }
     assert_raises(Slop::InvalidArgumentError) { opts.parse %w/-r abc/ }
@@ -86,6 +86,7 @@ class OptionTest < TestCase
 
   test "array type cast" do
     assert_equal %w/lee john bill/, option_value(%w/-p lee,john,bill/, :p=, :as => Array)
+    assert_equal %w/lee john bill jeff jill/, option_value(%w/-p lee,john,bill -p jeff,jill/, :p=, :as => Array)
     assert_equal %w/lee john bill/, option_value(%w/-p lee:john:bill/, :p=, :as => Array, :delimiter => ':')
     assert_equal %w/lee john,bill/, option_value(%w/-p lee,john,bill/, :p=, :as => Array, :limit => 2)
     assert_equal %w/lee john:bill/, option_value(%w/-p lee:john:bill/, :p=, :as => Array, :limit => 2, :delimiter => ':')
@@ -109,7 +110,7 @@ class OptionTest < TestCase
 
   test "using a default value as fallback" do
     opts = Slop.new
-    opt = opts.on :f, :argument => :optional, :default => 'foo'
+    opts.on :f, :argument => :optional, :default => 'foo'
     opts.parse %w'-f'
     assert_equal 'foo', opts[:f]
   end

data/test/slop_test.rb

@@ -47,6 +47,11 @@ class SlopTest < TestCase
     slop = Slop.new { on :foo= }
     slop.parse %w' --foo=bar '
     assert_equal 'bar', slop[:foo]
+
+    slop = Slop.new(:multiple_switches => false) { on :f=; on :b= }
+    slop.parse %w' -fabc -bdef '
+    assert_equal 'abc', slop[:f]
+    assert_equal 'def', slop[:b]
   end
 
   test "fetch_option" do
@@ -175,6 +180,14 @@ class SlopTest < TestCase
     assert opts.fetch_option(:foo).autocreated?
     assert_equal 'bar', opts.fetch_option(:foo).value
     refute opts.fetch_option(:baz).expects_argument?
+    assert_equal nil, opts.fetch_option(:bar)
+
+    opts = Slop.new :autocreate => true do
+      on :f, :foo=
+    end
+    opts.parse %w[ --foo bar --baz stuff ]
+    assert_equal 'bar', opts[:foo]
+    assert_equal 'stuff', opts[:baz]
   end
 
   test "option terminator" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slop
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3236998902673647399
+      hash: 3713237527878732625
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3236998902673647399
+      hash: 3713237527878732625
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23