clive 0.7.1 → 0.7.2

data/README.md

@@ -125,7 +125,7 @@ blocks of the options in it are only ran when they are found.
 ### Arguments
 
 Anything that is not captured as a command, option or argument of a flag, is returned by
-#parse in an array.
+\#parse in an array.
 
     class Args
       include Clive::Parser
@@ -139,7 +139,41 @@ Anything that is not captured as a command, option or argument of a flag, is ret
     #=> ['argument', 'A string']
 
 
-### Option Handling
+### Variables
+
+Usually you'll want to set up some kind of variable, such as a hash to store your 
+configuration in, or an array of items to do something with. This would be quite annoying
+due to the fact it's a class, so I addded some handy methods.
+
+    class CLI
+      option_var :ok, false
+    end
+    CLI.ok #=> false
+    CLI.ok = true 
+    CLI.ok #=> true
+    
+    class CLI
+      option_hash :config
+      #=> is same as option_var :config, {}
+      
+      flag :set, :args => "KEY VALUE" do |key, value|
+        config[key.to_sym] = value
+      end
+    
+      option_list :items
+      # or option_array :items
+      #=> are the same as option_var :items, []
+      #                   option_var :a_list, []
+      
+      flag :add, :args => "ITEM" do |item|
+        items << item
+      end
+    end
+    CLI.parse %w(--set works true --add apple --add orange)
+    CLI.config #=> {:works => true}
+    CLI.items #=> ['apple', 'orange']
+
+### Option Missing Handling
 
 You are able to intercept errors when an option does not exist in a similar way to 
 `method_missing`.

data/lib/clive/command.rb

@@ -106,8 +106,8 @@ module Clive
           v.run
         when :flag
           args = i[2..-1]
-          opt_args = v.arg_num(true)
-          nec_args = v.arg_num(false)
+          opt_args = v.arg_size(:optional)
+          nec_args = v.arg_size(:mandatory)
           # check for missing args
           if args.size < nec_args
             raise MissingArgument.new(v.sort_name)
@@ -151,7 +151,7 @@ module Clive
           pre_command << i
         end
       end
-
+      
       post_command = Tokens.new(tokens.array - pre_command - [command])
       pre_command_tokens = parse(pre_command)
       r = pre_command_tokens
@@ -184,7 +184,7 @@ module Clive
         else
           if k == :word
             # add to last flag?
-            if r.last && r.last[0] == :flag && r.last.size - 2 < r.last[1].arg_size
+            if r.last && r.last[0] == :flag && r.last.size - 2 < r.last[1].arg_size(:all)
               r.last.push(v)
             else
               r << [:argument, v]

data/lib/clive/flag.rb

@@ -81,13 +81,30 @@ module Clive
       @block.call(*args)
     end
     
-    # @param [Boolean] optional whether to include optional arguments
-    # @return [Integer] number of arguments this takes
-    def arg_num(optional)
-      if @args.is_a?(Array) && @args[0].is_a?(Hash)
-        @args.find_all {|i| i[:optional] == optional }.size
-      else
-        1
+    
+    # @param type [Symbol]
+    #   Can be passed three things; :all, returns size of all arguments; :optional
+    #   returns all optional arguments; :mandatory, returns size of mandatory arguments.
+    def arg_size(type=:all)
+      case type
+      when :all
+        if @args.is_a?(Array) && @args[0].is_a?(Hash)
+          @args.size
+        else
+          1
+        end
+      when :optional
+        if @args.is_a?(Array) && @args[0].is_a?(Hash)
+          @args.find_all {|i| i[:optional] == true }.size
+        else
+          0
+        end
+      when :mandatory
+        if @args.is_a?(Array) && @args[0].is_a?(Hash)
+          @args.find_all {|i| i[:optional] == false }.size
+        else
+          1
+        end
       end
     end
     
@@ -109,14 +126,6 @@ module Clive
       end
     end
     
-    def arg_size
-      if @args.is_a?(Range) || @args.is_a?(Array)
-        1
-      else
-        @args.size
-      end
-    end
-    
     def options_to_strings
       if @args.is_a? Range
         [@args.to_s]

data/lib/clive/formatter.rb

@@ -111,10 +111,9 @@ module Clive
     
     def parse_format(format, args)
       if format
-        tokens = Lexer.tokenise(format).to_a
         obj = Obj.new(args)
         r = ""
-        tokens.each do |(t,v)|
+        Lexer.tokenise(format).each do |t,v|
           case t
           when :block
             r << obj.evaluate(v)

data/lib/clive/version.rb

@@ -1,3 +1,3 @@
 module Clive
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/clive/flag_spec.rb

@@ -19,12 +19,6 @@ describe Clive::Flag do
     end
   end
   
-  describe "#arg_num" do
-    it "returns the number of arguments" do
-      subject.arg_num(false).should == 1
-    end
-  end
-  
   describe "#args_to_strings" do
     it "converts the arguments to strings" do
       subject.args_to_strings.should == ["WORD(S)"]
@@ -40,9 +34,18 @@ describe Clive::Flag do
     end
     
     context "when arguments are required" do
-      it "returns the number of arguments" do
-        subject.args = [{:name => "ARG", :optional => false}]
-        subject.arg_size.should == 1
+      subject { Clive::Flag.new([:n], "Description", ["REQ [OPT] REQ2 [OPT2] [OPT3]"]) }
+    
+      it "returns the number of all arguments" do
+        subject.arg_size(:all).should == 5
+      end
+      
+      it "returns the number of optional arguments" do
+        subject.arg_size(:optional).should == 3
+      end
+      
+      it "returns the number of mandatory arguments" do
+        subject.arg_size(:mandatory).should == 2
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 1
-  version: 0.7.1
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Joshua Hawxwell