/
be.rb
285 lines (234 loc) · 7.22 KB
/
be.rb
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
module RSpec
module Matchers
module BuiltIn
# @api private
# Provides the implementation for `be_truthy`.
# Not intended to be instantiated directly.
class BeTruthy < BaseMatcher
# @api private
# @return [String]
def failure_message
"expected: truthy value\n got: #{actual_formatted}"
end
# @api private
# @return [String]
def failure_message_when_negated
"expected: falsey value\n got: #{actual_formatted}"
end
private
def match(_, actual)
!!actual
end
end
# @api private
# Provides the implementation for `be_falsey`.
# Not intended to be instantiated directly.
class BeFalsey < BaseMatcher
# @api private
# @return [String]
def failure_message
"expected: falsey value\n got: #{actual_formatted}"
end
# @api private
# @return [String]
def failure_message_when_negated
"expected: truthy value\n got: #{actual_formatted}"
end
private
def match(_, actual)
!actual
end
end
# @api private
# Provides the implementation for `be_nil`.
# Not intended to be instantiated directly.
class BeNil < BaseMatcher
# @api private
# @return [String]
def failure_message
"expected: nil\n got: #{actual_formatted}"
end
# @api private
# @return [String]
def failure_message_when_negated
"expected: not nil\n got: nil"
end
private
def match(_, actual)
actual.nil?
end
end
# @private
module BeHelpers
private
def args_to_s
@args.empty? ? "" : parenthesize(inspected_args.join(', '))
end
def parenthesize(string)
"(#{string})"
end
def inspected_args
@args.map { |a| RSpec::Support::ObjectFormatter.format(a) }
end
def expected_to_sentence
EnglishPhrasing.split_words(@expected)
end
def args_to_sentence
EnglishPhrasing.list(@args)
end
end
# @api private
# Provides the implementation for `be`.
# Not intended to be instantiated directly.
class Be < BaseMatcher
include BeHelpers
def initialize(*args)
@args = args
end
# @api private
# @return [String]
def failure_message
"expected #{actual_formatted} to evaluate to true"
end
# @api private
# @return [String]
def failure_message_when_negated
"expected #{actual_formatted} to evaluate to false"
end
[:==, :<, :<=, :>=, :>, :===, :=~].each do |operator|
define_method operator do |operand|
BeComparedTo.new(operand, operator)
end
end
private
def match(_, actual)
!!actual
end
end
# @api private
# Provides the implementation of `be <operator> value`.
# Not intended to be instantiated directly.
class BeComparedTo < BaseMatcher
include BeHelpers
def initialize(operand, operator)
@expected, @operator = operand, operator
@args = []
end
def matches?(actual)
@actual = actual
@actual.__send__ @operator, @expected
rescue ArgumentError
false
end
# @api private
# @return [String]
def failure_message
"expected: #{@operator} #{expected_formatted}\n got: #{@operator.to_s.gsub(/./, ' ')} #{actual_formatted}"
end
# @api private
# @return [String]
def failure_message_when_negated
message = "`expect(#{actual_formatted}).not_to be #{@operator} #{expected_formatted}`"
if [:<, :>, :<=, :>=].include?(@operator)
message + " not only FAILED, it is a bit confusing."
else
message
end
end
# @api private
# @return [String]
def description
"be #{@operator} #{expected_to_sentence}#{args_to_sentence}"
end
end
# @api private
# Provides the implementation of `be_<predicate>`.
# Not intended to be instantiated directly.
class BePredicate < BaseMatcher
include BeHelpers
def initialize(*args, &block)
@expected = parse_expected(args.shift)
@args = args
@block = block
end
def matches?(actual, &block)
@actual = actual
@block ||= block
predicate_accessible? && predicate_matches?
end
def does_not_match?(actual, &block)
@actual = actual
@block ||= block
predicate_accessible? && !predicate_matches?
end
# @api private
# @return [String]
def failure_message
failure_message_expecting(true)
end
# @api private
# @return [String]
def failure_message_when_negated
failure_message_expecting(false)
end
# @api private
# @return [String]
def description
"#{prefix_to_sentence}#{expected_to_sentence}#{args_to_sentence}"
end
private
def predicate_accessible?
actual.respond_to?(predicate) || actual.respond_to?(present_tense_predicate)
end
# support 1.8.7, evaluate once at load time for performance
if String === methods.first
# :nocov:
def private_predicate?
@actual.private_methods.include? predicate.to_s
end
# :nocov:
else
def private_predicate?
@actual.private_methods.include? predicate
end
end
def predicate_matches?
method_name = actual.respond_to?(predicate) ? predicate : present_tense_predicate
@predicate_matches = actual.__send__(method_name, *@args, &@block)
end
def predicate
:"#{@expected}?"
end
def present_tense_predicate
:"#{@expected}s?"
end
def parse_expected(expected)
@prefix, expected = prefix_and_expected(expected)
expected
end
def prefix_and_expected(symbol)
Matchers::BE_PREDICATE_REGEX.match(symbol.to_s).captures.compact
end
def prefix_to_sentence
EnglishPhrasing.split_words(@prefix)
end
def failure_message_expecting(value)
validity_message ||
"expected `#{actual_formatted}.#{predicate}#{args_to_s}` to return #{value}, got #{description_of @predicate_matches}"
end
def validity_message
return nil if predicate_accessible?
msg = "expected #{@actual} to respond to `#{predicate}`"
if private_predicate?
msg << " but `#{predicate}` is a private method"
elsif predicate == :true?
msg << " or perhaps you meant `be true` or `be_truthy`"
elsif predicate == :false?
msg << " or perhaps you meant `be false` or `be_falsey`"
end
msg
end
end
end
end
end