123456789_123456789_123456789_123456789_123456789_

Class: RSpec::Core::Formatters::BaseTextFormatter

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
RSpec::Core::Formatters::BisectDebugFormatter, RSpec::Core::Formatters::BisectProgressFormatter, RSpec::Core::Formatters::DocumentationFormatter, RSpec::Core::Formatters::ProgressFormatter
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, BaseFormatter
Instance Chain:
self, BaseFormatter
Inherits: RSpec::Core::Formatters::BaseFormatter
Defined in: rspec-core/lib/rspec/core/formatters/base_text_formatter.rb

Overview

Base for all of RSpec’s built-in formatters. See RSpec::Core::Formatters::BaseFormatter to learn more about all of the methods called by the reporter.

See Also:

Class Method Summary

BaseFormatter - Inherited

.new

Instance Attribute Summary

BaseFormatter - Inherited

#example_group, #output

Instance Method Summary

BaseFormatter - Inherited

#close, #example_group_started, #start, #output_supports_sync, #restore_sync_output, #start_sync_output

Constructor Details

This class inherits a constructor from RSpec::Core::Formatters::BaseFormatter

Instance Method Details

#close(_notification)

Invoked at the end of a suite run. Allows the formatter to do any tidying up, but be aware that formatter output streams may be used elsewhere so don’t actually close them.

Parameters:

  • _notification (NullNotification) —

    (Ignored)

[ GitHub ] 

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 65



def close(_notification)
  return if output.closed?

  output.puts

  output.flush
end


  








  

    #dump_failures(notification)  
  



  

    

Dumps detailed information about each example failure.


  





  
Parameters:


    
  
  • 
    notification
    (NullNotification)
  
    • 





  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 30



def dump_failures(notification)
  return if notification.failure_notifications.empty?
  output.puts notification.fully_formatted_failed_examples
end


  








  

    #dump_pending(notification)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 47



def dump_pending(notification)
  return if notification.pending_examples.empty?
  output.puts notification.fully_formatted_pending_examples
end


  








  

    #dump_summary(summary)  
  



  

    

This method is invoked after the dumping of examples and failures. Each parameter is assigned to a corresponding attribute.


  





  
Parameters:


    
  
  • 
    summary
    (SummaryNotification)
—    
    

    containing duration, example_count, failure_count and pending_count
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 42



def dump_summary(summary)
  output.puts summary.fully_formatted
end


  








  

    #message(notification)  
  



  

    

Used by the reporter to send messages to the output stream.


  





  
Parameters:


    
  
  • 
    notification
    (MessageNotification)
—    
    

    containing message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 21



def message(notification)
  output.puts notification.message
end


  








  

    #seed(notification)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/base_text_formatter.rb', line 53



def seed(notification)
  return unless notification.seed_used?
  output.puts notification.fully_formatted
end