Exception: Spectus::Result::Fail Private

Inherits:
StandardError
  • Object
show all
Includes:
Base
Defined in:
lib/spectus/result/fail.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

The class that is responsible for reporting that the expectation is false.

Instance Attribute Summary

Attributes included from Base

#actual, #challenge, #error, #expected, #got, #level, #subject

Instance Method Summary collapse

Methods included from Base

#initialize, #negate?, #to_h, #valid?

Instance Method Details

#error? ⇒ Boolean

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.

The state of error.

Returns:

  • (Boolean) —

    The test was an error.



26
27
28
 
# File 'lib/spectus/result/fail.rb', line 26

def error?
  !failure?
end

#failure? ⇒ Boolean

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.

The state of failure.

Returns:

  • (Boolean) —

    The test was a failure.



19
20
21
 
# File 'lib/spectus/result/fail.rb', line 19

def failure?
  error.nil?
end

#result? ⇒ Boolean

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.

The value of the expectation of the spec.

Returns:

  • (Boolean) —

    The spec was false.



12
13
14
 
# File 'lib/spectus/result/fail.rb', line 12

def result?
  false
end

#to_char(color = false) ⇒ String

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.

Express the result with one char.

Parameters:

  • color (Boolean) (defaults to: false) —

    Enable the color.

Returns:

  • (String) —

    The char that identify the result.



42
43
44
45
46
47
48
 
# File 'lib/spectus/result/fail.rb', line 42

def to_char(color = false)
  if failure?
    color ? "\e[35mF\e[0m" : 'F'
  else
    color ? "\e[31mE\e[0m" : 'E'
  end
end

#to_sym ⇒ Symbol

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.

Identify the state of the result.

Returns:

  • (Symbol) —

    The identifier of the state.



33
34
35
 
# File 'lib/spectus/result/fail.rb', line 33

def to_sym
  failure? ? :failure : :error
end