Class: RSpec::Core::Notifications::FailedExampleNotification

Inherits:
ExampleNotification show all
Defined in:
lib/rspec/core/notifications.rb

Overview

The FailedExampleNotification extends ExampleNotification with things useful for failed specs.

Examples:

def example_failed(notification)
  puts "Hey I failed :("
  puts "Here's my stack trace"
  puts notification.exception.backtrace.join("\n")
end

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#exampleRSpec::Core::Example

the current example

Returns:



149
150
151
# File 'lib/rspec/core/notifications.rb', line 149

def example
  @example
end

Instance Method Details

#colorized_formatted_backtrace(colorizer = ::RSpec::Core::Formatters::ConsoleCodes) ⇒ Array<String>

Returns the failures colorized formatted backtrace.

Parameters:

  • colorizer (#wrap) (defaults to: ::RSpec::Core::Formatters::ConsoleCodes)

    An object to colorize the message_lines by

Returns:

  • (Array<String>)

    the examples colorized backtrace lines



190
191
192
193
194
# File 'lib/rspec/core/notifications.rb', line 190

def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
  formatted_backtrace.map do |backtrace_info|
    colorizer.wrap "# #{backtrace_info}", RSpec.configuration.detail_color
  end
end

#colorized_message_lines(colorizer = ::RSpec::Core::Formatters::ConsoleCodes) ⇒ Array<String>

Returns the message generated for this failure colorized line by line.

Parameters:

  • colorizer (#wrap) (defaults to: ::RSpec::Core::Formatters::ConsoleCodes)

    An object to colorize the message_lines by

Returns:

  • (Array<String>)

    The example failure message colorized



173
174
175
176
177
# File 'lib/rspec/core/notifications.rb', line 173

def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
  add_shared_group_lines(failure_lines, colorizer).map do |line|
    colorizer.wrap line, message_color
  end
end

#descriptionString

Returns The example description

Returns:

  • (String)

    The example description



158
159
160
# File 'lib/rspec/core/notifications.rb', line 158

def description
  example.full_description
end

#exceptionException

Returns The example failure

Returns:

  • (Exception)

    The example failure



153
154
155
# File 'lib/rspec/core/notifications.rb', line 153

def exception
  example.execution_result.exception
end

#formatted_backtraceArray<String>

Returns the failures formatted backtrace.

Returns:

  • (Array<String>)

    the examples backtrace lines



182
183
184
# File 'lib/rspec/core/notifications.rb', line 182

def formatted_backtrace
  backtrace_formatter.format_backtrace(exception.backtrace, example.)
end

#fully_formatted(failure_number, colorizer = ::RSpec::Core::Formatters::ConsoleCodes) ⇒ String

Returns The failure information fully formatted in the way that RSpec's built-in formatters emit.

Returns:

  • (String)

    The failure information fully formatted in the way that RSpec's built-in formatters emit.



198
199
200
# File 'lib/rspec/core/notifications.rb', line 198

def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
  "\n  #{failure_number}) #{description}\n#{formatted_message_and_backtrace(colorizer)}"
end

#message_linesArray<String>

Returns the message generated for this failure line by line.

Returns:

  • (Array<String>)

    The example failure message



165
166
167
# File 'lib/rspec/core/notifications.rb', line 165

def message_lines
  add_shared_group_lines(failure_lines, NullColorizer)
end