Class: SmartCore::Types::Primitive::SumValidator::Result Private

Inherits:
Object
  • Object
show all
Defined in:
lib/smart_core/types/primitive/sum_validator/result.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.

Since:

  • 0.2.0

Direct Known Subclasses

MultValidator::Result

Constant Summary collapse

NO_INVARIANT_ERRORS =

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

Returns:

  • (Array)

Since:

  • 0.2.0

[].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, concrete_validation_result, invariant_errors = NO_INVARIANT_ERRORS.dup) ⇒ 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.

]

Parameters:

Since:

  • 0.2.0



50
51
52
53
54
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 50

def initialize(type, concrete_validation_result, invariant_errors = NO_INVARIANT_ERRORS.dup)
  @type = type
  @concrete_validation_result = concrete_validation_result
  @invariant_errors = invariant_errors.dup.tap(&:freeze)
end

Instance Attribute Details

#concrete_validation_result ⇒ Object (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.

]

Since:

  • 0.2.0



27
28
29
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 27

def concrete_validation_result
  @concrete_validation_result
end

#invariant_errors ⇒ Array<String> (readonly) Also known as: errors, error_codes

Returns:

  • (Array<String>)

Since:

  • 0.2.0



33
34
35
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 33

def invariant_errors
  @invariant_errors
end

#type ⇒ SmartCore::Types::Primitive (readonly)

Returns:

Since:

  • 0.2.0



16
17
18
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 16

def type
  @type
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.2.0



94
95
96
97
98
99
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 94

def failure?
  # NOTE: at this moment type sum does not support invariant checking
  # TODO (0.x.0):
  #   concrete_validation_result.failure?
  !success?
end

#is_valid_check ⇒ Boolean Also known as: valid_check?

Returns:

  • (Boolean)

Since:

  • 0.2.0



71
72
73
74
75
76
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 71

def is_valid_check
  # NOTE: at this moment type sum does not support invariant checking
  # TODO (0.x.0):
  #   concrete_validation_result.is_valid_check
  concrete_validation_result
end

#success? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.2.0



83
84
85
86
87
88
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 83

def success?
  # NOTE: at this moment type sum does not support invariant checking
  # TODO (0.x.0):
  #   concrete_validation_result.success?
  concrete_validation_result
end

#valid_invariants? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.2.0



60
61
62
63
64
65
 
# File 'lib/smart_core/types/primitive/sum_validator/result.rb', line 60

def valid_invariants?
  # NOTE: at this moment type sum does not support invariant checking
  # TODO (0.x.0):
  #   concrete_validation_result.valid_invariants?
  true
end