Pablo 0.0.1 → 0.0.2

data/lib/pablo.rb

@@ -11,7 +11,10 @@
 #               For further information regarding this license, you can go to
 #               http://creativecommons.org/licenses/by/3.0/de/
 # Homepage::    http://pablo.rubyforge.org/
-# Git repo::    http://www.github.org/pablo-commandline-parser/
+# Git repo::    http://rubyforge.org/scm/?group_id=7334
+#
+# More information can be found in the documentation of the parser (_Pablo::parse_) and
+# the classes (_Pablo::Token_, _Pablo::Option_ and _Pablo::Command_).
 #
 
 module Pablo
@@ -25,8 +28,14 @@ module Pablo
     # Either of the two can be omitted.
     # If no arguments Array is found, +ARGV+ is parsed.
     # If no options Hash is found, the defaults are used.
+    #
+    # The options Hash can have the following arguments:
+    # - +:program+ - The name of the program
+    # - +:version+ - The program version
+    # - +:usage+   - How this program is to be used via the command-line, e.g.
+    #                "[help] [--verbose [level]] delete [number]"
 	#
-	# See _Pablo::Parser#command_ and _Pablo::Parser#option_ for more details.
+	# See _Pablo::Token_,_Pablo::Command_ and _Pablo::Option_ for more details.
 	#
 	def self.parse *argsopts, &block
         # parse arguments and options apart
@@ -39,6 +48,8 @@ module Pablo
 		args = ARGV if args.nil?
         # do under NO circumstances modify the real args
         args = args.dup
+
+        opts[:version] = opts[:version].join '.' if opts[:version].is_a? Array
 		
 		# create tokens
 		p = Pablo::TopLevel.new opts
@@ -46,6 +57,8 @@ module Pablo
 
         # test on a present help command
         return if p.help? args
+        # test on a present version command
+        return if opts[:version] and p.version?(args)
 
 		# prepare arguments for marking
 		args.collect! { |a| [ [], a ] }
@@ -244,6 +257,8 @@ module Pablo
 	##
 	# Keeps and parses an option.
 	# Simple, easy, no children.
+    #
+    # See also: +Pablo::Token+.
 	#
 	class Option < Pablo::Token
 		##
@@ -280,6 +295,8 @@ module Pablo
 	##
 	# Keeps and parses a command.
 	# More sophisticated than an option, can have children.
+    #
+    # See also: +Pablo::Token+.
 	#
 	class Command < Pablo::Token
 		##
@@ -330,6 +347,7 @@ module Pablo
             @everyone = []
             @options = options
             @help = false
+            @version = false
             super self # set toplevel
         end
 
@@ -337,7 +355,7 @@ module Pablo
 
         ##
         # Will run the default token's run block, if there is one or will try to show
-        # the help otherwise.
+        # the help or version otherwise.
         #
 		def do_defaults
             done = false
@@ -348,9 +366,27 @@ module Pablo
                 end
             }
 
-            help? [] unless done
+            version? [] unless help? [] unless done
 		end
 
+        ##
+        # Tests whether a version command is present in +args+ and +version!+ has been called
+        # and if so:
+        # - executes +Pablo::version+
+        # - and returns true
+        # otherwise only returns false.
+        #
+        def version? args
+            return false unless @version
+            found = args.index { |a|
+                @version_aliases.any? { |v| v == a }
+            }
+            found = 0 if args.empty?
+            return false unless found
+            Pablo::version @options
+            return true
+        end
+
         ##
         # Tests whether a help command is present in +args+ and +help!+ has been called
         # and if so:
@@ -365,7 +401,8 @@ module Pablo
             }
             found = 0 if args.empty?
             return false unless found
-            Pablo::help args[found+1..-1], @everyone, @options
+            a = args[found+1..-1] || []
+            Pablo::help a, @everyone, @options
             return true
         end
 
@@ -380,9 +417,22 @@ module Pablo
             @help = true
             @help_aliases = alis
         end
+
+        ##TODO: usage!, each token gives it's usage -> [alias1|alias2 usage]
+
+        ##
+        # Instructs Pablo to display a version message generated from the +:version+ argument
+        # given to the +parse+ function.
+        #
+        # +alis+ are the aliases the version command should respond to.
+        # By default these are _version_, _--version_ and _-v_.
+        #
+        def version! alis = ['version', '--version', '-v']
+            @version = true
+            @version_aliases = alis
+        end
     end
 
-    ##TODO: Version command and version in help command
     ##TODO: caseless aliases!
 
     ##
@@ -406,7 +456,7 @@ module Pablo
         found = found[1] if found
 
         # program name and version
-        puts "#{options[:program]} v#{options[:version].join '.'}" if
+        puts "#{options[:program]} v#{options[:version]}" if
             options[:program] and options[:version]
 
         # usage
@@ -436,6 +486,7 @@ module Pablo
             puts strs.join "   "
         else  # do short_descs
             # print short_descs
+            puts
             puts '::Available commands and options'
             puts
 
@@ -454,5 +505,17 @@ module Pablo
         end
     end
 
+    ##
+    # Displays a version message generated from the +:version+ parameter passed to
+    # the +parse+ function.
+    #
+    # +options+ must be a hash of options that will be used to generate the
+    # output, namely +:version+, +:program+.
+    #
+    def self.version options
+        puts "#{options[:program]} v#{options[:version]}" if
+            options[:program] and options[:version]
+    end
+
 end
 

data/tests/help.rb

@@ -16,6 +16,13 @@ def message msg
 end
 
 class Help < Test::Unit::TestCase
+
+    def assert_output
+        puts
+        print 'Does the output match? [yn]  '
+        assert_match /^(y|Y|yes|Yes)?\n$/, gets, "Bad output."
+    end
+
     def testHelp
         args = ['help']
 
@@ -46,6 +53,7 @@ class Help < Test::Unit::TestCase
 
         message '-----------------------------------------'
         message 'End of expected output'
+        assert_output
     end
 
     def testCommandHelp
@@ -83,7 +91,7 @@ class Help < Test::Unit::TestCase
 
         message '-----------------------------------------'
         message 'End of expected output'
-        puts
+        assert_output
     end
 
     def testHelpAliases
@@ -116,6 +124,7 @@ class Help < Test::Unit::TestCase
 
         message '-----------------------------------------'
         message 'End of expected output'
+        assert_output
     end
 
     def testHelpDefault
@@ -130,6 +139,61 @@ class Help < Test::Unit::TestCase
 
         message '-----------------------------------------'
         message 'End of expected output'
+        assert_output
+    end
+
+    def testVersion
+
+        puts
+        message 'Expected output: a version message'
+        message "-----------------------------------------"
+
+        Pablo::parse ['version'], :program => 'bacon',
+            :version => [0,0,1,'alpha'] do
+            version!
+        end
+
+        message '-----------------------------------------'
+        message 'End of expected output'
+        assert_output
+    end
+
+    def testVersion
+
+        puts
+        message 'Expected output: a version message'
+        message "-----------------------------------------"
+
+        Pablo::parse ['version'], :program => 'bacon',
+            :version => [0,0,1,'alpha'] do
+            version!
+        end
+
+        message '-----------------------------------------'
+        message 'End of expected output'
+        assert_output
+    end
+
+    def testVersionHelpDefault
+
+        puts
+        message 'Expected output: a help message'
+        message "-----------------------------------------"
+
+        Pablo::parse [], :program => 'bacon',
+            :version => [0,0,1,'alpha'] do
+            version!
+            help!
+
+            command do
+                name 'stupid'
+                short_desc 'foo'
+            end
+        end
+
+        message '-----------------------------------------'
+        message 'End of expected output'
+        assert_output
     end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Pablo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Fabian Streitel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-07 00:00:00 -08:00
+date: 2008-12-26 00:00:00 -08:00
 default_executable: 
 dependencies: []