Module: Spectus::Result::Base Private

Included in:
Fail, Pass
Defined in:
lib/spectus/result/base.rb

Overview

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

Result base’s module.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#actual ⇒ #object_id (readonly)

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.

Returns The value that the subject return through its challenge.

Returns:

  • (#object_id) —

    The value that the subject return through its challenge.



61
62
63
 
# File 'lib/spectus/result/base.rb', line 61

def actual
  @actual
end

#challenge ⇒ Symbol (readonly)

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.

Returns The method to call on the subject.

Returns:

  • (Symbol) —

    The method to call on the subject.



50
51
52
 
# File 'lib/spectus/result/base.rb', line 50

def challenge
  @challenge
end

#context ⇒ Array (readonly)

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.

Returns Parameters of the challenge.

Returns:

  • (Array) —

    Parameters of the challenge.



55
56
57
 
# File 'lib/spectus/result/base.rb', line 55

def context
  @context
end

#error ⇒ #exception? (readonly)

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.

Returns Any possible raised exception.

Returns:

  • (#exception, nil) —

    Any possible raised exception.



77
78
79
 
# File 'lib/spectus/result/base.rb', line 77

def error
  @error
end

#expected ⇒ Array, ... (readonly)

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.

Returns The definition of the expected value.

Returns:

  • (Array, Hash, Symbol) —

    The definition of the expected value.



66
67
68
 
# File 'lib/spectus/result/base.rb', line 66

def expected
  @expected
end

#got ⇒ #object_id (readonly)

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.

Returns The result of the boolean comparison between the actual value and the expected value.

Returns:

  • (#object_id) —

    The result of the boolean comparison between the actual value and the expected value.



72
73
74
 
# File 'lib/spectus/result/base.rb', line 72

def got
  @got
end

#level ⇒ :High, ... (readonly)

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.

Returns The level of the expectation.

Returns:

  • (:High, :Medium, :Low) —

    The level of the expectation.



82
83
84
 
# File 'lib/spectus/result/base.rb', line 82

def level
  @level
end

#subject ⇒ #object_id (readonly)

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.

Returns The untrusted object to be tested.

Returns:

  • (#object_id) —

    The untrusted object to be tested.



45
46
47
 
# File 'lib/spectus/result/base.rb', line 45

def subject
  @subject
end

Instance Method Details

#initialize(message, subject, challenge, context, actual, expected, got, error, level, negate, valid) ⇒ Object

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.

Initialize the result class.

Parameters:

  • message (String) —

    It is describing the actual/error value.

  • subject (#object_id) —

    The untrusted object to be tested.

  • challenge (Symbol) —

    The method to call on the subject.

  • context (Array) —

    Parameters of the challenge.

  • actual (#object_id) —

    The value that the subject return through its challenge.

  • expected (Array, Hash, Symbol) —

    The definition of the expected value.

  • got (#object_id) —

    The result of the boolean comparison between the actual value and the expected value.

  • error (#exception, nil) —

    Any possible raised exception.

  • level (:High, :Medium, :Low) —

    The level of the expectation.

  • negate (Boolean) —

    Evaluate to a negative assertion.

  • valid (Boolean) —

    Report if the test was true or false.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/spectus/result/base.rb', line 26

def initialize(message, subject, challenge, context, actual, expected,
  got, error, level, negate, valid)

  @message    = message
  @subject    = subject
  @challenge  = challenge
  @context    = context
  @actual     = actual
  @expected   = expected
  @got        = got
  @error      = error
  @level      = level
  @negate     = negate
  @valid      = valid
end

#negate? ⇒ 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 negate instance variable.

Returns:

  • (Boolean) —

    evaluated to a negative assertion or not.



87
88
89
 
# File 'lib/spectus/result/base.rb', line 87

def negate?
  @negate
end

#to_h ⇒ Hash

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.

Properties of the result.

Returns:

  • (Hash) —

    the properties of the result.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/spectus/result/base.rb', line 102

def to_h
  {
    subject:    subject,
    challenge:  challenge,
    context:    context,
    actual:     actual,
    expected:   expected,
    got:        got,
    error:      error,
    level:      level,
    negate:     negate?,
    valid:      valid?,
    result:     result?
  }
end

#valid? ⇒ 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 boolean comparison between the actual value and the expected value.

Returns:

  • (Boolean) —

    the test was true or false.



95
96
97
 
# File 'lib/spectus/result/base.rb', line 95

def valid?
  @valid
end