optitron 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optitron (0.1.0)
+    optitron (0.1.1)
       callsite (= 0.0.4)
       ruby2ruby (= 1.2.4)
       ruby_parser (>= 2.0)

data/README.rdoc

@@ -80,6 +80,29 @@ Will generate
 
   start <modes1 modes2 ...>       # Starts the process
 
+As well, you can provide type hints to the args:
+
+  desc "Does something awesome"
+  arg_types :numeric, :string, :boolean
+  def start(number, string, truth)
+    # ... does something
+  end
+
+Will generate
+
+  start [number] [string] [truth]       # Does something awesome
+
+And those arguments have to conform to the types given. For instance, calling this with
+
+  start 123 something flase
+  
+Will produce the error <tt>Truth is invalid</tt>. Calling with
+
+  start 123 something true
+  
+however, will correctly invoke the method.
+
+
 === Options
 
 Options are specified with the +opt+ method in your class, as follows:

data/lib/optitron/class_dsl.rb

@@ -124,20 +124,25 @@ class Optitron
         @opts << [name, desc, opts]
       end
 
+      def arg_types(*types)
+        @arg_types = types
+      end
+
       def build
         unless @built
           optitron_dsl.root.help unless send(:class_variable_defined?, :@@suppress_help)
           @cmds.each do |(cmd_name, cmd_desc, opts)|
             args = method_args[cmd_name.to_sym]
             arity = instance_method(cmd_name).arity
+            arg_types = @arg_types
             optitron_dsl.root.cmd(cmd_name, cmd_desc) do
               opts.each { |o| opt *o }
               args.each do |(arg_name, arg_type, arg_default)|
                 case arg_type
                 when :required
-                  arg arg_name.to_s, :default => arg_default && eval(arg_default)
+                  arg arg_name.to_s, :default => arg_default && eval(arg_default), :type => arg_types && arg_types.shift
                 when :optional
-                  arg arg_name.to_s, :default => arg_default && eval(arg_default), :required => false
+                  arg arg_name.to_s, :default => arg_default && eval(arg_default), :required => false, :type => arg_types && arg_types.shift
                 when :greedy
                   arg arg_name.to_s, :default => arg_default && eval(arg_default), :type => :greedy
                 end

data/lib/optitron/option.rb

@@ -194,27 +194,37 @@ class Optitron
         self.required = opts && opts.key?(:required) ? opts[:required] : (@default.nil? and !greedy?)
       end
       
-      def consume(response, tokens)
+      def consume_array(response, tokens)
         arg_tokens = tokens.select{ |tok| tok.respond_to?(:lit) }
-        if type == :greedy
-          response.args_with_tokens << [self, []]
-          while !arg_tokens.size.zero?
+        response.args_with_tokens << [self, []]
+        while !arg_tokens.size.zero?
+          if val = yield(arg_tokens.first)
             arg_tok = arg_tokens.shift
             tokens.delete_at(tokens.index(arg_tok))
-            response.args_with_tokens.last.last << arg_tok.lit
-          end
-          if required? and response.args_with_tokens.last.last.size.zero?
-            response.add_error("required", name)
+            response.args_with_tokens.last.last << val
+          else
+            break
           end
+        end
+        if required? and response.args_with_tokens.last.last.size.zero?
+          response.add_error("required", name)
+        end
+      end
+
+      def consume(response, tokens)
+        case type
+        when :greedy, :array
+          consume_array(response, tokens) { |t| t.lit }
+        when :hash
+          consume_array(response, tokens) { |t| t.lit[':'] && t.lit.split(':', 2) }
+          response.args_with_tokens.last[-1] = Hash[response.args_with_tokens.last[-1]]
         else
-          if arg_tokens.size.zero? and required?
+          arg_token = tokens.find{ |tok| tok.respond_to?(:lit) }
+          if arg_token || has_default
+            tokens.delete_at(tokens.index(arg_token)) if arg_token
+            response.args_with_tokens << [self, arg_token ? arg_token.lit : default]
+          elsif !arg_token and required?
             response.add_error("required", name)
-          elsif !arg_tokens.size.zero?
-            arg_tok = arg_tokens.shift
-            tokens.delete_at(tokens.index(arg_tok))
-            response.args_with_tokens << [self, arg_tok.lit]
-          elsif has_default
-            response.args_with_tokens << [self, default]
           end
         end
       end

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/arg_spec.rb

@@ -177,4 +177,22 @@ describe "Optitron::Parser arg spec" do
       response.valid?.should be_true
     end
   end
+
+  context "various arg types" do
+    before(:each) {
+      @parser = Optitron.new {
+        cmd "install" do
+          arg "file", :type => :hash
+        end
+      }
+    }
+
+    it "should parse" do
+      response = @parser.parse(%w(install test:one test2:two))
+      response.command.should == 'install'
+      response.args.should == [{'test' => 'one', 'test2' => 'two'}]
+      response.valid?.should be_true
+    end
+  end
+
 end

data/spec/cli_spec.rb

@@ -15,7 +15,9 @@ class CLIExample < Optitron::CLI
 
   desc "Use this too"
   opt 'another_opt'
+  arg_types :hash
   def use_too(one, two = 'three')
+    puts "one: #{one.inspect} #{two.inspect}"
   end
 
   desc "Use this three"
@@ -67,6 +69,10 @@ describe "Optitron::Parser defaults" do
     capture(:stdout) { CLIExample.dispatch(%w(use))}.should == "using this\n"
   end
 
+  it "should dispatch with the type hinting" do
+    capture(:stdout) { CLIExample.dispatch(%w(use_too one:two three:four))}.should == "one: {\"three\"=>\"four\", \"one\"=>\"two\"} \"three\"\n"
+  end
+
   it "should generate the correct help" do
     AnotherCLIExample.build
     AnotherCLIExample.optitron_parser.help.strip.should == "Commands\n\nuse_too [one] <two=\"three\">       # Use this too\n  -a/--another_opt                \n\nGlobal options\n\n-v/--verbose                      \n-?/--help                         # Print help message"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-21 00:00:00 -07:00
+date: 2010-08-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency