/
rspec_match_ordered_array.rb
47 lines (43 loc) · 1.27 KB
/
rspec_match_ordered_array.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
# frozen_string_literal: true
module RuboCop
module Cop
module Ezcater
# Enforce use of `match_ordered_array` matcher instead of using `eq` matcher
#
# @example
#
# # good
# expect(foo).to match_ordered_array([1, 2, 3])
# expect(foo).to match_ordered_array [1, 2, 3]
#
# # bad
# expect(foo).to eq([1, 2, 3])
# expect(foo).to eq [1, 2, 3]
class RspecMatchOrderedArray < Cop
MATCH_ORDERED_ARRAY = "match_ordered_array"
MSG = "Use the `match_ordered_array` matcher from ezcater_matchers gem "\
"instead of `eq` when comparing collections"
def_node_matcher "eq_array", <<~PATTERN
(send nil? :eq (array ...))
PATTERN
def on_send(node)
eq_array(node) do
add_offense(node, location: :expression, message: MSG)
end
end
def autocorrect(node)
lambda do |corrector|
corrector.replace(
Parser::Source::Range.new(
node.source_range.source_buffer,
node.source_range.begin_pos,
node.source_range.begin_pos + 2
),
MATCH_ORDERED_ARRAY
)
end
end
end
end
end
end