davetron5000-gli 0.2.0 → 0.2.1

data/README.rdoc

@@ -16,13 +16,17 @@ The simplest way to get started is to create a scaffold project
 
     gli init my_proj command_name other_command_name
 
-This will create a (very) basic scaffold project in <tt>./my_proj</tt>, with a bare-bones 
-main file in <tt>./my_proj/bin/my_proj</tt>.  This file demonstrates most of what you need
-to describe your command line interface
+This will create a basic scaffold project in <tt>./my_proj</tt> with:
 
-=== More Detail
+* executable in <tt>./my_proj/bin/my_proj</tt>.  This file demonstrates most of what you need to describe your command line interface.
+* an empty test in <tt>./my_proj/test/tc_nothing.rb</tt> that can bootstrap your tests
+* a gemspec shell
+* a README shell
+* Rakefile that can generate RDoc, package your Gem and run tests
 
-This sets you up to use the DSL that GLI defines:
+=== Example
+
+This example demonstrates most of the features of GLI
 
     #!/usr/bin/ruby
     $: << File.expand_path(File.dirname(__FILE__) + '/../lib') 
@@ -31,27 +35,31 @@ This sets you up to use the DSL that GLI defines:
 
     include GLI
 
-This describes a command line switch "-n" that is global to all commands and specified before
-the command name on the command line.
+This sets you up to use the DSL that GLI defines:
+
+
+    program_description 'Support program for bootstrapping GLI-based programs'
+
+This sets a description of your program.  This can be as long as you want.
+
 
     desc 'Dry run; don\'t change the disk'
     switch :n
 
+This describes a command line switch "-n" that is global to all commands and specified before
+the command name on the command line.
 
-This describes a command line flag that is global and has a default value of '<tt>.</tt>'.  It also
-specifies a short description of its argument.  This is used to print command line help.  Note that we
-have specified two different aliases for this flag.  <tt>-r</tt> (because it is listed first) is the default
-one and <tt>--root</tt> (note two-dash syntax) is also supported.  This means that <tt>-r some_dir</tt> and <tt>--root=some_dir</tt> mean
-the same thing to the application.
 
     desc 'Root dir in which to create project'
     default_value '.'
     arg_name 'root_dir'
     flag [:r,:root]
 
-Here we specify a command.  Inside the block we can use the same sorts of things as we did above to define flags
-and switches specific to the command.  These must come after the command name.  Also note that we use <tt>arg_name</tt>
-here to describe the arguments this command accepts.
+The following describes a command line flag that is global and has a default value of '<tt>.</tt>'.  It also
+specifies a short description of its argument.  This is used to print command line help.  Note that we
+have specified two different aliases for this flag.  <tt>-r</tt> (because it is listed first) is the default
+one and <tt>--root</tt> (note two-dash syntax) is also supported.  This means that <tt>-r some_dir</tt> and <tt>--root=some_dir</tt> mean
+the same thing to the application.
 
     desc 'Create a new GLI-based project'
     arg_name 'project_name [command[ command]*]'
@@ -63,9 +71,9 @@ here to describe the arguments this command accepts.
       c.desc 'Overwrite/ignore existing files and directories'
       c.switch [:force]
 
-Here we specify the actual actions to take when the command is executed.  We define a block that
-will be given the global options (as a Hash), the command-specific options (as a hash) and the command
-line arguments
+Here we specify a command.  Inside the block we can use the same sorts of things as we did above to define flags
+and switches specific to the command.  These must come after the command name.  Also note that we use <tt>arg_name</tt>
+here to describe the arguments this command accepts.
 
       c.action do |global_options,options,args|
         if args.length < 1
@@ -75,6 +83,10 @@ line arguments
       end
     end
 
+Here we specify the actual actions to take when the command is executed.  We define a block that
+will be given the global options (as a Hash), the command-specific options (as a hash) and the command
+line arguments
+
 You can also specify some global code to run before, after and on errors:
 
     pre do |global_options,command,options,args|
@@ -97,6 +109,8 @@ Now, we run the program using the arguments the user provided on the command lin
 
     run(ARGV)
 
+Note that by using <tt>gli init</tt> you can create a shell with all of this already there.
+
 What this gives you:
 
 * A reasonably useful help system.  <tt>your_program help</tt> will list all the global options and commands (along with command aliases) and <tt>your_program help command_name</tt> will list help for that given command.
@@ -109,9 +123,26 @@ What this doesn't give you:
 * A way to indicate required flags
 * 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>
-  
+
+== Reference
+
+
+[+action+] Specify the action to take when a command is executed from the command line.  This is only usable in a command block on the command object (e.g. <tt>c.action</tt>).  This takes a block that yields three parameters: a hash of global options specified on the commandline, a hash of command-specific options specified on the command line, and an array of arguments parsed after the options were set on the command line.  So, a command like <tt>git --git-dir=/tmp commit -a -m 'Foo bar' foo.c bar.c</tt> would result in the global hash containing <tt>:'git-dir' => '/tmp'</tt>, the options hash containing <tt>:a => true, :m => 'Foo bar'</tt> and the arguments array being <tt>['foo.c', 'bar.c']</tt>
+[+arg_name+] Describe the name of the argument to the next flag or command.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.arg_name</tt>)
+[+command+] Declare a command.  This takes a symbol or array of symbols and a block.  The block yields one argument, the command itself.  
+[+default_value+] Indicate the default value of the next flag.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.default_value</tt>)
+[+desc+] Describe the next flag, switch, or command you will declare.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.desc</tt>)
+[+flag+] Declare a flag, which is a command line switch that takes an argument.  This takes either a symbol or an array of symbols.  The first symbol decared is used in your program to determine the flag's value at runtime.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.flag</tt>)
+[+long_desc+] Provide a more lengthy description of the next flag, switch, or command you will declare.  This will appear in command line output for commands when you get help for a command.  For flags and switches, this will only appear in the generated rdoc and *not* on the command line.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.long_desc</tt>)
+[+on_error+] Declare an error handling routine that will be called if any command (or other GLI processing) encouters an exception.  This is a block that will receive the exception that was caught.  All exceptions are routed through this block. If the block evaluates to true, the built-in error handling will be called after, otherwise, nothing will happen.
+[+post+] Declare code to run after every command that didn't experience an error.  This is not available inside a command block.  This takes a block that will receive four arguments: the global argument hash (as in <tt>action</tt>), the command (instance of Command), the command-specific options (as in <tt>action</tt>, and the parsed command line arguments (as in <tt>action</tt>).  
+[+pre+] Declare code to run before every command.  This is not available inside a command block.  This takes a block that will receive four arguments: the global argument hash (as in <tt>action</tt>), the command (instance of Command), the command-specific options (as in <tt>action</tt>, and the parsed command line arguments (as in <tt>action</tt>).  If this block evaluates to false, the command will not be executed and the program will stop.
+[+switch+] Declare a switch, which is a command-line switch taking no argument that indicates a boolean "true" when specified on the command line.  This takes either a symbol or array of symbols.  The first symbol declared is used in your program to determine if the switch was set.  This can be used at the global level or inside a command block on the command object (e.g. <tt>c.switch</tt>)
+
 == Interface Generated
 
+The command line interface that is created with the GLI DSL is:
+
 *executable* <i>global options and flags</i> *command* <i>command specific options and flags</i> `arguments`
 
 [switch]    a command line control string that takes no argument.  The <tt>-l</tt> in <tt>ls -l</tt>
@@ -143,6 +174,8 @@ Flags can be specified in long or short form, and with or without an equals:
 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 "--"
 
+:include:gli.rdoc
+
 == Links
 
 * [http://davetron5000.github.com/gli] - RubyDoc

data/bin/gli

@@ -5,20 +5,28 @@ require 'gli'
 require 'support/scaffold'
 
 include GLI
+
 desc 'Be verbose'
 switch :v
 
-desc 'Print version'
+desc 'Show version'
 switch :version
 
-desc 'Dry run; don\'t change the disk'
+desc 'Dry run; don''t change the disk'
 switch :n
 
 desc 'Root dir of project'
+long_desc 'This is the directory where the project''s directory will be made, so if you specify a project name ''foo'' and the root dir of ''.'', the directory ''./foo'' will be created'
 default_value '.'
 flag [:r,:root]
 
 desc 'Create a new GLI-based project'
+long_desc <<EOS
+This will create a scaffold command line project that uses GLI
+for command line processing.  Specifically, this will create
+an executable ready to go, as well as a lib and test directory, all
+inside the directory named for your project
+EOS
 arg_name 'project_name [command[ command]*]'
 command [:init,:scaffold] do |c|
 

data/gli.rdoc

@@ -0,0 +1,45 @@
+= <tt>gli</tt>
+
+    gli [global options] command_name [command-specific options] [--] arguments...
+
+* Use the command +help+ to get a summary of commands
+* Use the command <tt>help command_name</tt> to get a help for +command_name+
+* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them
+
+== Global Options
+These options are available for any command and are specified before the name of the command
+
+[<tt>-n</tt>] Dry run; dont change the disk
+[<tt>-r, --root=arg</tt>] Root dir of project <i>( default: <tt>.</tt>)</i>
+
+                          This is the directory where the projects directory will be made, so if you specify a project name foo and the root dir of ., the directory ./foo will be created
+
+[<tt>-v</tt>] Be verbose
+[<tt>--version</tt>] Show version
+== Commands
+[<tt>help</tt>] Shows list of commands or help for one command
+[<tt>init</tt>] Create a new GLI-based project
+
+=== <tt>help [command]</tt>
+
+Shows list of commands or help for one command
+
+=== <tt>init project_name [command[ command]*]</tt>
+
+Create a new GLI-based project
+
+*Aliases*
+* <tt><b>scaffold</b></tt>
+
+This will create a scaffold command line project that uses GLI
+for command line processing.  Specifically, this will create
+an executable ready to go, as well as a lib and test directory, all
+inside the directory named for your project
+
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-e, --ext</tt>] Create an ext dir
+[<tt>--force</tt>] Overwrite/ignore existing files and directories
+[<tt>--notest</tt>] Do not create a test dir

data/lib/gli.rb

@@ -3,6 +3,7 @@ require 'gli/command.rb'
 require 'gli/switch.rb'
 require 'gli/flag.rb'
 require 'support/help.rb'
+require 'support/rdoc.rb'
 
 # A means to define and parse a command line interface that works as
 # Git's does, in that you specify global options, a command name, command
@@ -10,7 +11,7 @@ require 'support/help.rb'
 module GLI
   extend self
 
-  VERSION = '0.1.5'
+  VERSION = '0.2.1'
 
   @@program_name = $0.split(/\//)[-1]
   @@post_block = nil
@@ -25,8 +26,14 @@ module GLI
     clear_nexts
   end
 
-  # describe the next switch, flag, or command
+  # describe the next switch, flag, or command.  This should be a
+  # short, one-line description
   def desc(description); @@next_desc = description; end
+
+  # Provide a longer, more detailed description.  This
+  # will be reformatted and wrapped to fit in 80 columns
+  def long_desc(long_desc); @@next_long_desc = long_desc; end
+
   # describe the argument name of the next flag
   def arg_name(name); @@next_arg_name = name; end
   # set the default value of the next flag
@@ -34,21 +41,21 @@ module GLI
 
   # Create a flag, which is a switch that takes an argument
   def flag(names)
-    flag = Flag.new(names,@@next_desc,@@next_arg_name,@@next_default_value)
+    flag = Flag.new(names,@@next_desc,@@next_arg_name,@@next_default_value,@@next_long_desc)
     flags[flag.name] = flag
     clear_nexts
   end
 
   # Create a switch
   def switch(names)
-    switch = Switch.new(names,@@next_desc)
+    switch = Switch.new(names,@@next_desc,@@next_long_desc)
     switches[switch.name] = switch
     clear_nexts
   end
 
   # Define a command.
   def command(names)
-    command = Command.new(names,@@next_desc,@@next_arg_name)
+    command = Command.new(names,@@next_desc,@@next_arg_name,@@next_long_desc)
     commands[command.name] = command
     yield command
     clear_nexts
@@ -81,7 +88,9 @@ module GLI
 
   # Runs whatever command is needed based on the arguments.
   def run(args)
-    commands[:help] = DefaultHelpCommand.new if !commands[:help]
+    rdoc = RDocCommand.new
+    commands[:rdoc] = rdoc if !commands[:rdoc]
+    commands[:help] = DefaultHelpCommand.new(rdoc) if !commands[:help]
     begin
       global_options,command,options,arguments = parse_options(args)
       proceed = true
@@ -139,6 +148,7 @@ module GLI
     @@next_desc = nil
     @@next_arg_name = nil
     @@next_default_value = nil
+    @@next_long_desc = nil
   end
 
   clear_nexts

data/lib/gli/command.rb

@@ -9,13 +9,16 @@ module GLI
     # [names] the name or names of this command (symbol or Array of symbols)
     # [description] description of this command
     # [arguments_name] description of the arguments, or nil if this command doesn't take arguments
+    # [long_desc] a longer description of the command, possibly with multiple lines and text formatting
     #
-    def initialize(names,description,arguments_name=nil)
-      super(names,description)
+    def initialize(names,description,arguments_name=nil,long_desc=nil)
+      super(names,description,long_desc)
       @arguments_description = arguments_name || ''
       clear_nexts
     end
 
+    def arguments_description; @arguments_description; end
+
     def names
       all_forms
     end

data/lib/gli/command_line_token.rb

@@ -5,9 +5,11 @@ module GLI
     attr_reader :name
     attr_reader :aliases
     attr_reader :description
+    attr_reader :long_description
 
-    def initialize(names,description)
+    def initialize(names,description,long_description=nil)
       @description = description
+      @long_description = long_description
       @name,@aliases,@names = parse_names(names)
     end
 
@@ -15,6 +17,10 @@ module GLI
       all_forms
     end
 
+    def <=>(other)
+      self.name.to_s <=> other.name.to_s
+    end
+
     private
     # Returns a string of all possible forms
     # of this flag.  Mostly intended for printing

data/lib/gli/flag.rb

@@ -6,8 +6,8 @@ module GLI
 
     attr_reader :default_value
 
-    def initialize(names,description,argument_name=nil,default=nil)
-      super(names,description)
+    def initialize(names,description,argument_name=nil,default=nil,long_desc=nil)
+      super(names,description,long_desc)
       @argument_name = argument_name || "arg"
       @default_value = default
     end

data/lib/gli/switch.rb

@@ -4,8 +4,8 @@ module GLI
   # Defines a command line switch
   class Switch < CommandLineToken
 
-    def initialize(names,description)
-      super(names,description)
+    def initialize(names,description,long_desc=nil)
+      super(names,description,long_desc)
     end
 
     # Given the argument list, scans it looking for this switch

data/lib/support/help.rb

@@ -3,7 +3,8 @@ require 'gli/command'
 
 module GLI
   class DefaultHelpCommand < Command
-    def initialize
+    def initialize(*omit_from_list)
+      @omit_from_list = omit_from_list
       super(:help,'Shows list of commands or help for one command','[command]')
     end
 
@@ -33,7 +34,8 @@ module GLI
 
     def list_commands
       puts 'Commands:'
-      output_command_tokens_for_help(GLI.commands,:names)
+      commands_to_show = GLI.commands.reject{ |name,c| @omit_from_list.include?(c) }
+      output_command_tokens_for_help(commands_to_show,:names)
     end
 
     def list_one_command_help(command_name)
@@ -42,6 +44,10 @@ module GLI
         puts command.usage
         description = wrap(command.description,4)
         puts "    #{description}"
+        if command.long_description
+          puts
+          puts "    #{wrap(command.long_description,4)}"
+        end
         all_options = command.switches.merge(command.flags)
         if !all_options.empty?
           puts

data/lib/support/rdoc.rb

@@ -0,0 +1,78 @@
+require 'gli'
+require 'fileutils'
+
+module GLI
+  class RDocCommand < Command
+
+    def initialize
+      super(:rdoc,'Generates RDoc for your command line interface')
+    end
+
+    def execute(g,o,a)
+      File.open("#{GLI.program_name}.rdoc",'w') do |file|
+        file << "= <tt>#{GLI.program_name}</tt>\n\n"
+        file << "    "
+        file << GLI.program_name
+        file << " "
+        global_options = GLI.switches.merge(GLI.flags)
+        if (global_options && global_options.length > 0)
+          file << "[global options] "
+        end
+        file << "command_name"
+        file << " [command-specific options]"
+        file << " [--] arguments...\n\n"
+        file << "* Use the command +help+ to get a summary of commands\n"
+        file << "* Use the command <tt>help command_name</tt> to get a help for +command_name+\n"
+        file << "* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them\n"
+        file << "\n"
+        if (global_options && global_options.length > 0)
+          file << "== Global Options\n"
+          file << "These options are available for any command and are specified before the name of the command\n\n"
+          output_flags(file,global_options)
+        end
+        file << "== Commands\n"
+        GLI.commands.values.sort.each do |command|
+          next if command == self
+          file << "[<tt>#{command.name}</tt>] #{command.description}\n"
+        end
+        file << "\n"
+
+        GLI.commands.values.sort.each do |command|
+          next if command == self
+          file << "=== <tt>#{command.name} #{command.arguments_description}</tt>\n\n"
+          file << "#{command.description}\n\n"
+          if command.aliases
+            file << "*Aliases*\n"
+            command.aliases.each do |al|
+              file << "* <tt><b>#{al}</b></tt>\n"
+            end 
+            file << "\n"
+          end
+          all_options = command.switches.merge(command.flags)
+          if (all_options && all_options.length > 0)
+            file << "#{command.long_description}\n\n"
+            file << "==== Options\n"
+            file << "These options are specified *after* the command.\n\n"
+            output_flags(file,all_options)
+          end
+        end
+      end
+    end
+
+    def output_flags(file,flags)
+      flags.values.sort.each do |flag|
+        file << "[<tt>#{flag.usage}</tt>] #{flag.description}"
+        if flag.kind_of? Flag
+          file << " <i>( default: <tt>#{flag.default_value}</tt>)</i>" if flag.default_value
+        end
+        file << "\n"
+        if flag.long_description
+          file << "\n"
+          # 12 is 4 for tt, 5 for /tt, 2 for the brackets and 1 for spacing
+          (flag.usage.length + 12).times { file << " " }
+          file << "#{flag.long_description}\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/support/scaffold.rb

@@ -12,6 +12,105 @@ module GLI
 
       if mkdirs(dirs,force,dry_run)
         mk_binfile(root_dir,create_ext_dir,force,dry_run,project_name,commands)
+        mk_readme(root_dir,dry_run,project_name)
+        mk_gemspec(root_dir,dry_run,project_name)
+        mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
+      end
+    end
+
+    def self.mk_readme(root_dir,dry_run,project_name)
+      return if dry_run
+      File.open("#{root_dir}/#{project_name}/README.rdoc",'w') do |file|
+        file << "= #{project_name}\n\n"
+        file << "Describe your project here\n\n"
+        file << ":include:#{project_name}.rdoc\n\n"
+      end
+      File.open("#{root_dir}/#{project_name}/#{project_name}.rdoc",'w') do |file|
+        file << "= #{project_name}\n\n"
+        file << "Generate this with\n    #{project_name} rdoc\nAfter you have described your command line interface"
+      end
+    end
+
+    def self.mk_gemspec(root_dir,dry_run,project_name)
+      return if dry_run
+      File.open("#{root_dir}/#{project_name}/#{project_name}.gemspec",'w') do |file|
+        file.puts <<EOS
+spec = Gem::Specification.new do |s| 
+  s.name = '#{project_name}'
+  s.version = '0.0.01'
+  s.author = 'Your Name Here'
+  s.email = 'your@email.address.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+# Add your other files here if you make them
+  s.files = %w(
+bin/#{project_name}
+  )
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','#{project_name}.rdoc']
+  s.rdoc_options << '--title' << 'Git Like Interface' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << '#{project_name}'
+end
+EOS
+      end
+    end
+
+    def self.mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
+      return if dry_run
+      File.open("#{root_dir}/#{project_name}/Rakefile",'w') do |file|
+        file.puts <<EOS
+require 'rake/clean'
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('#{project_name}.gemspec'))
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+EOS
+        if create_test_dir
+          file.puts <<EOS
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/tc_*.rb']
+end
+
+task :default => :test
+EOS
+          File.open("#{root_dir}/#{project_name}/test/tc_nothing.rb",'w') do |test_file|
+            test_file.puts <<EOS
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+class TC_testNothing < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end
+EOS
+          end
+        else
+          file.puts "task :default => :package\n"
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davetron5000-gli
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - David Copeland
@@ -13,7 +13,7 @@ date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: 
+description: An application and API for describing command line interfaces that can be used to quickly create a shell for executing command-line tasks.  The command line user interface is similar to Gits, in that it takes global options, a command, command-specific options, and arguments
 email: davidcopeland@naildrivin5.com
 executables: 
 - gli
@@ -21,6 +21,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- gli.rdoc
 files: 
 - lib/gli/command.rb
 - lib/gli/command_line_token.rb
@@ -28,9 +29,11 @@ files:
 - lib/gli/switch.rb
 - lib/gli.rb
 - lib/support/help.rb
+- lib/support/rdoc.rb
 - lib/support/scaffold.rb
 - bin/gli
 - README.rdoc
+- gli.rdoc
 has_rdoc: true
 homepage: http://davetron5000.github.com/gli
 post_install_message: