Exception: OptionParser::ParseError

Inherits:
RuntimeError
  • Object
show all
Defined in:
lib/optparse.rb

Overview

Base class of exceptions from OptionParser.

Constant Summary collapse

Reason =

Reason which caused the error.

'parse error'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, additional: nil) ⇒ ParseError

Returns a new instance of ParseError.


2028
2029
2030
2031
2032
2033
# File 'lib/optparse.rb', line 2028

def initialize(*args, additional: nil)
  @additional = additional
  @arg0, = args
  @args = args
  @reason = nil
end

Instance Attribute Details

#additionalObject

Returns the value of attribute additional


2037
2038
2039
# File 'lib/optparse.rb', line 2037

def additional
  @additional
end

#argsObject (readonly)

Returns the value of attribute args


2035
2036
2037
# File 'lib/optparse.rb', line 2035

def args
  @args
end

#reasonObject

Returns error reason. Override this for I18N.


2070
2071
2072
# File 'lib/optparse.rb', line 2070

def reason
  @reason || self.class::Reason
end

Class Method Details

.filter_backtrace(array) ⇒ Object


2047
2048
2049
2050
2051
2052
# File 'lib/optparse.rb', line 2047

def self.filter_backtrace(array)
  unless $DEBUG
    array.delete_if(&%r"\A#{Regexp.quote(__FILE__)}:"o.method(:=~))
  end
  array
end

Instance Method Details

#inspectObject


2074
2075
2076
# File 'lib/optparse.rb', line 2074

def inspect
  "#<#{self.class}: #{args.join(' ')}>"
end

#messageObject Also known as: to_s

Default stringizing method to emit standard error message.


2081
2082
2083
# File 'lib/optparse.rb', line 2081

def message
  "#{reason}: #{args.join(' ')}#{additional[@arg0] if additional}"
end

#recover(argv) ⇒ Object

Pushes back erred argument(s) to argv.


2042
2043
2044
2045
# File 'lib/optparse.rb', line 2042

def recover(argv)
  argv[0, 0] = @args
  argv
end

#set_backtrace(array) ⇒ Object


2054
2055
2056
# File 'lib/optparse.rb', line 2054

def set_backtrace(array)
  super(self.class.filter_backtrace(array))
end

#set_option(opt, eq) ⇒ Object


2058
2059
2060
2061
2062
2063
2064
2065
# File 'lib/optparse.rb', line 2058

def set_option(opt, eq)
  if eq
    @args[0] = opt
  else
    @args.unshift(opt)
  end
  self
end