CommandLine 0.7.0 → 0.7.1

data/lib/commandline/application.rb

@@ -34,7 +34,6 @@ class Application
   DEFAULT_BODY_INDENT   =  4
 
   def initialize
-
     @synopsis       = ""
     @arg_arity     = [0,0]
     @options       = []
@@ -42,7 +41,7 @@ class Application
     @args          = []
     @argv        ||= ARGV
 
-    _init_format
+    __init_format
 
     __child_initialize if 
       self.class.private_instance_methods(false).include?("__child_initialize")
@@ -50,49 +49,6 @@ class Application
     @option_parser ||= CommandLine::OptionParser.new(@options)
   end
 
-  def parse_command_line(argv)
-    if argv.empty? && [0,0] != @arg_arity
-      puts usage
-      exit(0)
-    end
-
-    @option_data = @option_parser.parse(argv)
-
-    validate_args(@option_data.args)
-    @arg_names.each_with_index { |name, idx|
-      instance_variable_set("@#{name}", @option_data.args[idx])
-    }
-  end
-
-  def _init_format
-    #
-    # Formatting defaults
-    #
-    console_width = ENV["COLUMNS"]
-    @columns = 
-      if console_width.nil?
-        DEFAULT_CONSOLE_WIDTH
-      elsif console_width < MIN_CONSOLE_WIDTH
-        console_width
-      else
-        console_width - DEFAULT_BODY_INDENT
-      end
-    @body_indent   = DEFAULT_BODY_INDENT
-    @tag_paragraph = false
-    @order         = :index  # | :alpha
-  end
-
-  def validate_args(od_args)
-    size = od_args.size
-    min, max = @arg_arity
-    max = 1.0/0.0 if -1 == max
-    raise(ArgumentError, 
-      "Missing expected arguments. Found #{size} but expected #{min}.\n"+
-      "#{usage}") if size < min
-    raise(ArgumentError, "Too many arguments. Found #{size} but "+
-      "expected #{max}.\n#{usage}") if size > max
-  end
-
   def options(*opts)
     opts.each { |opt| option(*[opt].flatten) }
   end
@@ -103,10 +59,10 @@ class Application
     args.each { |arg|
       new_list << 
       case arg
-        when :help    then _help
-        when :debug   then _debug
-        when :verbose then _verbose
-        when :version then _version
+        when :help    then __help
+        when :debug   then __debug
+        when :verbose then __verbose
+        when :version then __version
         else arg
       end
     }
@@ -177,7 +133,7 @@ class Application
         @arg_arity = [1,1]
       when Array
         v = expected_args[0]
-        validate_arg_arity(v)
+        __validate_arg_arity(v)
         @arg_arity = v
       else 
         raise(InvalidArgumentArityError, 
@@ -190,22 +146,12 @@ class Application
     end
   end
 
-  def validate_arg_arity(arity)
-    min, max = *arity
-    raise(InvalidArgumentArityError, "Minimum argument arity '#{min}' must be "+
-      "greater than or equal to 0.") unless min >= 0
-    raise(InvalidArgumentArityError, "Maximum argument arity '#{max}' must be "+
-      "greater than or equal to -1.") if max < -1
-    raise(InvalidArgumentArityError, "Maximum argument arity '#{max}' must be "+
-      "greater than minimum arg_arity '#{min}'.") if max < min && max != -1
-  end
-
   def usage
     " Usage: #{name} #{synopsis}"
   end
 
   def man
-    require 'commandline/text/format'
+    require 'text/format'
     f = Text::Format.new
     f = Text::Format.new
     f.columns = @columns
@@ -219,7 +165,7 @@ class Application
     nm = "#{short_description}".empty? ? name : "#{name} - #{short_description}"
     s << f.format(nm)
 
-    sn = "#{synopsis}"
+    sn = "#{synopsis}".empty? ? "" : "#{name} #{synopsis}"
     unless sn.empty?
       s << "SYNOPSIS\n"
       s << f.format(sn)
@@ -251,14 +197,14 @@ class Application
   end
   alias :help :man
 
-  def pathname
-    @@appname
-  end
-
   def name
     File.basename(pathname)
   end
 
+  def pathname
+    @@appname
+  end
+
   def get_arg
     CommandLine::OptionParser::GET_ARGS
   end
@@ -278,7 +224,7 @@ class Application
       $VERBOSE = verbose
     end
     obj = self.new
-    obj.parse_command_line(argv)
+    obj.__parse_command_line(argv)
     obj.main
 
     #alias :user_init :initialize
@@ -303,7 +249,61 @@ class Application
     #self.class_eval %{ def main; end }
   end
 
-  def _help
+  def __parse_command_line(argv)
+    if argv.empty? && [0,0] != @arg_arity
+      puts usage
+      exit(0)
+    end
+
+    @option_data = @option_parser.parse(argv)
+
+    __validate_args(@option_data.args)
+    @arg_names.each_with_index { |name, idx|
+      instance_variable_set("@#{name}", @option_data.args[idx])
+    }
+  end
+
+  def __validate_arg_arity(arity)
+    min, max = *arity
+    raise(InvalidArgumentArityError, "Minimum argument arity '#{min}' must be "+
+      "greater than or equal to 0.") unless min >= 0
+    raise(InvalidArgumentArityError, "Maximum argument arity '#{max}' must be "+
+      "greater than or equal to -1.") if max < -1
+    raise(InvalidArgumentArityError, "Maximum argument arity '#{max}' must be "+
+      "greater than minimum arg_arity '#{min}'.") if max < min && max != -1
+  end
+
+  def __init_format
+    #
+    # Formatting defaults
+    #
+    console_width = ENV["COLUMNS"]
+    @columns = 
+      if console_width.nil?
+        DEFAULT_CONSOLE_WIDTH
+      elsif console_width < MIN_CONSOLE_WIDTH
+        console_width
+      else
+        console_width - DEFAULT_BODY_INDENT
+      end
+    @body_indent   = DEFAULT_BODY_INDENT
+    @tag_paragraph = false
+    @order         = :index  # | :alpha
+  end
+
+  def __validate_args(od_args)
+    size = od_args.size
+    min, max = @arg_arity
+    max = 1.0/0.0 if -1 == max
+    raise(ArgumentError, 
+      "Missing expected arguments. Found #{size} but expected #{min}.\n"+
+      "#{usage}") if size < min
+    raise(ArgumentError, "Too many arguments. Found #{size} but "+
+      "expected #{max}.\n#{usage}") if size > max
+  end
+
+
+  def __help
      {
        :names           => %w(--help -h),
        :arity           => [0,0],
@@ -314,7 +314,7 @@ class Application
      }
   end
 
-  def _verbose
+  def __verbose
      {
        :names           => %w(--verbose -v),
        :arity           => [0,0],
@@ -326,7 +326,7 @@ class Application
      }
   end
 
-  def _version
+  def __version
      {
        :names           => %w(--version -V),
        :arity           => [0,0],
@@ -344,7 +344,7 @@ class Application
      }
   end
 
-  def _debug
+  def __debug
      {
        :names           => %w(--debug -d),
        :arity           => [0,0],

data/lib/commandline/optionparser/optionparser.rb

@@ -252,8 +252,8 @@ raise "Wrong data type '#{option.name}." unless Option === option
         @unknown_options << user_option
       elsif :ignore == @unknown_options_action
       else
-        raise(UnknownOptionError, "Unknown option '#{user_option}' in "+
-          "#{@opt_lookup_by_any_name.inspect}.") 
+        raise(UnknownOptionError, "Unknown option '#{user_option}'"+
+          "#{$DEBUG ? ' in ' + @opt_lookup_by_any_name.keys.inspect : ''}.") 
       end
     }
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: CommandLine
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
-date: 2005-07-13
+  version: 0.7.1
+date: 2005-07-14
 summary: Tools to facilitate creation of command line applications and flexible parsing of command line options.
 require_paths: 
   - lib