slop 0.1.4 → 0.1.5

data/README.md

@@ -26,7 +26,7 @@ Usage
     s = Slop.parse(ARGV) do
       option(:v, :verbose, "Enable verbose mode", :default => false)
       option(:n, :name, "Your name", true) # compulsory argument
-      option(:c, :country, "Your country", argument => true) # the same thing
+      option(:c, :country, "Your country", :argument => true) # the same thing
 
       option(:a, :age, "Your age", true, :optional => true) # optional argument
       option(:address, "Your address", :optional => true)   # the same

data/lib/slop/option.rb

@@ -1,13 +1,32 @@
 class Slop
   class Option
 
+    # @return [Symbol,#to_s]
     attr_reader :flag
+
+    # @return [Symbol,#to_s]
     attr_reader :option
+
+    # @return [String]
     attr_reader :description
-    attr_reader :argument_value
+
+    # @return [Object]
     attr_reader :default
+
+    # @return [Proc]
     attr_reader :callback
 
+    # @param [Hash] options Option attributes
+    # @option options [Symbol,#to_s] :flag
+    # @option options [Symbol,#to_s] :option
+    # @option options [Symbol,#to_s] :description
+    # @option options [Boolean] :argument
+    # @option options [Boolean] :optional
+    # @option options [Object] :default
+    # @option options [Object] :as
+    # @option options [Proc] :callback
+    # @option options [String,#to_s] :delimiter
+    # @option options [Integer] :limit
     def initialize(options={}, &blk)
       @options = options
       @flag = options[:flag]
@@ -22,7 +41,7 @@ class Slop
 
       # Array properties
       @delimiter = options[:delimiter] || ','
-      @limit = options[:limit] || 1
+      @limit = options[:limit] || 0
 
       @argument_value = nil
     end
@@ -106,7 +125,7 @@ class Slop
     # Now when the `-v` or `--verbose` option is supplied, verbose will
     # be set to `true`, rather than the default `false` option
     def switch_argument_value
-      @argument_value = @option[:switch]
+      @argument_value = @options[:switch]
     end
 
     # return a key for an option, prioritize

data/lib/slop.rb

@@ -3,7 +3,7 @@ require 'set'
 require 'slop/option'
 
 class Slop
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 
   # Raised when an option expects an argument and none is given
   class MissingArgumentError < ArgumentError; end
@@ -11,6 +11,11 @@ class Slop
   # @return [Set]
   attr_reader :options
 
+  # @return [Set] the last set of options used
+  def self.options
+    @@options
+  end
+
   # Sugar for new(..).parse(stuff)
   def self.parse(values=[], &blk)
     new(&blk).parse(values)
@@ -18,6 +23,7 @@ class Slop
 
   def initialize(&blk)
     @options = Set.new
+    @@options = @options
     instance_eval(&blk) if block_given?
   end
 
@@ -33,10 +39,8 @@ class Slop
     args.unshift nil if args.first.size > 1
     args.push nil if args.size == 2
     args.push false if args.size == 3
-    if args[2] == true
-      args[2] = nil
-      args[3] = true
-    end
+
+    args[2..3] = [nil, true] if args[2] == true
 
     attributes = [:flag, :option, :description, :argument]
     options = Hash[attributes.zip(args)]
@@ -60,15 +64,17 @@ class Slop
   # Parse an Array (usually ARGV) of options
   #
   # @param [Array, #split] Array or String of options to parse
+  # @raise [MissingArgumentError] raised when a compulsory argument is missing
   def parse(values=[])
     values = values.split(/\s+/) if values.respond_to?(:split)
 
     values.each do |value|
-      if value[1] == '-' or value[0] == '-'
-        opt = value.size == 2 ? value[1] : value[2..-1]
-        next unless option = option_for(opt) # skip unknown values for now
+      if flag_or_option?(value)
+        opt   = value.size == 2 ? value[1] : value[2..-1]
         index = values.index(value)
 
+        next unless option = option_for(opt) # skip unknown values for now
+
         option.execute_callback if option.has_callback?
         option.switch_argument_value if option.has_switch?
 
@@ -76,13 +82,13 @@ class Slop
           value = values.at(index + 1)
 
           unless option.optional_argument?
-            if not value or value[0] == '-' or value[1] == '-'
+            if not value or flag_or_option?(value)
               raise MissingArgumentError,
                   "#{option.key} requires a compulsory argument, none given"
               end
           end
 
-          unless !value or value[0] == '-' or value[1] == '-'
+          unless not value or flag_or_option?(value)
             option.argument_value = values.delete_at(values.index(value))
           end
         end
@@ -142,4 +148,11 @@ class Slop
     option.argument_value
   end
   alias :[] :value_for
+
+  private
+
+  def flag_or_option?(flag)
+    return unless flag
+    flag[1, 2].include?('-')
+  end
 end

data/spec/option_spec.rb

@@ -2,4 +2,144 @@ require File.expand_path('../../lib/slop', __FILE__)
 
 describe Slop::Option do
 
+  describe "argument_value" do
+    it "should return the default value if no value is found" do
+      Slop::Option.new(:default => :foo).argument_value.should == :foo
+    end
+
+    it "is nil if there's no argument value and no default" do
+      Slop::Option.new().argument_value.should be_nil
+    end
+
+    it "converts arguments into an integer with the :as => Integer flag" do
+      opt = Slop::Option.new(:as => Integer)
+      opt.argument_value = "1"
+      opt.argument_value.should == 1
+      opt.argument_value.should be_kind_of Integer
+    end
+
+    it "converts arguments into a symbol with the :as => Symbol flag" do
+      opt = Slop::Option.new(:as => Symbol)
+      opt.argument_value = "lee"
+      opt.argument_value.should == :lee
+      opt.argument_value.should be_kind_of Symbol
+    end
+
+    describe "with the :as Array option" do
+      it "returns nil if no argument_value is set" do
+        Slop::Option.new(:as => Array).argument_value.should be_nil
+      end
+
+      it "returns an Array" do
+        opt = Slop::Option.new(:as => Array)
+        opt.argument_value = "foo"
+        opt.argument_value.should be_kind_of Array
+      end
+
+      it "uses , as the default delimiter" do
+        opt = Slop::Option.new(:as => Array)
+        opt.argument_value = "foo,bar"
+        opt.argument_value.should == ["foo", "bar"]
+        opt.argument_value = "foo:bar"
+        opt.argument_value.should == ["foo:bar"]
+      end
+
+      it "can use a custom delimited" do
+        opt = Slop::Option.new(:as => Array, :delimiter => ':')
+        opt.argument_value = "foo,bar"
+        opt.argument_value.should == ["foo,bar"]
+        opt.argument_value = "foo:bar"
+        opt.argument_value = ["foo", "bar"]
+      end
+
+      it "can uses a custom limit" do
+        opt = Slop::Option.new(:as => Array, :limit => 3)
+        opt.argument_value = "foo,bar,baz,etc"
+        opt.argument_value.should == ["foo", "bar", "baz,etc"]
+      end
+    end
+  end
+
+  describe "has_flag?" do
+    it "is true if the option contains a flag" do
+      Slop::Option.new().has_flag?(:n).should be_false
+      Slop::Option.new(:flag => :n).has_flag?(:n).should be_true
+    end
+  end
+
+  describe "has_option?" do
+    it "is true if the option constains an.. option" do
+      Slop::Option.new().has_option?(:name).should be_false
+      Slop::Option.new(:option => :name).has_option?(:name).should be_true
+    end
+  end
+
+  describe "has_default?" do
+    it "is true if the option contains a default value" do
+      Slop::Option.new(:default => 'Lee').has_default?.should be_true
+      Slop::Option.new().has_default?.should be_false
+    end
+  end
+
+  describe "has_switch?" do
+    it "is true if the option contains a switchable value" do
+      Slop::Option.new().has_switch?.should be_false
+      Slop::Option.new(:switch => 'injekt').has_switch?.should be_true
+    end
+  end
+
+  describe "has_callback?" do
+    it "is true if the option has a callback" do
+      Slop::Option.new().has_callback?.should be_false
+      Slop::Option.new(:callback => proc { }).has_callback?.should be_true
+    end
+  end
+
+  describe "execute_callback" do
+    it "executes a callback" do
+      opt = Slop::Option.new(:callback => proc { 'foo' })
+      opt.execute_callback.should == 'foo'
+    end
+  end
+
+  describe "requires_argument?" do
+    it "returns true if the option requires an argument" do
+      Slop::Option.new().requires_argument?.should be_false
+      Slop::Option.new(:argument => true).requires_argument?.should be_true
+    end
+  end
+
+  describe "optional_argument?" do
+    it "returns true if the option argument is optional" do
+      Slop::Option.new(:argument => true).optional_argument?.should be_false
+      Slop::Option.new(:argument => true, :optional => true).optional_argument?.should be_true
+      Slop::Option.new(:optional => true).optional_argument?.should be_true
+    end
+  end
+
+  describe "[]" do
+    it "should return an options value" do
+      Slop::Option.new()[:foo].should be_nil
+      Slop::Option.new(:foo => 'bar')[:foo].should == 'bar'
+    end
+  end
+
+  describe "switch_argument_value" do
+    it "replaces an options argument value with the switch value" do
+      opt = Slop::Option.new(:default => 'foo', :switch => 'bar')
+      opt.argument_value.should == 'foo'
+      opt.switch_argument_value
+      opt.argument_value.should == 'bar'
+    end
+  end
+
+  describe "key" do
+    it "returns the option if both a flag and option exist" do
+      Slop::Option.new(:flag => :n, :option => :name).key.should == :name
+    end
+
+    it "returns the flag if there is no option" do
+      Slop::Option.new(:flag => :n).key.should == :n
+    end
+  end
 end

data/spec/slop_spec.rb

@@ -7,6 +7,15 @@ describe Slop do
     end
   end
 
+  describe "::options" do
+    it "should return the last set of options" do
+      s = Slop.new { option(:f, :foo, "foo") }
+      Slop.options.should == s.options
+      p = Slop.new { option(:b, :bar, "bar") }
+      Slop.options.should == p.options
+    end
+  end
+
   describe "option" do
     it "adds an option" do
       @slop.options.find do |opt|

metadata

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