-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
redundant_string_escape.rb
181 lines (148 loc) · 5.17 KB
/
redundant_string_escape.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
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# Checks for redundant escapes in string literals.
#
# @example
# # bad - no need to escape # without following {/$/@
# "\#foo"
#
# # bad - no need to escape single quotes inside double quoted string
# "\'foo\'"
#
# # bad - heredocs are also checked for unnecessary escapes
# <<~STR
# \#foo \"foo\"
# STR
#
# # good
# "#foo"
#
# # good
# "\#{no_interpolation}"
#
# # good
# "'foo'"
#
# # good
# "foo\
# bar"
#
# # good
# <<~STR
# #foo "foo"
# STR
class RedundantStringEscape < Base
include MatchRange
include RangeHelp
extend AutoCorrector
MSG = 'Redundant escape of %<char>s inside string literal.'
def on_str(node)
return if node.parent&.regexp_type? || node.parent&.xstr_type? || node.character_literal?
str_contents_range = str_contents_range(node)
each_match_range(str_contents_range, /(\\.)/) do |range|
next if allowed_escape?(node, range.resize(3))
add_offense(range) do |corrector|
corrector.remove_leading(range, 1)
end
end
end
private
def message(range)
format(MSG, char: range.source.chars.last)
end
def str_contents_range(node)
if heredoc?(node)
node.loc.heredoc_body
elsif begin_loc_present?(node)
contents_range(node)
else
node.loc.expression
end
end
def begin_loc_present?(node)
# e.g. a __FILE__ literal has no begin loc so we can't query if it's nil
node.loc.to_hash.key?(:begin) && !node.loc.begin.nil?
end
def allowed_escape?(node, range)
escaped = range.source[(1..-1)]
# Inside a single-quoted string, escapes (except \\ and \') do not have special meaning,
# and so are not redundant, as they are a literal backslash.
return true if interpolation_not_enabled?(node)
# Strictly speaking a few single-letter chars are currently unnecessary to "escape", e.g.
# d, but enumerating them is rather difficult, and their behavior could change over time
# with different versions of Ruby so that e.g. /\d/ != /d/
return true if /[\n\\[[:alnum:]]]/.match?(escaped[0])
return true if escaped[0] == ' ' && percent_array_literal?(node)
return true if disabling_interpolation?(range)
return true if delimiter?(node, escaped[0])
false
end
def interpolation_not_enabled?(node)
single_quoted?(node) ||
percent_w_literal?(node) ||
percent_q_literal?(node) ||
heredoc_with_disabled_interpolation?(node)
end
def single_quoted?(node)
delimiter?(node, "'")
end
def percent_q_literal?(node)
if literal_in_interpolated_or_multiline_string?(node)
percent_q_literal?(node.parent)
else
node.source.start_with?('%q')
end
end
def array_literal?(node, prefix)
if literal_in_interpolated_or_multiline_string?(node)
array_literal?(node.parent, prefix)
else
node.parent&.array_type? && node.parent.source.start_with?(prefix)
end
end
def percent_w_literal?(node)
array_literal?(node, '%w')
end
def percent_w_upper_literal?(node)
array_literal?(node, '%W')
end
def percent_array_literal?(node)
(percent_w_literal?(node) || percent_w_upper_literal?(node))
end
def heredoc_with_disabled_interpolation?(node)
if heredoc?(node)
node.loc.expression.source.end_with?("'")
elsif node.parent&.dstr_type?
heredoc_with_disabled_interpolation?(node.parent)
else
false
end
end
def heredoc?(node)
(node.str_type? || node.dstr_type?) && node.heredoc?
end
def delimiter?(node, char)
return false if heredoc?(node)
if literal_in_interpolated_or_multiline_string?(node) || percent_array_literal?(node)
return delimiter?(node.parent, char)
end
delimiters = [node.loc.begin.source[-1], node.loc.end.source[0]]
delimiters.include?(char)
end
def literal_in_interpolated_or_multiline_string?(node)
node.str_type? && !begin_loc_present?(node) && node.parent&.dstr_type?
end
def disabling_interpolation?(range)
# Allow \#{foo}, \#$foo, \#@foo, and \#@@foo
# for escaping local, global, instance and class variable interpolations
return true if range.source.match?(/\A\\#[{$@]/)
# Also allow #\{foo}, #\$foo, #\@foo and #\@@foo
return true if range.adjust(begin_pos: -2).source.match?(/\A[^\\]#\\[{$@]/)
false
end
end
end
end
end