cmdparse 2.0.1 → 2.0.2

data/ChangeLog

@@ -1,16 +1,48 @@
 ------------------------------------------------------------------------
-r398 | thomas | 2006-04-05 16:13:43 +0200 (Wed, 05 Apr 2006) | 1 line
-Changed paths:
-   A /versions/cmdparse-2.0.1 (from /trunk/cmdparse:340)
-   R /versions/cmdparse-2.0.1/Rakefile (from /trunk/cmdparse/Rakefile:396)
-   R /versions/cmdparse-2.0.1/TODO (from /trunk/cmdparse/TODO:396)
-   R /versions/cmdparse-2.0.1/doc/src/default.template (from /trunk/cmdparse/doc/src/default.template:396)
-   D /versions/cmdparse-2.0.1/doc/src/documentation.page
-   R /versions/cmdparse-2.0.1/doc/src/index.page (from /trunk/cmdparse/doc/src/index.page:396)
-   A /versions/cmdparse-2.0.1/doc/src/tutorial.page (from /trunk/cmdparse/doc/src/tutorial.page:397)
-   R /versions/cmdparse-2.0.1/lib/cmdparse.rb (from /trunk/cmdparse/lib/cmdparse.rb:396)
-
-* created version 2.0.1 of cmdparse
+r417 | thomas | 2006-06-17 21:35:12 +0200 (Sat, 17 Jun 2006) | 1 line
+Changed paths:
+   M /trunk/cmdparse/doc/src/index.page
+
+* fixed spelling error
+------------------------------------------------------------------------
+r416 | thomas | 2006-06-17 21:32:55 +0200 (Sat, 17 Jun 2006) | 7 lines
+Changed paths:
+   A /trunk/cmdparse/.emacs.desktop
+   M /trunk/cmdparse/Rakefile
+   M /trunk/cmdparse/doc/src/index.page
+   M /trunk/cmdparse/doc/src/tutorial.page
+   M /trunk/cmdparse/lib/cmdparse.rb
+   M /trunk/cmdparse/net.rb
+   A /trunk/cmdparse/test
+   A /trunk/cmdparse/test/tc_commandhash.rb
+
+* included patches #4756 and #4729 from Assaph Mehr and slightly modified them
+* added the test file for CommandHash from Assaph Mehr
+* updated Rakefile to run test the test file
+* updated the tutorial to include information about partial command matching
+* minor update to index page
+* update sampe net.rb script to use partial command matching
+* added emacs desktop file
+------------------------------------------------------------------------
+r397 | thomas | 2006-04-05 16:12:46 +0200 (Wed, 05 Apr 2006) | 1 line
+Changed paths:
+   M /trunk/cmdparse/doc/src/tutorial.page
+
+* small changes
+------------------------------------------------------------------------
+r396 | thomas | 2006-04-04 17:43:24 +0200 (Tue, 04 Apr 2006) | 3 lines
+Changed paths:
+   M /trunk/cmdparse/Rakefile
+   M /trunk/cmdparse/TODO
+   M /trunk/cmdparse/doc/src/default.template
+   D /trunk/cmdparse/doc/src/documentation.page
+   M /trunk/cmdparse/doc/src/index.page
+   A /trunk/cmdparse/doc/src/tutorial.page (from /trunk/cmdparse/doc/src/documentation.page:340)
+   M /trunk/cmdparse/lib/cmdparse.rb
+
+* bumped version number to 2.0.1
+* fixed bug with GemSpec reported by Marcus Werne: lib/cmdparse.rb get automatically loaded now
+* split documentation page into main docu page and tutorial page
 ------------------------------------------------------------------------
 r332 | thomas | 2005-08-16 10:54:01 +0200 (Tue, 16 Aug 2005) | 1 line
 Changed paths:

data/Rakefile

@@ -44,7 +44,7 @@ SRC_RB = FileList['lib/**/*.rb']
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :doc
+task :default => :test
 
 
 # End user tasks ################################################################
@@ -67,6 +67,9 @@ task :clean do
   ruby "setup.rb clean"
 end
 
+task :test do
+  ruby "-Ilib test/tc_commandhash.rb"
+end
 
 CLOBBER << "doc/output"
 desc "Builds the documentation"

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.2

data/doc/src/index.page

@@ -12,6 +12,14 @@ Have a look around the site!
 
 h2. News
 
+<b>2006-06-17 cmdparse 2.0.2 released!!!</b>
+
+Changes:
+
+* Included two patches from Assaph Mehr:
+  * partial command matching can now be used (see <a href="{relocatable: tutorial.page}">tutorial page</a>)
+  * now a banner for the help and version commands can be specified
+
 <b>2006-04-05 cmdparse 2.0.1 released!!!</b>
 
 Changes:

data/doc/src/tutorial.page

@@ -65,9 +65,12 @@ Create a new new file and write the necessary @require@ statements.
 h3. The @CommandParser@ class
 
 Next we will define our basic @CommandParser@ by defining the name of the program, its version and
-the global options. The boolean argument to the constructor of the @CommandParser@ class defines
-whether exceptions should be handled gracefully, i.e. by showing an appropriate error message and
-the help screen.
+the global options. The first boolean argument to the constructor of the @CommandParser@ class
+defines whether exceptions should be handled gracefully, i.e. by showing an appropriate error
+message and the help screen. The second boolean argument defines whether the top level commands
+should use partial command matching instead of full command matching. If partial command matching is
+used, then the shortest unambiguous part of a command name can be used instead of always specifing
+the full command name.
 
 <notextile>{extract: {file: ../net.rb, lines: !ruby/range 30..36}}</notextile>
 
@@ -97,10 +100,10 @@ However, we want the program to do something "useful". Therefore we define a new
 
 <notextile>{extract: {file: ../net.rb, lines: !ruby/range 41..44}}</notextile>
 
-This command is defined by using the default @Command@ class. First an instance is created
-assigning a name to the command and defining whether this command takes subcommands. Next we add a
-short description so that the @help@ command can produce something useful. And at last, we add this
-command to our @CommandParser@ instance.
+This command is defined by using the default @Command@ class. First an instance is created assigning
+a name to the command and defining whether this command takes subcommands and uses partial command
+matching. Next we add a short description so that the @help@ command can produce something useful.
+And at last, we add this command to our @CommandParser@ instance.
 
 We specified that our @ipaddr@ command takes subcommands. So we have to define them, too:
 
@@ -158,6 +161,15 @@ Why? As the @ipaddr@ command takes subcommands there should be an additional com
 @list@) on the command line. However, as the @list@ command is the default command for @ipaddr@ you
 do not need to type it.
 
+*By the way:* You get the same output if you type
+<pre>
+  $ ruby net.rb ip
+</pre>
+
+Why? As partial command matching is used for the top level commands, the shortest unambiguous name
+for a command can be used. As there is no other command starting with @ip@ (or even with the letter
+@i@), it is sufficient to write the above to select the @ipaddr@ command.
+
 *Notice:* The options of a command which does not take subcommands do not need to be at the front;
 they can be anywhere, like this
 <pre>

data/lib/cmdparse.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: cmdparse.rb 398 2006-04-05 14:13:43Z thomas $
+# $Id: cmdparse.rb 416 2006-06-17 19:32:55Z thomas $
 #
 # cmdparse: advanced command line parser supporting commands
 # Copyright (C) 2004 Thomas Leitner
@@ -25,7 +25,7 @@
 module CmdParse
 
   # The version of this cmdparse implemention
-  VERSION = [2, 0, 1]
+  VERSION = [2, 0, 2]
 
 
   # Base class for all cmdparse errors.
@@ -103,6 +103,18 @@ module CmdParse
   # Require default option parser wrapper
   require 'cmdparse/wrappers/optparse'
 
+  # Command Hash - will return partial key matches as well if there is a single
+  # non-ambigous matching key
+  class CommandHash < Hash
+
+    def []( cmd_name )
+      super or begin
+        possible = keys.select {|key| key =~ /^#{cmd_name}.*/ }
+        fetch( possible[0] ) if possible.size == 1
+      end
+    end
+
+  end
 
   # Base class for the commands. This class implements all needed methods so that it can be used by
   # the +CommandParser+ class.
@@ -131,13 +143,21 @@ module CmdParse
     attr_reader :commands
 
     # Initializes the command called +name+. The parameter +has_commands+ specifies if this command
-    # takes other commands as argument.
-    def initialize( name, has_commands )
+    # takes other commands as argument. The optional argument +partial_commands+ specifies, if
+    # partial command matching should be used.
+    def initialize( name, has_commands, partial_commands = false )
       @name = name
       @options = ParserWrapper.new
       @has_commands = has_commands
-      @commands = {}
+      @commands = Hash.new
       @default_command = nil
+      use_partial_commands( partial_commands )
+    end
+
+    def use_partial_commands( use_partial )
+      temp = ( use_partial ? CommandHash.new : Hash.new )
+      temp.update( @commands )
+      @commands = temp
     end
 
     # Returns +true+ if this command supports sub commands.
@@ -272,7 +292,7 @@ module CmdParse
       if args.length > 0
         cmd = commandparser.main_command
         arg = args.shift
-        while !arg.nil? && cmd.commands.keys.include?( arg )
+        while !arg.nil? && cmd.commands[ arg ]
           cmd = cmd.commands[arg]
           arg = args.shift
         end
@@ -292,6 +312,7 @@ module CmdParse
     #######
 
     def show_program_help
+      puts commandparser.banner + "\n" if commandparser.banner
       puts "Usage: #{commandparser.program_name} [options] COMMAND [options] [COMMAND [options] ...] [args]"
       puts ""
       list_commands( 1, commandparser.main_command )
@@ -331,6 +352,7 @@ module CmdParse
     def execute( args )
       version = commandparser.program_version
       version = version.join( '.' ) if version.instance_of?( Array )
+      puts commandparser.banner + "\n" if commandparser.banner
       puts version
       exit
     end
@@ -341,6 +363,9 @@ module CmdParse
   # The main class for creating a command based CLI program.
   class CommandParser
 
+    # A standard banner for help & version screens
+    attr_accessor :banner
+
     # The top level command representing the program itself.
     attr_reader :main_command
 
@@ -354,10 +379,12 @@ module CmdParse
     attr_reader :handle_exceptions
 
     # Create a new CommandParser object. The optional argument +handleExceptions+ specifies if the
-    # object should handle exceptions gracefully.
-    def initialize( handleExceptions = false )
+    # object should handle exceptions gracefully. Set +partial_commands+ to +true+, if you want
+    # partial command matching for the top level commands.
+    def initialize( handleExceptions = false, partial_commands = false )
       @main_command = Command.new( 'mainCommand', true )
       @main_command.super_command = self
+      @main_command.use_partial_commands( partial_commands )
       @program_name = $0
       @program_version = "0.0.0"
       @handle_exceptions = handleExceptions
@@ -402,7 +429,7 @@ module CmdParse
               cmdName = command.default_command
             end
           else
-            raise InvalidCommandError.new( cmdName ) unless command.commands.include?( cmdName )
+            raise InvalidCommandError.new( cmdName ) unless command.commands[ cmdName ]
           end
 
           command = command.commands[cmdName]

data/lib/cmdparse/wrappers/optparse.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: optparse.rb 398 2006-04-05 14:13:43Z thomas $
+# $Id: optparse.rb 329 2005-08-14 15:39:05Z thomas $
 #
 # cmdparse: advanced command line parser supporting commands
 # Copyright (C) 2004 Thomas Leitner

data/net.rb

@@ -27,7 +27,7 @@ class NetStatCommand < CmdParse::Command
 
 end
 
-cmd = CmdParse::CommandParser.new( true )
+cmd = CmdParse::CommandParser.new( true, true )
 cmd.program_name = "net"
 cmd.program_version = [0, 1, 1]
 cmd.options = CmdParse::OptionParserWrapper.new do |opt|
@@ -39,7 +39,7 @@ cmd.add_command( CmdParse::VersionCommand.new )
 cmd.add_command( NetStatCommand.new )
 
 # ipaddr
-ipaddr = CmdParse::Command.new( 'ipaddr', true )
+ipaddr = CmdParse::Command.new( 'ipaddr', true, true )
 ipaddr.short_desc = "Manage IP addresses"
 cmd.add_command( ipaddr )
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: cmdparse
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
-date: 2006-04-05 00:00:00 +02:00
+  version: 2.0.2
+date: 2006-06-17 00:00:00 +02:00
 summary: Advanced command line parser supporting commands
 require_paths: 
 - lib