slop 1.0.0 → 1.1.0

data/README.md

@@ -151,13 +151,15 @@ You can also change both the split delimiter and limit
     opts = Slop.parse do
       opt :people, true, :as => Array, :delimiter => ':', :limit => 2)
     end
+
+    # ARGV is `--people lee:injekt:bob`
     opts[:people] #=> ["lee", "injekt:bob"]
 
 Woah woah, why you hating on OptionParser?
 ------------------------------------------
 
 I'm not, honestly! I love OptionParser. I really do, it's a fantastic library.
-So why did I build Slop? Well, I find myself using OptionParser to simple
+So why did I build Slop? Well, I find myself using OptionParser to simply
 gather a bunch of key/value options, usually you would do something like this:
 
 	require 'optparse'

data/Rakefile

@@ -3,7 +3,7 @@ task :test do
   require 'slop'
   require 'minitest/autorun'
   begin; require 'turn'; rescue LoadError; end
-  Dir.glob("test/**/*_test.rb").each { |test| require_relative test }
+  Dir.glob("test/**/*_test.rb").each { |test| require "./#{test}" }
 end
 
 task :default => :test

data/lib/slop.rb

@@ -23,7 +23,7 @@ class Slop
   # @see Slop#option
   def self.parse(items=ARGV, &block)
     slop = new(&block)
-    slop.parse(items)
+    slop.parse items
     slop
   end
 
@@ -35,6 +35,7 @@ class Slop
     @options = Options.new
     @banner = nil
     @longest_flag = 0
+    @items = []
 
     if block_given?
       block.arity == 1 ? yield(self) : instance_eval(&block)
@@ -59,14 +60,20 @@ class Slop
   #
   # @param items
   def parse(items=ARGV)
-    parse_items(items)
+    @items = parse_items items, block_given?
+
+    if block_given?
+      @items.each { |item| yield item }
+    end
+
+    @items
   end
 
   # Parse a list of options, removing parsed options from the original Array.
   #
   # @parse items
   def parse!(items=ARGV)
-    parse_items(items, true)
+    parse_items items, true
   end
 
   # Enumerable interface
@@ -111,7 +118,8 @@ class Slop
     options = args.pop if args.last.is_a?(Hash)
     options ||= {}
 
-    option = Option.new(self, *clean_options(args), options, &block)
+    short, long, desc, arg = clean_options(args)
+    option = Option.new(self, short, long, desc, arg, options, &block)
     @options << option
 
     option
@@ -124,10 +132,15 @@ class Slop
   # @return [Hash] Returns a hash with each specified option as a symbolic key with an associated value.
   # @example
   #   opts.to_hash
+  #   #=> { 'name' => 'Emily' }
+  #
+  #   # symbols!
+  #   opts.to_hash(true)
   #   #=> { :name => 'Emily' }
-  def to_hash
-    @options.to_hash
+  def to_hash(symbols=nil)
+    @options.to_hash(symbols)
   end
+  alias :to_h :to_hash
 
   # Allows you to check whether an option was specified in the parsed list.
   #
@@ -140,11 +153,7 @@ class Slop
   #   #=> false
   # @see Slop#[]
   def method_missing(meth, *args, &block)
-    if meth.to_s =~ /\?$/
-      !!self[meth.to_s.chomp('?')]
-    else
-      super
-    end
+    meth.to_s[/\?$/] ? !!self[meth.to_s.chomp('?')] : super
   end
 
   # Returns the banner followed by available options listed on the next line.
@@ -171,8 +180,9 @@ private
 
     items.each do |item|
       flag = item.to_s.sub(/^--?/, '')
+      option = @options[flag]
 
-      if option = @options[flag]
+      if option
         trash << item if delete
         option.argument_value = true
 
@@ -182,18 +192,18 @@ private
 
           if argument
             option.argument_value = argument
-            option.callback.call(option.argument_value) if option.callback
+            option.callback.call option.argument_value if option.callback
           else
             option.argument_value = nil
             if option.accepts_optional_argument?
-              option.callback.call(nil) if option.callback
+              option.callback.call nil if option.callback
             else
               raise MissingArgumentError,
                 "'#{flag}' expects an argument, none given"
             end
           end
         elsif option.callback
-          option.callback.call(nil)
+          option.callback.call nil
         end
       end
     end
@@ -201,8 +211,6 @@ private
     items.delete_if { |item| trash.include? item }
   end
 
-  # @param [Array] args
-  # @return [Array]
   def clean_options(args)
     options = []
 
@@ -215,7 +223,8 @@ private
     end
 
     long = args.first
-    if !long.is_a?(TrueClass) && !long.is_a?(FalseClass) && long.to_s =~ /\A(--?)?[a-zA-Z0-9_-]+\z/
+    boolean = long.is_a?(TrueClass) || long.is_a?(FalseClass)
+    if !boolean && long.to_s =~ /\A(--?)?[a-zA-Z0-9_-]+\z/
       options.push args.shift.to_s.sub(/^--?/, '')
     else
       options.push nil

data/lib/slop/option.rb

@@ -1,15 +1,19 @@
 class Slop
   class Options < Array
-    def to_hash
-      each_with_object({}) do |option, out|
-        out[option.key] = option.argument_value
+    def to_hash(symbols)
+      out = {}
+      each do |option|
+        key = option.key
+        key = key.to_sym if symbols
+        out[key] = option.argument_value
       end
+      out
     end
 
     def [](item)
       item = item.to_s
       if item =~ /^\d+$/
-        slice(item.to_i)
+        slice item.to_i
       else
         find do |option|
           option.short_flag == item || option.long_flag == item

data/lib/slop/version.rb

@@ -1,3 +1,3 @@
 class Slop
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/option_test.rb

@@ -60,12 +60,10 @@ class OptionTest < TestCase
     )
   end
 
-  test 'returns a symbol with :as => Symbol' do
+  test 'casting' do
     assert_equal :foo, option_value(%w/--name foo/, :name, true, :as => Symbol)
-  end
-
-  test 'returns an integer with :as => Integer' do
     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
 
   test 'printing options' do

data/test/slop_test.rb

@@ -33,6 +33,15 @@ class SlopTest < TestCase
     assert_kind_of Slop, slop
   end
 
+  test 'yielding non-options when a block is passed to "parse"' do
+    opts = Slop.new do
+      on :name, true
+    end
+    opts.parse(%w/--name lee a/) do |v|
+      assert_equal 'a', v
+    end
+  end
+
   test 'setting the banner' do
     slop = Slop.new
     slop.banner = "foo bar"
@@ -44,6 +53,15 @@ class SlopTest < TestCase
     assert_equal "", slop.to_s
   end
 
+  test 'storing long option lengths' do
+    slop = Slop.new
+    assert_equal 0, slop.longest_flag
+    slop.opt(:name)
+    assert_equal 4, slop.longest_flag
+    slop.opt(:username)
+    assert_equal 8, slop.longest_flag
+  end
+
   test '#parse does not remove parsed items' do
     items = %w/--foo/
     Slop.new { |opt| opt.on :foo }.parse(items)
@@ -125,6 +143,7 @@ class SlopTest < TestCase
     slop.parse %w/--name lee --version/
 
     assert_equal({'name' => 'lee', 'version' => true, 'verbose' => false}, slop.to_hash)
+    assert_equal({:name => 'lee', :version => true, :verbose => false}, slop.to_hash(true))
   end
 
   test 'iterating options' do
@@ -153,4 +172,12 @@ class SlopTest < TestCase
 
     assert slop.to_s =~ /^Usage: foo/
   end
+
+  test 'passing argument values to blocks' do
+    name = nil
+    opts = Slop.new
+    opts.on :name, true, :callback => proc {|n| name = n}
+    opts.parse %w/--name lee/
+    assert_equal 'lee', name
+  end
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slop
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
-  version: 1.0.0
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 +00:00
+date: 2011-03-17 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -50,17 +55,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy