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
|
# frozen_string_literal: true
module RuboCop
module Cop
module RSpec
# Check that a consistent implicit expectation style is used.
#
# This cop can be configured using the `EnforcedStyle` option
# and supports the `--auto-gen-config` flag.
#
# @example `EnforcedStyle: is_expected` (default)
# # bad
# it { should be_truthy }
#
# # good
# it { is_expected.to be_truthy }
#
# @example `EnforcedStyle: should`
# # bad
# it { is_expected.to be_truthy }
#
# # good
# it { should be_truthy }
#
class ImplicitExpect < Base
extend AutoCorrector
include ConfigurableEnforcedStyle
MSG = 'Prefer `%<good>s` over `%<bad>s`.'
RESTRICT_ON_SEND = Runners.all + %i[should should_not]
# @!method implicit_expect(node)
def_node_matcher :implicit_expect, <<-PATTERN
{
(send nil? ${:should :should_not} ...)
(send (send nil? $:is_expected) #Runners.all ...)
}
PATTERN
alternatives = {
'is_expected.to' => 'should',
'is_expected.not_to' => 'should_not',
'is_expected.to_not' => 'should_not'
}
ENFORCED_REPLACEMENTS = alternatives.merge(alternatives.invert).freeze
def on_send(node) # rubocop:disable Metrics/MethodLength
return unless (source_range = offending_expect(node))
expectation_source = source_range.source
if expectation_source.start_with?(style.to_s)
correct_style_detected
else
opposite_style_detected
msg = offense_message(expectation_source)
add_offense(source_range, message: msg) do |corrector|
replacement = replacement_source(expectation_source)
corrector.replace(source_range, replacement)
end
end
end
private
def offending_expect(node)
case implicit_expect(node)
when :is_expected
is_expected_range(node.loc)
when :should, :should_not
node.loc.selector
end
end
def is_expected_range(source_map) # rubocop:disable Naming/PredicateName
Parser::Source::Range.new(
source_map.expression.source_buffer,
source_map.expression.begin_pos,
source_map.selector.end_pos
)
end
def offense_message(offending_source)
format(
MSG,
good: replacement_source(offending_source),
bad: offending_source
)
end
def replacement_source(offending_source)
ENFORCED_REPLACEMENTS.fetch(offending_source)
end
end
end
end
end
|
