cooloptions 1.0.4 → 1.0.5

data/History.txt

@@ -1,3 +1,7 @@
+== 1.0.5 / 
+
+* Added CoolOptions#desc (suggested by John Long).
+
 == 1.0.4 / 2006-12-09
 
 * Added a Rake dependency.

data/README.txt

@@ -13,6 +13,7 @@ As a huge fan of optparse due to its flexibility, self-documenting nature, and e
 === Declaration:
 
   options = CoolOptions.parse!("[options] PROJECTNAME") do |o|
+    o.desc 'Sets up a new Rails project.'
     o.on "repository URL",         "Remote subversion repository."          
     o.on "svk",                    "Use svk.",                              true
     o.on "project-path PATH",      "Root of project workspaces.",           File.expand_path("~/svk")

data/Rakefile

@@ -5,7 +5,7 @@ require './lib/cooloptions.rb'
 Hoe.new('cooloptions', CoolOptions::VERSION) do |p|
   p.rubyforge_name = 'cooloptions'
   p.summary = 'CoolOptions is a simple wrapper around optparse that provides less configuration and more convenience for doing command-line option handling.'
-  p.description = 'As a huge fan of optparse due to its flexibility, self-documenting nature, and ease of use, I nevertheless found myself doing almost the exact same thing with it over and over again, and decided to write a thin wrapper around it to handle the common cases. Thus CoolOptions was born.'
+  p.description = 'As a huge fan of optparse due to its flexibility, self-documenting nature, and ease of use, I nevertheless found myself doing almost the exact same thing with it over and over again, and decided to write a thin wrapper around it to handle the common cases. Thus CoolOptions was born. CoolOptions is a simple wrapper around optparse that provides less configuration and more convenience for doing command-line option handling.'
   p.url = 'http://cooloptions.rubyforge.org/'
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.author = "Nathaniel Talbott"

data/lib/cooloptions.rb

@@ -11,7 +11,7 @@ require 'ostruct'
 #   :include:samples/literate.rb
 
 class CoolOptions
-  VERSION = '1.0.4' #:nodoc:
+  VERSION = '1.0.5' #:nodoc:
 
   class Error < StandardError #:nodoc:
   end
@@ -53,6 +53,13 @@ class CoolOptions
     @after = nil
   end
   
+  # Adds additional descriptive text to the help text.
+  def desc(string)
+    string.each_line do |s|
+      @parser.separator s.chomp
+    end
+  end
+  
   NO_DEFAULT = Object.new #:nodoc:
   
   # Called on cooloptions within the #parse! block to add options to parse on.

data/samples/literate.rb

@@ -1,6 +1,7 @@
 require 'cooloptions'
 
 options = CoolOptions.parse!('[options] NAME') do |cooloptions|
+  cooloptions.desc 'This is a literate sample of what CoolOptions can do.'  # Adds some extra descriptive text.
   cooloptions.on 'option STRING',  'Description', 'default' # Matches '-o string' or '--option string' or uses the 'default'.
 
   cooloptions.on 'required VALUE', 'Required'               # Because there's no default, the option is required.

data/samples/new_rails_project

@@ -1,6 +1,7 @@
 require 'cooloptions'
 
 options = CoolOptions.parse!("[options] PROJECTNAME") do |o|
+  o.desc 'Sets up a new Rails project.'
   o.on "repository URL",         "Remote subversion repository."          
   o.on "svk",                    "Use svk.",                              true
   o.on "project-path PATH",      "Root of project workspaces.",           File.expand_path("~/svk")

data/test/test_cooloptions.rb

@@ -71,6 +71,10 @@ class TestCoolOptions < Test::Unit::TestCase
   def test_should_output_help
     begin
       r = CoolOptions.parse!('details', %w(--help)) do |o|
+        o.desc <<EOD.chomp
+This is a sweet little non-existent command.
+Really!
+EOD
         o.on 'a', 'aa'
       end
     rescue SystemExit
@@ -80,6 +84,8 @@ class TestCoolOptions < Test::Unit::TestCase
     assert rescued
     assert_equal <<EOH, @out.string
 Usage: #{File.basename($0)} details
+This is a sweet little non-existent command.
+Really!
     -a, --[no-]a                     aa
     -h, --help                       This help info.
 EOH

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: cooloptions
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 date: 2006-12-09 00:00:00 -05:00
 summary: CoolOptions is a simple wrapper around optparse that provides less configuration and more convenience for doing command-line option handling.
 require_paths: 
@@ -11,7 +11,7 @@ require_paths:
 email: nathaniel@terralien.com
 homepage: http://cooloptions.rubyforge.org/
 rubyforge_project: cooloptions
-description: As a huge fan of optparse due to its flexibility, self-documenting nature, and ease of use, I nevertheless found myself doing almost the exact same thing with it over and over again, and decided to write a thin wrapper around it to handle the common cases. Thus CoolOptions was born.
+description: As a huge fan of optparse due to its flexibility, self-documenting nature, and ease of use, I nevertheless found myself doing almost the exact same thing with it over and over again, and decided to write a thin wrapper around it to handle the common cases. Thus CoolOptions was born. CoolOptions is a simple wrapper around optparse that provides less configuration and more convenience for doing command-line option handling.
 autorequire: 
 default_executable: 
 bindir: bin