Class: RSpec::Core::Reporter

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/reporter.rb

Overview

A reporter will send notifications to listeners, usually formatters for the spec suite run.

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Reporter

Returns a new instance of Reporter



5
6
7
8
9
10
11
12
# File 'lib/rspec/core/reporter.rb', line 5

def initialize(configuration)
  @configuration = configuration
  @listeners = Hash.new { |h, k| h[k] = Set.new }
  @examples = []
  @failed_examples = []
  @pending_examples = []
  @duration = @start = @load_time = nil
end

Instance Method Details

#register_listener(listener, *notifications) ⇒ void

Registers a listener to a list of notifications. The reporter will send notification of events to all registered listeners.

Parameters:

  • listener (Object)

    An obect that wishes to be notified of reporter events

  • notifications (Array)

    Array of symbols represents the events a listener wishes to subscribe too



31
32
33
34
35
36
# File 'lib/rspec/core/reporter.rb', line 31

def register_listener(listener, *notifications)
  notifications.each do |notification|
    @listeners[notification.to_sym] << listener
  end
  true
end

#report(count, &block) ⇒ void #report(count, &block) ⇒ void

Initializes the report run and yields itself for further reporting. The block is required, so that the reporter can manage cleaning up after the run.

Examples:


reporter.report(group.examples.size) do |r|
  example_groups.map {|g| g.run(r) }
end

Parameters:

  • expected_example_count (Integer)

    the number of examples being run

Yields:

  • (Block)

    block yields itself for further reporting.



59
60
61
62
63
64
65
66
# File 'lib/rspec/core/reporter.rb', line 59

def report(expected_example_count)
  start(expected_example_count)
  begin
    yield self
  ensure
    finish
  end
end