forked from rubocop/rubocop
/
out_of_range_regexp_ref.rb
98 lines (81 loc) · 2.68 KB
/
out_of_range_regexp_ref.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
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# This cops looks for references of Regexp captures that are out of range
# and thus always returns nil.
#
# @example
#
# /(foo)bar/ =~ 'foobar'
#
# # bad - always returns nil
#
# puts $2 # => nil
#
# # good
#
# puts $1 # => foo
#
class OutOfRangeRegexpRef < Base
MSG = '$%<backref>s is out of range (%<count>s regexp capture %<group>s detected).'
REGEXP_RECEIVER_METHODS = %i[=~ === match].to_set.freeze
REGEXP_ARGUMENT_METHODS = %i[=~ match grep gsub gsub! sub sub! [] slice slice! index rindex
scan partition rpartition start_with? end_with?].to_set.freeze
REGEXP_CAPTURE_METHODS = (REGEXP_RECEIVER_METHODS + REGEXP_ARGUMENT_METHODS).freeze
RESTRICT_ON_SEND = REGEXP_CAPTURE_METHODS
def on_new_investigation
@valid_ref = 0
end
def on_match_with_lvasgn(node)
check_regexp(node.children.first)
end
def after_send(node)
@valid_ref = nil
if regexp_first_argument?(node)
check_regexp(node.first_argument)
elsif regexp_receiver?(node)
check_regexp(node.receiver)
end
end
def on_when(node)
regexp_conditions = node.conditions.select(&:regexp_type?)
@valid_ref = regexp_conditions.map do |condition|
check_regexp(condition)
end.compact.max
end
def on_nth_ref(node)
backref, = *node
return if @valid_ref.nil? || backref <= @valid_ref
message = format(
MSG,
backref: backref,
count: @valid_ref.zero? ? 'no' : @valid_ref,
group: @valid_ref == 1 ? 'group' : 'groups'
)
add_offense(node, message: message)
end
private
def check_regexp(node)
return if node.interpolation?
named_capture = node.each_capture(named: true).count
@valid_ref = if named_capture.positive?
named_capture
else
node.each_capture(named: false).count
end
end
def regexp_first_argument?(send_node)
send_node.first_argument&.regexp_type? \
&& REGEXP_ARGUMENT_METHODS.include?(send_node.method_name)
end
def regexp_receiver?(send_node)
send_node.receiver&.regexp_type?
end
def nth_ref_receiver?(send_node)
send_node.receiver&.nth_ref_type?
end
end
end
end
end