Class: RSpec::Core::Notifications::SummaryNotification
- Inherits:
-
Struct
- Object
- Struct
- RSpec::Core::Notifications::SummaryNotification
- Defined in:
- lib/rspec/core/notifications.rb,
lib/rspec/core/notifications.rb
Overview
The SummaryNotification
holds information about the results of running
a test suite. It is used by formatters to provide information at the end
of the test run.
Instance Attribute Summary (collapse)
-
- (Float) duration
the time taken (in seconds) to run the suite.
-
- (Array<RSpec::Core::Example>) examples
the examples run.
-
- (Array<RSpec::Core::Example>) failed_examples
the failed examples.
-
- (Float) load_time
the number of seconds taken to boot RSpec and load the spec files.
-
- (Array<RSpec::Core::Example>) pending_examples
the pending examples.
Instance Method Summary (collapse)
-
- (String) colorized_rerun_commands(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
Formats failures into a rerunable command format.
-
- (String) colorized_totals_line(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
Wraps the results line with colors based on the configured colors for failure, pending, and success.
-
- (Fixnum) example_count
The number of examples run.
-
- (Fixnum) failure_count
The number of failed examples.
-
- (String) formatted_duration
A formatted version of the time it took to run the suite.
-
- (String) formatted_load_time
A formatted version of the time it took to boot RSpec and load the spec files.
-
- (String) fully_formatted(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
The summary information fully formatted in the way that RSpec's built-in formatters emit.
-
- (Fixnum) pending_count
The number of pending examples.
-
- (String) totals_line
A line summarising the result totals of the spec run.
Instance Attribute Details
- (Float) duration
the time taken (in seconds) to run the suite
422 423 424 |
# File 'lib/rspec/core/notifications.rb', line 422 def duration @duration end |
- (Array<RSpec::Core::Example>) examples
the examples run
422 423 424 |
# File 'lib/rspec/core/notifications.rb', line 422 def examples @examples end |
- (Array<RSpec::Core::Example>) failed_examples
the failed examples
422 423 424 |
# File 'lib/rspec/core/notifications.rb', line 422 def failed_examples @failed_examples end |
- (Float) load_time
the number of seconds taken to boot RSpec and load the spec files
422 423 424 |
# File 'lib/rspec/core/notifications.rb', line 422 def load_time @load_time end |
- (Array<RSpec::Core::Example>) pending_examples
the pending examples
422 423 424 |
# File 'lib/rspec/core/notifications.rb', line 422 def pending_examples @pending_examples end |
Instance Method Details
- (String) colorized_rerun_commands(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
Formats failures into a rerunable command format.
477 478 479 480 481 482 483 |
# File 'lib/rspec/core/notifications.rb', line 477 def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes) "\nFailed examples:\n\n" + failed_examples.map do |example| colorizer.wrap("rspec #{example.rerun_argument}", RSpec.configuration.failure_color) + " " + colorizer.wrap("# #{example.full_description}", RSpec.configuration.detail_color) end.join("\n") end |
- (String) colorized_totals_line(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
Wraps the results line with colors based on the configured colors for failure, pending, and success. Defaults to red, yellow, green accordingly.
460 461 462 463 464 465 466 467 468 |
# File 'lib/rspec/core/notifications.rb', line 460 def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes) if failure_count > 0 colorizer.wrap(totals_line, RSpec.configuration.failure_color) elsif pending_count > 0 colorizer.wrap(totals_line, RSpec.configuration.pending_color) else colorizer.wrap(totals_line, RSpec.configuration.success_color) end end |
- (Fixnum) example_count
Returns the number of examples run
426 427 428 |
# File 'lib/rspec/core/notifications.rb', line 426 def example_count @example_count ||= examples.size end |
- (Fixnum) failure_count
Returns the number of failed examples
432 433 434 |
# File 'lib/rspec/core/notifications.rb', line 432 def failure_count @failure_count ||= failed_examples.size end |
- (String) formatted_duration
Returns a formatted version of the time it took to run the suite
487 488 489 |
# File 'lib/rspec/core/notifications.rb', line 487 def formatted_duration Formatters::Helpers.format_duration(duration) end |
- (String) formatted_load_time
Returns a formatted version of the time it took to boot RSpec and load the spec files
493 494 495 |
# File 'lib/rspec/core/notifications.rb', line 493 def formatted_load_time Formatters::Helpers.format_duration(load_time) end |
- (String) fully_formatted(colorizer = ::RSpec::Core::Formatters::ConsoleCodes)
Returns The summary information fully formatted in the way that RSpec's built-in formatters emit.
499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/rspec/core/notifications.rb', line 499 def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes) formatted = "\nFinished in #{formatted_duration} " \ "(files took #{formatted_load_time} to load)\n" \ "#{colorized_totals_line(colorizer)}\n" unless failed_examples.empty? formatted << colorized_rerun_commands(colorizer) << "\n" end formatted end |
- (Fixnum) pending_count
Returns the number of pending examples
438 439 440 |
# File 'lib/rspec/core/notifications.rb', line 438 def pending_count @pending_count ||= pending_examples.size end |
- (String) totals_line
Returns A line summarising the result totals of the spec run.
444 445 446 447 448 449 |
# File 'lib/rspec/core/notifications.rb', line 444 def totals_line summary = Formatters::Helpers.pluralize(example_count, "example") summary << ", " << Formatters::Helpers.pluralize(failure_count, "failure") summary << ", #{pending_count} pending" if pending_count > 0 summary end |