optitron 0.0.1 → 0.0.2

data/README.rdoc

@@ -52,3 +52,14 @@ And <tt>@parser.parse(%w(-v install file))</tt> gives back:
   => ["file"]
   response.params
   => {"verbose" => true}
+
+If you try parsing invalid parameters, get back friendly error messages
+
+  @parser.parse(%w()).error_messages
+  => ["Unknown command"]
+  @parser.parse(%w(something)).error_messages
+  => ["Something is an unknown command"]
+  @parser.parse(%w(install)).error_messages
+  => ["File is required"]
+  @parser.parse(%w(kill --pid=something)).error_messages
+  => ["Pid is invalid"]

data/lib/optitron/option.rb

@@ -82,7 +82,7 @@ class Optitron
             elsif default
               default
             else
-              response.add_error(opt.name, "required")
+              response.add_error("required", opt.name)
             end
             response.params_array << [self, value]
           when :array
@@ -95,7 +95,7 @@ class Optitron
           when :hash
             values = []
             if opt_tok.respond_to?(:value)
-              response.add_error(name, "First value isn't in the form key:value") if opt_tok.value[':'].nil?
+              response.add_error("not in the form key:value", name) if opt_tok.value[':'].nil?
               values << opt_tok.value.split(':', 2)
             end
             while tokens[opt_tok_index].respond_to?(:val) and !tokens[opt_tok_index].val[':'].nil?
@@ -143,11 +143,11 @@ class Optitron
             response.args_with_tokens.last.last << arg_tok
           end
           if required? and response.args_with_tokens.last.last.size.zero?
-            response.add_error(self, "required")
+            response.add_error("required", name)
           end
         else
           if arg_tokens.size.zero? and required?
-            response.add_error(self, "required")
+            response.add_error("required", name)
           elsif !arg_tokens.size.zero?
             arg_tok = arg_tokens.shift
             tokens.delete_at(tokens.index(arg_tok))

data/lib/optitron/parser.rb

@@ -11,14 +11,17 @@ class Optitron
       response = Response.new(tokens)
       options = @options 
       args = nil
-      if !@commands.empty? 
-        if cmd_tok = tokens.find { |t| t.is_a?(Tokenizer::Value) and @commands[t.val] }
+      if !@commands.empty?
+        potential_cmd_toks = tokens.select { |t| t.respond_to?(:val) }
+        if cmd_tok = potential_cmd_toks.find { |t| @commands[t.val] }
           tokens.delete(cmd_tok)
           response.command = cmd_tok.val
           options += @commands[cmd_tok.val].options
           args = @commands[cmd_tok.val].args
         else
-          response.add_error(nil, 'unknown command')
+          potential_cmd_toks.first ?
+            response.add_error('an unknown command', potential_cmd_toks.first.val) :
+            response.add_error('unknown command')
         end
       end
       parse_options(tokens, options, response)

data/lib/optitron/response.rb

@@ -8,12 +8,16 @@ class Optitron
       @args_with_tokens = []
       @args = []
       @command = nil
-      @errors = Hash.new{|h,k| h[k] = []}
+      @errors = []
       @params = {}
     end
     
-    def add_error(field, type)
-      @errors[field] << type
+    def add_error(type, field = nil)
+      @errors << [type, field]
+    end
+    
+    def error_messages
+      @errors.map{|(error, field)| field ? "#{field} is #{error}".capitalize : error.capitalize}
     end
     
     def compile_params
@@ -21,7 +25,7 @@ class Optitron
         begin
           params[key.name] = key.validate(value)
         rescue
-          add_error(key.name, 'invalid')
+          add_error('invalid', key.name)
           params[key.name] = value
         end
       end
@@ -33,7 +37,7 @@ class Optitron
         begin
           tok.is_a?(Array) ? tok.map{ |t| arg.validate(t.val) } : arg.validate(tok.val)
         rescue
-          add_error(arg.name, 'invalid')
+          add_error('invalid', arg.name)
           tok.is_a?(Array) ? tok.map{ |t| t.val } : tok.val
         end
       }
@@ -41,12 +45,12 @@ class Optitron
       unless @tokens.empty?
         @tokens.select{|t| t.respond_to?(:name)}.each do |named_token|
           @tokens.delete(named_token)
-          add_error(named_token.name, 'unrecognized')
+          add_error('unrecognized', named_token.name)
         end
         
         if @errors.empty?
           @tokens.each do |token|
-            add_error(token.val, 'unrecognized')
+            add_error('unrecognized', token.val)
           end
         end
       end

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/errors_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe "Optitron::Parser errors" do
+  it "should fail on invalid commands" do
+    @parser = Optitron.new {
+      cmd "command"
+    }
+    response = @parser.parse(%w[])
+    response.valid?.should be_false
+    response.error_messages.should == ["Unknown command"]
+  end
+
+  it "should fail on missing args" do
+    @parser = Optitron.new {
+      cmd "command" do
+        arg "argument"
+      end
+    }
+    response = @parser.parse(%w[command])
+    response.valid?.should be_false
+    response.error_messages.should == ["Argument is required"]
+  end
+
+  it "should fail on invalid opts" do
+    @parser = Optitron.new {
+      cmd "command" do
+        opt "option", :type => :numeric
+      end
+    }
+    response = @parser.parse(%w[command --option=asd])
+    response.valid?.should be_false
+    response.error_messages.should == ["Option is invalid"]
+  end
+
+  it "should fail on extra args" do
+    @parser = Optitron.new {
+      cmd "command" do
+        arg "argument"
+      end
+    }
+    response = @parser.parse(%w[command argument extra-argument])
+    response.valid?.should be_false
+    response.error_messages.should == ["Extra-argument is unrecognized"]
+  end
+
+  it "should fail on unrecognized options" do
+    @parser = Optitron.new {
+      cmd "command"
+    }
+    response = @parser.parse(%w[command --option])
+    response.valid?.should be_false
+    response.error_messages.should == ["Option is unrecognized"]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Joshua Hull
@@ -50,7 +50,6 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
-- ideas.txt
 - lib/optitron.rb
 - lib/optitron/dsl.rb
 - lib/optitron/option.rb
@@ -61,13 +60,13 @@ files:
 - optitron.gemspec
 - spec/arg_spec.rb
 - spec/dispatch_spec.rb
+- spec/errors_spec.rb
 - spec/other_spec.rb
 - spec/short_name_spec.rb
 - spec/simple_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/type_spec.rb
-- test.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/optitron
 licenses: []

data/ideas.txt

@@ -1,43 +0,0 @@
-ordered params
-named params
-default values
-
-Optitron::Parse
-
-parser = Optitron::Parser.new
-parser.literal('test')
-parser.required(:test).integer.parse_with { 
-  ordered(:test2)
-  ordered(:test3).optional.default('value')
-  named(:something)
-}
-
-parser.required(:test2).type(:integer).parse_with
-
-Optitron.transform {
-    opt 'no-color', "Uncolored output", :short => 'c'
-    opt 'quiet', "Don't output anything"
-    cmd "install" {
-        desc "This is the group to install from"
-        arg "group", :requied => false
-        opt "noop"
-    }
-    cmd "list" {
-        arg "group", :requied => false
-        opt "format", 'human', :valid => ['human', 'xml', 'json'] <--- and this???
-        opt "depth", nil, :type => :number (allow nil is implied)
-    }
-}
-
-=> {:cmd => 'install', :args => {'group' => 'development}, :options => {'quiet' => true}}
-
-Optitron.new {
-     ...
-     ..
-}.parse( ... ) 
-
-same as
-
-Optitron.transform ?
-
-

data/test.rb

@@ -1,17 +0,0 @@
-$LOAD_PATH << 'lib'
-require 'optitron'
-
-parser = Optitron::Parser.new { parser.literal('test') }
-parser.ordered('test').mandatory.match('test')
-parser.ordered('test2').mandatory.match('test2')
-#
-#p parser.parse(['test'])
-#p parser.parse(['test', 'test2'])
-
-parser = Optitron::Parser.new
-parser.ordered('test').mandatory.match('test')
-parser.named('a').alias('after').string.mandatory
-#p parser.parse(['test', '--after=val'])
-#p parser.parse(['test', '-a', 'val'])
-p parser.parse(['--after=val', 'test'])
-p parser.parse(['-a', 'val', 'test'])