Module: RuboCop::Cop::Util

Extended by:
AST::Sexp
Includes:
PathUtil
Included in:
Cop
Defined in:
lib/rubocop/cop/util.rb

Overview

This module contains a collection of useful utility methods.

Constant Summary collapse

BYTE_ORDER_MARK =

The Unicode codepoint

0xfeff
EQUALS_ASGN_NODES = 
[:lvasgn, :ivasgn, :cvasgn, :gvasgn,
:casgn, :masgn].freeze
SHORTHAND_ASGN_NODES = 
[:op_asgn, :or_asgn, :and_asgn].freeze
ASGN_NODES = 
(EQUALS_ASGN_NODES + SHORTHAND_ASGN_NODES).freeze
MODIFIER_NODES = 
[:if, :while, :until].freeze
CONDITIONAL_NODES = 
(MODIFIER_NODES + [:case]).freeze
LOGICAL_OPERATOR_NODES = 
[:and, :or].freeze
OPERATOR_METHODS =

phrogz.net/programmingruby/language.html#table_18.4 Backtick is added last just to help editors parse this code.

%w(
  | ^ & <=> == === =~ > >= < <= << >>
  + - * / % ** ~ +@ -@ [] []= ! != !~
).map(&:to_sym).push(:'`').freeze
LITERAL_REGEX =

Match literal regex characters, not including anchors, character classes, alternatives, groups, repetitions, references, etc

/[\w\s\-,"'!#%&<>=;:`~]|\\[^AbBdDgGhHkpPRwWXsSzZ0-9]/

Class Method Summary collapse

Methods included from AST::Sexp

s

Methods included from PathUtil

absolute?, match_path?, relative_path

Class Method Details

.begins_its_line?(range) ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/rubocop/cop/util.rb', line 169

def begins_its_line?(range)
  (range.source_line =~ /\S/) == range.column
end

.block_length(block_node) ⇒ Object 



51
52
53
 
# File 'lib/rubocop/cop/util.rb', line 51

def block_length(block_node)
  block_node.loc.end.line - block_node.loc.begin.line
end

.comment_line?(line_source) ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/rubocop/cop/util.rb', line 55

def comment_line?(line_source)
  line_source =~ /^\s*#/
end

.compatible_external_encoding_for?(src) ⇒ Boolean

Returns:

  • (Boolean) 


274
275
276
277
 
# File 'lib/rubocop/cop/util.rb', line 274

def compatible_external_encoding_for?(src)
  src = src.dup if RUBY_VERSION < '2.3'
  src.force_encoding(Encoding.default_external).valid_encoding?
end

.directions(side) ⇒ Object 



161
162
163
164
165
166
167
 
# File 'lib/rubocop/cop/util.rb', line 161

def directions(side)
  if side == :both
    [true, true]
  else
    [side == :left, side == :right]
  end
end

.double_quotes_acceptable?(string) ⇒ Boolean

If double quoted string literals are found in Ruby code, and they are not the preferred style, should they be flagged?

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/rubocop/cop/util.rb', line 224

def double_quotes_acceptable?(string)
  needs_escaping?(string) || hard_to_type?(string)
end

.double_quotes_required?(string) ⇒ Boolean

If converting a string to Ruby string literal source code, must double quotes be used?

Returns:

  • (Boolean) 


212
213
214
215
216
217
218
219
220
 
# File 'lib/rubocop/cop/util.rb', line 212

def double_quotes_required?(string)
  # Double quotes are required for strings which either:
  # - Contain single quotes
  # - Contain non-printable characters, which must use an escape

  # Regex matches IF there is a ' or there is a \\ in the string that is
  # not preceded/followed by another \\ (e.g. "\\x34") but not "\\\\".
  string =~ /'|(?<! \\) \\{2}* \\ (?![\\"])/x
end

.effective_column(range) ⇒ Object

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. This gives the column as it appears when viewing the file in an editor.



113
114
115
116
117
118
119
120
 
# File 'lib/rubocop/cop/util.rb', line 113

def effective_column(range)
  if range.line == 1 &&
     @processed_source.raw_source.codepoints.first == BYTE_ORDER_MARK
    range.column - 1
  else
    range.column
  end
end

.ends_its_line?(range) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
176
 
# File 'lib/rubocop/cop/util.rb', line 173

def ends_its_line?(range)
  line = range.source_buffer.source_line(range.last_line)
  (line =~ /\s*\z/) == range.last_column
end

.escape_string(string) ⇒ Object 



236
237
238
 
# File 'lib/rubocop/cop/util.rb', line 236

def escape_string(string)
  string.inspect[1..-2].tap { |s| s.gsub!(/\\"/, '"') }
end

.first_part_of_call_chain(node) ⇒ Object

Returns, for example, a bare if node if the given node is an if with calls chained to the end of it.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/rubocop/cop/util.rb', line 186

def first_part_of_call_chain(node)
  while node
    case node.type
    when :send
      receiver, _method_name, _args = *node
      node = receiver
    when :block
      method, _args, _body = *node
      node = method
    else
      break
    end
  end
  node
end

.hard_to_type?(string) ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/rubocop/cop/util.rb', line 228

def hard_to_type?(string)
  string.codepoints.any? { |cp| cp < 32 || cp > 126 }
end

.interpret_string_escapes(string) ⇒ Object 



252
253
254
 
# File 'lib/rubocop/cop/util.rb', line 252

def interpret_string_escapes(string)
  StringInterpreter.interpret(string)
end

.line_distance(n1, n2) ⇒ Object 



262
263
264
 
# File 'lib/rubocop/cop/util.rb', line 262

def line_distance(n1, n2)
  n2.loc.line - n1.loc.line
end

.line_range(arg) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rubocop/cop/util.rb', line 59

def line_range(arg)
  source_range = case arg
                 when Parser::Source::Range
                   arg
                 when Parser::AST::Node
                   arg.source_range
                 else
                   raise ArgumentError, "Invalid argument #{arg}"
                 end

  source_range.begin.line..source_range.end.line
end

.move_pos(src, pos, step, condition, regexp) ⇒ Object 



155
156
157
158
159
 
# File 'lib/rubocop/cop/util.rb', line 155

def move_pos(src, pos, step, condition, regexp)
  offset = step == -1 ? -1 : 0
  pos += step while condition && src[pos + offset] =~ regexp
  pos < 0 ? 0 : pos
end

.needs_escaping?(string) ⇒ Boolean

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/rubocop/cop/util.rb', line 232

def needs_escaping?(string)
  double_quotes_required?(escape_string(string))
end

.numeric_range_size(range) ⇒ Object

Range#size is not available prior to Ruby 2.0.



203
204
205
206
207
208
 
# File 'lib/rubocop/cop/util.rb', line 203

def numeric_range_size(range)
  size = range.end - range.begin
  size += 1 unless range.exclude_end?
  size = 0 if size < 0
  size
end

.on_node(syms, sexp, excludes = []) {|sexp| ... } ⇒ Object

Yields:

  • (sexp) 


81
82
83
84
85
86
87
88
 
# File 'lib/rubocop/cop/util.rb', line 81

def on_node(syms, sexp, excludes = [], &block)
  return to_enum(:on_node, syms, sexp, excludes) unless block_given?

  yield sexp if Array(syms).include?(sexp.type)
  return if Array(excludes).include?(sexp.type)

  sexp.each_child_node { |elem| on_node(syms, elem, excludes, &block) }
end

.operator?(symbol) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/rubocop/cop/util.rb', line 35

def operator?(symbol)
  OPERATOR_METHODS.include?(symbol)
end

.parentheses?(node) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
 
# File 'lib/rubocop/cop/util.rb', line 72

def parentheses?(node)
  node.loc.respond_to?(:end) && node.loc.end &&
    node.loc.end.is?(')'.freeze)
end

.parenthesized_call?(send) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/rubocop/cop/util.rb', line 77

def parenthesized_call?(send)
  send.loc.begin && send.loc.begin.is?('(')
end

.preceed?(n1, n2) ⇒ Boolean

Returns:

  • (Boolean) 


266
267
268
 
# File 'lib/rubocop/cop/util.rb', line 266

def preceed?(n1, n2)
  line_distance(n1, n2) == 1
end

.range_between(start_pos, end_pos) ⇒ Object 



122
123
124
 
# File 'lib/rubocop/cop/util.rb', line 122

def range_between(start_pos, end_pos)
  Parser::Source::Range.new(processed_source.buffer, start_pos, end_pos)
end

.range_with_surrounding_comma(range, side = :both) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rubocop/cop/util.rb', line 126

def range_with_surrounding_comma(range, side = :both)
  buffer = @processed_source.buffer
  src = buffer.source

  go_left, go_right = directions(side)

  begin_pos = range.begin_pos
  end_pos = range.end_pos
  begin_pos = move_pos(src, begin_pos, -1, go_left, /,/)
  end_pos = move_pos(src, end_pos, 1, go_right, /,/)

  Parser::Source::Range.new(buffer, begin_pos, end_pos)
end

.range_with_surrounding_space(range, side = :both, with_newline = true) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/rubocop/cop/util.rb', line 140

def range_with_surrounding_space(range, side = :both, with_newline = true)
  buffer = @processed_source.buffer
  src = buffer.source

  go_left, go_right = directions(side)

  begin_pos = range.begin_pos
  end_pos = range.end_pos
  begin_pos = move_pos(src, begin_pos, -1, go_left, /[ \t]/)
  begin_pos = move_pos(src, begin_pos, -1, go_left && with_newline, /\n/)
  end_pos = move_pos(src, end_pos, 1, go_right, /[ \t]/)
  end_pos = move_pos(src, end_pos, 1, go_right && with_newline, /\n/)
  Parser::Source::Range.new(buffer, begin_pos, end_pos)
end

.same_line?(n1, n2) ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
259
260
 
# File 'lib/rubocop/cop/util.rb', line 256

def same_line?(n1, n2)
  n1.respond_to?(:loc) &&
    n2.respond_to?(:loc) &&
    n1.loc.line == n2.loc.line
end

.source_range(source_buffer, line_number, column, length = 1) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/rubocop/cop/util.rb', line 90

def source_range(source_buffer, line_number, column, length = 1)
  if column.is_a?(Range)
    column_index = column.begin
    length = numeric_range_size(column)
  else
    column_index = column
  end

  line_begin_pos = if line_number.zero?
                     0
                   else
                     source_buffer.line_range(line_number).begin_pos
                   end
  begin_pos = line_begin_pos + column_index
  end_pos = begin_pos + length

  Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
end

.strip_quotes(str) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/util.rb', line 39

def strip_quotes(str)
  if str[0] == '"' || str[0] == "'"
    str[0] = ''
  else
    # we're dealing with %q or %Q
    str[0, 3] = ''
  end
  str[-1] = ''

  str
end

.stripped_source_upto(line) ⇒ Object 



270
271
272
 
# File 'lib/rubocop/cop/util.rb', line 270

def stripped_source_upto(line)
  processed_source[0..line].map(&:strip)
end

.to_string_literal(string) ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/rubocop/cop/util.rb', line 240

def to_string_literal(string)
  if needs_escaping?(string) && compatible_external_encoding_for?(string)
    string.inspect
  else
    "'#{string.gsub('\\') { '\\\\' }}'"
  end
end

.to_supported_styles(enforced_style) ⇒ Object 



279
280
281
282
283
 
# File 'lib/rubocop/cop/util.rb', line 279

def to_supported_styles(enforced_style)
  enforced_style
    .sub(/^Enforced/, 'Supported')
    .sub('Style', 'Styles')
end

.to_symbol_literal(string) ⇒ Object 



248
249
250
 
# File 'lib/rubocop/cop/util.rb', line 248

def to_symbol_literal(string)
  ":#{string.to_sym}"
end

.within_node?(inner, outer) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
181
182
 
# File 'lib/rubocop/cop/util.rb', line 178

def within_node?(inner, outer)
  o = outer.is_a?(AST::Node) ? outer.source_range : outer
  i = inner.is_a?(AST::Node) ? inner.source_range : inner
  i.begin_pos >= o.begin_pos && i.end_pos <= o.end_pos
end