slop 0.1.8 → 0.1.9

data/README.md

@@ -16,13 +16,6 @@ Installation
     cd slop
     rake install
 
-Features Overview
------------------
-
- - Callbacks
- - Casting
- - Lists
-
 Usage
 -----
 
@@ -89,6 +82,26 @@ you can pass the `:as` attribute to your option.
     end
     s.value_for(:age) #=> 20 # not "20"
 
+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:
+
+    opt(:n, "Your name")
+
+and Slop will detect a description in place of an option, so you don't have to
+do this:
+
+    opt(:n, nil, "Your name")
+
+You can also try other variations:
+
+    opt(:name, "Your name")
+    opt(:n, :name)
+    opt(:name)
+
 Lists
 -----
 

data/lib/slop.rb

@@ -5,7 +5,7 @@ require 'slop/option'
 class Slop
   include Enumerable
 
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 
   # Raised when an option expects an argument and none is given
   class MissingArgumentError < ArgumentError; end
@@ -162,11 +162,29 @@ class Slop
   end
 
   def pad_options(args)
+    # if the first value is not a single character, it's probably an option
+    # so we just replace it with nil
     args.unshift nil if args.first.nil? || args.first.size > 1
-    args.push nil if args.size < 2
+
+    # if there's only one or two arguments, we pad the values out
+    # with nil values, eventually adding a 'false' to the end of the stack
+    # because that's the default to represent required arguments
+    args.push nil if args.size == 1
     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
+    # insert the original value into the description field
+    args[1..2] = [nil, args[1]] if args[1].to_s.include?(" ")
+
+    # if there's no description given but the option requires an argument, it'll
+    # probably look like this: `[:f, :option, true]`
+    # so we replace the third option with nil to represent the description
+    # and push the true to the end of the stack
     args[2..3] = [nil, true] if args[2] == true
+
+    # phew
     args
   end
 end

data/lib/slop/option.rb

@@ -16,6 +16,8 @@ class Slop
     # @return [Proc]
     attr_reader :callback
 
+    @@max_option_size = 0
+
     # @param [Hash] options Option attributes
     # @option options [Symbol,#to_s] :flag
     # @option options [Symbol,#to_s] :option
@@ -44,6 +46,16 @@ class Slop
       @limit = options[:limit] || 0
 
       @argument_value = nil
+
+      if @option
+        if requires_argument?
+          size = (@option.size * 2) + 4
+        else
+          size = @option.size + 2
+        end
+
+        @@max_option_size = size if @@max_option_size < size
+      end
     end
 
     # Set the argument value
@@ -134,13 +146,36 @@ class Slop
       @option || @flag
     end
 
+    # @todo Write specs for the output string
     def to_s
       str = "\t"
-      str << "-#{@flag}" if @flag
-      str << "\t"
-      str << "--#{@option}\t\t" if @option
-      str << "#{@description}" if @description
-      str << "\n"
+
+      if @flag
+        str << "-#{@flag}"
+      else
+        str << " " * 4
+      end
+
+      if @option
+        str << ", " if @flag
+        optionstr = "--#{@option}"
+
+        if requires_argument?
+          if optional_argument?
+            optionstr << " [#{@option}]"
+          else
+            optionstr << " <#{@option}>"
+          end
+        end
+        size_diff = @@max_option_size - ((@option.size * 2) + 4)
+        optionstr << " " * size_diff
+        str << optionstr
+      else
+        str << " " * (@@max_option_size + 2)
+      end
+
+      str << "\t#{@description}" if @description
+      str
     end
 
     def inspect

data/spec/option_spec.rb

@@ -142,4 +142,45 @@ describe Slop::Option do
       Slop::Option.new(:flag => :n).key.should == :n
     end
   end
+
+  describe "to_s" do
+    before :all do
+      o = Slop.new do
+        opt(:n, nil, "Your name", true)
+        opt(:a, :age, "Your age", :optional => true)
+        opt(:verbose, "Enable verbose mode")
+        opt(:p, :password, "Your password", true)
+      end
+      @opt = {}
+      @opt[:flag] = o.option_for(:n)
+      @opt[:optional] = o.option_for(:age)
+      @opt[:option] = o.option_for(:verbose)
+      @opt[:required] = o.option_for(:password)
+    end
+
+    it "starts with a tab space" do
+      @opt[:flag].to_s[0].should == "\t"
+    end
+
+    it "displays a flag if one exists" do
+      @opt[:flag].to_s[1, 2].should == "-n"
+    end
+
+    it "appends a comma to the flag if an option exists" do
+      @opt[:flag].to_s[3].should_not == ","
+      @opt[:optional].to_s[3].should == ","
+    end
+
+    it "displays an option if one exists" do
+      @opt[:option].to_s[5, 9].should == "--verbose"
+    end
+
+    it "adds square brackes to the option if the argument is optional" do
+      @opt[:optional].to_s[5, 11].should == "--age [age]"
+    end
+
+    it "adds angle brackets to the option if the argument is required" do
+      @opt[:required].to_s[5, 21].should == "--password <password>"
+    end
+  end
 end

data/spec/slop_spec.rb

@@ -135,6 +135,11 @@ 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]
+    end
+
     it "always returns an array of 4 elements" do
       @args.each do |arr|
         args = @slop.send(:pad_options, arr)

metadata

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