slop 1.5.3 → 1.5.4

data/README.md

@@ -127,8 +127,8 @@ Here's what we'll get back
     	:password=>"hello there"
     }
 
-Callbacks
----------
+Events
+------
 
 If you'd like to trigger an event when an option is used, you can pass a
 block to your option. Here's how:

data/Rakefile

@@ -1,9 +1,6 @@
 task :test do
-  $LOAD_PATH.unshift './lib'
-  require 'slop'
-  require 'minitest/autorun'
-  begin; require 'turn'; rescue LoadError; end
-  Dir.glob("test/**/*_test.rb").each { |test| require "./#{test}" }
+  $:.unshift './test'
+  Dir.glob("test/*_test.rb").each { |test| require "./#{test}" }
 end
 
 task :default => :test

data/lib/slop.rb

@@ -16,7 +16,7 @@ class Slop
   class InvalidOptionError < RuntimeError; end
 
   # @return [String] The current version string
-  VERSION = '1.5.3'
+  VERSION = '1.5.4'
 
   # Parses the items from a CLI format into a friendly object.
   #
@@ -72,7 +72,7 @@ class Slop
   def initialize(*opts, &block)
     sloptions = {}
     sloptions.merge! opts.pop if opts.last.is_a? Hash
-    @banner = opts.shift if opts[0].respond_to?(:to_str)
+    sloptions[:banner] = opts.shift if opts[0].respond_to?(:to_str)
     opts.each { |o| sloptions[o] = true }
 
     @options = Options.new
@@ -81,7 +81,7 @@ class Slop
     @longest_flag = 0
     @invalid_options = []
 
-    @banner ||= sloptions[:banner]
+    @banner = sloptions[:banner]
     @strict = sloptions[:strict]
     @multiple_switches = sloptions[:multiple_switches]
     @on_empty = sloptions[:on_empty]
@@ -109,7 +109,7 @@ class Slop
   #   opts = Slop.parse do
   #     banner "Usage - ruby foo.rb [arguments]"
   #   end
-  # @return [String] Returns current banner.
+  # @return [String] The current banner.
   def banner(text=nil)
     @banner = text if text
     @banner
@@ -134,16 +134,17 @@ class Slop
     @options.each(&block)
   end
 
-  # Return the value of an option via the subscript operator.
-  #
   # @param [Symbol] key Option symbol.
   # @example
   #   opts[:name] #=> "Emily"
-  # @return [Object] Returns the value associated with that option.
+  #   opts.get(:name) #=> "Emily"
+  # @return [Object] Returns the value associated with that option. If an
+  #   option doesn't exist, a command will instead be searched for
   def [](key)
     option = @options[key]
     option ? option.argument_value : @commands[key]
   end
+  alias :get :[]
 
   # Specify an option with a short or long version, description and type.
   #
@@ -245,7 +246,16 @@ class Slop
   # @return [Boolean] Whether the desired option was specified.
   def method_missing(meth, *args, &block)
     super unless meth.to_s =~ /\?\z/
-    !!self[meth.to_s.chomp '?']
+    present? meth.to_s.chomp '?'
+  end
+
+  # Check if an option is specified in the parsed list. Does the same as
+  # Slop#option? but a convenience method for unacceptable method names.
+  #
+  # @param [Object] The object name to check
+  # @return [Boolean] true if this option is present
+  def present?(option_name)
+    !!get(option_name)
   end
 
   # Returns the banner followed by available options listed on the next line.
@@ -263,6 +273,11 @@ class Slop
   end
   alias :help :to_s
 
+  def inspect
+    "#<Slop config_options=#{@sloptions.inspect}\n  " +
+    options.map(&:inspect).join("\n  ") + "\n>"
+  end
+
   private
 
   class << self
@@ -315,14 +330,15 @@ class Slop
       end
 
       if option
-        trash << item
-        next if option.forced?
+        option.count += 1
+        trash << index
+        next if option.forced
         option.argument_value = true
 
         if option.expects_argument? || option.accepts_optional_argument?
           argument ||= items.at(index + 1)
           check_valid_argument!(option, argument)
-          trash << argument
+          trash << index + 1
 
           if argument
             check_matching_argument!(option, argument)
@@ -337,11 +353,11 @@ class Slop
         end
       else
         check_invalid_option!(item, flag)
-        block.call(item) if block_given? && !trash.include?(item)
+        block.call(item) if block_given? && !trash.include?(index)
       end
     end
 
-    items.delete_if { |item| trash.include? item } if delete
+    items.reject!.with_index { |o, i| trash.include?(i) } if delete
     raise_if_invalid_options!
     items
   end

data/lib/slop/option.rb

@@ -24,11 +24,17 @@ class Slop
     # @return [Object] true/false, or an optional help string to append
     attr_reader :help
 
+    # @return [Boolean] true if this options argument value has been forced
+    attr_reader :forced
+
     # @overload argument_value=(value)
     #   Set this options argument value
     #   @param [Object] value The value you'd like applied to this option
     attr_writer :argument_value
 
+    # @return [Integer] The amount of times this option has been invoked
+    attr_accessor :count
+
     # @param [Slop] slop
     # @param [String, #to_s] short
     # @param [String, #to_s] long
@@ -56,26 +62,19 @@ class Slop
 
       @tail = options[:tail]
       @match = options[:match]
+      @delimiter = options[:delimiter] || ','
+      @limit = options[:limit] || 0
       @help = options[:help]
       @help = true if @help.nil?
 
       @forced = false
       @argument_value = nil
-
-      @delimiter = options[:delimiter] || ','
-      @limit = options[:limit] || 0
-
-      if @long_flag && @long_flag.size > @slop.longest_flag
-        if @help.respond_to? :to_str
-          size = @long_flag.size + @help.size
-        else
-          size = @long_flag.size
-        end
-        @slop.longest_flag = size
-      end
+      @count = 0
 
       @callback = blk if block_given?
       @callback ||= options[:callback]
+
+      build_longest_flag
     end
 
     # @return [Boolean] true if this option expects an argument
@@ -105,9 +104,9 @@ class Slop
         value.split @delimiter, @limit
       when 'range'
         value_to_range value
-      when 'string';  value.to_s
-      when 'symbol';  value.to_s.to_sym
-      when 'integer'; value.to_s.to_i
+      when 'string', 'str';  value.to_s
+      when 'symbol', 'sym';  value.to_s.to_sym
+      when 'integer', 'int'; value.to_s.to_i
       when 'float';   value.to_s.to_f
       else
         value
@@ -123,11 +122,6 @@ class Slop
       @forced = true
     end
 
-    # @return [Boolean] true if this argument value has been forced
-    def forced?
-      @forced
-    end
-
     # This option in a nice pretty string, including a short flag, long
     #   flag, and description (if they exist).
     # @see Slop#help
@@ -176,5 +170,16 @@ class Slop
         value
       end
     end
+
+    def build_longest_flag
+      if @long_flag && @long_flag.size > @slop.longest_flag
+        if @help.respond_to? :to_str
+          size = @long_flag.size + @help.size
+        else
+          size = @long_flag.size
+        end
+        @slop.longest_flag = size
+      end
+    end
   end
 end

data/lib/slop/options.rb

@@ -4,22 +4,21 @@ class Slop
     # @param [Boolean] symbols true to cast hash keys to symbols
     # @return [Hash]
     def to_hash(symbols)
-      out = {}
-      each do |option|
+      reduce({}) do |hsh, option|
         key = option.key
         key = key.to_sym if symbols
-        out[key] = option.argument_value
+        hsh[key] = option.argument_value
+        hsh
       end
-      out
     end
 
     # @param [Object] flag The short/long flag representing the option
     # @return [Option] the option assoiated with this flag
     def [](flag)
-      item = flag.to_s
       if flag.is_a?(Integer)
         slice flag
       else
+        item = flag.to_s
         find do |option|
           option.short_flag == item || option.long_flag == item
         end
@@ -29,9 +28,9 @@ class Slop
     # @see Slop#help
     # @return [String] All options in a pretty help string
     def to_help
-      heads = reject {|x| x.tail }
-      tails = select {|x| x.tail }
-      all = (heads + tails).reject {|x| !x.help }
+      heads = reject(&:tail)
+      tails = select(&:tail)
+      all = (heads + tails).select(&:help)
       all.map(&:to_s).join("\n")
     end
   end

data/slop.gemspec

@@ -4,14 +4,11 @@ require 'slop'
 Gem::Specification.new do |s|
   s.name = 'slop'
   s.version = Slop::VERSION
-  s.platform = Gem::Platform::RUBY
   s.summary = 'Option gathering made easy'
   s.description = 'A simple DSL for gathering options and parsing the command line'
   s.author = 'Lee Jarvis'
   s.email = 'lee@jarvis.co'
   s.homepage = 'http://github.com/injekt/slop'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.require_paths = ["lib"]
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
 end

data/test/commands_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require 'helper'
 
 class CommandsTest < TestCase
   test 'creating commands' do

data/test/helper.rb

@@ -1,3 +1,15 @@
+unless Object.const_defined? 'Slop'
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  require 'slop'
+end
+
+require 'minitest/autorun'
+
+begin
+  require 'turn'
+rescue LoadError
+end
+
 class TestCase < MiniTest::Unit::TestCase
   def self.test(name, &block)
     test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym

data/test/option_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require 'helper'
 
 class OptionTest < TestCase
   def option(*args, &block)
@@ -63,6 +63,7 @@ class OptionTest < TestCase
   test 'casting' do
     assert_equal :foo, option_value(%w/--name foo/, :name, true, :as => Symbol)
     assert_equal :foo, option_value(%w/--name foo/, :name, true, :as => :symbol)
+    assert_equal :foo, option_value(%w/--name foo/, :name, true, :as => :sym)
     assert_equal 30, option_value(%w/--age 30/, :age, true, :as => Integer)
     assert_equal "1.0", option_value(%w/--id 1/, :id, true, :as => Float).to_s
   end
@@ -75,7 +76,7 @@ class OptionTest < TestCase
 
     # default back to the string unless a regex is successful
     # return value.to_i if the value is /\A\d+\z/
-    # maybe this should raise is Slop#strict?
+    # maybe this should raise if Slop#strict?
     assert_equal "1abc10", option_value(%w/-r 1abc10/, :r, true, :as => Range)
     assert_equal 1, option_value(%w/-r 1/, :r, true, :as => Range)
   end
@@ -137,4 +138,11 @@ class OptionTest < TestCase
     assert_equal nil, slop[:foo]
     refute_equal "", slop[:foo]
   end
+
+  test 'counting options' do
+    slop = Slop.new { on :v; on :x }
+    slop.parse %w/-v -v -v -x/
+    assert_equal 1, slop.options[:x].count
+    assert_equal 3, slop.options[:v].count
+  end
 end

data/test/slop_test.rb

@@ -1,3 +1,5 @@
+require 'helper'
+
 class SlopTest < TestCase
   def clean_options(*args)
     Slop.new.send(:clean_options, args)
@@ -32,7 +34,7 @@ class SlopTest < TestCase
     slop.opt(:f, :foo, 'foo')
     slop.opt(:b, :bar, 'bar')
 
-    slop.each { |option| assert option }
+    slop.each { |option| assert_kind_of Slop::Option, option }
   end
 
   test 'defaulting to ARGV' do
@@ -42,13 +44,12 @@ class SlopTest < TestCase
   end
 
   test 'callback when option array is empty' do
-    item1 = item2 = nil
+    item1 = nil
     temp_argv([]) do
       Slop.new { on_empty { item1 = 'foo' } }.parse
     end
 
     assert_equal 'foo', item1
-    assert_nil item2
   end
 
   test 'multiple switches with the :multiple_switches flag' do
@@ -144,6 +145,12 @@ class SlopTest < TestCase
     assert_empty items
   end
 
+  test '#parse! does not remove unparsed items with same value as a parsed item' do
+    items = %w/bar --foo bar/
+    Slop.new { |opt| opt.on :foo, 'foo', true }.parse!(items)
+    assert_equal %w/bar/, items
+  end
+
   test '#parse! removes parsed items prefixed with --no-' do
     items = %w/--no-foo/
     Slop.new { |opt| opt.on :foo }.parse!(items)
@@ -210,6 +217,14 @@ class SlopTest < TestCase
     refute slop.debug?
   end
 
+  test 'options are present' do
+    opts = Slop.new { on :f, 'foo-bar'; on :b, 'bar-baz' }
+    opts.parse %w/--foo-bar/
+
+    assert opts.present?('foo-bar')
+    refute opts.present?('bar-baz')
+  end
+
   test 'raises if an option expects an argument and none is given' do
     slop = Slop.new
     slop.opt :name, true

metadata

@@ -2,7 +2,7 @@
 name: slop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 +01:00
+date: 2011-05-01 00:00:00 +01:00
 default_executable: 
 dependencies: []