Class: Ruber::RSpec::Version2Formatter

Inherits:

BaseFormatter

Object
BaseFormatter
Ruber::RSpec::Version2Formatter

show all

Defined in:

plugins/rspec/ruber_rspec_formatter.rb

Constant Summary

Constants inherited from BaseFormatter

ENDING_DELIMITER, STARTING_DELIMITER

Instance Method Summary (collapse)

- (nil) example_failed(ex)
Method called by RSpec after an example has been completed and failed.
- (nil) example_pending(ex)
Method called by RSpec after a pending example has been executed.

Methods inherited from BaseFormatter

#dump_failure, #dump_failures, #dump_pending, #dump_summary, #example_passed, #example_started, #start, #write_data

Instance Method Details

- (nil) example_failed(ex)

TODO:

add an entry contaning the code which caused the error (obtained using the

Method called by RSpec after an example has been completed and failed

It writes to the output a YAML dump of a hash with the following entries:

:type: :failure
:description: the name of the failed example, made of the name of the example group and the description of the example itself
:exception: the name of the exception class which caused the failure
:message: the error message contained in the exception which caused the failure
:location: a string with the location (file name and line number) where the failure happened
:backtrace: a string containing the entries of the exception’s backtrace, joined by newlines read_failed_line method defined in RSpec::Core::Formatters::BaseFormatter).

Parameters:

ex (RSpec::Core::Example) —
the failed example

Returns:

(nil)

# File 'plugins/rspec/ruber_rspec_formatter.rb', line 270

def example_failed ex
  super
  hash = {}
  hash[:type] = :failure
  hash[:description] = ex.metadata[:full_description]
  # It seems that rspec up tp 2.2 uses :exception_encountered, while from
  # 2.3 it uses :exception. This should work for both
  exception = ex.metadata[:execution_result][:exception]
  exception ||= ex.metadata[:execution_result][:exception_encountered]
  hash[:exception] = exception.class.name
  hash[:message] = exception.message
  hash[:location] = ex.metadata[:location]
  hash[:backtrace] =  format_backtrace(exception.backtrace, ex).join "\n"
  write_data hash
end

- (nil) example_pending(ex)

Method called by RSpec after a pending example has been executed

It writes to the output a YAML dump of a hash with the following entries:

:type: :pending
:description: the name of the pending example, made of the name of the example group and the description of the example itself
:message: the message produced by pending
:location: a string with the location (file name and line number) of pending example

Parameters:

ex (RSpec::Core::Example) —
the pending example

Returns:

(nil)

# File 'plugins/rspec/ruber_rspec_formatter.rb', line 299

def example_pending ex
  super
  hash = {}
  hash[:type] = :pending
  hash[:description] = ex.metadata[:full_description]
  hash[:message] = ex.metadata[:execution_result][:pending_message]
  hash[:location] = ex.metadata[:location]
  write_data hash
end