Module: ApiEngineBase::ArgumentValidation::ClassMethods

Defined in:
app/services/api_engine_base/argument_validation/class_methods.rb

Constant Summary collapse

ON_ARGUMENT_VALIDATION = 
[
  DEFAULT_VALIDATION = :raise,
  :fail_early,
  :log,
]

Instance Method Summary collapse

Instance Method Details

#__existing_names ⇒ Object 



174
175
176
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 174

def __existing_names
  @__existing_names ||= []
end

#__stacked_type ⇒ Object 



170
171
172
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 170

def __stacked_type
  @__stacked_type ||= []
end

#at_least(count, name, required:, &block) ⇒ Object

Raises:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 56

def at_least(count, name, required:, &block)
  raise ApiEngineBase::ServiceBase::CompositionValidationError, "Count must be greater than 0" if count < 1

  validation_proc = Proc.new do |input_count, keys|
    {
      message: "Expected at least #{count} keys assigned. Available keys",
      is_valid: (input_count >= count),
      requirement: "Validation Error: At least #{count} key(s) of #{keys} must be provided.",
    }
  end

  composition_validation_proc = Proc.new do
    keys = compositions[__stacked_type.last[:name]][:keys]
    if keys.length < count
      raise ApiEngineBase::ServiceBase::CompositionValidationError, "Composition configuration error. Key [#{name}] expects AT LEAST #{count} keys to create an instance. Only #{keys.length} is provided for the composition. Please add more keys or reduce the expectation"
    end
  end
  composition(name:, type: :at_least, required:, delegation: false, composition_validation_proc:, validation_proc:, &block)
end

#at_least_one(name, required:, &block) ⇒ Object 



76
77
78
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 76

def at_least_one(name, required:, &block)
  at_least(1, name, required:, &block)
end

#at_most(count, name, required:, &block) ⇒ Object

Raises:



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 42

def at_most(count, name, required:, &block)
  raise ApiEngineBase::ServiceBase::CompositionValidationError, "Count must be greater than 0" if count < 1

  validation_proc = Proc.new do |input_count, keys|
    {
      message: "Expected at most #{count} keys assigned",
      is_valid: (input_count <= count),
      requirement: "Validation Error: At most #{count} key(s) of #{keys} can be provided.",
    }
  end

  composition(name:, type: :at_most, required:, delegation: false, validation_proc:, &block)
end

#compose_exact(count, name, required:, delegation: false, &block) ⇒ Object

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 21

def compose_exact(count, name, required:, delegation: false, &block)
  raise ApiEngineBase::ServiceBase::CompositionValidationError, "Count must be greater than 0" if count < 1

  validation_proc = Proc.new do |input_count, keys|
    language = (input_count > 0) ? "But #{input_count} keys were assigned" : "But no key was assigned"
    {
      message: "Expected [#{count}] of the keys to have a value assigned. #{language}",
      is_valid: (input_count == count),
      requirement: "Exactly #{count} key(s) of #{keys} must be provided.",
    }
  end

  composition_validation_proc = Proc.new do
    keys = compositions[__stacked_type.last[:name]][:keys]
    if keys.length < count
      raise ApiEngineBase::ServiceBase::CompositionValidationError, "Composition configuration error. Key [#{name}] expects EXACTLY #{count} keys to create an instance. Only #{keys.length} is provided for the composition. Please add more keys or reduce the expectation"
    end
  end
  composition(name:, type: :compose_exact, required:, delegation:, composition_validation_proc:, validation_proc:, &block)
end

#composition(name:, type:, required:, delegation:, validation_proc:, composition_validation_proc: nil, &block) ⇒ 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
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 84

def composition(name:, type:, required:, delegation:, validation_proc:, composition_validation_proc: nil, &block)
  compositions[name] ||= { type:, name:, keys: [], required:, delegation:, validation_proc: }
  if __stacked_type.map { _1[:type] }.include?(type)
    raise ApiEngineBase::ServiceBase::NestedDuplicateTypeError, "Duplicate Nested type's are not allowed. #{type} composition was included more than once"
  end

  __stacked_type << { type:, name: }

  yield

  if composition_validation_proc
    composition_validation_proc.()
  end

  if __existing_names.include?(name)
    raise ApiEngineBase::ServiceBase::NameConflictError, "Name conflict for #{name}. Duplicated as a key"
  end

  __existing_names << name
  # returning from the yield...pop it from the stack.
  # This allows us to know the current depth of where we are in the nested stack
  __stacked_type.pop

  if delegation
    delegate name, to: :context
    delegate :"#{name}_key", to: :context
  end
end

#compositions ⇒ Object 



166
167
168
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 166

def compositions
  @compositions ||= {}
end

#on_argument_validation(set) ⇒ Object 



15
16
17
18
19
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 15

def on_argument_validation(set)
  raise "Must be one of #{ON_ARGUMENT_VALIDATION}" unless ON_ARGUMENT_VALIDATION.include?(set)

  @on_argument_validation = set
end

#on_argument_validation_assigned ⇒ Object 



11
12
13
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 11

def on_argument_validation_assigned
  @on_argument_validation ||= DEFAULT_VALIDATION
end

#one_of(name, required:, delegation: true, &block) ⇒ Object 



80
81
82
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 80

def one_of(name, required:, delegation: true, &block)
  compose_exact(1, name, required:, delegation:, &block)
end

#sensitive_params ⇒ Object 



158
159
160
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 158

def sensitive_params
  @sensitive_params ||= []
end

#validate(name, default: nil, length: false, is_a: nil, is_one: nil, lt: nil, lte: nil, eq: nil, gt: nil, gte: nil, delegation: true, sensitive: false, required: false) ⇒ Object 



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
147
148
149
150
151
152
153
154
155
156
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 113

def validate(name, default: nil, length: false, is_a: nil, is_one: nil, lt: nil, lte: nil, eq: nil, gt: nil, gte: nil, delegation: true, sensitive: false, required: false)
  if __existing_names.include?(name)
    raise ApiEngineBase::ServiceBase::NameConflictError, "Duplicate key name found. [#{name}] can only be defined once"
  end

  __existing_names << name

  if default
    if is_a
      if Array(is_a).none? { _1 === default }
        raise ApiEngineBase::ServiceBase::DefaultValueError, "Default value provided [#{default}] does not match any `is_a` value(s) of #{is_a}."
      end
    end

    if is_one
      if Array(is_one).none? { _1 == default }
        raise ApiEngineBase::ServiceBase::DefaultValueError, "Default value provided [#{default}] does not match any `is_one` value(s) of #{is_one}."
      end
    end
  end

  if __stacked_type.length > 0
    compositions[__stacked_type.last[:name]][:keys] << name
  end

  validate_params << {
    name:,
    is_a:,
    lt:,
    lte:,
    eq:,
    gt:,
    gte:,
    length:,
    required:,
    is_one:,
    default:,
  }
  sensitive_params << name if sensitive

  if delegation
    delegate name, to: :context
  end
end

#validate_params ⇒ Object 



162
163
164
 
# File 'app/services/api_engine_base/argument_validation/class_methods.rb', line 162

def validate_params
  @validate_params ||= []
end