opt-simple 0.9.5 → 0.9.6

data/README

@@ -1,4 +1,4 @@
-= OptSimple provides a very simple interface to command line parsing. 
+== OptSimple provides a very simple interface to command line parsing. 
 
 == Description
 Parameter specification, validity checking and argument transformations
@@ -36,62 +36,81 @@ It is recommended to install OptSimple using RubyGems:
 
 == Examples
 
-=== One example that shows a lot of the behavior you might use
-require 'opt_simple'
-
- min = 5
- max = 15
+=== One example that shows most of the behavior you might use
+ require 'opt_simple'
  
- options = OptSimple.new.parse_opts! do 
+ defaults = {
+   :n => 42,
+   :range => [5,10]
+ }
+ 
+ opts = OptSimple.new(defaults).parse_opts! do 
    argument %w[-i --infile], "Infile, multiple allowed", "FILE" do | arg |
      accumulate_opt arg
    end
  
-   option %w[-p --pattern --glob-pattern], "glob pattern","PATTERN"
+   flag %w[-d --debug],"debug mode"
  
-   option %w[-n -num --num-values],"Number of val","VAL" do |arg|
+   flag %w[-m --cowbell --morecowbell],"I've got a fever, and this is the only prescription." do 
+     accumulate_opt
+   end
+   
+   option %w[-n -num --num-values],"The answer to everything","VAL" do |arg|
      set_opt arg.to_i
    end
  
-   option "--range", "range: min,max (both >0) default is #{min},#{max}" do | arg1,arg2 |
-     min = arg1.to_i
-     max = arg2.to_i    
+   option %w[-p --pattern --glob-pattern], "glob pattern","PATTERN"
+ 
+   option "--range", "range: min,max (both >0)" do | arg1,arg2 |
+     min,max = [arg1.to_i,arg2.to_i]
+     set_opt [min,max]
       
      error "max must be greater than min" unless max > min
      error "both must be >=0" if min < 0
    end
- 
-   flag %w[-v  --verbose],"Verbosity. the more you set, the more we give" do 
-     accumulate_opt
-   end
- 
  end
  
  puts "Options"
- puts options
- # access the results using method names or hash syntax 
- puts options.pattern
- puts options[:p]
- puts options['glob-pattern']
+ puts opts
+
+ # you can use method syntax to access the options
+ puts "Infile list: #{opts.infile}"
+
+ # Flags are set to false by default
+ puts "Debug" if opts.debug
+
+ # If accumulate_opt is used, flags still default to false, but
+ # will be integers if set on the CL
+ puts "Cowbell: #{opts['cowbell']}"
+
+ # You can use hash syntax to access the options as strings or symbols
+ puts "N: #{opts[:n]}"
+
+ # You can check to see if Options were set
+ puts "Pattern: #{opts.p}" if opts.include?(:p)
+
+ # Here, range was set to an Array. 
+ puts "Range: #{opts.range.first} #{opts.range.last}"
  
 Which prints out an automatic usage statement:
  Usage: opt_ex.rb [options]
-                                                                                                                                                             
+ 
    MANDATORY ARGS:
-     -i, --infile FILE                           Infile, multiple allowed                                                                                     
-
+     -i, --infile FILE                           Infile, multiple allowed
+ 
    OPTIONS:
+     -d, --debug                                 debug mode
+ 
+     -m, --cowbell, --morecowbell                I've got a fever, and this is the only prescription.
+ 
+     -n, -num, --num-values VAL                  The answer to everything
+ 
      -p, --pattern, --glob-pattern PATTERN       glob pattern
-
-     -n, -num, --num-values VAL                  Number of val
-
-         --range ARG                             range: min,max (both >0) default is 5,15
-
-     -v, --verbose                               Verbosity. the more you set, the more we give
-
+ 
+         --range ARG                             range: min,max (both >0) (default is [5, 10])
+ 
      -h, --help                                  (for this help message)
 
-
 === A very simple example with no error checking. Use at your own risk!
 
  require 'opt_simple'

data/lib/opt_simple.rb

@@ -264,8 +264,11 @@ class OptSimple
       optional_opts.each do | parm |
 	help_str << parm.help_str(@longest_switch_len)
 	
-	# check to see if we have any defaults set to help in the help doc
-	intersection = @defaults.keys & parm.names
+	# check to see if we have any defaults for options and args only
+	# to add to the help doc
+	intersection = []
+
+	intersection = @defaults.keys & parm.names unless parm.class == Flag
 	if intersection.empty?
 	  help_str << "\n\n"
 	else
@@ -299,8 +302,8 @@ class OptSimple
   end
 
   # The base class for command line parameter objects from which Flag, 
-  # Option and Argument are derived. Provides documentation methods, 
-  # an 'error method', and the 'set_opt' utility funciton. 
+  # Option and Argument are derived. Users will probably only use the 
+  # an 'error method' and the 'set_opt' utility funciton. 
   class Parameter
     attr_reader :switches,:param_options,:metavar,:block
 
@@ -312,7 +315,6 @@ class OptSimple
       @help = help
       @block = block
       @param_options = OptSimple::Result.new
-      @names = nil
       @param_options.add_alias(self.names)
     end
 
@@ -323,7 +325,12 @@ class OptSimple
 
     # returns a list of the switches without the leading '-'s
     def names
-      @names ||= switches.map {|s| s.sub(/^-+/,'')}
+      names = []
+      switches.each do  |s| 
+	st = s.sub(/^-+/,'')
+	names << st << st.to_sym
+      end
+      names 
     end
 
     def switch_len #:nodoc:
@@ -359,7 +366,7 @@ class OptSimple
       @param_options[names.first] = val
     end
 
-    # is it mandatory to see this parameter on the command line?
+    # is it mandatory to see this parameter on the command line? Returns false unless overidden.  
     def mandatory?; false; end
 
   end
@@ -439,6 +446,7 @@ class OptSimple
   # leading '-'s removed) will be used as keys in the Result 
   # and the values set to the arg following the switch the args array.
   class Argument < Option
+    # returns true in an Argument
     def mandatory?; true; end
   end
 

metadata

@@ -2,7 +2,7 @@
 name: opt-simple
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors: 
 - Ethan Stryker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 +00:00
+date: 2011-03-26 00:00:00 +00:00
 default_executable: 
 dependencies: []