CommandLine 0.6.0 → 0.7.0

data/lib/commandline/application.rb

@@ -33,25 +33,30 @@ class Application
   MIN_CONSOLE_WIDTH     = 10
   DEFAULT_BODY_INDENT   =  4
 
-  #def options
-  #  raise(OptionError,
-  #    "Options must be over-written with a valid (or empty) options list.")
-  #end
-
   def initialize
-    # Ensure initializations have taken place
-    @arg_arity     ||= [0,0]
-    @options       ||= []
-    @arg_names     ||= []
-    @option_parser ||= CommandLine::OptionParser.new(@options)
+
+    @synopsis       = ""
+    @arg_arity     = [0,0]
+    @options       = []
+    @arg_names     = []
+    @args          = []
+    @argv        ||= ARGV
+
     _init_format
 
-    if ARGV.empty? && [0,0] != @arg_arity
+    __child_initialize if 
+      self.class.private_instance_methods(false).include?("__child_initialize")
+
+    @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 
+    @option_data = @option_parser.parse(argv)
 
     validate_args(@option_data.args)
     @arg_names.each_with_index { |name, idx|
@@ -88,6 +93,10 @@ class Application
       "expected #{max}.\n#{usage}") if size > max
   end
 
+  def options(*opts)
+    opts.each { |opt| option(*[opt].flatten) }
+  end
+
   def option(*args)
     @options ||= []
     new_list = []
@@ -106,43 +115,55 @@ class Application
   end
 
   #
-  # Args tells the application how many arguments (not belonging
+  # expected_args tells the application how many arguments (not belonging
   # any option) are expected to be seen on the command line
   # The names of the args are used for describing the synopsis (or usage).
   # If there is an indeterminant amount of arguments, they are not
   # named, but returned in an array.
+  # expected_args takes either a list of argument names
+  #
+  # =Usage
+  #   expected_args :sym1
+  #   expected_args :sym1, :sym2, ...
+  #   expected_args n    #=> arg_arity => [n,n]
+  #   expected_args arity
+  #
+  # =Examples
+  #
   # Many forms are valid. Some examples follow:
-  #   args 0
-  #   synopsis: Usage: app
-
-  #   args :none
+  #   expected_args 0                #=> @args = []; same as not calling expected_args
   #   synopsis: Usage: app
 
-  #   args 1                #=> args is array
+  #   expected_args 1                #=> @args is array
   #   synopsis: Usage: app arg
 
-  #   args 2                #=> args is array
+  #   expected_args 2                #=> @args is array
   #   synopsis: Usage: app arg1 arg2
 
-  #   args 10               #=> args is array
+  #   expected_args 10               #=> @args is array
   #   synopsis: Usage: app arg1 ... arg10
 
-  #   args :file            #=> @file = <arg>
+  #   expected_args :file            #=> @file = <arg>
   #   synopsis: Usage: app file
 
-  #   args :file1, :file2   #=> @file1 = <arg1>, @file2 = <arg2>
+  #   expected_args :file1, :file2   #=> @file1 = <arg1>, @file2 = <arg2>
   #   synopsis: Usage: app file1 file2
 
-  #   args [0,1]            #=> args is array
-  #   synopsis: Usage: app [arg [arg]]
+  #   expected_args [0,1]            #=> @args is array
+  #   synopsis: Usage: app [arg1 [arg2]]
 
-  #   args [2,3]            #=> args is array
-  #   synopsis: Usage: app arg[2,3]
+  #   expected_args [2,3]            #=> @args is array
+  #   synopsis: Usage: app arg1 arg2 [arg3]
 
-  #   args [0,-1]           #=> args is array
-  #   synopsis: Usage: app [arg [arg...]]
+  #   expected_args [0,-1]           #=> @args is array
+  #   synopsis: Usage: app [arg1 [arg...]]
   #
-  def args(*expected_args)
+
+  #   expected_args :cmd
+  #   Now, what to do if command line has more args than expected
+  #   app --app-option cmd --cmd-option arg-for-cmd
+  #
+  def expected_args(*expected_args)
     @arg_names = []
     case expected_args.size
     when 0 then @arg_arity = [0,0]
@@ -247,28 +268,45 @@ class Application
     CommandLine::OptionParser::GET_ARG_ARRAY
   end
 
-  def self.run
-    @@app.new.main if ($0 == @@appname)
+  def self.run(argv=ARGV)
+    if self.private_instance_methods(false).include?("initialize")
+      $VERBOSE, verbose = nil, $VERBOSE
+      self.class_eval {
+        alias :__child_initialize :initialize
+        remove_method :initialize
+      }
+      $VERBOSE = verbose
+    end
+    obj = self.new
+    obj.parse_command_line(argv)
+    obj.main
+
+    #alias :user_init :initialize
+    #@@child_class.new.main if ($0 == @@appname)
+    obj
     rescue => err
       puts "ERROR: #{err}"
       exit(-1)
   end
 
-  def self.inherited(klass)
+  def self.inherited(child_class)
     @@appname = caller[0][/.*:/][0..-2]
-    @@app = klass
-    at_exit { @@app.run }
+    @@child_class = child_class
+    if @@appname == $0
+      at_exit { @@child_class.run }
+    end
   end
 
   def main
-    #raise(MissingMainError, "Method #main must be defined in class #{@@app}.")
-    @@app.class_eval %{ def main; end }
+    #raise(MissingMainError, "Method #main must be defined in class #{@@child_class}.")
+    @@child_class.class_eval %{ def main; end }
+    #self.class_eval %{ def main; end }
   end
 
   def _help
      {
        :names           => %w(--help -h),
-       :arg_arity       => [0,0],
+       :arity           => [0,0],
        :opt_description => "Displays help page.",
        :arg_description => "",
        :opt_found       => lambda { puts man; exit },
@@ -279,7 +317,7 @@ class Application
   def _verbose
      {
        :names           => %w(--verbose -v),
-       :arg_arity       => [0,0],
+       :arity           => [0,0],
        :opt_description => "Sets verbosity level. Subsequent "+
                            "flags increase verbosity level",
        :arg_description => "",
@@ -291,7 +329,7 @@ class Application
   def _version
      {
        :names           => %w(--version -V),
-       :arg_arity       => [0,0],
+       :arity           => [0,0],
        :opt_description => "Displays application version.",
        :arg_description => "",
        :opt_found       => lambda { 
@@ -309,7 +347,7 @@ class Application
   def _debug
      {
        :names           => %w(--debug -d),
-       :arg_arity       => [0,0],
+       :arity           => [0,0],
        :opt_description => "Sets debug to true.",
        :arg_description => "",
        :opt_found       => lambda { $DEBUG = true }

data/lib/commandline/optionparser/option.rb

@@ -36,12 +36,12 @@ class Option
   # need to change this to support - and --
   NON_POSIX_OPTION_RE = /^(-|-{1,2}[a-zA-Z_]+[-_a-zA-Z0-9]*)/
 
-  PROPERTIES = [ :arg_arity, :opt_description, :arg_description,
+  PROPERTIES = [ :arity, :opt_description, :arg_description,
                  :opt_found, :opt_not_found, :posix
                ]
 
   FLAG_BASE_OPTS = {
-    :arg_arity       => [0,0],
+    :arity       => [0,0],
 #    :opt_description => nil,
     :arg_description => "",
     :opt_found       => true,
@@ -50,7 +50,7 @@ class Option
 
   # You get these without asking for them
   DEFAULT_OPTS = {
-    :arg_arity       => [1,1],
+    :arity       => [1,1],
     :opt_description => "",
     :arg_description => "",
     :opt_found       => true,
@@ -77,6 +77,7 @@ class Option
       end
     end
 
+    @flag = nil unless defined?(@flag)
     type = @flag.nil? ? :default : :flag
     merge_hash = 
       case type
@@ -84,7 +85,7 @@ class Option
       when :default then DEFAULT_OPTS
       else raise(InvalidConstructionError, 
         "Invalid arguments to Option.new. Must be a property hash with "+
-        "keys [:names, :arg_arity, :opt_description, :arg_description, "+
+        "keys [:names, :arity, :opt_description, :arg_description, "+
         ":opt_found, :opt_not_found] or "+
         "an option type [:flag, :default].")
       end
@@ -102,17 +103,17 @@ class Option
     @properties[:names] = [@properties[:names]] unless 
       @properties[:names].kind_of?(Array)
 
-    arg_arity = @properties[:arg_arity]
-    @properties[:arg_arity] = [arg_arity, arg_arity] unless 
+    arg_arity = @properties[:arity]
+    @properties[:arity] = [arg_arity, arg_arity] unless 
       arg_arity.kind_of?(Array)
 
-    raise "Invalid value for arg_arity '#{arg_arity}'." unless 
+    raise "Invalid value for arity '#{arg_arity}'." unless 
       arg_arity.kind_of?(Array) || arg_arity.kind_of?(Fixnum)
 
     raise(InvalidArgumentArityError,
       "Conflicting value given to new option: :flag "+
-      "and :arg_arity = #{@properties[:arg_arity].inspect}.") if 
-        :flag == type && [0,0] != @properties[:arg_arity]
+      "and :arity = #{@properties[:arity].inspect}.") if 
+        :flag == type && [0,0] != @properties[:arity]
 
     names = @properties[:names]
     raise(MissingOptionNameError, 
@@ -120,7 +121,7 @@ class Option
       names.nil? || names.empty?
 
     names.each { |name| check_option_name(name) }
-    validate_arity @properties[:arg_arity]
+    validate_arity @properties[:arity]
 
     create_opt_description if :flag == type
   end
@@ -149,7 +150,7 @@ class Option
   end
 
   def validate_arity(arity)
-  raise ":arg_arity is nil" if arity.nil?
+  raise ":arity is nil" if arity.nil?
     min, max = *arity
 
     raise(InvalidArgumentArityError, "Minimum argument arity '#{min}' must be "+
@@ -157,9 +158,9 @@ class Option
     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
+      "greater than minimum arity '#{min}'.") if max < min && max != -1
     if @posix
-      raise(InvalidArgumentArityError, "Posix options only support :arg_arity "+
+      raise(InvalidArgumentArityError, "Posix options only support :arity "+
         "of [0,0] or [1,1].") unless ([0,0] == arity) || ([1,1] == arity)
     end
   end

data/lib/commandline/optionparser/optionparser.rb

@@ -142,10 +142,10 @@ class OptionParser
   #             :
   #
   #  add_option :names              => %w(--version -v),
-  #             :arg_arity          => [0,0],  # default
+  #             :arity              => [0,0],  # default
   #             :option_description => "Returns Version"
   #  add_option :names              => %w(--file -f),
-  #             :arg_arity          => [1,:unlimited],
+  #             :arity              => [1,:unlimited],
   #             :opt_description    => "Define the output filename.",
   #             :arg_description    => "Output file"
   #             :opt_exists         => lambda {}
@@ -276,13 +276,13 @@ raise "Wrong data type '#{option.name}." unless Option === option
   end
       
   def get_opt_args(opt, user_option, args)
-    min, max = *opt.arg_arity
+    min, max = *opt.arity
     size     = args.size
 
     if (min == max && max > 0 && size < max) || (size < min)
       raise(MissingRequiredOptionArgumentError,
         "Insufficient arguments #{args.inspect}for option '#{user_option}' "+
-        "with :arg_arity #{opt.arg_arity.inspect}")
+        "with :arity #{opt.arity.inspect}")
     end
 
     if 0 == min && 0 == max
@@ -297,7 +297,7 @@ raise "Wrong data type '#{option.name}." unless Option === option
     flags  = []
     nflags = []
     @options.each { |o| 
-      if [0,0] == o.arg_arity 
+      if [0,0] == o.arity 
         flags << o.names[0][1..1] 
       else
         nflags << o.names[0][1..1]
@@ -457,7 +457,7 @@ end
   def to_s(sep="\n")
     return "" if @options.empty?
 
-    require 'commandline/text/format'
+    require 'text/format'
     @f = Text::Format.new
     @f.columns = @columns
     @f.first_indent  = 4

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: CommandLine
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
-date: 2005-06-24
+  version: 0.7.0
+date: 2005-07-13
 summary: Tools to facilitate creation of command line applications and flexible parsing of command line options.
 require_paths: 
   - lib
@@ -36,12 +36,10 @@ files:
   - lib/commandline/application.rb
   - lib/commandline/optionparser
   - lib/commandline/optionparser.rb
-  - lib/commandline/text
   - lib/commandline/utils.rb
   - lib/commandline/optionparser/option.rb
   - lib/commandline/optionparser/optiondata.rb
   - lib/commandline/optionparser/optionparser.rb
-  - lib/commandline/text/format.rb
   - lib/test/unit
   - lib/test/unit/systemtest.rb
   - README
@@ -54,4 +52,14 @@ extra_rdoc_files:
 executables: []
 extensions: []
 requirements: []
-dependencies: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: text-format
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - "="
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+      version: