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.



2117
2118
2119
2120
2121
2122
 
# File 'lib/optparse.rb', line 2117

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

Instance Attribute Details

#additional ⇒ Object

Returns the value of attribute additional.



2126
2127
2128
 
# File 'lib/optparse.rb', line 2126

def additional
  @additional
end

#args ⇒ Object (readonly)

Returns the value of attribute args.



2124
2125
2126
 
# File 'lib/optparse.rb', line 2124

def args
  @args
end

#reason ⇒ Object

Returns error reason. Override this for I18N.



2159
2160
2161
 
# File 'lib/optparse.rb', line 2159

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

Class Method Details

.filter_backtrace(array) ⇒ Object 



2136
2137
2138
2139
2140
2141
 
# File 'lib/optparse.rb', line 2136

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

Instance Method Details

#inspect ⇒ Object 



2163
2164
2165
 
# File 'lib/optparse.rb', line 2163

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

#message ⇒ Object Also known as: to_s

Default stringizing method to emit standard error message.



2170
2171
2172
 
# File 'lib/optparse.rb', line 2170

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

#recover(argv) ⇒ Object

Pushes back erred argument(s) to argv.



2131
2132
2133
2134
 
# File 'lib/optparse.rb', line 2131

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

#set_backtrace(array) ⇒ Object 



2143
2144
2145
 
# File 'lib/optparse.rb', line 2143

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

#set_option(opt, eq) ⇒ Object 



2147
2148
2149
2150
2151
2152
2153
2154
 
# File 'lib/optparse.rb', line 2147

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