slop 0.1.9 → 0.2.0

data/README.md

@@ -47,13 +47,30 @@ Usage
     end
 
     # without `-v`
-    s.value_for(:verbose) #=> false
+    s[:verbose] #=> false
 
     # using `-v`
-    s.value_for(:verbose) #=> true
+    s[:verbose] #=> true
 
     # using `--applicable_age`
-    s.value_for(:applicable_age) #=> 20
+    s[:applicable_age] #=> 20
+
+Want these options back in a nice readable help string? Just call `Slop.to_s`
+and Slop will return a nice indented option list. You can even add a banner to
+the help text using the `banner` method like so:
+
+    opts = Slop.new do
+      banner("Usage: foo [options]")
+
+      opt(:n, :name, "Your name", true)
+    end
+
+    puts opts
+
+Returns:
+
+    Usage: foo [options]
+	      -n, --name <name>	     Your name
 
 Callbacks
 ---------
@@ -80,7 +97,7 @@ you can pass the `:as` attribute to your option.
     s = Slop.parse("--age 20") do
       opt(:age, true, :as => Integer) # :int/:integer both also work
     end
-    s.value_for(:age) #=> 20 # not "20"
+    s[:age] #=> 20 # not "20"
 
 Smart
 -----
@@ -110,14 +127,14 @@ You can of course also parse lists into options. Here's how:
     s = Slop.parse("--people lee,injekt") do
       opt(:people, true, :as => Array)
     end
-    s.value_for(:people) #=> ["lee", "injekt"]
+    s[:people] #=> ["lee", "injekt"]
 
 You can also change both the split delimiter and limit
 
     s = Slop.parse("--people lee:injekt:bob") do
       opt(:people, true, :as => Array, :delimiter => ':', :limit => 2)
     end
-    s.value_for(:people) #=> ["lee", "injekt:bob"]
+    s[:people] #=> ["lee", "injekt:bob"]
 
 Contributing
 ------------

data/lib/slop.rb

@@ -5,7 +5,7 @@ require 'slop/option'
 class Slop
   include Enumerable
 
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 
   # Raised when an option expects an argument and none is given
   class MissingArgumentError < ArgumentError; end
@@ -24,11 +24,20 @@ class Slop
   end
 
   def initialize(&blk)
+    @banner = nil
     @options = Set.new
     @@options = @options
     instance_eval(&blk) if block_given?
   end
 
+  # set the help string banner
+  # @param [String,#to_s] banner
+  # @return The banner, or nil
+  def banner(banner=nil)
+    @banner = banner if banner
+    @banner
+  end
+
   # add an option
   def option(*args, &blk)
     opts = args.pop if args.last.is_a?(Hash)
@@ -149,6 +158,15 @@ class Slop
     @options.each { |opt| yield opt }
   end
 
+  def to_s
+    str = ""
+    str << @banner + "\n" if @banner
+    each do |opt|
+      str << "#{opt}\n"
+    end
+    str
+  end
+
   private
 
   def flag_or_option?(flag)
@@ -173,10 +191,10 @@ class Slop
     args.push nil if args.size == 2
     args.push false if args.size == 3
 
-    # if the second argument includes a space it's probably a
-    # description, so we insert a nil into the option field and
+    # if the second argument includes a space or some odd character it's
+    # probably a description, so we insert a nil into the option field and
     # insert the original value into the description field
-    args[1..2] = [nil, args[1]] if args[1].to_s.include?(" ")
+    args[1..2] = [nil, args[1]] unless args[1].to_s =~ /\A[a-zA-Z_-]*\z/
 
     # if there's no description given but the option requires an argument, it'll
     # probably look like this: `[:f, :option, true]`

data/lib/slop/option.rb

@@ -16,6 +16,11 @@ class Slop
     # @return [Proc]
     attr_reader :callback
 
+    # The maximum size of any --option, recorded for
+    # padding out any output string with smaller option lengths
+    # with the correct amount of whitespace
+    #
+    # @return [Fixnum]
     @@max_option_size = 0
 
     # @param [Hash] options Option attributes
@@ -146,7 +151,6 @@ class Slop
       @option || @flag
     end
 
-    # @todo Write specs for the output string
     def to_s
       str = "\t"
 
@@ -168,13 +172,13 @@ class Slop
           end
         end
         size_diff = @@max_option_size - ((@option.size * 2) + 4)
-        optionstr << " " * size_diff
+        optionstr << " " * size_diff if size_diff > 0
         str << optionstr
       else
         str << " " * (@@max_option_size + 2)
       end
 
-      str << "\t#{@description}" if @description
+      str << "\t\t#{@description}" if @description
       str
     end
 

data/spec/option_spec.rb

@@ -44,7 +44,7 @@ describe Slop::Option do
         opt.argument_value.should == ["foo:bar"]
       end
 
-      it "can use a custom delimited" do
+      it "can use a custom delimiter" do
         opt = Slop::Option.new(:as => Array, :delimiter => ':')
         opt.argument_value = "foo,bar"
         opt.argument_value.should == ["foo,bar"]

data/spec/slop_spec.rb

@@ -13,6 +13,15 @@ describe Slop do
     end
   end
 
+  describe "banner" do
+    it "adds a banner to the beginning of the help string" do
+      o = Slop.new do
+        banner("foo bar")
+      end
+      o.to_s.should == "foo bar\n"
+    end
+  end
+
   describe "::options" do
     it "should return the last set of options" do
       s = Slop.new { option(:f, :foo, "foo") }
@@ -136,8 +145,16 @@ describe Slop do
     end
 
     it "detects a description in place of an option, if one exists" do
-      args = @slop.send(:pad_options, [:n, "Description here"])
-      args.should == [:n, nil, "Description here", false]
+      valid = [ "Description here", "Description!", "de#scription" ]
+      invalid = [ "Description", "some-description" ] # these pass as valid options
+
+      valid.each do |v|
+        @slop.send(:pad_options, [:n, v]).should == [:n, nil, v, false]
+      end
+
+      invalid.each do |i|
+        @slop.send(:pad_options, [:n, i]).should == [:n, i, nil, false]
+      end
     end
 
     it "always returns an array of 4 elements" do
@@ -164,4 +181,24 @@ describe Slop do
     end
   end
 
+  describe "help string" do
+    before :all do
+      @o = Slop.new do
+        banner("Usage: foo [options]")
+        opt(:n, :name, "Your name")
+        opt(:a, :age, "Your age")
+      end
+    end
+
+    it "starts with a banner if one exists" do
+      @o.to_s.split("\n").first.should == "Usage: foo [options]"
+    end
+
+    it "should include all options" do
+      @o.each do |option|
+        flag, opt, des = option.flag, option.option, option.description
+        [flag, opt, des].each {|a| @o.to_s.include?(a.to_s).should be_true }
+      end
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 +00:00
+date: 2010-12-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency