slop 1.7.0 → 1.8.0

data/.yardopts

@@ -1,6 +1,6 @@
---hide-void-return 
+--hide-void-return
 -m markdown
 --title "Slop - Option gathering made easy"
 lib/**/*.rb
 --no-private
---main README.md
+--readme README.md

data/CHANGES.md

@@ -1,3 +1,15 @@
+1.8.0 (2011-06-12)
+------------------
+
+* Added `execute` method to Slop for commands. This block will be invoked
+  when a specific command is used. The Slop object will be yielded to the
+  block
+* Allow passing a class name to `on` to be used as an `:as` option. ie:
+  `on :people, 'Some people', Array`
+* Get smart with parsing options optparse style: `on '--name NAME'` and
+  `on 'password [OPTIONAL]'`
+* Feature: `:arguments` setting to enable argument passing for all options
+
 1.7.0 (2011-06-06)
 ------------------
 

data/README.md

@@ -20,7 +20,7 @@ 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 :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
@@ -33,6 +33,10 @@ Usage
     opts.age?     #=> false
     opts[:age]    #=> nil
 
+For more information about creating options, see the
+[Creating Options](https://github.com/injekt/slop/wiki/Creating-Options)
+wiki page.
+
 You can also return your options as a Hash
 
     opts.to_hash #=> {'name' => 'Lee Jarvis', 'verbose' => true, 'age' => nil, 'sex' => 'male'}
@@ -51,19 +55,10 @@ Will output something like
 
 You can also add a banner using the `banner` method
 
-    opts = Slop.parse
-    opts.banner = "Usage: foo.rb [options]"
-
-or
-
     opts = Slop.parse do
       banner "Usage: foo.rb [options]"
     end
 
-or
-
-    opts = Slop.new "Usage: foo.rb [options]"
-
 Helpful Help
 ------------
 
@@ -196,26 +191,6 @@ You can of course also parse lists into options. Here's how:
 Slop supports a few styles of list parsing. Check out
 [this wiki page](https://github.com/injekt/slop/wiki/Lists) for more info.
 
-Smart
------
-
-Slop is pretty smart when it comes to building your options, for example if you
-want your option to have a flag attribute, but no `--option` attribute, you
-can do this:
-
-    on :n, "Your name"
-
-and Slop will detect a description in place of an option, so you don't have to
-do this:
-
-    on :n, nil, "Your name", true
-
-You can also try other variations:
-
-    on :name, "Your name"
-    on :n, :name
-    on :name, true
-
 Strict Mode
 -----------
 
@@ -225,41 +200,6 @@ when an invalid option is found (`false` by default):
     Slop.new(:strict => true).parse(%w/--foo/)
     # => Slop::InvalidOptionError: Unknown option -- 'foo'
 
-Commands
---------
-
-Slop allows you to nest more instances of Slop inside of `commands`. These
-instances will then be used to parse arguments if they're called upon.
-
-Slop will use the first argument in the list of items passed to `parse` to
-check if it is a `command`.
-
-    Slop.parse ['foo', '--bar', 'baz']
-
-Slop will look to see if the `foo` command exists, and if it does, it'll pass
-the options `['--bar', 'baz']` to the instance of Slop that belongs to `foo`.
-Here's how commands might look:
-
-    opts = Slop.new do
-      command :foo do
-        on :b, :bar, 'something', true
-      end
-
-      command :clean do
-        on :v, :verbose, do
-          puts 'Enabled verbose mode for clean'
-        end
-      end
-
-      # non-command specific options
-      on :v, :version do
-        puts 'version 1'
-      end
-    end
-
-* `run.rb -v       #=> version 1`
-* `run.rb clean -v #=> Enabled verbose mode for clean`
-
 Features
 --------
 
@@ -267,6 +207,7 @@ Check out the following wiki pages for more features:
 
 * [Ranges](https://github.com/injekt/slop/wiki/Ranges)
 * [Auto Create](https://github.com/injekt/slop/wiki/Auto-Create)
+* [Commands](https://github.com/injekt/slop/wiki/Commands)
 
 Woah woah, why you hating on OptionParser?
 ------------------------------------------

data/lib/slop.rb

@@ -16,9 +16,9 @@ class Slop
   class InvalidOptionError < RuntimeError; end
 
   # @return [String] The current version string
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 
-  # Parses the items from a CLI format into a friendly object.
+  # Parses the items from a CLI format into a friendly object
   #
   # @param [Array] items Items to parse into options.
   # @example Specifying three options to parse:
@@ -27,15 +27,15 @@ class Slop
   #    on :n, :name,    'Your name'
   #    on :a, :age,     'Your age'
   #  end
-  # @return [Slop] Returns an instance of Slop.
+  # @return [Slop] Returns an instance of Slop
   def self.parse(items=ARGV, options={}, &block)
     initialize_and_parse items, false, options, &block
   end
 
   # Identical to {Slop.parse}, but removes parsed options from the
-  # original Array.
+  # original Array
   #
-  # @return [Slop] Returns an instance of Slop.
+  # @return [Slop] Returns an instance of Slop
   def self.parse!(items=ARGV, options={}, &block)
     initialize_and_parse items, true, options, &block
   end
@@ -54,25 +54,43 @@ class Slop
   # @return [Integer] The length of the longest flag slop knows of
   attr_accessor :longest_flag
 
-  # @param [Hash] options
-  # @option opts [Boolean] :help Automatically add the `help` option
-  # @option opts [Boolean] :strict Strict mode raises when a non listed
-  #   option is found, false by default
-  # @option opts [Boolean] :multiple_switches Allows `-abc` to be processed
-  #   as the options 'a', 'b', 'c' and will force their argument values to
-  #   true. By default Slop with parse this as 'a' with the argument 'bc'
-  # @option opts [String] :banner The banner text used for the help
-  # @option opts [Proc, #call] :on_empty Any object that respondes to `call`
-  #   which is executed when Slop has no items to parse
-  # @option opts [IO, #puts] :io ($stderr) An IO object for writing to when
-  #   :help => true is used
-  # @option opts [Boolean] :exit_on_help (true) When false and coupled with
-  #   the :help option, Slop will not exit inside of the `help` option
-  # @option opts [Boolean] :ignore_case (false) Ignore options case
-  # @option opts [Proc, #call] :on_noopts Trigger an event when no options
-  #   are found
-  # @option opts [Boolean] :autocreate (false) Autocreate options depending
-  #   on the Array passed to {parse}
+  # @option opts [Boolean] :help
+  #   * Automatically add the `help` option
+  #
+  # @option opts [Boolean] :strict
+  #   * Raises when a non listed option is found, false by default
+  #
+  # @option opts [Boolean] :multiple_switches
+  #   * Allows `-abc` to be processed as the options 'a', 'b', 'c' and will
+  #     force their argument values to true. By default Slop with parse this
+  #     as 'a' with the argument 'bc'
+  #
+  # @option opts [String] :banner
+  #   * The banner text used for the help
+  #
+  # @option opts [Proc, #call] :on_empty
+  #   * Any object that respondes to `call` which is executed when Slop has
+  #     no items to parse
+  #
+  # @option opts [IO, #puts] :io ($stderr)
+  #   * An IO object for writing to when :help => true is used
+  #
+  # @option opts [Boolean] :exit_on_help (true)
+  #   * When false and coupled with the :help option, Slop will not exit
+  #     inside of the `help` option
+  #
+  # @option opts [Boolean] :ignore_case (false)
+  #   * Ignore options case
+  #
+  # @option opts [Proc, #call] :on_noopts
+  #   * Trigger an event when no options are found
+  #
+  # @option opts [Boolean] :autocreate (false)
+  #   * Autocreate options depending on the Array passed to {#parse}
+  #
+  # @option opts [Boolean] :arguments (false)
+  #   * Set to true to enable all specified options to accept arguments
+  #     by default
   def initialize(*opts, &block)
     sloptions = opts.last.is_a?(Hash) ? opts.pop : {}
     sloptions[:banner] = opts.shift if opts[0].respond_to? :to_str
@@ -80,6 +98,7 @@ class Slop
 
     @options = Options.new
     @commands = {}
+    @execution_block = nil
 
     @longest_flag = 0
     @invalid_options = []
@@ -89,6 +108,7 @@ class Slop
     @ignore_case = sloptions[:ignore_case]
     @multiple_switches = sloptions[:multiple_switches]
     @autocreate = sloptions[:autocreate]
+    @arguments = sloptions[:arguments]
     @on_empty = sloptions[:on_empty]
     @on_noopts = sloptions[:on_noopts] || sloptions[:on_optionless]
     @sloptions = sloptions
@@ -105,27 +125,27 @@ class Slop
     end
   end
 
-  # Set or return banner text.
+  # Set or return banner text
   #
-  # @param [String] text Displayed banner text.
+  # @param [String] text Displayed banner text
   # @example
   #   opts = Slop.parse do
   #     banner "Usage - ruby foo.rb [arguments]"
   #   end
-  # @return [String] The current banner.
+  # @return [String] The current banner
   def banner(text=nil)
     @banner = text if text
     @banner
   end
 
-  # Parse a list of options, leaving the original Array unchanged.
+  # Parse a list of options, leaving the original Array unchanged
   #
   # @param [Array] items A list of items to parse
   def parse(items=ARGV, &block)
     parse_items items, &block
   end
 
-  # Parse a list of options, removing parsed options from the original Array.
+  # Parse a list of options, removing parsed options from the original Array
   #
   # @param [Array] items A list of items to parse
   def parse!(items=ARGV, &block)
@@ -137,7 +157,7 @@ class Slop
     @options.each(&block)
   end
 
-  # @param [Symbol] key Option symbol.
+  # @param [Symbol] key Option symbol
   # @example
   #   opts[:name] #=> "Emily"
   #   opts.get(:name) #=> "Emily"
@@ -149,7 +169,7 @@ class Slop
   end
   alias :get :[]
 
-  # Specify an option with a short or long version, description and type.
+  # Specify an option with a short or long version, description and type
   #
   # @param [*] args Option configuration.
   # @option args [Symbol, String] :short_flag Short option name.
@@ -173,7 +193,8 @@ class Slop
   def option(*args, &block)
     options = args.last.is_a?(Hash) ? args.pop : {}
 
-    short, long, desc, arg = clean_options args
+    short, long, desc, arg, extras = clean_options args
+    options.merge!(extras)
     option = Option.new self, short, long, desc, arg, options, &block
     @options << option
 
@@ -240,7 +261,31 @@ class Slop
   end
   alias :on_optionless :on_noopts
 
-  # Returns the parsed list into a option/value hash.
+  # Add an execution block (for commands)
+  #
+  # @example
+  #   opts = Slop.new do
+  #     command :foo do
+  #       on :v, :verbose
+  #
+  #       execute { |o| p o.verbose? }
+  #     end
+  #   end
+  #   opts.parse %w[foo --verbose] #=> true
+  #
+  # @param [Object, #call] obj The object to be triggered when this command
+  #   is invoked
+  # @since 1.8.0
+  # @yields [Slop] an instance of Slop for this command
+  def execute(obj=nil, &block)
+    if obj || block_given?
+      @execution_block = obj || block
+    elsif @execution_block.respond_to?(:call)
+      @execution_block.call(self)
+    end
+  end
+
+  # Returns the parsed list into a option/value hash
   #
   # @example
   #   opts.to_hash #=> { 'name' => 'Emily' }
@@ -253,7 +298,8 @@ class Slop
   end
   alias :to_h :to_hash
 
-  # Allows you to check whether an option was specified in the parsed list.
+  # Allows you to check whether an option was specified in the parsed list
+  #
   # Merely sugar for `present?`
   #
   # @example
@@ -267,8 +313,10 @@ class Slop
     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.
+  # 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
   # @since 1.5.0
@@ -277,7 +325,7 @@ class Slop
     !!get(option_name)
   end
 
-  # Returns the banner followed by available options listed on the next line.
+  # Returns the banner followed by available options listed on the next line
   #
   # @example
   #  opts = Slop.parse do
@@ -342,11 +390,17 @@ class Slop
 
         if option.expects_argument? || option.accepts_optional_argument?
           argument ||= items.at(index + 1)
-          check_valid_argument!(option, argument)
           trash << index + 1
 
+          if !option.accepts_optional_argument? && flag?(argument)
+            raise MissingArgumentError, "'#{option.key}' expects an argument, none given"
+          end
+
           if argument
-            check_matching_argument!(option, argument)
+            if option.match && !argument.match(option.match)
+              raise InvalidArgumentError, "'#{argument}' does not match #{option.match.inspect}"
+            end
+
             option.argument_value = argument
             option.call option.argument_value unless option.omit_exec?(items)
           else
@@ -367,18 +421,6 @@ class Slop
     items
   end
 
-  def check_valid_argument!(option, argument)
-    if !option.accepts_optional_argument? && flag?(argument)
-      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}"
-    end
-  end
-
   def check_optional_argument!(option, flag)
     if option.accepts_optional_argument?
       option.call
@@ -389,8 +431,7 @@ class Slop
 
   def raise_if_invalid_options!
     return if !@strict || @invalid_options.empty?
-    message = "Unknown option"
-    message << 's' if @invalid_options.size > 1
+    message = "Unknown option#{'s' if @invalid_options.size > 1}"
     message << ' -- ' << @invalid_options.map { |o| "'#{o}'" }.join(', ')
     raise InvalidOptionError, message
   end
@@ -400,9 +441,8 @@ class Slop
       if option = @options[switch]
         if option.expects_argument?
           raise MissingArgumentError, "'-#{switch}' expects an argument, used in multiple_switch context"
-        else
-          option.argument_value = true
         end
+        option.argument_value = true
       else
         raise InvalidOptionError, "Unknown option '-#{switch}'" if @strict
       end
@@ -439,7 +479,7 @@ class Slop
       items.shift
       opts = @commands[command]
       delete ? opts.parse!(items) : opts.parse(items)
-      true
+      opts.execute
     end
   end
 
@@ -452,6 +492,10 @@ class Slop
 
   def clean_options(args)
     options = []
+    extras = {}
+    extras[:as] = args.find {|c| c.is_a? Class }
+    args.delete(extras[:as])
+    extras.delete(:as) unless extras[:as]
 
     short = args.first.to_s.sub(/\A--?/, '')
     if short.size == 1
@@ -463,14 +507,20 @@ class Slop
 
     long = args.first
     boolean = [true, false].include? long
-    if !boolean && long.to_s =~ /\A(?:--?)?[a-zA-Z][a-zA-Z0-9_-]+\z/
+    if !boolean && long.to_s =~ /\A(?:--?)?[a-z_-]+\s[A-Z\s\[\]]+\z/
+      arg, help = args.shift.split(/ /, 2)
+      options.push arg.sub(/\A--?/, '')
+      extras[:optional] = help[0, 1] == '[' && help[-1, 1] == ']'
+      extras[:help] = help
+    elsif !boolean && long.to_s =~ /\A(?:--?)?[a-zA-Z][a-zA-Z0-9_-]+\z/
       options.push args.shift.to_s.sub(/\A--?/, '')
     else
       options.push nil
     end
 
     options.push args.first.respond_to?(:to_sym) ? args.shift : nil
-    options.push args.shift ? true : false # force true/false
+    options.push @arguments ?  true : (args.shift ? true : false)
+    options.push extras
   end
 
   def flag?(str)

data/lib/slop/option.rb

@@ -195,11 +195,10 @@ class Slop
     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
+          @slop.longest_flag = @long_flag.size + @help.size
         else
-          size = @long_flag.size
+          @slop.longest_flag = @long_flag.size
         end
-        @slop.longest_flag = size
       end
     end
   end

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'slop'
-  s.version = '1.7.0'
+  s.version = '1.8.0'
   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

@@ -69,4 +69,21 @@ class CommandsTest < TestCase
     assert incmd
     refute inslop
   end
+
+  test 'executing blocks' do
+    foo = bar = nil
+    slop = Slop.new
+    slop.command :foo do
+      on :v, :verbose
+      execute { |o| foo = o.verbose? }
+    end
+    slop.command :bar do
+      on :v, :verbose
+      execute { |o| bar = o.verbose? }
+    end
+    slop.parse %w[ foo --verbose ]
+
+    assert foo
+    refute bar
+  end
 end

data/test/slop_test.rb

@@ -184,32 +184,45 @@ class SlopTest < TestCase
 
   test 'the shit out of clean_options' do
     assert_equal(
-      ['s', 'short', 'short option', false],
+      ['s', 'short', 'short option', false, {}],
       clean_options('-s', '--short', 'short option')
     )
 
     assert_equal(
-      [nil, 'long', 'long option only', true],
+      [nil, 'long', 'long option only', true, {}],
       clean_options('--long', 'long option only', true)
     )
 
     assert_equal(
-      ['S', 'symbol', 'symbolize', false],
+      ['S', 'symbol', 'symbolize', false, {}],
       clean_options(:S, :symbol, 'symbolize')
     )
 
     assert_equal(
-      ['a', nil, 'alphabetical only', true],
+      ['a', nil, 'alphabetical only', true, {}],
       clean_options('a', 'alphabetical only', true)
     )
 
     assert_equal( # for description-less options
-      [nil, 'optiononly', nil, false],
+      [nil, 'optiononly', nil, false, {}],
       clean_options('--optiononly')
     )
 
-    assert_equal(['c', nil, nil, true], clean_options(:c, true))
-    assert_equal(['c', nil, nil, false], clean_options(:c, false))
+    assert_equal(
+      ['f', 'foo', 'some description', false, {:optional => false, :help => 'BAR'}],
+      clean_options(:f, 'foo BAR', 'some description')
+    )
+
+    assert_equal(
+      [nil, 'bar', nil, false, {:optional => true, :help => '[STUFF]'}],
+      clean_options('bar [STUFF]')
+    )
+
+    assert_equal([nil, 'foo', nil, false, {:as => Array}], clean_options(:foo, Array, false))
+    assert_equal([nil, 'foo', nil, false, {:as => Array}], clean_options(Array, :foo, false))
+
+    assert_equal(['c', nil, nil, true, {}], clean_options(:c, true))
+    assert_equal(['c', nil, nil, false, {}], clean_options(:c, false))
   end
 
   test '[] returns an options argument value or a command or nil (in that order)' do
@@ -407,4 +420,35 @@ class SlopTest < TestCase
     assert_equal %w/foo bar etc/, opts[:a]
   end
 
+  test ':arguments => true' do
+    opts = Slop.new(:arguments) { on :foo }
+    opts.parse %w/--foo bar/
+
+    assert_equal 'bar', opts[:foo]
+  end
+
+  test 'long flag strings' do
+    opts = Slop.new do
+      on 'f', 'foo BAR'
+      on 'bar [HELLO]'
+    end
+
+    assert opts.options[:foo].expects_argument?
+    assert opts.options[:bar].accepts_optional_argument?
+
+    assert_equal '    -f, --foo BAR     ', opts.options[:foo].to_s
+    assert_equal '        --bar [HELLO] ', opts.options[:bar].to_s
+  end
+
+  test 'inline classes' do
+    opts = Slop.new do
+      on :foo, Array, true
+      on Symbol, :bar, true
+    end
+    opts.parse %w/--foo one,two --bar hello/
+
+    assert_equal %w[one two], opts[:foo]
+    assert_equal :hello, opts[:bar]
+  end
+
 end

metadata

@@ -2,7 +2,7 @@
 name: slop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 Z
+date: 2011-06-12 00:00:00 Z
 dependencies: []
 
 description: A simple DSL for gathering options and parsing the command line
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy