Class: Spoom::Sorbet::Errors::Error

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/spoom/sorbet/errors.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file, line, message, code, more = []) ⇒ Error

Returns a new instance of Error.

Signature:

  • (String? file, Integer? line, String? message, Integer? code, ?Array[String] more) -> void



188
189
190
191
192
193
194
195
 
# File 'lib/spoom/sorbet/errors.rb', line 188

def initialize(file, line, message, code, more = [])
  @file = file
  @line = line
  @message = message
  @code = code
  @more = more
  @files_from_error_sections = Set.new #: Set[String]
end

Instance Attribute Details

#code ⇒ Object (readonly)

Signature:

  • Integer?



178
179
180
 
# File 'lib/spoom/sorbet/errors.rb', line 178

def code
  @code
end

#file ⇒ Object (readonly)

Signature:

  • String?



175
176
177
 
# File 'lib/spoom/sorbet/errors.rb', line 175

def file
  @file
end

#files_from_error_sections ⇒ Object (readonly)

Other files associated with the error

Signature:

  • Set[String]



185
186
187
 
# File 'lib/spoom/sorbet/errors.rb', line 185

def files_from_error_sections
  @files_from_error_sections
end

#line ⇒ Object (readonly)

Signature:

  • Integer?



178
179
180
 
# File 'lib/spoom/sorbet/errors.rb', line 178

def line
  @line
end

#message ⇒ Object (readonly)

Signature:

  • String?



175
176
177
 
# File 'lib/spoom/sorbet/errors.rb', line 175

def message
  @message
end

#more ⇒ Object (readonly)

Signature:

  • Array[String]



181
182
183
 
# File 'lib/spoom/sorbet/errors.rb', line 181

def more
  @more
end

Instance Method Details

#<=>(other) ⇒ Object

By default errors are sorted by location

Signature:

  • (untyped other) -> Integer



199
200
201
202
203
 
# File 'lib/spoom/sorbet/errors.rb', line 199

def <=>(other)
  return 0 unless other.is_a?(Error)

  [file, line, code, message] <=> [other.file, other.line, other.code, other.message]
end

#to_junit_xml_element ⇒ Object

Signature:

  • -> REXML::Element



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/spoom/sorbet/errors.rb', line 211

def to_junit_xml_element
  testcase_element = REXML::Element.new("testcase")
  # Unlike traditional test suites, we can't report all tests
  # regardless of outcome; we only have errors to report. As a
  # result we reinterpret the definitions of the test properties
  # bit: the error message becomes the test name and the full error
  # info gets plugged into the failure body along with file/line
  # information (displayed in Jenkins as the "Stacktrace" for the
  # error).
  testcase_element.add_attributes(
    "name" => message,
    "file" => file,
    "line" => line,
  )
  failure_element = testcase_element.add_element("failure")
  failure_element.add_attributes(
    "type" => code,
  )
  explanation_text = [
    "In file #{file}:\n",
    *more,
  ].join.chomp
  # Use CDATA so that parsers know the whitespace is significant.
  failure_element.add(REXML::CData.new(explanation_text))

  testcase_element
end

#to_s ⇒ Object

Signature:

  • -> String



206
207
208
 
# File 'lib/spoom/sorbet/errors.rb', line 206

def to_s
  "#{file}:#{line}: #{message} (#{code})"
end