Class: OpenapiFirst::Failure

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_first/failure.rb

Constant Summary collapse

FAILURE = 
:openapi_first_validation_failure

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_type, message: nil, errors: nil) ⇒ Failure

Returns a new instance of Failure.

Parameters:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/openapi_first/failure.rb', line 35

def initialize(error_type, message: nil, errors: nil)
  unless TYPES.key?(error_type)
    raise ArgumentError,
          "error_type must be one of #{TYPES.keys} but was #{error_type.inspect}"
  end

  @error_type = error_type
  @message = message
  @errors = errors
end

Instance Attribute Details

#error_type ⇒ Object (readonly)

Returns the value of attribute error_type.



46
47
48
 
# File 'lib/openapi_first/failure.rb', line 46

def error_type
  @error_type
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



46
47
48
 
# File 'lib/openapi_first/failure.rb', line 46

def errors
  @errors
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



46
47
48
 
# File 'lib/openapi_first/failure.rb', line 46

def message
  @message
end

Class Method Details

.fail!(error_type, message: nil, errors: nil) ⇒ Object

Parameters:



24
25
26
27
28
29
30
 
# File 'lib/openapi_first/failure.rb', line 24

def self.fail!(error_type, message: nil, errors: nil)
  throw FAILURE, new(
    error_type,
    message:,
    errors:
  )
end

Instance Method Details

#raise! ⇒ Object

Raise an exception that fits the failure.

Raises:

  • (exception) 


49
50
51
52
53
 
# File 'lib/openapi_first/failure.rb', line 49

def raise!
  exception, message_prefix = TYPES.fetch(error_type)

  raise exception, "#{message_prefix} #{@message || errors&.map(&:error)&.join('. ')}"
end