optitron 0.0.4 → 0.0.5

data/README.rdoc

@@ -63,3 +63,76 @@ If you try parsing invalid parameters, get back friendly error messages
   => ["File is required"]
   @parser.parse(%w(kill --pid=something)).error_messages
   => ["Pid is invalid"]
+
+== Usage in a binary
+
+To use this in a file, create a parser, and tell it to dispatch to your favourite object. For instance, save this down to <tt>test.rb</tt>
+
+  class Runner
+    def install(file, opts)
+      puts "installing #{file} with #{opts}!"
+    end
+  end
+
+  Optitron.dispatch(Runner.new) {
+    opt 'verbose', "Be very loud"
+    cmd "install", "This installs things" do
+      arg "file", "The file to install"
+    end
+    cmd "show", "This shows things" do
+      arg "first", "The first thing to show"
+      arg "second", "The second optional thing to show", :required => false
+    end
+    cmd "kill", "This kills things" do
+      opt "pids", "A list of pids to kill", :type => :array
+      opt "pid", "A pid to kill", :type => :numeric
+      opt "names", "Some sort of hash", :type => :hash
+    end
+    cmd "join", "This joins things" do
+      arg "thing", "Stuff to join", :type => :greedy
+    end
+  }
+
+Now, try running it.
+
+  crapbook-pro:optitron joshua$ ruby test.rb 
+  Commands
+  
+  show [first] <second>          # This shows things
+  install [file]                 # This installs things
+  kill                           # This kills things
+    -p/--pids=[ARRAY]            # A list of pids to kill
+    -P/--pid=[NUMERIC]           # A pid to kill
+    -n/--names=[HASH]            # Some sort of hash
+  join [thing1 thing2 ...]       # This joins things
+  
+  Global options
+  
+  -v/--verbose                   # Be very loud
+  
+  Errors:
+  Unknown command
+  
+  crapbook-pro:optitron joshua$ ruby test.rb install
+  Commands
+  
+  show [first] <second>          # This shows things
+  install [file]                 # This installs things
+  kill                           # This kills things
+    -p/--pids=[ARRAY]            # A list of pids to kill
+    -P/--pid=[NUMERIC]           # A pid to kill
+    -n/--names=[HASH]            # Some sort of hash
+  join [thing1 thing2 ...]       # This joins things
+  
+  Global options
+  
+  -v/--verbose                   # Be very loud
+  
+  Errors:
+  File is required
+  
+  crapbook-pro:optitron joshua$ ruby test.rb install file
+  installing file with {"verbose"=>false}!
+
+  crapbook-pro:optitron joshua$ ruby test.rb install file --verbose true
+  installing file with {"verbose"=>true}!

data/lib/optitron.rb

@@ -4,9 +4,12 @@ class Optitron
   autoload :Parser,    'optitron/parser'
   autoload :Response,  'optitron/response'
   autoload :Option,    'optitron/option'
+  autoload :Help,      'optitron/help'
 
   InvalidParser = Class.new(RuntimeError)
 
+  attr_reader :parser
+
   def initialize(&blk)
     @parser = Parser.new
     Dsl.new(@parser, &blk) if blk
@@ -20,6 +23,12 @@ class Optitron
     Optitron.new(&blk).parse(args)
   end
 
+  def self.dispatch(target = nil, args = ARGV, &blk)
+    optitron = Optitron.new(&blk)
+    optitron.parser.target = target
+    optitron.parser.parse(args).dispatch
+  end
+
   def help
     @parser.help
   end

data/lib/optitron/help.rb

@@ -0,0 +1,82 @@
+class Optitron
+  class Help
+    def initialize(parser)
+      @parser = parser
+    end
+
+    def help_line_for_opt(opt)
+      opt_line = ''
+      opt_line << [opt.short_name ? "-#{opt.short_name}" : nil, "--#{opt.name}"].compact.join('/')
+      opt_line << "=[#{opt.type.to_s.upcase}]" if opt.type != :boolean
+      [opt_line, opt.desc]
+    end
+
+    def help_line_for_arg(arg)
+      arg_line = ''
+      arg_line << (arg.required? ? '[' : '<')
+      if arg.type == :greedy
+        arg_line << arg.name << '1 ' << arg.name << '2 ...' 
+      else
+        arg_line << arg.name
+      end
+      arg_line << (arg.required? ? ']' : '>')
+      arg_line
+    end
+
+    def generate
+      cmds = {}
+      @parser.commands.each do |cmd_name, cmd|
+        cmd_line = "#{cmd_name}"
+        cmd.args.each do |arg|
+          cmd_line << " " << help_line_for_arg(arg)
+        end
+        cmds[cmd_line] = [cmd.desc]
+        cmd.options.each do |opt|
+          cmds[cmd_line] << help_line_for_opt(opt)
+        end
+      end
+      opts_lines = @parser.options.map do |opt|
+        help_line_for_opt(opt)
+      end
+
+      args_lines = @parser.args.empty? ? nil : [@parser.args.map{|arg| help_line_for_arg(arg)}.join(' '), @parser.args.map{|arg| arg.desc}.join(', ')]
+
+      longest_line = 0
+      longest_line = [longest_line, cmds.keys.map{|k| k.size}.max].max unless cmds.empty?
+      opt_lines = cmds.map{|k,v| k.size + 2}.flatten
+      longest_line = [longest_line, args_lines.first.size].max if args_lines
+      longest_line = [longest_line, opt_lines.max].max unless opt_lines.empty?
+      longest_line = [opts_lines.map{|o| o.first.size}.max, longest_line].max unless opts_lines.empty?
+      help_output = []
+
+      unless cmds.empty?
+        help_output << "Commands\n\n" + cmds.map do |cmd, opts|
+          cmd_text = ""
+          cmd_text << "%-#{longest_line}s     " % cmd
+          cmd_desc = opts.shift
+          cmd_text << "# #{cmd_desc}" if cmd_desc
+          opts.each do |opt|
+            cmd_text << "\n  %-#{longest_line}s   " % opt.first
+            cmd_text << "# #{opt.last}" if opt.last
+          end
+          cmd_text
+        end.join("\n")
+      end
+      if args_lines
+        arg_help = "Arguments\n\n"
+        arg_help << "%-#{longest_line}s     " % args_lines.first
+        arg_help << "# #{args_lines.last}" if args_lines.first
+        help_output << arg_help
+      end
+      unless opts_lines.empty?
+        help_output << "Global options\n\n" + opts_lines.map do |opt|
+          opt_text = ''
+          opt_text << "%-#{longest_line}s     " % opt.first
+          opt_text << "# #{opt.last}" if opt.last
+          opt_text
+        end.join("\n")
+      end
+      help_output.join("\n\n")
+    end
+  end
+end

data/lib/optitron/parser.rb

@@ -1,16 +1,23 @@
 class Optitron
   class Parser
-    attr_reader :commands, :options
+    attr_accessor :target
+    attr_reader :commands, :options, :args
     def initialize
       @options = []
       @commands = {}
+      @args = []
+      @help = Help.new(self)
+    end
+
+    def help
+      @help.generate
     end
 
     def parse(args = ARGV)
       tokens = Tokenizer.new(args).tokens
-      response = Response.new(tokens)
+      response = Response.new(self, tokens)
       options = @options 
-      args = nil
+      args = @args
       if !@commands.empty?
         potential_cmd_toks = tokens.select { |t| t.respond_to?(:val) }
         if cmd_tok = potential_cmd_toks.find { |t| @commands[t.val] }
@@ -43,60 +50,5 @@ class Optitron
     def parse_args(tokens, args, response)
       args.each { |arg| arg.consume(response, tokens) } if args
     end
-
-    def help
-      cmds = {}
-      @commands.each do |cmd_name, cmd|
-        cmd_line = "#{cmd_name}"
-        cmd.args.each do |arg|
-          cmd_line << " "
-          cmd_line << (arg.required? ? '[' : '<')
-          if arg.type == :greedy
-            cmd_line << arg.name << '1 ' << arg.name << '2 ...' 
-          else
-            cmd_line << arg.name
-          end
-          cmd_line << (arg.required? ? ']' : '>')
-        end
-        cmds[cmd_line] = [cmd.desc]
-        cmd.options.each do |opt|
-          opt_line = ''
-          opt_line << [opt.short_name ? "-#{opt.short_name}" : nil, "--#{opt.name}"].compact.join('/')
-          opt_line << "=[#{opt.type.to_s.upcase}]" if opt.type != :boolean
-          cmds[cmd_line] << [opt_line, opt.desc]
-        end
-      end
-      opts_lines = @options.map do |opt|
-        opt_line = ''
-        opt_line << [opt.short_name ? "-#{opt.short_name}" : nil, "--#{opt.name}"].compact.join('/')
-        opt_line << "=[#{opt.type.to_s.upcase}]" if opt.type != :boolean
-        [opt_line, opt.desc]
-      end
-
-      longest_line = cmds.keys.map{|k| k.size}.max
-      opt_lines = cmds.map{|k,v| k.size + 2}.flatten
-      longest_line = [longest_line, opt_lines.max].max unless opt_lines.empty?
-      longest_line = [opts_lines.map{|o| o.first.size}.max, longest_line].max unless opts_lines.empty?
-      help_output = "Commands\n\n" + cmds.map do |cmd, opts|
-        cmd_text = ""
-        cmd_text << "%-#{longest_line}s     " % cmd
-        cmd_desc = opts.shift
-        cmd_text << "# #{cmd_desc}" if cmd_desc
-        opts.each do |opt|
-          cmd_text << "\n  %-#{longest_line}s   " % opt.first
-          cmd_text << "# #{opt.last}" if opt.last
-        end
-        cmd_text
-      end.join("\n")
-      unless opts_lines.empty?
-        help_output << "\n\nGlobal options\n\n"
-        help_output << opts_lines.map do |opt|
-          opt_text = ''
-          opt_text << "%-#{longest_line}s     " % opt.first
-          opt_text << "# #{opt.last}" if opt.last
-          opt_text
-        end.join("\n")
-      end
-    end
   end
 end

data/lib/optitron/response.rb

@@ -2,8 +2,8 @@ class Optitron
   class Response
     attr_reader :params_array, :args, :params, :args_with_tokens, :errors
     attr_accessor :command
-    def initialize(tokens)
-      @tokens = tokens
+    def initialize(parser, tokens)
+      @parser, @tokens = parser, tokens
       @params_array = []
       @args_with_tokens = []
       @args = []
@@ -56,15 +56,18 @@ class Optitron
       end
     end
 
-    def dispatch(obj)
+    def dispatch
+      raise unless @parser.target
       if valid?
         dispatch_args = params.empty? ? args : args + [params]
-        obj.send(command.to_sym, *dispatch_args)
+        @parser.target.send(command.to_sym, *dispatch_args)
       else
-        raise
+        puts @parser.help
+        puts "\nErrors:"
+        puts error_messages.join("\n")
       end
     end
-    
+
     def valid?
       @errors.empty?
     end

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/arg_spec.rb

@@ -143,4 +143,19 @@ describe "Optitron::Parser arg spec" do
       }.should raise_error(Optitron::InvalidParser)
     end
   end
+  
+  context "root level args" do
+    before(:each) {
+      @parser = Optitron.new {
+        arg "file"
+      }
+    }
+
+    it "should parse" do
+      response = @parser.parse(%w(life.rb))
+      response.command.should be_nil
+      response.args.should == ['life.rb']
+      response.valid?.should be_true
+    end
+  end
 end

data/spec/dispatch_spec.rb

@@ -4,32 +4,29 @@ describe "Optitron::Parser dispatching" do
   it "should dispatch 'install'" do
     m = mock('mock')
     m.should_receive('install').with()
-    @parser = Optitron.new {
+    Optitron.dispatch(m, %w(install)) {
       cmd "install"
     }
-    @parser.parse(%w(install)).dispatch(m)
   end
 
   it "should dispatch 'install file'" do
     m = mock('mock')
     m.should_receive('install').with('file.rb')
-    @parser = Optitron.new {
+    Optitron.dispatch(m, %w(install file.rb)) {
       cmd "install" do
         arg "file"
       end
     }
-    @parser.parse(%w(install file.rb)).dispatch(m)
   end
 
   it "should dispatch 'install file --noop'" do
     m = mock('mock')
     m.should_receive('install').with('file.rb', {'noop' => true})
-    @parser = Optitron.new {
+    Optitron.dispatch(m, %w(install file.rb --noop)) {
       cmd "install" do
         opt 'noop'
         arg "file"
       end
     }
-    @parser.parse(%w(install file.rb --noop)).dispatch(m)
   end
 end

data/spec/{other_spec.rb → help_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe "Optitron::Parser help" do
-  it "generate help" do
+  it "generate help for command parsers" do
     @parser = Optitron.new {
       opt 'verbose', "Be very loud"
       cmd "install", "This installs things" do
@@ -22,4 +22,13 @@ describe "Optitron::Parser help" do
     }
     @parser.help.should == "Commands\n\nshow [first] <second>          # This shows things\ninstall [file]                 # This installs things\nkill                           # This kills things\n  -p/--pids=[ARRAY]            # A list of pids to kill\n  -P/--pid=[NUMERIC]           # A pid to kill\n  -n/--names=[HASH]            # Some sort of hash\njoin [thing1 thing2 ...]       # This joins things\n\nGlobal options\n\n-v/--verbose                   # Be very loud"
   end
+
+  it "generate help for non-command parsers" do
+    @parser = Optitron.new {
+      opt 'verbose', "Be very loud"
+      arg "src", "Source"
+      arg "dest", "Destination"
+    }
+    @parser.help.should == "Arguments\n\n[src] [dest]     # Source, Destination\n\nGlobal options\n\n-v/--verbose     # Be very loud"
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-15 00:00:00 -07:00
+date: 2010-08-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - Rakefile
 - lib/optitron.rb
 - lib/optitron/dsl.rb
+- lib/optitron/help.rb
 - lib/optitron/option.rb
 - lib/optitron/parser.rb
 - lib/optitron/response.rb
@@ -62,8 +63,8 @@ files:
 - spec/default_spec.rb
 - spec/dispatch_spec.rb
 - spec/errors_spec.rb
+- spec/help_spec.rb
 - spec/option_spec.rb
-- spec/other_spec.rb
 - spec/short_name_spec.rb
 - spec/simple_spec.rb
 - spec/spec.opts