cooloptions 1.0.0 → 1.0.1

data/History.txt

@@ -1,4 +1,9 @@
-== 1.0.0 / 
+== 1.0.1 / 2006-12-09
+
+* Added samples
+* Added contribution info to README.txt.
+
+== 1.0.0 / 2006-12-09
 
 * Added test for short options specification.
 * Improved the documentation.

data/Manifest.txt

@@ -3,4 +3,6 @@ Manifest.txt
 README.txt
 Rakefile
 lib/cooloptions.rb
+samples/literate.rb
+samples/new_rails_project
 test/test_cooloptions.rb

data/README.txt

@@ -71,6 +71,11 @@ optparse & ostruct (included in Ruby standard library).
 
   sudo gem install cooloptions
 
+== CONTRIBUTE:
+
+Drop me an email (see above) and/or check out the source at
+http://terralien.com/svn/projects/cooloptions/trunk.
+
 == LICENSE:
 
 The RUBY License

data/lib/cooloptions.rb

@@ -11,7 +11,7 @@ require 'ostruct'
 #   :include:samples/literate.rb
 
 class CoolOptions
-  VERSION = '1.0.0' #:nodoc:
+  VERSION = '1.0.1' #:nodoc:
 
   class Error < StandardError #:nodoc:
   end

data/samples/literate.rb

@@ -0,0 +1,29 @@
+require 'cooloptions'
+
+options = CoolOptions.parse!('[options] NAME') do |cooloptions|
+  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.
+
+  cooloptions.on 'boolean',        'Boolean',      false    # Matches '-b' or '--boolean' or '--no-boolean'.
+                                                            # Note the lack of a placeholder for the value.
+
+  cooloptions.on 'shor(t) VALUE',  'Short'                  # Use parens to delineate a short form other than the first char.
+                                                            # Matches '-o value' or '--short value'
+
+  cooloptions.on 'k)first VALUE',  'First'                  # No leading paren for a short character not in the long option.
+
+  cooloptions.after do |result|                             # Gets called with the result of the parse _before_ returning it.
+    unless result.option == 'a'                             # Allows for easy validation of options.
+      cooloptions.error("Invalid format.")    
+    end
+    result.name = ARGV.shift                                # Or grabbing additional arguments.
+  end
+
+  cooloptions.parser.on('-z', '--raw [STUFF]', String,      # If you want to do funky optparse stuff, you can use the parser.
+                        'Raw optparse.') do |option|        # However, if you're doing more of this than of the simple stuff,
+                          puts "RAW!"                       # you should consider just using optparse directly.
+                        end
+end
+
+p options.option    # All the options get put in to an OpenStruct keyed by their long name (with '-' becoming '_')

data/samples/new_rails_project

@@ -0,0 +1,27 @@
+require 'cooloptions'
+
+options = CoolOptions.parse!("[options] PROJECTNAME") do |o|
+  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")
+  o.on "l)repository-path PATH", "Remote repository path.",               "/"
+  o.on "mirror-path SVKPATH",    "SVK mirror path.",                      "//"
+  o.on "local-pa(t)h SVKPATH",   "SVK local path.",                       "//local"
+  o.on "create-structure",       "Create trunk/tags/branches structure.", true
+  o.on "finish",                 "Prep and commit the new project.",      true
+  
+  o.after do |r|
+    r.project_path = File.expand_path(r.project_path)
+    o.error("Invalid path.") unless File.exist?(r.project_path)
+    r.project_name = ARGV.shift
+    o.error("Project name is required.") unless r.project_name
+    o.error("Project name is too funky.") unless /^\w+$/ =~ r.project_name
+  end
+end
+
+p options.svk                 # => false
+p options.project_path        # => '/Users/ntalbott/svk'
+p options.repository          # => 'http://terralien.com/svn/terralien/'
+p options.finish              # => false
+p options.create_structure    # => true
+p options.project_name        # => 'myproject'

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: cooloptions
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 date: 2006-12-09 00:00:00 -05:00
 summary: CoolOptions is a simple wrapper around optparse that provides less options and more convenience.
 require_paths: 
@@ -33,6 +33,8 @@ files:
 - README.txt
 - Rakefile
 - lib/cooloptions.rb
+- samples/literate.rb
+- samples/new_rails_project
 - test/test_cooloptions.rb
 test_files: 
 - test/test_cooloptions.rb