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

• #exception ⇒ Exception^?

  The failure, if there was one.

• #finished_at ⇒ Time

  When the example finished.

• #pending_exception ⇒ Exception^?

  The exception triggered while executing the pending example.

• #pending_fixed ⇒ Boolean

  For examples tagged with :pending, this indicates whether or not it now passes.

• #pending_message ⇒ String^?

  The reason the example was pending, or nil if the example was not pending.

• #run_time ⇒ Float

  How long the example took in seconds.

• #started_at ⇒ Time

  When the example started.

• #status ⇒ Symbol

  :passed, :failed or :pending.

Instance Method Summary

• #ensure_timing_set(clock) ⇒ void private

  Populates finished_at and run_time if it has not yet been set.

• #example_skipped? ⇒ Boolean

  Indicates if the example was completely skipped (typically done via :skip metadata or the skip method).

• #pending_fixed? ⇒ Boolean
• #record_finished(status, finished_at) ⇒ void private

  Records the finished status of the example.

Instance Attribute Details

#exception ⇒ Exception^?

# File 'lib/rspec/core/example.rb', line 563

def exception
  @exception
end

#finished_at ⇒ Time

# File 'lib/rspec/core/example.rb', line 569

def finished_at
  @finished_at
end

#pending_exception ⇒ Exception^?

# File 'lib/rspec/core/example.rb', line 582

def pending_exception
  @pending_exception
end

#pending_fixed ⇒ Boolean

# File 'lib/rspec/core/example.rb', line 586

def pending_fixed
  @pending_fixed
end

#pending_message ⇒ String^?

# File 'lib/rspec/core/example.rb', line 576

def pending_message
  @pending_message
end

#run_time ⇒ Float

# File 'lib/rspec/core/example.rb', line 572

def run_time
  @run_time
end

#started_at ⇒ Time

# File 'lib/rspec/core/example.rb', line 566

def started_at
  @started_at
end

#status ⇒ Symbol

# File 'lib/rspec/core/example.rb', line 560

def status
  @status
end

Instance Method Details

#ensure_timing_set(clock) ⇒ void

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

# File 'lib/rspec/core/example.rb', line 610

def ensure_timing_set(clock)
  calculate_run_time(clock.now) unless finished_at
end

#example_skipped? ⇒ Boolean

# File 'lib/rspec/core/example.rb', line 597

def example_skipped?
  status == :pending && !pending_exception
end

#pending_fixed? ⇒ Boolean

# File 'lib/rspec/core/example.rb', line 588

def pending_fixed?
  !!pending_fixed
end

#record_finished(status, finished_at) ⇒ void

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.

# File 'lib/rspec/core/example.rb', line 603

def record_finished(status, finished_at)
  self.status = status
  calculate_run_time(finished_at)
end