-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
expectations.cr
444 lines (368 loc) · 12.3 KB
/
expectations.cr
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
83
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
module Spec
# :nodoc:
struct EqualExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
expected_value = @expected_value
# For the case of comparing strings we want to make sure that two strings
# are equal if their content is equal, but also their bytesize and size
# should be equal. Otherwise, an incorrect bytesize or size was used
# when creating them.
if actual_value.is_a?(String) && expected_value.is_a?(String)
actual_value == expected_value &&
actual_value.bytesize == expected_value.bytesize &&
actual_value.size == expected_value.size
else
actual_value == @expected_value
end
end
def failure_message(actual_value)
expected_value = @expected_value
# Check for the case of string equality when the content match
# but not the bytesize or size.
if actual_value.is_a?(String) &&
expected_value.is_a?(String) &&
actual_value == expected_value
if actual_value.bytesize != expected_value.bytesize
return <<-MSG
Expected bytesize: #{expected_value.bytesize}
got bytesize: #{actual_value.bytesize}
MSG
end
return <<-MSG
Expected size: #{expected_value.size}
got size: #{actual_value.size}
MSG
else
expected = expected_value.inspect
got = actual_value.inspect
if expected == got
expected += " : #{@expected_value.class}"
got += " : #{actual_value.class}"
end
"Expected: #{expected}\n got: #{got}"
end
end
def negative_failure_message(actual_value)
"Expected: actual_value != #{@expected_value.inspect}\n got: #{actual_value.inspect}"
end
end
# :nodoc:
struct BeExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
actual_value.same? @expected_value
end
def failure_message(actual_value)
"Expected: #{@expected_value.inspect} (object_id: #{@expected_value.object_id})\n got: #{actual_value.inspect} (object_id: #{actual_value.object_id})"
end
def negative_failure_message(actual_value)
"Expected: value.same? #{@expected_value.inspect} (object_id: #{@expected_value.object_id})\n got: #{actual_value.inspect} (object_id: #{actual_value.object_id})"
end
end
# :nodoc:
struct BeTruthyExpectation
def match(actual_value)
!!actual_value
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect} to be truthy"
end
def negative_failure_message(actual_value)
"Expected: #{actual_value.inspect} not to be truthy"
end
end
# :nodoc:
struct BeFalseyExpectation
def match(actual_value)
!actual_value
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect} to be falsey"
end
def negative_failure_message(actual_value)
"Expected: #{actual_value.inspect} not to be falsey"
end
end
# :nodoc:
struct BeNilExpectation
def match(actual_value)
actual_value.nil?
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect} to be nil"
end
def negative_failure_message(actual_value)
"Expected: #{actual_value.inspect} not to be nil"
end
end
# :nodoc:
struct CloseExpectation(T, D)
def initialize(@expected_value : T, @delta : D)
end
def match(actual_value)
(actual_value - @expected_value).abs <= @delta
end
def failure_message(actual_value)
"Expected #{actual_value.inspect} to be within #{@delta} of #{@expected_value}"
end
def negative_failure_message(actual_value)
"Expected #{actual_value.inspect} not to be within #{@delta} of #{@expected_value}"
end
end
# :nodoc:
struct BeAExpectation(T)
def match(actual_value)
actual_value.is_a?(T)
end
def failure_message(actual_value)
"Expected #{actual_value.inspect} (#{actual_value.class}) to be a #{T}"
end
def negative_failure_message(actual_value)
"Expected #{actual_value.inspect} (#{actual_value.class}) not to be a #{T}"
end
end
# :nodoc:
struct Be(T)
def self.<(other)
Be.new(other, :"<")
end
def self.<=(other)
Be.new(other, :"<=")
end
def self.>(other)
Be.new(other, :">")
end
def self.>=(other)
Be.new(other, :">=")
end
def initialize(@expected_value : T, @op : Symbol)
end
def match(actual_value)
case @op
when :"<"
actual_value < @expected_value
when :"<="
actual_value <= @expected_value
when :">"
actual_value > @expected_value
when :">="
actual_value >= @expected_value
else
false
end
end
def failure_message(actual_value)
"Expected #{actual_value.inspect} to be #{@op} #{@expected_value}"
end
def negative_failure_message(actual_value)
"Expected #{actual_value.inspect} not to be #{@op} #{@expected_value}"
end
end
# :nodoc:
struct MatchExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
actual_value =~ @expected_value
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect}\nto match: #{@expected_value.inspect}"
end
def negative_failure_message(actual_value)
"Expected: value #{actual_value.inspect}\n to not match: #{@expected_value.inspect}"
end
end
# :nodoc:
struct ContainExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
actual_value.includes?(@expected_value)
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect}\nto include: #{@expected_value.inspect}"
end
def negative_failure_message(actual_value)
"Expected: value #{actual_value.inspect}\nto not include: #{@expected_value.inspect}"
end
end
# :nodoc:
struct StartWithExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
actual_value.starts_with?(@expected_value)
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect}\nto start with: #{@expected_value.inspect}"
end
def negative_failure_message(actual_value)
"Expected: value #{actual_value.inspect}\nnot to start with: #{@expected_value.inspect}"
end
end
# :nodoc:
struct EndWithExpectation(T)
def initialize(@expected_value : T)
end
def match(actual_value)
actual_value.ends_with?(@expected_value)
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect}\nto end with: #{@expected_value.inspect}"
end
def negative_failure_message(actual_value)
"Expected: value #{actual_value.inspect}\nnot to end with: #{@expected_value.inspect}"
end
end
# :nodoc:
struct BeEmptyExpectation
def match(actual_value)
actual_value.empty?
end
def failure_message(actual_value)
"Expected: #{actual_value.inspect} to be empty"
end
def negative_failure_message(actual_value)
"Expected: #{actual_value.inspect} not to be empty"
end
end
# This module defines a number of methods to create expectations, which are
# automatically included into the top level namespace.
#
# Expectations are used by `Spec::ObjectExtensions#should` and `Spec::ObjectExtensions#should_not`.
module Expectations
# Creates an `Expectation` that passes if actual equals *value* (`==`).
def eq(value)
Spec::EqualExpectation.new value
end
# Creates an `Expectation` that passes if actual and *value* are identical (`.same?`).
def be(value)
Spec::BeExpectation.new value
end
# Creates an `Expectation` that passes if actual is true (`== true`).
def be_true
eq true
end
# Creates an `Expectation` that passes if actual is false (`== false`).
def be_false
eq false
end
# Creates an `Expectation` that passes if actual is truthy (neither `nil` nor `false`).
def be_truthy
Spec::BeTruthyExpectation.new
end
# Creates an `Expectation` that passes if actual is falsy (`nil` or `false`).
def be_falsey
Spec::BeFalseyExpectation.new
end
# Creates an `Expectation` that passes if actual is nil (`== nil`).
def be_nil
Spec::BeNilExpectation.new
end
# Creates an `Expectation` that passes if actual is within *delta* of *expected*.
def be_close(expected, delta)
Spec::CloseExpectation.new(expected, delta)
end
# Returns a factory to create a comparison `Expectation` that:
#
# * passes if actual is lesser than *value*: `be < value`
# * passes if actual is lesser than or equal *value*: `be <= value`
# * passes if actual is greater than *value*: `be > value`
# * passes if actual is greater than or equal *value*: `be >= value`
def be
Spec::Be
end
# Creates an `Expectation` that passes if actual matches *value* (`=~`).
def match(value)
Spec::MatchExpectation.new(value)
end
# Creates an `Expectation` that passes if actual includes *expected* (`.includes?`).
# Works on collections and `String`.
def contain(expected)
Spec::ContainExpectation.new(expected)
end
# Creates an `Expectation` that passes if actual starts with *expected* (`.starts_with?`).
# Works on `String`.
def start_with(expected)
Spec::StartWithExpectation.new(expected)
end
# Creates an `Expectation` that passes if actual ends with *expected* (`.ends_with?`).
# Works on `String`.
def end_with(expected)
Spec::EndWithExpectation.new(expected)
end
# Creates an `Expectation` that passes if actual is empty (`.empty?`).
def be_empty
Spec::BeEmptyExpectation.new
end
# Creates an `Expectation` that passes if actual is of type *type* (`is_a?`).
macro be_a(type)
Spec::BeAExpectation({{type}}).new
end
# Runs the block and passes if it raises an exception of type *klass* and the error message matches.
#
# If *message* is a string, it matches if the exception's error message contains that string.
# If *message* is a regular expression, it is used to match the error message.
#
# It returns the rescued exception.
def expect_raises(klass : T.class, message = nil, file = __FILE__, line = __LINE__) forall T
yield
rescue ex : T
# We usually bubble Spec::AssertaionFailed, unless this is the expected exception
if ex.is_a?(Spec::AssertionFailed) && klass != Spec::AssertionFailed
raise ex
end
# `NestingSpecError` is treated as the same above.
if ex.is_a?(Spec::NestingSpecError) && klass != Spec::NestingSpecError
raise ex
end
ex_to_s = ex.to_s
case message
when Regex
unless (ex_to_s =~ message)
backtrace = ex.backtrace.join('\n') { |f| " # #{f}" }
fail "Expected #{klass} with message matching #{message.inspect}, " \
"got #<#{ex.class}: #{ex_to_s}> with backtrace:\n#{backtrace}", file, line
end
when String
unless ex_to_s.includes?(message)
backtrace = ex.backtrace.join('\n') { |f| " # #{f}" }
fail "Expected #{klass} with #{message.inspect}, got #<#{ex.class}: " \
"#{ex_to_s}> with backtrace:\n#{backtrace}", file, line
end
end
ex
rescue ex
backtrace = ex.backtrace.join('\n') { |f| " # #{f}" }
fail "Expected #{klass}, got #<#{ex.class}: #{ex.to_s}> with backtrace:\n" \
"#{backtrace}", file, line
else
fail "Expected #{klass} but nothing was raised", file, line
end
end
module ObjectExtensions
# Validates an expectation and fails the example if it does not match.
#
# See `Spec::Expecations` for available expectations.
def should(expectation, file = __FILE__, line = __LINE__)
unless expectation.match self
fail(expectation.failure_message(self), file, line)
end
end
# Validates an expectation and fails the example if it matches.
#
# See `Spec::Expecations` for available expectations.
def should_not(expectation, file = __FILE__, line = __LINE__)
if expectation.match self
fail(expectation.negative_failure_message(self), file, line)
end
end
end
end
include Spec::Expectations
class Object
include Spec::ObjectExtensions
end