Class: RSpec::Core::Formatters::Protocol

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

Overview

This class isn't loaded at runtime but serves to document all of the notifications implemented as part of the standard interface. The reporter will issue these during a normal test suite run, but a formatter will only receive those notifications it has registered itself to receive. To register a formatter call:

::RSpec::Core::Formatters.register class, :list, :of, :notifications

e.g.

::RSpec::Core::Formatters.register self, :start, :example_started

See Also:

Suite Notifications (collapse)

Group Notifications (collapse)

Example Notifications (collapse)

Instance Method Summary (collapse)

Constructor Details

- (void) initialize

Parameters:

  • output (IO) —

    the formatter output


    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 20


    		
  







  

    
Instance Method Details

      

  

    - (void) close 


  

    
Invoked at the very end, close allows the formatter to clean
up resources, e.g. open streams, etc.

  





  
Parameters:


    
    
  • 
        notification
        (NullNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 170


    		
  





      

  

    - (void) dump_failures 


  

    
Dumps detailed information about each example failure.

  





  
Parameters:


    
    
  • 
        notification
        (NullNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 133


    		
  





      

  

    - (void) dump_pending 


  

    
Outputs a report of pending examples. This gets invoked
after the summary if option is set to do so.

  





  
Parameters:


    
    
  • 
        notification
        (NullNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 161


    		
  





      

  

    - (void) dump_profile 


  

    
This method is invoked after the dumping the summary if profiling is
enabled.

  





  
Parameters:


    
    
  • 
        profile
        (ProfileNotification)
        —
        
    containing duration,
slowest_examples and slowest_example_groups
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 151


    		
  





      

  

    - (void) dump_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
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 141


    		
  





      

  

    - (void) example_failed 


  

    
Invoked when an example fails.

  





  
Parameters:


    
    
  • 
        notification
        (ExampleNotification)
        —
        
    containing example subclass
of RSpec::Core::Example
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 96


    		
  





      

  

    - (void) example_finished 


  

    
Invoked at the end of the execution of each example.

  





  
Parameters:


    
    
  • 
        notification
        (ExampleNotification)
        —
        
    containing example subclass
of RSpec::Core::Example
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 69


    		
  





      

  

    - (void) example_group_finished 


  

    
Invoked at the end of the execution of each example group.

  





  
Parameters:


    
    
  • 
        notification
        (GroupNotification)
        —
        
    containing example_group
subclass of RSpec::Core::ExampleGroup
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 51


    		
  





      

  

    - (void) example_group_started 


  

    
This method is invoked at the beginning of the execution of each
example group.


The next method to be invoked after this is #example_passed,
#example_pending, or #example_group_finished.

  





  
Parameters:


    
    
  • 
        notification
        (GroupNotification)
        —
        
    containing example_group
subclass of RSpec::Core::ExampleGroup
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 38


    		
  





      

  

    - (void) example_passed 


  

    
Invoked when an example passes.

  





  
Parameters:


    
    
  • 
        notification
        (ExampleNotification)
        —
        
    containing example subclass
of RSpec::Core::Example
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 78


    		
  





      

  

    - (void) example_pending 


  

    
Invoked when an example is pending.

  





  
Parameters:


    
    
  • 
        notification
        (ExampleNotification)
        —
        
    containing example subclass
of RSpec::Core::Example
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 87


    		
  





      

  

    - (void) example_started 


  

    
Invoked at the beginning of the execution of each example.

  





  
Parameters:


    
    
  • 
        notification
        (ExampleNotification)
        —
        
    containing example subclass
of RSpec::Core::Example
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 60


    		
  





      

  

    - (void) message 


  

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

  





  
Parameters:


    
    
  • 
        notification
        (MessageNotification)
        —
        
    containing message
    

    
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 105


    		
  





      

  

    - (void) start 


  

    
This method is invoked before any examples are run, right after
they have all been collected. This can be useful for special
formatters that need to provide progress on feedback (graphical ones).


This will only be invoked once, and the next one to be invoked
is #example_group_started.

  





  
Parameters:


    
    
  • 
        notification
        (StartNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 25


    		
  





      

  

    - (void) start_dump 


  

    
This method is invoked after all of the examples have executed. The
next method to be invoked after this one is #dump_failures
(BaseTextFormatter then calls #dump_failures once for each failed
example).

  





  
Parameters:


    
    
  • 
        notification
        (NullNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 122


    		
  





      

  

    - (void) stop 


  

    
Invoked after all examples have executed, before dumping post-run
reports.

  





  
Parameters:


    
    
  • 
        notification
        (NullNotification)
    
    • 




  

    
      

    		
    
      
# File 'lib/rspec/core/formatters/protocol.rb', line 113