slop 1.9.0 → 1.9.1

data/CHANGES.md

@@ -1,5 +1,11 @@
-TBA
----
+1.9.1 (2011-06-16)
+------------------
+
+* Ensure optional items with no arguments still return true when searching
+  for presence
+
+1.9.0 (2011-06-15)
+------------------
 
 * Add command completion and support for an error message when ambiguous
   commands are used

data/lib/slop.rb

@@ -16,7 +16,7 @@ class Slop
   class InvalidOptionError < RuntimeError; end
 
   # @return [String] The current version string
-  VERSION = '1.9.0'
+  VERSION = '1.9.1'
 
   # Parses the items from a CLI format into a friendly object
   #
@@ -65,7 +65,7 @@ class Slop
   attr_accessor :longest_flag
 
   # @return [Array] A list of aliases this command uses
-  attr_reader :aliases
+  attr_accessor :aliases
 
   # @option opts [Boolean] :help
   #   * Automatically add the `help` option
@@ -123,7 +123,6 @@ class Slop
     @longest_flag = 0
     @invalid_options = []
 
-    @aliases = Array(sloptions[:aliases] || sloptions[:alias])
     @banner = sloptions[:banner]
     @strict = sloptions[:strict]
     @ignore_case = sloptions[:ignore_case]
@@ -266,18 +265,18 @@ class Slop
   #   # ARGV is `create -v`
   #   opts.commands[:create].verbose? #=> true
   # @since 1.5.0
+  # @raise [ArgumentError] When this command already exists
   # @return [Slop] a new instance of Slop namespaced to +label+
   def command(label, options={}, &block)
     if @commands[label]
       raise ArgumentError, "command `#{label}` already exists"
     end
 
-    slop = Slop.new @sloptions.merge options
+    slop = Slop.new @sloptions.merge(options)
+    slop.aliases = Array(options.delete(:aliases) || options.delete(:alias))
     @commands[label] = slop
 
-    Array(options[:aliases] || options[:alias]).each do |a|
-      @commands[a] = @commands[label]
-    end
+    slop.aliases.each { |a| @commands[a] = @commands[label] }
 
     if block_given?
       block.arity == 1 ? yield(slop) : slop.instance_eval(&block)
@@ -363,7 +362,7 @@ class Slop
   # @return [Boolean] true if this option is present, false otherwise
   def method_missing(meth, *args, &block)
     super unless meth.to_s[-1, 1] == '?'
-    present = present? meth.to_s.chomp '?'
+    present = present? meth.to_s.chomp('?')
 
     (class << self; self; end).instance_eval do
       define_method(meth) { present }
@@ -381,7 +380,7 @@ class Slop
   # @since 1.5.0
   # @return [Boolean] true if this option is present, false otherwise
   def present?(option_name)
-    !!get(option_name)
+    @options[option_name] && @options[option_name].count > 0
   end
 
   # Returns the banner followed by available options listed on the next line
@@ -406,6 +405,8 @@ class Slop
   end
   alias :help :to_s
 
+  # @return [String] This Slop object will options and configuration
+  #   settings revealed
   def inspect
     "#<Slop config_options=#{@sloptions.inspect}\n  " +
     options.map(&:inspect).join("\n  ") + "\n>"
@@ -428,6 +429,14 @@ class Slop
     end
   end
 
+  # traverse through the list of items sent to parse() or parse!() and
+  # attempt to do the following:
+  #
+  # * Find an option object
+  # * Assign an argument to this option
+  # * Validate an option and/or argument depending on configuration options
+  # * Remove non-parsed items if `delete` is true
+  # * Yield any non-options to the block (if one is given)
   def parse_items(items, delete=false, &block)
     if items.empty? && @on_empty.respond_to?(:call)
       @on_empty.call self
@@ -460,7 +469,7 @@ class Slop
       end
 
       if option
-        option.count += 1
+        option.count += 1 unless item[/\A--no-/]
         trash << index
         next if option.forced
         option.argument_value = true
@@ -469,7 +478,7 @@ class Slop
           argument ||= items.at(index + 1)
           trash << index + 1
 
-          if !option.accepts_optional_argument? && flag?(argument)
+          if !option.accepts_optional_argument? && argument =~ /\A--?[a-zA-Z][a-zA-Z0-9_-]*\z/
             raise MissingArgumentError, "'#{option.key}' expects an argument, none given"
           end
 
@@ -513,6 +522,11 @@ class Slop
     raise InvalidOptionError, message
   end
 
+  # if multiple_switches is enabled, this method filters through an items
+  # characters and attempts to find an Option object for each flag.
+  #
+  # Raises if a flag expects an argument or strict mode is enabled and a
+  # flag was not found
   def enable_multiple_switches(item)
     item[1..-1].each_char do |switch|
       if option = @options[switch]
@@ -520,20 +534,19 @@ class Slop
           raise MissingArgumentError, "'-#{switch}' expects an argument, used in multiple_switch context"
         end
         option.argument_value = true
+        option.count += 1
       else
         raise InvalidOptionError, "Unknown option '-#{switch}'" if @strict
       end
     end
   end
 
+  # wrap and indent a string, used to wrap and indent a description string
   def wrap_and_indent(string, width, indentation)
-    # Wrap and indent each paragraph
     string.lines.map do |paragraph|
-      # Initialize
       lines = []
       line = ''
 
-      # Split into words
       paragraph.split(/\s/).each do |word|
         # Begin new line if it's too long
         if (line + ' ' + word).length >= width
@@ -546,11 +559,13 @@ class Slop
       end
       lines << line
 
-      # Join lines
       lines.map { |l| ' '*indentation + l }.join("\n")
     end.join("\n")
   end
 
+  # attempt to extract an option from an argument, this method allows us
+  # to parse things like 'foo=bar' and '--no-value' for negative values
+  # returns an array of the Option object and an argument if one was found
   def extract_option(item, flag)
     if item[0, 1] == '-'
       option = @options[flag]
@@ -575,6 +590,10 @@ class Slop
     [option, argument]
   end
 
+  # attempt to execute a command if one exists, returns a positive (tru-ish)
+  # result if the command was found and executed. If completion is enabled
+  # and a flag is found to be ambiguous, this method prints an error message
+  # to the @io object informing the user
   def execute_command(items, delete)
     str = items[0]
 
@@ -601,13 +620,23 @@ class Slop
     end
   end
 
+  # If autocreation is enabled this method simply generates an option
+  # and add's it to the existing list of options
   def autocreate(flag, index, items)
     return if present? flag
     short, long = clean_options Array(flag)
     arg = (items[index + 1] && items[index + 1] !~ /\A--?/)
-    @options << Option.new(self, short, long, nil, arg, {})
+    option = Option.new(self, short, long, nil, arg, {})
+    option.count = 1
+    @options << option
   end
 
+  # Clean up arguments sent to `on` and return a list of 5 elements:
+  # * short flag (or nil)
+  # * long flag (or nil)
+  # * description (or nil)
+  # * true/false if this option takes an argument or not
+  # * extra options (ie: :as, :optional, and :help)
   def clean_options(args)
     options = []
     extras = {}
@@ -640,8 +669,4 @@ class Slop
     options.push @arguments ?  true : (args.shift ? true : false)
     options.push extras
   end
-
-  def flag?(str)
-    str =~ /\A--?[a-zA-Z][a-zA-Z0-9_-]*\z/
-  end
 end

data/slop.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'slop'
-  s.version = '1.9.0'
+  s.version = '1.9.1'
   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/slop_test.rb

@@ -291,11 +291,16 @@ class SlopTest < TestCase
   end
 
   test 'options are present' do
-    opts = Slop.new { on :f, 'foo-bar'; on :b, 'bar-baz' }
-    opts.parse %w/--foo-bar/
+    opts = Slop.new do
+      on :f, 'foo-bar'
+      on :b, 'bar-baz'
+      on :h, :optional => true
+    end
+    opts.parse %w/--foo-bar -h/
 
     assert opts.present?('foo-bar')
     refute opts.present?('bar-baz')
+    assert opts.present?(:h)
   end
 
   test 'raises if an option expects an argument and none is given' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slop
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 49
   prerelease: 
   segments: 
   - 1
   - 9
-  - 0
-  version: 1.9.0
+  - 1
+  version: 1.9.1
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-15 00:00:00 +01:00
+date: 2011-06-16 00:00:00 +01:00
 default_executable: 
 dependencies: []