slop 1.5.2 → 1.5.3

data/README.md

@@ -21,7 +21,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 :n, :name, 'Your name', true              # compulsory argument
+      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
@@ -389,4 +389,4 @@ thing in Slop:
       on :a, :age, 'Your age', true
     end
 
-    opts.to_hash(true) #=> { :name => 'lee', :age => 105 }
+    opts.to_hash(true) #=> { :name => 'lee', :age => 105 }

data/lib/slop.rb

@@ -16,7 +16,7 @@ class Slop
   class InvalidOptionError < RuntimeError; end
 
   # @return [String] The current version string
-  VERSION = '1.5.2'
+  VERSION = '1.5.3'
 
   # Parses the items from a CLI format into a friendly object.
   #
@@ -65,6 +65,10 @@ class Slop
   # @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
   def initialize(*opts, &block)
     sloptions = {}
     sloptions.merge! opts.pop if opts.last.is_a? Hash
@@ -83,14 +87,17 @@ class Slop
     @on_empty = sloptions[:on_empty]
     @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
-        puts help
-        exit
+        io.puts help
+        exit if eoh
       end
     end
   end

data/lib/slop/option.rb

@@ -21,6 +21,9 @@ class Slop
     #   regexp, otherwise Slop will raise an InvalidArgumentError
     attr_reader :match
 
+    # @return [Object] true/false, or an optional help string to append
+    attr_reader :help
+
     # @overload argument_value=(value)
     #   Set this options argument value
     #   @param [Object] value The value you'd like applied to this option
@@ -40,6 +43,7 @@ class Slop
     # @option options [Integer] :limit (0)
     # @option options [Boolean] :tail (false)
     # @option options [Regexp] :match
+    # @option options [Boolean, String] :help
     def initialize(slop, short, long, description, argument, options={}, &blk)
       @slop = slop
       @short_flag = short
@@ -52,6 +56,8 @@ class Slop
 
       @tail = options[:tail]
       @match = options[:match]
+      @help = options[:help]
+      @help = true if @help.nil?
 
       @forced = false
       @argument_value = nil
@@ -60,7 +66,12 @@ class Slop
       @limit = options[:limit] || 0
 
       if @long_flag && @long_flag.size > @slop.longest_flag
-        @slop.longest_flag = @long_flag.size
+        if @help.respond_to? :to_str
+          size = @long_flag.size + @help.size
+        else
+          size = @long_flag.size
+        end
+        @slop.longest_flag = size
       end
 
       @callback = blk if block_given?
@@ -127,7 +138,13 @@ class Slop
 
       if @long_flag
         out += "--#{@long_flag}"
-        diff = @slop.longest_flag - @long_flag.size
+        if @help.respond_to? :to_str
+          out += " #{@help}"
+          size = @long_flag.size + @help.size + 1
+        else
+          size = @long_flag.size
+        end
+        diff = @slop.longest_flag - size
         spaces = " " * (diff + 6)
         out += spaces
       else

data/lib/slop/options.rb

@@ -31,7 +31,8 @@ class Slop
     def to_help
       heads = reject {|x| x.tail }
       tails = select {|x| x.tail }
-      (heads + tails).map(&:to_s).join("\n")
+      all = (heads + tails).reject {|x| !x.help }
+      all.map(&:to_s).join("\n")
     end
   end
 end

data/test/option_test.rb

@@ -110,6 +110,18 @@ class OptionTest < TestCase
     assert slop.to_s.strip =~ /foo$/
   end
 
+  test 'do not print help for options with :help => false' do
+    slop = Slop.new
+    slop.on :f, :foo, :help => false
+    refute slop.help.include?('foo')
+  end
+
+  test 'appends a help string with :help => "string"' do
+    slop = Slop.new
+    slop.on :n, :name, 'Your name', true, :help => '<YOUR NAME HERE>'
+    assert_equal '    -n, --name <YOUR NAME HERE>     Your name', slop.options[:name].to_s
+  end
+
   test 'argument matching' do
     slop = Slop.new
     slop.on :f, :foo, true, :match => /^h/

data/test/slop_test.rb

@@ -317,4 +317,26 @@ class SlopTest < TestCase
     slop = Slop.new { on :f, :foo, true }
     assert_raises(Slop::MissingArgumentError) { slop.parse %w/-f --bar/ }
   end
+
+  test 'custom IO object' do
+    require 'stringio'
+    io = StringIO.new
+    slop = Slop.new(:help => true, :io => io)
+    slop.on :f, :foo, 'something fooey'
+    begin
+      slop.parse %w/--help/
+    rescue SystemExit
+    end
+    assert io.string.include? 'something fooey'
+  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/ }
+
+    opts = Slop.new(:help => true, :io => io, :exit_on_help => false)
+    assert opts.parse %w/--help/
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: slop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 +01:00
+date: 2011-04-23 00:00:00 +01:00
 default_executable: 
 dependencies: []