Module: RuboCop::Cop::Util

Includes:
PathUtil
Included in:
Layout::EmptyLineAfterGuardClause, LineBreakCorrector, Metrics::Utils::CodeLengthCalculator, PercentLiteralCorrector, StringLiteralCorrector, Style::StringConcatenation
Defined in:
lib/rubocop/cop/util.rb

Overview

This module contains a collection of useful utility methods.

Constant Summary collapse

LITERAL_REGEX =

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

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

Class Method Summary collapse

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Class Method Details

.add_parentheses(node, corrector) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/util.rb', line 33

def add_parentheses(node, corrector)
  if !node.respond_to?(:arguments)
    corrector.wrap(node, '(', ')')
  elsif node.arguments.empty?
    corrector.insert_after(node, '()')
  else
    args_begin = args_begin(node)

    corrector.remove(args_begin)
    corrector.insert_before(args_begin, '(')
    corrector.insert_after(args_end(node), ')')
  end
end

.args_begin(node) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rubocop/cop/util.rb', line 47

def args_begin(node)
  loc = node.loc
  selector = if node.super_type? || node.yield_type?
               loc.keyword
             elsif node.def_type? || node.defs_type?
               loc.name
             else
               loc.selector
             end
  selector.end.resize(1)
end

.args_end(node) ⇒ Object 



59
60
61
 
# File 'lib/rubocop/cop/util.rb', line 59

def args_end(node)
  node.loc.expression.end
end

.begins_its_line?(range) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

.comment_line?(line_source) ⇒ Boolean

This is a bad API

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/rubocop/cop/util.rb', line 16

def comment_line?(line_source)
  /^\s*#/.match?(line_source)
end

.comment_lines?(node) ⇒ Boolean

Deprecated.

Use ‘ProcessedSource#line_with_comment?`, `contains_comment?` or similar

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/rubocop/cop/util.rb', line 21

def comment_lines?(node)
  processed_source[line_range(node)].any? { |line| comment_line?(line) }
end

.double_quotes_required?(string) ⇒ Boolean

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

Returns:

  • (Boolean) 


94
95
96
97
98
99
100
101
102
 
# File 'lib/rubocop/cop/util.rb', line 94

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 "\\\\".
  /'|(?<! \\) \\{2}* \\ (?![\\"])/x.match?(string)
end

.escape_string(string) ⇒ Object 



108
109
110
 
# File 'lib/rubocop/cop/util.rb', line 108

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.



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

def first_part_of_call_chain(node)
  while node
    case node.type
    when :send
      node = node.receiver
    when :block
      node = node.send_node
    else
      break
    end
  end
  node
end

.indent(node, offset: 0) ⇒ Object 



133
134
135
 
# File 'lib/rubocop/cop/util.rb', line 133

def indent(node, offset: 0)
  ' ' * (node.loc.column + offset)
end

.interpret_string_escapes(string) ⇒ Object 



125
126
127
 
# File 'lib/rubocop/cop/util.rb', line 125

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

.line_range(node) ⇒ Object 



25
26
27
 
# File 'lib/rubocop/cop/util.rb', line 25

def line_range(node)
  node.first_line..node.last_line
end

.needs_escaping?(string) ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/rubocop/cop/util.rb', line 104

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

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

Yields:

  • (sexp) 


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

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

  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

.parentheses?(node) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/rubocop/cop/util.rb', line 29

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

.same_line?(node1, node2) ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/rubocop/cop/util.rb', line 129

def same_line?(node1, node2)
  node1.respond_to?(:loc) && node2.respond_to?(:loc) && node1.loc.line == node2.loc.line
end

.to_string_literal(string) ⇒ Object 



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

def to_string_literal(string)
  if needs_escaping?(string) && compatible_external_encoding_for?(string)
    string.inspect
  else
    # In a single-quoted strings, double quotes don't need to be escaped
    "'#{string.gsub('\"', '"').gsub('\\') { '\\\\' }}'"
  end
end

.to_supported_styles(enforced_style) ⇒ Object 



137
138
139
 
# File 'lib/rubocop/cop/util.rb', line 137

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

.trim_string_interporation_escape_character(str) ⇒ Object 



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

def trim_string_interporation_escape_character(str)
  str.gsub(/\\\#\{(.*?)\}/) { "\#{#{Regexp.last_match(1)}}" }
end