optitron 0.2.1 → 0.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optitron (0.2.0)
+    optitron (0.2.1)
       callsite (~> 0.0.4)
       ruby2ruby (~> 1.2.4)
       ruby_parser (~> 2.0)

data/lib/optitron/class_dsl.rb

@@ -109,6 +109,7 @@ class Optitron
           @opts.clear if @opts
           @args.clear if @args
           @last_desc = nil
+          @last_group = nil
         end
       end
       def optitron_parser
@@ -149,6 +150,10 @@ class Optitron
         @last_desc = desc
       end
 
+      def group(group)
+        @last_group = group
+      end
+
       def opt(name, desc = nil, opts = nil)
         @opts ||= []
         @opts << [name, desc, opts]
@@ -198,14 +203,20 @@ class Optitron
         if response.valid?
           optitron_parser.target.params = response.params
           args = response.args
-          while (args.size < optitron_parser.commands.assoc(response.command).last.args.size)
-            args << optitron_parser.commandsassoc(response.command).last.args[args.size].default
+          parser_args = optitron_parser.commands.assoc(response.command).last.args
+          while (args.size < parser_args.size && !(parser_args[args.size].type == :greedy && parser_args[args.size].default.nil?))
+            args << parser_args[args.size].default 
           end
+
           optitron_parser.target.send(response.command.to_sym, *response.args)
         else
-          puts response.error_messages.join("\n")
+          puts optitron_parser.help
+
+          unless response.args.empty?
+            puts response.error_messages.join("\n")
+          end
         end
       end
     end
   end
-end
+end

data/lib/optitron/cli.rb

@@ -2,5 +2,4 @@ class Optitron
   class CLI
     include ClassDsl
   end
-end
-    
+end

data/lib/optitron/help.rb

@@ -54,10 +54,8 @@ class Optitron
           cmds.assoc(cmd_line) << help_line_for_opt(opt)
         end
       end
-      opts_lines = @parser.options.map do |opt|
-        help_line_for_opt(opt)
-      end
-
+      cmds.sort!{ |cmd1, cmd2| (cmd1[1].group || '') <=> (cmd2[1].group || '') }
+      opts_lines = @parser.options.map { |opt| help_line_for_opt(opt) }
       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
@@ -68,11 +66,17 @@ class Optitron
       longest_line = [opts_lines.map{|o| o.first.size}.max, longest_line].max unless opts_lines.empty?
       help_output = []
 
+      last_group = nil
+
       unless cmds.empty?
         help_output << "Commands\n\n" + cmds.map do |(cmd, *opts)|
           cmd_text = ""
-          cmd_text << "%-#{longest_line}s     " % cmd
           cmd_obj = opts.shift
+          if last_group != cmd_obj.group
+            cmd_text << "#{cmd_obj.group}:\n"
+            last_group = cmd_obj.group
+          end
+          cmd_text << "%-#{longest_line}s     " % cmd
           cmd_text << "# #{cmd_obj.desc}" if cmd_obj.desc
           cmd_obj.args.each do |arg|
             if arg.desc
@@ -104,4 +108,4 @@ class Optitron
       help_output.join("\n\n")
     end
   end
-end
+end

data/lib/optitron/option.rb

@@ -1,7 +1,7 @@
 class Optitron
   class Option
     attr_reader :inclusion_test, :type
-    attr_accessor :required, :name, :default, :parameterize, :desc, :has_default
+    attr_accessor :required, :name, :default, :parameterize, :desc, :has_default, :group
     alias_method :required?, :required
     alias_method :has_default?, :has_default
     alias_method :parameterize?, :parameterize
@@ -112,6 +112,7 @@ class Optitron
         self.type = opts && opts[:type] || :boolean
         self.short_name = opts[:short_name] if opts && opts[:short_name]
         self.run = opts[:run] if opts && opts[:run]
+        self.group = opts[:group] if opts && opts[:group]
         self.inclusion_test = opts[:in] if opts && opts[:in]
         self.required = opts && opts.key?(:required) ? opts[:required] : false
         self.default = opts && opts.key?(:default) ? opts[:default] : (@type == :boolean ? false : nil)
@@ -191,6 +192,7 @@ class Optitron
         end
         @name, @desc = name, desc
         @run = opts[:run] if opts && opts[:run]
+        @group = opts[:group] if opts && opts[:group]
         @options = []
         @args = []
       end
@@ -205,6 +207,7 @@ class Optitron
         @name, @desc = name, desc
         self.inclusion_test = opts[:in] if opts && opts[:in]
         self.default = opts && opts[:default]
+        self.group = opts[:group] if opts && opts[:group]
         self.type = opts && opts[:type]
         self.required = opts && opts.key?(:required) ? opts[:required] : (@default.nil? and !greedy?)
       end

data/lib/optitron/parser.rb

@@ -15,8 +15,8 @@ class Optitron
       @help.generate
     end
 
-    def parse(args = ARGV)
-      tokens = Tokenizer.new(self, args).tokens
+    def parse(argv = ARGV)
+      tokens = Tokenizer.new(self, argv).tokens
       response = Response.new(self, tokens)
       options = @options 
       args = @args
@@ -27,8 +27,21 @@ class Optitron
           response.command = cmd_tok.lit
           options += @commands.assoc(cmd_tok.lit).last.options
           args = @commands.assoc(cmd_tok.lit).last.args
+        elsif !potential_cmd_toks.empty? && @target.respond_to?(:command_missing)
+          command = potential_cmd_toks.first.lit
+          response.command = 'command_missing'
+          @commands << [response.command, Option::Cmd.new(response.command)]
+          @commands.assoc(response.command).last.options.insert(-1, *tokens.select { |t| !t.respond_to?(:lit) }.map { |t|
+            t.is_a?(Tokenizer::Named) ?
+              Option::Opt.new(t.name, nil, :short_name => t.name) :
+              Option::Opt.new(t.name, nil, :type => (t.value ? :string : :boolean))
+          })
+          @commands.assoc(response.command).last.args <<
+            Option::Arg.new('command', 'Command name', :type => :string) <<
+            Option::Arg.new('args', 'Command arguments', :type => :greedy)
+          options += @commands.assoc(response.command).last.options
+          args = @commands.assoc(response.command).last.args
         else
-          puts @help.generate
           potential_cmd_toks.first ?
             response.add_error('an unknown command', potential_cmd_toks.first.lit) :
             response.add_error('unknown command')
@@ -56,4 +69,4 @@ class Optitron
       args.each { |arg| arg.consume(response, tokens) }
     end
   end
-end
+end

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/cli_spec.rb

@@ -100,6 +100,11 @@ describe "Optitron::Parser defaults" do
     capture(:stdout) { CLIExample.dispatch(%w(use))}.should == "using this\n"
   end
 
+  it "should display help when there is no args" do
+    capture(:stdout) { CLIExample.dispatch([])}.should == "Commands\n\nuse                                     # Use this\n  -u/--use_opt                          \nuse_too [one(HASH)] <two=\"three\">       # Use this too\n  -a/--another_opt                      \nuse_greedy [one] <two1 two2 ...>        # Use this three\n  -A/--another_opt_as_well=[NUMERIC]    \nwith_array <ary=[1, 2, 3]>              # something with an array\n\nGlobal options\n\n-v/--verbose                            \n-?/--help                               # Print help message\n"
+  end
+
+
   it "should dispatch with the type hinting" do
     capture(:stdout) { CLIExample.dispatch(%w(use_too one:two three:four))}.should == 'one: [["one", "two"], ["three", "four"]] "three"' + "\n"
   end
@@ -114,7 +119,7 @@ describe "Optitron::Parser defaults" do
   end
 
   it "should be able to suppress help" do
-    capture(:stdout) { NoHelpExample.dispatch(%w(--help)) }.should == "Commands\n\nuse_too [one] <two=\"three\">       # Use this too\n  -a/--another_opt                \n\nGlobal options\n\n-v/--verbose                      \nUnknown command\nHelp is unrecognized\n"
+    capture(:stdout) { NoHelpExample.dispatch(%w(--help)) }.should == "Commands\n\nuse_too [one] <two=\"three\">       # Use this too\n  -a/--another_opt                \n\nGlobal options\n\n-v/--verbose                      \n"
   end
 
   it "should strip the type information from the names when its using the _type info" do
@@ -135,4 +140,4 @@ describe "Optitron::Parser defaults" do
     Nested::NestedExample.build
     AModule::CLIInAModule.optitron_parser.help.should == "Commands\n\nmethod [arg1]       # a method\n\nGlobal options\n\n-?/--help           # Print help message"
   end
-end
+end

data/spec/group_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "Optitron::Parser groups" do
+  it "generate help for command parsers" do
+    @parser = Optitron.new {
+      opt 'verbose', "Be very loud", :use_no => true
+      cmd "install", "This installs things", :group => "group1" do
+        arg "file", "The file to install"
+      end
+      cmd "show", "This shows things", :group => "group1" do
+        arg "first", "The first thing to show"
+        arg "second", "The second optional thing to show", :required => false
+      end
+      cmd "kill", "This kills things", :group => "group2" 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, :required => true
+      end
+    }
+    @parser.help.should == "Commands\n\njoin [thing1 thing2 ...]       # This joins things\n                               #   thing -- Stuff to join\ngroup1:\nshow [first] <second>          # This shows things\n                               #   first -- The first thing to show\n                               #   second -- The second optional thing to show\ninstall [file]                 # This installs things\n                               #   file -- The file to install\ngroup2:\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\n\nGlobal options\n\n-v/--(no-)verbose              # Be very loud"
+  end
+end

data/spec/option_spec.rb

@@ -16,6 +16,10 @@ describe "Optitron::Parser options" do
       @parser.parse(%w(--option=test)).params.should == {'option' => 'test'}
     end
 
+    it "should parse '--option=\"test -testing\"'" do
+      @parser.parse(['--option=test -testing']).params.should == {'option' => 'test -testing'}
+    end
+
     it "shouldn't parse '--option test'" do
       @parser.parse(%w(--option test)).valid?.should be_false
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 -07:00
+date: 2010-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -157,6 +157,7 @@ files:
 - spec/default_spec.rb
 - spec/dispatch_spec.rb
 - spec/errors_spec.rb
+- spec/group_spec.rb
 - spec/help_spec.rb
 - spec/option_spec.rb
 - spec/short_name_spec.rb