Module: EasyTalk::ErrorHelper

Defined in:
lib/easy_talk/errors_helper.rb

Overview

Helper module for generating consistent error messages

Class Method Summary collapse

Class Method Details

.extract_inner_type(type_info) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/easy_talk/errors_helper.rb', line 25

def self.extract_inner_type(type_info)
  # No change needed here
  if type_info.respond_to?(:type) && type_info.type.respond_to?(:raw_type)
    type_info.type.raw_type
  # special boolean handling
  elsif type_info.try(:type).try(:name) == 'T::Boolean'
    T::Boolean
  elsif type_info.respond_to?(:type_parameter)
    type_info.type_parameter
  elsif type_info.respond_to?(:raw_a) && type_info.respond_to?(:raw_b)
    # Handle SimplePairUnion types
    [type_info.raw_a, type_info.raw_b]
  elsif type_info.respond_to?(:types)
    # Handle complex union types
    type_info.types.map { |t| t.respond_to?(:raw_type) ? t.raw_type : t }
  else
    # Fallback to something sensible
    Object
  end
end

.raise_array_constraint_error(property_name:, constraint_name:, index:, expected:, got:) ⇒ Object

Raises:



12
13
14
15
16
 
# File 'lib/easy_talk/errors_helper.rb', line 12

def self.raise_array_constraint_error(property_name:, constraint_name:, index:, expected:, got:)
  message = "Error in property '#{property_name}': Constraint '#{constraint_name}' at index #{index} " \
            "expects #{expected}, but received #{got.inspect} (#{got.class})."
  raise ConstraintError, message
end

.raise_constraint_error(property_name:, constraint_name:, expected:, got:) ⇒ Object

Raises:



6
7
8
9
10
 
# File 'lib/easy_talk/errors_helper.rb', line 6

def self.raise_constraint_error(property_name:, constraint_name:, expected:, got:)
  message = "Error in property '#{property_name}': Constraint '#{constraint_name}' expects #{expected}, " \
            "but received #{got.inspect} (#{got.class})."
  raise ConstraintError, message
end

.raise_unknown_option_error(property_name:, option:, valid_options:) ⇒ Object

Raises:



18
19
20
21
22
23
 
# File 'lib/easy_talk/errors_helper.rb', line 18

def self.raise_unknown_option_error(property_name:, option:, valid_options:)
  option = option.keys.first if option.is_a?(Hash)
  message = "Unknown option '#{option}' for property '#{property_name}'. " \
            "Valid options are: #{valid_options.join(', ')}."
  raise UnknownOptionError, message
end

.validate_constraint_value(property_name:, constraint_name:, value_type:, value:) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/easy_talk/errors_helper.rb', line 84

def self.validate_constraint_value(property_name:, constraint_name:, value_type:, value:)
  return if value.nil?

  if value_type.to_s.include?('Boolean')
    return if value.is_a?(Array) && value.all? { |v| [true, false].include?(v) }

    unless [true, false].include?(value)
      raise_constraint_error(
        property_name: property_name,
        constraint_name: constraint_name,
        expected: 'Boolean (true or false)',
        got: value
      )
    end
    return
  end

  # Handle simple scalar types (String, Integer, etc.)
  if value_type.is_a?(Class)
    unless value.is_a?(value_type)
      raise_constraint_error(
        property_name: property_name,
        constraint_name: constraint_name,
        expected: value_type,
        got: value
      )
    end
  # Handle array types specifically
  elsif value_type.class.name.include?('TypedArray') ||
        (value_type.respond_to?(:to_s) && value_type.to_s.include?('T::Array'))
    # This is an array type, validate it
    validate_typed_array_values(
      property_name: property_name,
      constraint_name: constraint_name,
      type_info: value_type,
      array_value: value
    )
  # Handle Sorbet type objects
  elsif value_type.class.ancestors.include?(T::Types::Base)
    # Extract the inner type
    inner_type = extract_inner_type(value_type)

    if inner_type.is_a?(Array)
      # For union types, check if the value matches any of the allowed types
      unless inner_type.any? { |t| value.is_a?(t) }
        expected = inner_type.join(' or ')
        raise_constraint_error(
          property_name: property_name,
          constraint_name: constraint_name,
          expected: expected,
          got: value
        )
      end
    elsif !value.is_a?(inner_type)
      raise_constraint_error(
        property_name: property_name,
        constraint_name: constraint_name,
        expected: inner_type,
        got: value
      )
    end
  end
end

.validate_typed_array_values(property_name:, constraint_name:, type_info:, array_value:) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/easy_talk/errors_helper.rb', line 46

def self.validate_typed_array_values(property_name:, constraint_name:, type_info:, array_value:)
  # Skip validation if it's not actually an array
  return unless array_value.is_a?(Array)

  # Extract the inner type from the array type definition
  inner_type = extract_inner_type(type_info)

  # Check each element of the array
  array_value.each_with_index do |element, index|
    if inner_type.is_a?(Array)
      # For union types, check if the element matches any of the allowed types
      unless inner_type.any? { |t| element.is_a?(t) }
        expected = inner_type.join(' or ')
        raise_array_constraint_error(
          property_name: property_name,
          constraint_name: constraint_name,
          index: index,
          expected: expected,
          got: element
        )
      end
    else
      # For single types, just check against that type
      next if [true, false].include?(element)

      unless element.is_a?(inner_type)
        raise_array_constraint_error(
          property_name: property_name,
          constraint_name: constraint_name,
          index: index,
          expected: inner_type,
          got: element
        )
      end
    end
  end
end