slop 1.2.1 → 1.3.0

data/.yardopts

@@ -1,5 +1,5 @@
 --hide-void-return 
 -m markdown
---title "slop"
+--title "Slop - Option gathering made easy"
 lib/**/*.rb
 --no-private

data/README.md

@@ -98,6 +98,31 @@ Shortcut:
       ...
     end
 
+Parsing
+-------
+
+Slop's pretty good at parsing, let's take a look at what it'll extract for you
+
+	Slop.parse do
+		on 's', 'server', true
+		on 'p', 'port', true, :as => :integer
+		on 'username', true, :matches => /[^a-zA-Z]+$/
+		on 'password', true
+	end
+
+Now throw some options at it:
+
+    -s ftp://foobar.com -p1234 --username=FooBar --password 'hello there'
+
+Here's what we'll get back
+
+	{
+		:server=>"ftp://foobar.com",
+		:port=>1234,
+		:username=>"FooBar",
+		:password=>"hello there"
+	}
+
 Callbacks
 ---------
 
@@ -217,7 +242,7 @@ You can also change both the split delimiter and limit
 Strict Mode
 -----------
 
-Passing `strict => true` to `Slop.parse` causes it to raise a `Slop::InvalidOptionError` 
+Passing `strict => true` to `Slop.parse` causes it to raise a `Slop::InvalidOptionError`
 when an invalid option is found (`false` by default):
 
     Slop.new(:strict => true).parse(%w/--foo/)
@@ -230,12 +255,13 @@ and it handles multiple invalid options with a sprinkling of pluralization:
 
 Significantly, however, Slop will still parse the valid options:
 
-    begin
-      slop = Slop.new(:strict => true, :help => true) do
-        banner "Usage:\n\t./awesome_sauce [options]\n\nOptions:"
-        on :n, :name, 'Your name'
-      end
-      slop.parse(%w/--foo --bar -z/)
+    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

data/lib/slop.rb

@@ -11,8 +11,6 @@ class Slop
   # Parses the items from a CLI format into a friendly object.
   #
   # @param [Array] items Items to parse into options.
-  # @yield Specify available CLI arguments using Slop# methods such as Slop#banner and Slop#option
-  # @return [Slop] Returns an instance of Slop.
   # @example Specifying three options to parse:
   #  opts = Slops.parse do
   #    on :v, :verbose, 'Enable verbose mode'
@@ -21,15 +19,13 @@ class Slop
   #  end
   #  -------
   #  program.rb --verbose -n 'Emily' -a 25
-  # @see Slop#banner
-  # @see Slop#option
+  # @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.
   #
-  # @yield Specify available CLI arguments using Slop# methods such as Slop#banner and Slop#option
   # @return [Slop] Returns an instance of Slop.
   def self.parse!(items=ARGV, options={}, &block)
     initialize_and_parse(items, true, options, &block)
@@ -67,12 +63,11 @@ class Slop
   # Set or return banner text.
   #
   # @param [String] text Displayed banner text.
-  # @return [String] Returns current banner.
   # @example
   #   opts = Slop.parse do
   #     banner "Usage - ruby foo.rb [arguments]"
   #   end
-  # @see Slop#to_s
+  # @return [String] Returns current banner.
   def banner(text=nil)
     @banner = text if text
     @banner
@@ -101,14 +96,12 @@ class Slop
   # Return the value of an option via the subscript operator.
   #
   # @param [Symbol] key Option symbol.
-  # @return [Object] Returns the object associated with that option.
   # @example
-  #   opts[:name]
-  #   #=> "Emily"
-  # @see Slop#method_missing
+  #   opts[:name] #=> "Emily"
+  # @return [Object] Returns the value associated with that option.
   def [](key)
     option = @options[key]
-    option ? option.argument_value : nil
+    option.argument_value if option
   end
 
   # Specify an option with a short or long version, description and type.
@@ -122,14 +115,15 @@ class Slop
   # @example
   #   opts = Slop.parse do
   #     on :n, :name, 'Your username', true # Required argument
-  #     on :a, :age,  'Your age (optional)', :optional => true # Optional argument
-  #     on :g, :gender, 'Your gender', :optional => false # Required argument
-  #     on :V, :verbose, 'Run in verbose mode', :default => true # Runs verbose mode by default
-  #     on :P, :people, 'Your friends', true, :as => Array # Required, list of people.
+  #     on :a, :age,  'Your age (optional)', :optional => true
+  #     on :g, :gender, 'Your gender', :optional => false
+  #     on :V, :verbose, 'Run in verbose mode', :default => true
+  #     on :P, :people, 'Your friends', true, :as => Array
   #     on :h, :help, 'Print this help screen' do
   #       puts help
-  #     end # Runs a block
+  #     end
   #   end
+  # @return [Slop::Option]
   def option(*args, &block)
     options = args.pop if args.last.is_a?(Hash)
     options ||= {}
@@ -145,14 +139,12 @@ class Slop
 
   # Returns the parsed list into a option/value hash.
   #
-  # @return [Hash] Returns a hash with each specified option as a symbolic key with an associated value.
   # @example
-  #   opts.to_hash
-  #   #=> { 'name' => 'Emily' }
+  #   opts.to_hash #=> { 'name' => 'Emily' }
   #
   #   # symbols!
-  #   opts.to_hash(true)
-  #   #=> { :name => 'Emily' }
+  #   opts.to_hash(true) #=> { :name => 'Emily' }
+  # @return [Hash]
   def to_hash(symbols=nil)
     @options.to_hash(symbols)
   end
@@ -160,29 +152,25 @@ class Slop
 
   # Allows you to check whether an option was specified in the parsed list.
   #
-  # @return [Boolean] Whether the desired option was specified.
   # @example
   #   #== ruby foo.rb -v
-  #   opts.verbose?
-  #   #=> true
-  #   opts.name?
-  #   #=> false
-  # @see Slop#[]
+  #   opts.verbose? #=> true
+  #   opts.name?    #=> false
+  # @return [Boolean] Whether the desired option was specified.
   def method_missing(meth, *args, &block)
-    meth.to_s[/\?$/] ? !!self[meth.to_s.chomp('?')] : super
+    super unless meth.to_s =~ /\?\z/
+    !!self[meth.to_s.chomp '?']
   end
 
   # Returns the banner followed by available options listed on the next line.
   #
-  # @return [String] Help text.
   # @example
   #  opts = Slop.parse do
   #    banner "Usage - ruby foo.rb [arguments]"
   #    on :v, :verbose, "Enable verbose mode"
   #  end
-  #  opts.to_s
-  #  #=> "Usage - ruby foo.rb [options]\n    -v, --verbose      Enable verbose mode"
-  # @see Slop#banner
+  #  puts opts
+  # @return [String] Help text.
   def to_s
     banner = "#{@banner}\n" if @banner
     (banner || '') + options.to_help
@@ -210,18 +198,22 @@ private
       flag = item.sub(/^--?/, '')
       option = @options[flag]
 
-      if !option && item =~ /^-[^-]/
-        flag, argument = flag.split('', 2)
-        option = @options[flag]
-      elsif !option && item =~ /--no-(.+)$/
-        if option = @options[$1]
-          option.force_argument_value false
-          next
+      unless option
+        case item
+        when /\A-[^-]/
+          flag, argument = flag.split('', 2)
+          option = @options[flag]
+        when /\A--([^=]+)=(.+)\z/
+          option = @options[$1]
+          argument = $2
+        when /\A--no-(.+)\z/
+          option.force_argument_value(false) if option = @options[$1]
         end
       end
 
       if option
         trash << item
+        next if option.forced?
         option.argument_value = true
 
         if option.expects_argument? || option.accepts_optional_argument?
@@ -267,13 +259,13 @@ private
   end
 
   def check_invalid_option(item, flag)
-    @invalid_options << flag if item[/^--?/] && @strict
+    @invalid_options << flag if item[/\A--?/] && @strict
   end
 
   def clean_options(args)
     options = []
 
-    short = args.first.to_s.sub(/^--?/, '')
+    short = args.first.to_s.sub(/\A--?/, '')
     if short.size == 1
       options.push short
       args.shift
@@ -284,7 +276,7 @@ private
     long = args.first
     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(/^--?/, '')
+      options.push args.shift.to_s.sub(/\A--?/, '')
     else
       options.push nil
     end
@@ -302,5 +294,4 @@ private
     message << ' -- ' << @invalid_options.map { |o| "'#{o}'" }.join(', ')
     raise InvalidOptionError, message
   end
-
 end

data/lib/slop/option.rb

@@ -17,7 +17,7 @@ class Slop
     # @return [Option] the option assoiated with this flag
     def [](flag)
       item = flag.to_s
-      if item =~ /^\d+$/
+      if item =~ /\A\d+\z/
         slice item.to_i
       else
         find do |option|
@@ -28,7 +28,7 @@ class Slop
 
     # @return [String]
     def to_help
-      heads = select {|x| !x.tail }
+      heads = reject {|x| x.tail }
       tails = select {|x| x.tail }
       (heads + tails).map(&:to_s).join("\n")
     end
@@ -76,11 +76,15 @@ class Slop
       @long_flag = long
       @description = description
       @options = options
+
       @expects_argument = argument
       @expects_argument = true if options[:optional] == false
+
       @tail = options[:tail]
       @match = options[:match]
+
       @forced = false
+      @argument_value = nil
 
       @delimiter = options[:delimiter] || ','
       @limit = options[:limit] || 0
@@ -91,7 +95,6 @@ class Slop
 
       @callback = blk if block_given?
       @callback ||= options[:callback]
-      @argument_value = nil
     end
 
     # @return [Boolean] true if this option expects an argument
@@ -109,16 +112,11 @@ class Slop
       @long_flag || @short_flag
     end
 
-    # @return [Object]
-    def default
-      @options[:default]
-    end
-
     # @return [Object] the argument value after it's been case
     #   according to the `:as` option
     def argument_value
       return @argument_value if @forced
-      value = @argument_value || default
+      value = @argument_value || @options[:default]
 
       case @options[:as].to_s.downcase
       when 'array'
@@ -141,6 +139,10 @@ class Slop
       @forced = true
     end
 
+    def forced?
+      @forced
+    end
+
     def to_s
       out = "    "
       out += @short_flag ? "-#{@short_flag}, " : ' ' * 4

data/lib/slop/version.rb

@@ -1,3 +1,3 @@
 class Slop
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/test/slop_test.rb

@@ -101,6 +101,12 @@ class SlopTest < TestCase
     assert_empty items
   end
 
+  test '#parse! removes parsed items prefixed with --no-' do
+    items = %w/--no-foo/
+    Slop.new { |opt| opt.on :foo }.parse!(items)
+    assert_empty items
+  end
+
   test 'the shit out of clean_options' do
     assert_equal(
       ['s', 'short', 'short option', false],
@@ -245,4 +251,13 @@ class SlopTest < TestCase
     refute slop[:verbose]
     refute slop[:debug]
   end
+
+  test 'option=value' do
+    slop = Slop.new
+    slop.opt :n, :name, true
+    slop.parse %w/--name=lee/
+
+    assert_equal 'lee', slop[:name]
+    assert slop.name?
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: slop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 +00:00
+date: 2011-03-28 00:00:00 +01:00
 default_executable: 
 dependencies: []