类: RSpec::Core::Formatters::Protocol

继承
Object
  • Object
显示全部
定义于
lib/rspec/core/formatters/protocol.rb

概述

此类在运行时不会加载，但用于记录作为标准接口的一部分实现的所有通知。 报道者将在正常测试套件运行期间发出这些通知，但格式化器只会接收它注册接收的通知。 要注册格式化器，请调用

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

例如：

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

另请参阅

套件通知 折叠

组通知 折叠

示例通知 折叠

实例方法摘要 折叠

构造函数详细信息

#initialize(output) ⇒void

参数

  • output (IO) —

    格式化器输出


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


    		
  







  

    
实例方法详细信息

      

  
#close(notification) ⇒void 


  

    
在套件运行结束时调用。 允许格式化器进行任何整理，但请注意，格式化器输出流可能在其他地方使用，因此不要实际关闭它们。

  





  
参数




  

    
      

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


    		
  





      

  
#dump_failures(notification) ⇒void 


  

    
转储每个示例失败的详细信息。

  





  
参数




  

    
      

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


    		
  





      

  
#dump_pending(notification) ⇒void 


  

    
输出挂起的示例报告。 如果选项设置为这样做，则会在摘要之后调用它。

  





  
参数




  

    
      

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


    		
  





      

  
#dump_profile(profile) ⇒void 


  

    
如果启用了性能分析，则在转储摘要后调用此方法。

  





  
参数




  

    
      

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


    		
  





      

  
#dump_summary(summary) ⇒void 


  

    
此方法在转储示例和失败后调用。 每个参数都分配给相应的属性。

  





  
参数




  

    
      

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


    		
  





      

  
#example_failed(notification) ⇒void 


  

    
当示例失败时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#example_finished(notification) ⇒void 


  

    
在每个示例执行结束时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#example_group_finished(notification) ⇒void 


  

    
在每个示例组执行结束时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#example_group_started(notification) ⇒void 


  

    
此方法在每个示例组执行开始时调用。


此方法之后调用的下一个方法是 #example_passed、#example_pending 或 #example_group_finished。

  





  
参数




  

    
      

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


    		
  





      

  
#example_passed(notification) ⇒void 


  

    
当示例通过时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#example_pending(notification) ⇒void 


  

    
当示例挂起时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#example_started(notification) ⇒void 


  

    
在每个示例执行开始时调用。

  





  
参数




  

    
      

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


    		
  





      

  
#message(notification) ⇒void 


  

    
由报道者用来向输出流发送消息。

  





  
参数




  

    
      

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


    		
  





      

  
#start(notification) ⇒void 


  

    
此方法在运行任何示例之前调用，紧随其后是收集所有示例。 这对于需要提供进度或反馈（图形化）的特殊格式化器很有用。


此方法只会被调用一次，下一个调用的方法是 #example_group_started。

  





  
参数




  

    
      

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


    		
  





      

  
#start_dump(notification) ⇒void 


  

    
此方法在所有示例执行后调用。 此方法之后调用的下一个方法是 #dump_failures（BaseTextFormatter 然后为每个失败的示例调用一次 #dump_failures）。

  





  
参数




  

    
      

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


    		
  





      

  
#stop(notification) ⇒void 


  

    
在所有示例执行后调用，在转储运行后报告之前。

  





  
参数




  

    
      

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