davetron5000-gli 0.1.6 → 0.2.0

data/README.rdoc

@@ -1,6 +1,16 @@
-This is a command line parser for a git-like command line client.
+= Git-Like Interface Command Line Parser
 
-= Use
+Author::  Dave Copeland (mailto:davetron5000 at g mail dot com)
+Copyright:: Copyright (c) 2009 by Dave Copeland
+License:: Distributes under the Apache License, see LICENSE.txt in the source distro
+
+This is a DSL you can use to create a command line interface like git, gem or svn, in that the first argument is a command, and there are global and command specific flags.
+
+== Use
+
+Install if you need to:
+
+    sudo gem install gli
 
 The simplest way to get started is to create a scaffold project
 
@@ -10,7 +20,7 @@ This will create a (very) basic scaffold project in <tt>./my_proj</tt>, with a b
 main file in <tt>./my_proj/bin/my_proj</tt>.  This file demonstrates most of what you need
 to describe your command line interface
 
-== More Detail
+=== More Detail
 
 This sets you up to use the DSL that GLI defines:
 
@@ -59,7 +69,7 @@ line arguments
 
       c.action do |global_options,options,args|
         if args.length < 1
-          raise(MissingArgumentException,'You must specify the name of your project')
+          raise 'You must specify the name of your project'
         end
         Scaffold.create_scaffold(g[:r],!o[:notest],o[:e],args[0],args[1..-1],o[:force],g[:n])
       end
@@ -100,7 +110,7 @@ What this doesn't give you:
 * A way to indicate a require argument or required number of arguments
 * A way to do default switches to 'true' and therefore accept things like <tt>--no-force</tt>
   
-= Interface Generated
+== Interface Generated
 
 *executable* <i>global options and flags</i> *command* <i>command specific options and flags</i> `arguments`
 
@@ -109,7 +119,7 @@ What this doesn't give you:
 [command]   the command to execute.  The <tt>rebase</tt> in <tt>git rebase</tt>
 [arguments] Anything that's not a switch, flag, or command.  The <tt>main.c</tt> in <tt>git add main.c</tt>
 
-== Switches
+=== Switches
 
 Switches can be specified one at a time in either a long or short format:
 
@@ -121,15 +131,20 @@ Switches can also be combined in their short form:
     ls -l -a    
     ls -la
 
-== Flags
+=== Flags
 
 Flags can be specified in long or short form, and with or without an equals:
 
     git merge -s resolve
     git merge --strategy=resolve
 
-== Stop Switch
+=== Stop Switch
 
 A <tt>--</tt> at any time stops processing and sends the rest of the argument to the command as arguments, even if
 they start with a "--"
 
+== Links
+
+* [http://davetron5000.github.com/gli] - RubyDoc
+* [http://www.github.com/davetron5000/gli] - Source on GitHub
+

data/bin/gli

@@ -33,7 +33,7 @@ command [:init,:scaffold] do |c|
 
   c.action do |g,o,args|
     if args.length < 1
-      raise(MissingArgumentException,'You must specify the name of your project')
+      raise 'You must specify the name of your project'
     end
     Scaffold.create_scaffold(g[:r],!o[:notest],o[:e],args[0],args[1..-1],o[:force],g[:n])
   end
@@ -53,9 +53,4 @@ post do |global,command,options,args|
   puts "Executed #{command.name}" if global[:v]
 end
 
-#on_error do |global,command,options,args|
-#  puts "Got an error" if global[:v]
-#  true
-#end
-
 run(ARGV)

data/lib/gli.rb

@@ -72,8 +72,9 @@ module GLI
   end
 
   # Define a block to run if an error occurs.
-  # The block will receive the exception that was caught.
-  # It should return false to avoid the built-in error handling
+  # The block will receive any Exception that was caught.
+  # It should return false to avoid the built-in error handling (which basically just
+  # prints out a message)
   def on_error(&a_proc)
     @@error_block = a_proc
   end
@@ -90,15 +91,12 @@ module GLI
         command.execute(global_options,options,arguments)
         @@post_block.call(global_options,command,options,arguments) if @@post_block 
       end
-    rescue UnknownCommandException, UnknownArgumentException, MissingArgumentException => ex
+    rescue Exception => ex
       regular_error_handling = true
       regular_error_handling = @@error_block.call(ex) if @@error_block
 
       if regular_error_handling
-        puts "error: #{ex}"
-        puts
-        help = commands[:help]
-        help.execute({},{},[])
+        puts "error: #{ex.message}"
       end
     end
   end
@@ -175,7 +173,7 @@ module GLI
       if !command
         command_name = args.shift
         command = find_command(command_name)
-        raise(UnknownCommandException,"Unknown command '#{command_name}'") if !command
+        raise "Unknown command '#{command_name}'" if !command
         return parse_options_helper(args,global_options,command,command_options,arguments)
       else
         return global_options,command,command_options,arguments | args
@@ -225,16 +223,16 @@ module GLI
             try_me.delete arg
             break 
           end
-          raise(UnknownArgumentException,"Unknown argument #{arg}") if arg =~ /^\-/ 
+          raise "Unknown argument #{arg}" if arg =~ /^\-/ 
         end
         return [global_options,command,command_options,try_me | rest]
       else
         # Now we have our command name
         command_name = try_me.shift
-        raise(UnknownArgumentException,"Unknown argument #{command_name}") if command_name =~ /^\-/
+        raise "Unknown argument #{command_name}" if command_name =~ /^\-/
 
         command = find_command(command_name)
-        raise(UnknownCommandException,"Unknown command '#{command_name}'") if !command
+        raise "Unknown command '#{command_name}'" if !command
 
         return parse_options_helper(rest,global_options,command,command_options,arguments)
       end
@@ -252,14 +250,4 @@ module GLI
     nil
   end
 
-  # Raise this if you get an argument you were not expecting
-  class UnknownArgumentException < Exception
-  end
-
-  class UnknownCommandException < Exception
-  end
-
-  # Raise this if your command doesn't get the number of arguments you were expecting
-  class MissingArgumentException < Exception
-  end
 end

data/lib/gli/flag.rb

@@ -24,7 +24,7 @@ module GLI
               args.delete_at index
               return value
             else
-              raise(MissingArgumentException,"#{matched} requires an argument")
+              raise "#{matched} requires an argument"
             end
           else
             return value
@@ -38,7 +38,7 @@ module GLI
       if @names[arg]
         return [true,arg,nil] if arg.length == 2
         # This means we matched the long-form, but there's no argument
-        raise(MissingArgumentException,"#{arg} requires an argument via #{arg}=argument")
+        raise "#{arg} requires an argument via #{arg}=argument"
       end
       @names.keys.each() do |name|
         match_string = "^#{name}=(.*)$"

data/lib/support/scaffold.rb

@@ -53,7 +53,11 @@ command :#{command} do |c|
   c.default_value 'default'
   c.flag :s
   c.action do |global_options,options,args|
+
     # Your command logic here
+     
+    # If you have any errors, just raise them
+    # raise "that command made no sense"
   end
 end
 EOS

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davetron5000-gli
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Copeland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: []