module RubbyCop::Cop::Util
This module contains a collection of useful utility methods.
Constants
- ASGN_NODES
- BYTE_ORDER_MARK
- CONDITIONAL_NODES
- EQUALS_ASGN_NODES
- LITERAL_REGEX
Match literal regex characters, not including anchors, character classes, alternatives, groups, repetitions, references, etc
- LOGICAL_OPERATOR_NODES
- MODIFIER_NODES
- OPERATOR_METHODS
phrogz.net/programmingruby/language.html#table_18.4 Backtick is added last just to help editors parse this code.
- SHORTHAND_ASGN_NODES
Public Instance Methods
# File lib/rubbycop/cop/util.rb, line 185 def begins_its_line?(range) (range.source_line =~ /\S/) == range.column end
# File lib/rubbycop/cop/util.rb, line 51 def block_length(block_node) block_node.loc.end.line - block_node.loc.begin.line end
# File lib/rubbycop/cop/util.rb, line 55 def comment_line?(line_source) line_source =~ /^\s*#/ end
# File lib/rubbycop/cop/util.rb, line 297 def compatible_external_encoding_for?(src) src = src.dup if RUBY_VERSION < '2.3' src.force_encoding(Encoding.default_external).valid_encoding? end
# File lib/rubbycop/cop/util.rb, line 177 def directions(side) if side == :both [true, true] else [side == :left, side == :right] end end
If converting a string to Ruby string literal source code, must double quotes be used?
# File lib/rubbycop/cop/util.rb, line 220 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
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.
# File lib/rubbycop/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
# File lib/rubbycop/cop/util.rb, line 189 def ends_its_line?(range) line = range.source_buffer.source_line(range.last_line) (line =~ /\s*\z/) == range.last_column end
# File lib/rubbycop/cop/util.rb, line 234 def escape_string(string) string.inspect[1..-2].tap { |s| s.gsub!(/\\"/, '"') } end
Returns, for example, a bare `if` node if the given node is an `if` with calls chained to the end of it.
# File lib/rubbycop/cop/util.rb, line 202 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
# File lib/rubbycop/cop/util.rb, line 275 def interpret_string_escapes(string) StringInterpreter.interpret(string) end
# File lib/rubbycop/cop/util.rb, line 285 def line_distance(n1, n2) n2.loc.line - n1.loc.line end
# File lib/rubbycop/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
# File lib/rubbycop/cop/util.rb, line 171 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
# File lib/rubbycop/cop/util.rb, line 230 def needs_escaping?(string) double_quotes_required?(escape_string(string)) end
# File lib/rubbycop/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
# File lib/rubbycop/cop/util.rb, line 35 def operator?(symbol) OPERATOR_METHODS.include?(symbol) end
# File lib/rubbycop/cop/util.rb, line 72 def parentheses?(node) node.loc.respond_to?(:end) && node.loc.end && node.loc.end.is?(')'.freeze) end
# File lib/rubbycop/cop/util.rb, line 77 def parenthesized_call?(send) send.loc.begin && send.loc.begin.is?('(') end
# File lib/rubbycop/cop/util.rb, line 289 def preceed?(n1, n2) line_distance(n1, n2) == 1 end
# File lib/rubbycop/cop/util.rb, line 122 def range_between(start_pos, end_pos) Parser::Source::Range.new(processed_source.buffer, start_pos, end_pos) end
# File lib/rubbycop/cop/util.rb, line 155 def range_by_whole_lines(range, include_final_newline: false) buffer = @processed_source.buffer begin_pos = range.begin_pos begin_offset = range.column begin_of_first_line = begin_pos - begin_offset last_line = buffer.source_line(range.last_line) end_pos = range.end_pos end_offset = last_line.length - range.last_column end_offset += 1 if include_final_newline end_of_last_line = end_pos + end_offset Parser::Source::Range.new(buffer, begin_of_first_line, end_of_last_line) end
# File lib/rubbycop/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
# File lib/rubbycop/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
# File lib/rubbycop/cop/util.rb, line 279 def same_line?(n1, n2) n1.respond_to?(:loc) && n2.respond_to?(:loc) && n1.loc.line == n2.loc.line end
# File lib/rubbycop/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 = column.size 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
# File lib/rubbycop/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
# File lib/rubbycop/cop/util.rb, line 293 def stripped_source_upto(line) processed_source[0..line].map(&:strip) end
# File lib/rubbycop/cop/util.rb, line 254 def symbol_without_quote?(string) special_gvars = %w[ $! $" $$ $& $' $* $+ $, $/ $; $: $. $< $= $> $? $@ $\\ $_ $` $~ $0 $-0 $-F $-I $-K $-W $-a $-d $-i $-l $-p $-v $-w ] redefinable_operators = %w( | ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~ ) # method name string =~ /\A[a-zA-Z_]\w*[!?]?\z/ || # instance / class variable string =~ /\A\@\@?[a-zA-Z_]\w*\z/ || # global variable string =~ /\A\$[1-9]\d*\z/ || string =~ /\A\$[a-zA-Z_]\w*\z/ || special_gvars.include?(string) || redefinable_operators.include?(string) end
# File lib/rubbycop/cop/util.rb, line 238 def to_string_literal(string) if needs_escaping?(string) && compatible_external_encoding_for?(string) string.inspect else "'#{string.gsub('\\') { '\\\\' }}'" end end
# File lib/rubbycop/cop/util.rb, line 302 def to_supported_styles(enforced_style) enforced_style .sub(/^Enforced/, 'Supported') .sub('Style', 'Styles') end
# File lib/rubbycop/cop/util.rb, line 246 def to_symbol_literal(string) if symbol_without_quote?(string) ":#{string}" else ":#{to_string_literal(string)}" end end
# File lib/rubbycop/cop/util.rb, line 194 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