slop 1.6.0 → 1.6.1

data/.gitignore

@@ -3,3 +3,4 @@
 doc
 *.swp
 *.gem
+*.rbc

data/CHANGES.md

@@ -1,3 +1,9 @@
+1.6.1 (2011-06-01)
+------------------
+
+* Fix tests and using a temporary Array for ARGV, fixes RubyGems Test issues
+* General cleanup of code
+
 1.6.0 (2011-05-18)
 ------------------
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Lee Jarvis
+Copyright (c) 2011 Lee Jarvis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -20,10 +20,10 @@ Usage
 -----
     # parse assumes ARGV, otherwise you can pass it your own Array
     opts = Slop.parse do
-      on :v, :verbose, 'Enable verbose mode' 	   # boolean value
-      on :n, :name, 'Your name', true              # option requires a compulsory argument
-      on :s, :sex, 'Your sex', :optional => false  # the same thing
-      on :a, :age, 'Your age', :optional => true   # optional argument
+      on :v, :verbose, 'Enable verbose mode' 	         # boolean value
+      on :n, :name, 'Your name', true                  # option requires a compulsory argument
+      on :s, :sex, 'Your sex', :optional => false      # the same thing
+      on '-a', '--age', 'Your age', :optional => true  # optional argument
     end
 
     # if ARGV is `-v --name 'lee jarvis' -s male`
@@ -37,25 +37,6 @@ You can also return your options as a Hash
 
     opts.to_hash #=> {'name' => 'Lee Jarvis', 'verbose' => true, 'age' => nil, 'sex' => 'male'}
 
-    # Symbols
-    opts.to_hash(true) #=> {:name => 'Lee Jarvis', :verbose => true, :age => nil, :sex => 'male'}
-
-If you don't like the method `on` (because it sounds like the option **expects**
-a block), you can use the `opt` or `option` alternatives.
-
-    on :v, :verbose
-    opt :v, :verbose
-    option :v, :verbose
-
-If you don't like that Slop evaluates your block, or you want slop access
-inside of your block without referring to `self`, you can pass a block argument to
-`parse`.
-
-    Slop.parse do |opts|
-      opts.on :v, :verbose
-      opts.on :n, :name, 'Your name', true
-    end
-
 If you want some pretty output for the user to see your options, you can just
 send the Slop object to `puts` or use the `help` method.
 
@@ -170,7 +151,7 @@ Slop also allows you to prefix `--no-` to an option which will force the option
 to return a false value.
 
     opts = Slop.parse do
-    	on :v, :verbose, :default => true
+      on :v, :verbose, :default => true
     end
 
     # with no command line options
@@ -233,28 +214,6 @@ What would Slop be if it didn't know what ranges were?
     # ARGV is `--range 1..10` or 1-10, or 1,10 (yes Slop supports them all)
     opts[:range].to_a #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 
-Ugh, Symbols
-------------
-
-Fine, don't use them
-
-    Slop.parse do
-      on :n, :name, 'Your name'
-      on 'n', 'name', 'Your name'
-      on '-n', '--name', 'Your name'
-    end
-
-All of these options will do the same thing
-
-Ugh, Blocks
------------
-
-C'mon man, this is Ruby, GTFO if you don't like blocks.
-
-    opts = Slop.new
-    opts.on :v, :verbose
-    opts.parse
-
 Smart
 -----
 
@@ -284,37 +243,6 @@ when an invalid option is found (`false` by default):
     Slop.new(:strict => true).parse(%w/--foo/)
     # => Slop::InvalidOptionError: Unknown option -- 'foo'
 
-and it handles multiple invalid options with a sprinkling of pluralization:
-
-    Slop.new(:strict => true).parse(%w/--foo --bar -z/)
-    # => Slop::InvalidOptionError: Unknown options -- 'foo', 'bar', 'z'
-
-Significantly, however, Slop will still parse the valid options:
-
-    slop = Slop.new(:strict => true, :help => true) do
-      banner "Usage:\n\t./awesome_sauce [options]\n\nOptions:"
-      on :n, :name, 'Your name'
-    end
-
-    begin
-      slop.parse(%w/--foo --bar -z/)
-    rescue Slop::InvalidOptionError => e
-      puts "\n#{e.message}\n\n"
-      puts slop
-      exit
-    end
-
-yields:
-
-    Unknown options -- 'foo', 'bar', 'z'
-
-    Usage:
-    	./awesome_sauce [options]
-
-    Options:
-        -n, --name      Your name
-        -h, --help      Print this help message
-
 Commands
 --------
 
@@ -347,11 +275,8 @@ Here's how commands might look:
       end
     end
 
-* Run with `run.rb -v`
-* Output:  `version 1`
-
-* Run with: `run.rb clean -v`
-* Output:   `Enabled verbose mode for clean`
+* `run.rb -v       #=> version 1`
+* `run.rb clean -v #=> Enabled verbose mode for clean`
 
 Woah woah, why you hating on OptionParser?
 ------------------------------------------
@@ -370,7 +295,7 @@ gather a bunch of key/value options, usually you would do something like this:
       end
 
       opt.on('-a', '--age AGE', 'Your age') do |age|
-    	things[:age] = age
+        things[:age] = age.to_i
       end
 
       # you get the point
@@ -379,14 +304,14 @@ gather a bunch of key/value options, usually you would do something like this:
     opt.parse
     things #=> { :name => 'lee', :age => 105 }
 
-Which is all great and stuff, but it can lead to some repetition, the same
+Which is all great and stuff, but it can lead to some repetition. The same
 thing in Slop:
 
     require 'slop'
 
     opts = Slop.parse do
       on :n, :name, 'Your name', true
-      on :a, :age, 'Your age', true
+      on :a, :age, 'Your age', true, :as => :int
     end
 
     opts.to_hash(true) #=> { :name => 'lee', :age => 105 }

data/Rakefile

@@ -3,4 +3,8 @@ task :test do
   Dir.glob("test/*_test.rb").each { |test| require "./#{test}" }
 end
 
+task :test_all do
+  sh "rvm 1.8.7,jruby,rbx,1.9.2 exec rake 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.6.0'
+  VERSION = '1.6.1'
 
   # Parses the items from a CLI format into a friendly object.
   #
@@ -27,18 +27,17 @@ class Slop
   #    on :n, :name,    'Your name'
   #    on :a, :age,     'Your age'
   #  end
-  #  -------
-  #  program.rb --verbose -n 'Emily' -a 25
   # @return [Slop] Returns an instance of Slop.
   def self.parse(items=ARGV, options={}, &block)
-    initialize_and_parse(items, false, options, &block)
+    initialize_and_parse items, false, options, &block
   end
 
-  # Identical to {Slop.parse}, but removes parsed options from the original Array.
+  # Identical to {Slop.parse}, but removes parsed options from the
+  # original Array.
   #
   # @return [Slop] Returns an instance of Slop.
   def self.parse!(items=ARGV, options={}, &block)
-    initialize_and_parse(items, true, options, &block)
+    initialize_and_parse items, true, options, &block
   end
 
   # @return [Options]
@@ -73,9 +72,8 @@ class Slop
   # @option opts [Proc, #call] :on_noopts Trigger an event when no options
   #   are found
   def initialize(*opts, &block)
-    sloptions = {}
-    sloptions.merge! opts.pop if opts.last.is_a? Hash
-    sloptions[:banner] = opts.shift if opts[0].respond_to?(:to_str)
+    sloptions = opts.last.is_a?(Hash) ? opts.pop : {}
+    sloptions[:banner] = opts.shift if opts[0].respond_to? :to_str
     opts.each { |o| sloptions[o] = true }
 
     @options = Options.new
@@ -92,17 +90,14 @@ class Slop
     @on_noopts = sloptions[:on_noopts] || sloptions[:on_optionless]
     @sloptions = sloptions
 
-    io = sloptions[:io] || $stderr
-    eoh = true if sloptions[:exit_on_help].nil?
-
     if block_given?
       block.arity == 1 ? yield(self) : instance_eval(&block)
     end
 
     if sloptions[:help]
       on :h, :help, 'Print this help message', :tail => true do
-        io.puts help
-        exit if eoh
+        (sloptions[:io] || $stderr).puts help
+        exit unless sloptions[:exit_on_help] == false
       end
     end
   end
@@ -173,11 +168,10 @@ class Slop
   #   end
   # @return [Slop::Option]
   def option(*args, &block)
-    options = args.pop if args.last.is_a?(Hash)
-    options ||= {}
+    options = args.last.is_a?(Hash) ? args.pop : {}
 
-    short, long, desc, arg = clean_options(args)
-    option = Option.new(self, short, long, desc, arg, options, &block)
+    short, long, desc, arg = clean_options args
+    option = Option.new self, short, long, desc, arg, options, &block
     @options << option
 
     option
@@ -205,8 +199,7 @@ class Slop
       raise ArgumentError, "command `#{label}` already exists"
     end
 
-    options = @sloptions.merge(options)
-    slop = Slop.new(options)
+    slop = Slop.new @sloptions.merge options
     @commands[label] = slop
 
     if block_given?
@@ -218,7 +211,7 @@ class Slop
 
   # Trigger an event when Slop has no values to parse
   #
-  # @param [Object, nil] proc The object (which can be anything
+  # @param [Object, #call] obj The object (which can be anything
   #   responding to `call`)
   # @example
   #   Slop.parse do
@@ -232,7 +225,7 @@ class Slop
 
   # Trigger an event when the arguments contain no options
   #
-  # @param [Object, nil] obj The object to be triggered (anything
+  # @param [Object, #call] obj The object to be triggered (anything
   #   responding to `call`)
   # @example
   #   Slop.parse do
@@ -253,19 +246,21 @@ class Slop
   #   opts.to_hash(true) #=> { :name => 'Emily' }
   # @return [Hash]
   def to_hash(symbols=false)
-    @options.to_hash(symbols)
+    @options.to_hash symbols
   end
   alias :to_h :to_hash
 
   # Allows you to check whether an option was specified in the parsed list.
+  # Merely sugar for `present?`
   #
   # @example
   #   #== ruby foo.rb -v
   #   opts.verbose? #=> true
   #   opts.name?    #=> false
-  # @return [Boolean] Whether the desired option was specified.
+  # @see Slop#present?
+  # @return [Boolean] true if this option is present, false otherwise
   def method_missing(meth, *args, &block)
-    super unless meth.to_s =~ /\?\z/
+    super unless meth.to_s[-1, 1] == '?'
     present? meth.to_s.chomp '?'
   end
 
@@ -274,7 +269,7 @@ class Slop
   #
   # @param [Object] The object name to check
   # @since 1.5.0
-  # @return [Boolean] true if this option is present
+  # @return [Boolean] true if this option is present, false otherwise
   def present?(option_name)
     !!get(option_name)
   end
@@ -323,10 +318,10 @@ class Slop
     elsif !items.any? {|i| i.to_s[/\A--?/] } && @on_noopts.respond_to?(:call)
       @on_noopts.call self
       return items
+    elsif execute_command(items, delete)
+      return items
     end
 
-    return if execute_command(items, delete)
-
     trash = []
 
     items.each_with_index do |item, index|
@@ -358,7 +353,7 @@ class Slop
           option.call unless option.omit_exec?(items)
         end
       else
-        check_invalid_option!(item, flag)
+        @invalid_options << flag if item[/\A--?/] && @strict
         block.call(item) if block_given? && !trash.include?(index)
       end
     end
@@ -370,15 +365,13 @@ class Slop
 
   def check_valid_argument!(option, argument)
     if !option.accepts_optional_argument? && flag?(argument)
-      raise MissingArgumentError,
-        "'#{option.key}' expects an argument, none given"
+      raise MissingArgumentError, "'#{option.key}' expects an argument, none given"
     end
   end
 
   def check_matching_argument!(option, argument)
     if option.match && !argument.match(option.match)
-      raise InvalidArgumentError,
-        "'#{argument}' does not match #{option.match.inspect}"
+      raise InvalidArgumentError, "'#{argument}' does not match #{option.match.inspect}"
     end
   end
 
@@ -386,15 +379,10 @@ class Slop
     if option.accepts_optional_argument?
       option.call
     else
-      raise MissingArgumentError,
-        "'#{flag}' expects an argument, none given"
+      raise MissingArgumentError, "'#{flag}' expects an argument, none given"
     end
   end
 
-  def check_invalid_option!(item, flag)
-    @invalid_options << flag if item[/\A--?/] && @strict
-  end
-
   def raise_if_invalid_options!
     return if !@strict || @invalid_options.empty?
     message = "Unknown option"
@@ -404,18 +392,15 @@ class Slop
   end
 
   def enable_multiple_switches(item)
-    item[1..-1].split('').each do |switch|
+    item[1..-1].each_char do |switch|
       if option = @options[switch]
         if option.expects_argument?
-          raise MissingArgumentError,
-            "'-#{switch}' expects an argument, used in multiple_switch context"
+          raise MissingArgumentError, "'-#{switch}' expects an argument, used in multiple_switch context"
         else
           option.argument_value = true
         end
       else
-        if @strict
-          raise InvalidOptionError, "Unknown option '-#{switch}'"
-        end
+        raise InvalidOptionError, "Unknown option '-#{switch}'" if @strict
       end
     end
   end
@@ -423,9 +408,7 @@ class Slop
   def extract_option(item, flag)
     if item[0, 1] == '-'
       option = @options[flag]
-      if !option && @ignore_case
-        option = @options[flag.downcase]
-      end
+      option ||= @options[flag.downcase] if @ignore_case
     end
     unless option
       case item
@@ -437,8 +420,7 @@ class Slop
           option = @options[flag]
         end
       when /\A--([^=]+)=(.+)\z/
-        option = @options[$1]
-        argument = $2
+        option, argument = @options[$1], $2
       when /\A--no-(.+)\z/
         option = @options[$1]
         option.force_argument_value(false) if option
@@ -448,9 +430,8 @@ class Slop
   end
 
   def execute_command(items, delete)
-    command = items[0]
-    command = @commands.keys.find { |cmd| cmd.to_s == command.to_s }
-    if @commands.key?(command)
+    command = @commands.keys.find { |cmd| cmd.to_s == items[0].to_s }
+    if command
       items.shift
       opts = @commands[command]
       delete ? opts.parse!(items) : opts.parse(items)
@@ -470,7 +451,7 @@ class Slop
     end
 
     long = args.first
-    boolean = [true, false].include?(long)
+    boolean = [true, false].include? long
     if !boolean && long.to_s =~ /\A(?:--?)?[a-zA-Z][a-zA-Z0-9_-]+\z/
       options.push args.shift.to_s.sub(/\A--?/, '')
     else
@@ -482,6 +463,6 @@ class Slop
   end
 
   def flag?(str)
-    str =~ /\A--?[a-zA-Z][a-zA-Z0-9_-]+\z/
+    str =~ /\A--?[a-zA-Z][a-zA-Z0-9_-]*\z/
   end
 end

data/lib/slop/option.rb

@@ -32,10 +32,6 @@ class Slop
     # @return [Integer] The amount of times this option has been invoked
     attr_accessor :count
 
-    # @return [Object] Omit execution of this Options block or callback if
-    #   this object exists in the Array of items passed to `Slop.new`
-    attr_accessor :unless
-
     # @param [Slop] slop
     # @param [String, #to_s] short
     # @param [String, #to_s] long
@@ -51,24 +47,20 @@ class Slop
     # @option options [Boolean] :tail (false)
     # @option options [Regexp] :match
     # @option options [String, #to_s] :unless
-    # @option options [Boolean, String] :help
-    def initialize(slop, short, long, description, argument, options={}, &blk)
+    # @option options [Boolean, String] :help (true)
+    def initialize(slop, short, long, description, argument, options, &blk)
       @slop = slop
       @short_flag = short
       @long_flag = long
       @description = description
+      @argument = argument
       @options = options
 
-      @expects_argument = argument
-      @expects_argument = true if options[:optional] == false
-
       @tail = options[:tail]
       @match = options[:match]
-      @delimiter = options[:delimiter] || ','
-      @limit = options[:limit] || 0
-      @unless = options[:unless]
-      @help = options[:help]
-      @help = true if @help.nil?
+      @delimiter = options.fetch(:delimiter, ',')
+      @limit = options.fetch(:limit, 0)
+      @help = options.fetch(:help, true)
 
       @forced = false
       @argument_value = nil
@@ -82,7 +74,7 @@ class Slop
 
     # @return [Boolean] true if this option expects an argument
     def expects_argument?
-      @expects_argument || @options[:argument]
+      @argument || @options[:argument] || @options[:optional] == false
     end
 
     # @return [Boolean] true if this option accepts an optional argument
@@ -103,14 +95,12 @@ class Slop
       return if value.nil?
 
       case @options[:as].to_s.downcase
-      when 'array'
-        value.split @delimiter, @limit
-      when 'range'
-        value_to_range value
+      when 'array'; value.split @delimiter, @limit
+      when 'range'; value_to_range value
+      when 'float'; value.to_s.to_f
       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
       end
@@ -136,7 +126,7 @@ class Slop
     # @return [Boolean] true if this options `:unless` argument exists
     #   inside *items*
     def omit_exec?(items)
-      string = @unless.to_s.sub(/\A--?/, '')
+      string = @options[:unless].to_s.sub(/\A--?/, '')
       items.any? { |i| i.to_s.sub(/\A--?/, '') == string }
     end
 
@@ -158,11 +148,9 @@ class Slop
           size = @long_flag.size
         end
         diff = @slop.longest_flag - size
-        spaces = " " * (diff + 6)
-        out += spaces
+        out += " " * (diff + 6)
       else
-        spaces = " " * (@slop.longest_flag + 8)
-        out += spaces
+        out += " " * (@slop.longest_flag + 8)
       end
 
       "#{out}#{@description}"

data/lib/slop/options.rb

@@ -2,6 +2,7 @@ class Slop
   class Options < Array
 
     # @param [Boolean] symbols true to cast hash keys to symbols
+    # @see Slop#to_hash
     # @return [Hash]
     def to_hash(symbols)
       reduce({}) do |hsh, option|
@@ -12,7 +13,13 @@ class Slop
       end
     end
 
-    # Fetch an Option object
+    # Fetch an Option object. This method overrides Array#[] to provide
+    # a nicer interface for fetching options via their short or long flag.
+    # The reason we don't use a Hash here is because an option cannot be
+    # identified by a single label. Instead this method tests against
+    # a short flag first, followed by a long flag. When passing this
+    # method an Integer, it will work as an Array usually would, fetching
+    # the Slop::Option at this index.
     #
     # @param [Object] flag The short/long flag representing the option
     # @example
@@ -21,12 +28,11 @@ class Slop
     #   opts.options[:v].description #=> "Verbose mode"
     # @return [Option] the option assoiated with this flag
     def [](flag)
-      if flag.is_a?(Integer)
-        slice flag
+      if flag.is_a? Integer
+        super
       else
-        item = flag.to_s
         find do |option|
-          option.short_flag == item || option.long_flag == item
+          [option.short_flag, option.long_flag].include? flag.to_s
         end
       end
     end

data/test/helper.rb

@@ -4,6 +4,7 @@ unless Object.const_defined? 'Slop'
 end
 
 require 'minitest/autorun'
+require 'stringio'
 
 begin
   require 'turn'

data/test/slop_test.rb

@@ -59,7 +59,10 @@ class SlopTest < TestCase
     end
 
     assert_equal 'foo', item1
-    assert_equal [], Slop.new { on_empty {} }.parse
+
+    temp_argv([]) do
+      assert_equal [], Slop.new { on_empty {} }.parse
+    end
   end
 
   test 'callback when arguments contain no options' do
@@ -356,7 +359,6 @@ class SlopTest < TestCase
   end
 
   test 'custom IO object' do
-    require 'stringio'
     io = StringIO.new
     slop = Slop.new(:help => true, :io => io)
     slop.on :f, :foo, 'something fooey'
@@ -368,7 +370,6 @@ class SlopTest < TestCase
   end
 
   test 'exiting when using :help option' do
-    require 'stringio'
     io = StringIO.new
     opts = Slop.new(:help => true, :io => io)
     assert_raises(SystemExit) { opts.parse %w/--help/ }

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slop
 version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
-  version: 1.6.0
+  segments: 
+  - 1
+  - 6
+  - 1
+  version: 1.6.1
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 +01:00
+date: 2011-06-01 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -52,17 +57,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.6.2
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy