Module: DataModel::Errors

Extended by:
T::Sig
Includes:
Kernel
Included in:
Builtin::Array, Builtin::BigDecimal, Builtin::Boolean, Builtin::Date, Builtin::Float, Builtin::Hash, Builtin::Integer, Builtin::String, Builtin::Symbol, Builtin::Time, TypeRegistry
Defined in:
lib/data_model/errors.rb

Overview

Provide Error building functionality as a mixin

Constant Summary collapse

TTemporal = 
T.type_alias { T.any(::Date, ::Time, ::DateTime) }
TErrorMessageBuilder =

API TODO: split this file

T.type_alias { T.proc.params(ctx: T.untyped).returns(String) }
TErrorMessages = 
T.type_alias { T::Hash[Symbol, TErrorMessageBuilder] }
TClassValueCtx = 
T.type_alias { [T.class_of(Object), Object] }
TClassCtx = 
T.type_alias { T.class_of(Object) }
TSetCtx = 
T.type_alias { T::Array[Symbol] }
TWithinCtx = 
T.type_alias { [Numeric, Numeric] }
TWithinTemporalCtx = 
T.type_alias { [TTemporal, TTemporal] }
TFormatCtx = 
T.type_alias { [Object, String] }

Instance Method Summary collapse

Instance Method Details

#blank_error ⇒ Object 



45
46
47
 
# File 'lib/data_model/errors.rb', line 45

def blank_error
	[:blank, nil]
end

#blank_error_message ⇒ Object 



119
120
121
 
# File 'lib/data_model/errors.rb', line 119

def blank_error_message
	"cannot be blank"
end

#coerce_error(cls, value) ⇒ Object 



21
22
23
 
# File 'lib/data_model/errors.rb', line 21

def coerce_error(cls, value)
	[:coerce, [cls, value]]
end

#coerce_error_message(cls, value) ⇒ Object 



95
96
97
 
# File 'lib/data_model/errors.rb', line 95

def coerce_error_message(cls, value)
	"cannot be coerced to #{cls.name}, it is a #{value.class.name}"
end

#earliest_error(earliest, val) ⇒ Object 



69
70
71
 
# File 'lib/data_model/errors.rb', line 69

def earliest_error(earliest, val)
	[:earliest, [earliest, val]]
end

#early_error_message(earliest, val) ⇒ Object 



143
144
145
 
# File 'lib/data_model/errors.rb', line 143

def early_error_message(earliest, val)
	"value #{val} is before #{earliest}"
end

#error_message(error) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/data_model/errors.rb', line 251

def error_message(error)
	type = T.let(error[0], Symbol)
	ctx = T.let(error[1], T.untyped)

	builder = error_message_builders[type]

	if builder.nil?
		raise "no error message builder for #{type}"
	end

	builder.call(ctx)
end

#error_message_builders ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/data_model/errors.rb', line 180

def error_message_builders
	if @error_messages.nil?
		@error_messages ||= T.let({}, T.nilable(TErrorMessages))

		# wire up defaults

		register_error_message(:type) do |ctx|
			cls, val = T.let(ctx, TClassValueCtx)
			type_error_message(cls, val)
		end

		register_error_message(:coerce) do |ctx|
			cls, val = T.let(ctx, TClassValueCtx)
			coerce_error_message(cls, val)
		end

		register_error_message(:missing) do |ctx|
			cls = T.let(ctx, TClassCtx)
			missing_error_message(cls)
		end

		register_error_message(:inclusion) do |ctx|
			set = T.let(ctx, TSetCtx)
			inclusion_error_message(set)
		end

		register_error_message(:exclusion) do |ctx|
			set = T.let(ctx, TSetCtx)
			exclusion_error_message(set)
		end

		register_error_message(:extra_keys) do |ctx|
			set = T.let(ctx, TSetCtx)
			extra_keys_error_message(set)
		end

		register_error_message(:min) do |ctx|
			min, val = T.let(ctx, TWithinCtx)
			min_error_message(min, val)
		end

		register_error_message(:max) do |ctx|
			max, val = T.let(ctx, TWithinCtx)
			max_error_message(max, val)
		end

		register_error_message(:earliest) do |ctx|
			earliest, val = T.let(ctx, TWithinTemporalCtx)
			early_error_message(earliest, val)
		end

		register_error_message(:latest) do |ctx|
			latest, val = T.let(ctx, TWithinTemporalCtx)
			late_error_message(latest, val)
		end

		register_error_message(:blank) do
			blank_error_message
		end

		register_error_message(:format) do |ctx|
			format, val = T.let(ctx, TFormatCtx)
			format_error_message(format, val)
		end
	end

	@error_messages
end

#error_messages(error) ⇒ Object 



267
268
269
270
271
 
# File 'lib/data_model/errors.rb', line 267

def error_messages(error)
	error.to_h.transform_values do |error_list|
		error_list.map { |e| error_message(e) }
	end
end

#exclusion_error(set) ⇒ Object 



39
40
41
 
# File 'lib/data_model/errors.rb', line 39

def exclusion_error(set)
	[:exclusion, set]
end

#exclusion_error_message(set) ⇒ Object 



113
114
115
 
# File 'lib/data_model/errors.rb', line 113

def exclusion_error_message(set)
	"must not be one of #{set.join(', ')}"
end

#extra_keys_error(keys) ⇒ Object 



51
52
53
 
# File 'lib/data_model/errors.rb', line 51

def extra_keys_error(keys)
	[:extra_keys, keys]
end

#extra_keys_error_message(keys) ⇒ Object 



125
126
127
 
# File 'lib/data_model/errors.rb', line 125

def extra_keys_error_message(keys)
	"more elements found in closed hash then specified children: #{keys.join(', ')}"
end

#format_error(format, val) ⇒ Object 



81
82
83
 
# File 'lib/data_model/errors.rb', line 81

def format_error(format, val)
	[:format, [format, val]]
end

#format_error_message(format, val) ⇒ Object 



155
156
157
 
# File 'lib/data_model/errors.rb', line 155

def format_error_message(format, val)
	"value #{val} does not match format #{format}"
end

#inclusion_error(set) ⇒ Object 



33
34
35
 
# File 'lib/data_model/errors.rb', line 33

def inclusion_error(set)
	[:inclusion, set]
end

#inclusion_error_message(set) ⇒ Object 



107
108
109
 
# File 'lib/data_model/errors.rb', line 107

def inclusion_error_message(set)
	"must be one of #{set.join(', ')}"
end

#late_error_message(latest, val) ⇒ Object 



149
150
151
 
# File 'lib/data_model/errors.rb', line 149

def late_error_message(latest, val)
	"value #{val} is after #{latest}"
end

#latest_error(latest, val) ⇒ Object 



75
76
77
 
# File 'lib/data_model/errors.rb', line 75

def latest_error(latest, val)
	[:latest, [latest, val]]
end

#max_error(min, val) ⇒ Object 



63
64
65
 
# File 'lib/data_model/errors.rb', line 63

def max_error(min, val)
	[:max, [min, val]]
end

#max_error_message(max, val) ⇒ Object 



137
138
139
 
# File 'lib/data_model/errors.rb', line 137

def max_error_message(max, val)
	"value is more than the maximum of #{max}, it is #{val}"
end

#min_error(min, val) ⇒ Object 



57
58
59
 
# File 'lib/data_model/errors.rb', line 57

def min_error(min, val)
	[:min, [min, val]]
end

#min_error_message(min, val) ⇒ Object 



131
132
133
 
# File 'lib/data_model/errors.rb', line 131

def min_error_message(min, val)
	"value is less than the minimum of #{min}, it is #{val}"
end

#missing_error(cls) ⇒ Object 



27
28
29
 
# File 'lib/data_model/errors.rb', line 27

def missing_error(cls)
	[:missing, cls]
end

#missing_error_message(cls) ⇒ Object 



101
102
103
 
# File 'lib/data_model/errors.rb', line 101

def missing_error_message(cls)
	"missing value, expected a #{cls.name}"
end

#register_error_message(type, &block) ⇒ Object 



166
167
168
 
# File 'lib/data_model/errors.rb', line 166

def register_error_message(type, &block)
	error_message_builders[type] = block
end

#set_error_class(error, from, to) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/data_model/errors.rb', line 274

def set_error_class(error, from, to)
	error.transform_context do |ctx, type|
		case type
		when :type, :coerce
			cls, val = T.cast(ctx, TClassValueCtx)
			if cls == from
				[to, val]
			else
				[cls, val]
			end
		when :missing
			if ctx == from
				[to, val]
			else
				[cls, val]
			end
		else
			[cls, val]
		end
	end
end

#type_error(cls, value) ⇒ Object 



15
16
17
 
# File 'lib/data_model/errors.rb', line 15

def type_error(cls, value)
	[:type, [cls, value]]
end

#type_error_message(cls, value) ⇒ Object 



89
90
91
 
# File 'lib/data_model/errors.rb', line 89

def type_error_message(cls, value)
	"#{value.inspect} is not a #{cls.name}, it is a #{value.class.name}"
end