Class: RSpec::Core::Example::ExecutionResult
- Inherits:
- 
      Object
        - Object
- RSpec::Core::Example::ExecutionResult
 
- Defined in:
- lib/rspec/core/example.rb
Overview
Represents the result of executing an example. Behaves like a hash for backwards compatibility.
Instance Attribute Summary (collapse)
- 
  
      - (Exception?) exception 
  
    The failure, if there was one. 
- 
  
      - (Time) finished_at 
  
    When the example finished. 
- 
  
      - (Exception?) pending_exception 
  
    The exception triggered while executing the pending example. 
- 
  
      - (Boolean) pending_fixed 
      (also: #pending_fixed?)
  
    For examples tagged with :pending, this indicates whether or not it now passes.
- 
  
      - (String?) pending_message 
  
    The reason the example was pending, or nil if the example was not pending. 
- 
  
      - (Float) run_time 
  
    How long the example took in seconds. 
- 
  
      - (Time) started_at 
  
    When the example started. 
- 
  
      - (Symbol) status 
  
    :passed,:failedor:pending.
Instance Method Summary (collapse)
- 
  
      - (void) ensure_timing_set(clock) 
  
  private
    Populates finished_at and run_time if it has not yet been set. 
- 
  
      - (Boolean) example_skipped? 
  
    Indicates if the example was completely skipped (typically done via :skipmetadata or theskipmethod).
- 
  
      - (void) record_finished(status, finished_at) 
  
  private
    Records the finished status of the example. 
Instance Attribute Details
- (Exception?) exception
Returns The failure, if there was one.
| 552 553 554 | # File 'lib/rspec/core/example.rb', line 552 def exception @exception end | 
- (Time) finished_at
Returns When the example finished.
| 558 559 560 | # File 'lib/rspec/core/example.rb', line 558 def finished_at @finished_at end | 
- (Exception?) pending_exception
Returns The exception triggered while
executing the pending example. If no exception was triggered
it would no longer get a status of :pending unless it was
tagged with :skip.
| 571 572 573 | # File 'lib/rspec/core/example.rb', line 571 def pending_exception @pending_exception end | 
- (Boolean) pending_fixed Also known as: pending_fixed?
Returns For examples tagged with :pending,
this indicates whether or not it now passes.
| 575 576 577 | # File 'lib/rspec/core/example.rb', line 575 def pending_fixed @pending_fixed end | 
- (String?) pending_message
Returns The reason the example was pending, or nil if the example was not pending.
| 565 566 567 | # File 'lib/rspec/core/example.rb', line 565 def @pending_message end | 
- (Float) run_time
Returns How long the example took in seconds.
| 561 562 563 | # File 'lib/rspec/core/example.rb', line 561 def run_time @run_time end | 
- (Time) started_at
Returns When the example started.
| 555 556 557 | # File 'lib/rspec/core/example.rb', line 555 def started_at @started_at end | 
- (Symbol) status
Returns :passed, :failed or :pending.
| 549 550 551 | # File 'lib/rspec/core/example.rb', line 549 def status @status end | 
Instance Method Details
- (void) ensure_timing_set(clock)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Populates finished_at and run_time if it has not yet been set
| 597 598 599 | # File 'lib/rspec/core/example.rb', line 597 def ensure_timing_set(clock) calculate_run_time(clock.now) unless finished_at end | 
- (Boolean) example_skipped?
Returns Indicates if the example was completely skipped
(typically done via :skip metadata or the skip method). Skipped examples
will have a :pending result. A :pending result can also come from examples
that were marked as :pending, which causes them to be run, and produces a
:failed result if the example passes.
| 584 585 586 | # File 'lib/rspec/core/example.rb', line 584 def example_skipped? status == :pending && !pending_exception end | 
- (void) record_finished(status, finished_at)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Records the finished status of the example.
| 590 591 592 593 | # File 'lib/rspec/core/example.rb', line 590 def record_finished(status, finished_at) self.status = status calculate_run_time(finished_at) end |