Class: RSpec::Core::Formatters::BaseFormatter

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

Overview

RSpec's built-in formatters are all subclasses of RSpec::Core::Formatters::BaseFormatter.

See Also:

Direct Known Subclasses

BaseTextFormatter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(output) ⇒ BaseFormatter

Returns a new instance of BaseFormatter.

Parameters:

  • output (IO) —

    the formatter output

See Also:

23
24
25
26
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 23
def initialize(output)
  @output = output || StringIO.new
  @example_group = nil
end

Instance Attribute Details

#example_group ⇒ void

Returns the value of attribute example_group.

17
18
19
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 17
def example_group
  @example_group
end

#output ⇒ void (readonly)

Returns the value of attribute output.

18
19
20
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 18
def output
  @output
end

Instance Method Details

#close(_notification) ⇒ void

Parameters:

  • _notification (NullNotification) —

    (Ignored)

See Also:

50
51
52
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 50
def close(_notification)
  restore_sync_output
end

#example_group_started(notification) ⇒ void

Parameters:

  • notification (GroupNotification) —

    containing example_group subclass of RSpec::Core::ExampleGroup

See Also:

42
43
44
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 42
def example_group_started(notification)
  @example_group = notification.group
end

#start(notification) ⇒ void

Parameters:

  • notification (StartNotification)

See Also:

32
33
34
35
 
# File 'lib/rspec/core/formatters/base_formatter.rb', line 32
def start(notification)
  start_sync_output
  @example_count = notification.count
end