module RuboCop::Cop::Util
def begins_its_line?(range)
def begins_its_line?(range) source_before_end = range.source_buffer.source[0...range.begin_pos] source_before_end =~ /\n\s*\Z/ end
def block_length(block_node)
def block_length(block_node) block_node.loc.end.line - block_node.loc.begin.line end
def command?(name, node)
def command?(name, node) return unless node.type == :send receiver, method_name, _args = *node # commands have no explicit receiver !receiver && method_name == name end
def comment_line?(line_source)
def comment_line?(line_source) line_source =~ /^\s*#/ end
def const_name(node)
def const_name(node) return nil if node.nil? || node.type != :const const_names = [] const_node = node loop do namespace_node, name = *const_node const_names << name break unless namespace_node break unless namespace_node.is_a?(Parser::AST::Node) break if namespace_node.type == :cbase const_node = namespace_node end const_names.reverse.join('::') end
def directions(side)
def directions(side) if side == :both [true, true] else [side == :left, side == :right] end end
def first_part_of_call_chain(node)
Returns, for example, a bare `if` node if the given node is an `if`
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
def lambda?(node)
def lambda?(node) fail 'Not a block node' unless node.type == :block send_node, _block_args, _block_body = *node command?(:lambda, send_node) end
def lambda_or_proc?(node)
def lambda_or_proc?(node) lambda?(node) || proc?(node) end
def line_range(arg)
def line_range(arg) source_range = case arg when Parser::Source::Range arg when Parser::AST::Node arg.loc.expression else fail ArgumentError, "Invalid argument #{arg}" end source_range.begin.line..source_range.end.line end
def move_pos(src, pos, step, condition, regexp)
def move_pos(src, pos, step, condition, regexp) offset = step == -1 ? -1 : 0 pos += step while condition && src[pos + offset] =~ regexp pos end
def numeric_range_size(range)
def numeric_range_size(range) size = range.end - range.begin size += 1 unless range.exclude_end? size = 0 if size < 0 size end
def on_node(syms, sexp, excludes = [])
def on_node(syms, sexp, excludes = []) yield sexp if Array(syms).include?(sexp.type) return if Array(excludes).include?(sexp.type) sexp.children.each do |elem| next unless elem.is_a?(Parser::AST::Node) on_node(syms, elem, excludes) { |s| yield s } end end
def operator?(symbol)
def operator?(symbol) OPERATOR_METHODS.include?(symbol) end
def parentheses?(node)
def parentheses?(node) node.loc.respond_to?(:end) && node.loc.end end
def proc?(node)
def proc?(node) fail 'Not a block node' unless node.type == :block send_node, _block_args, _block_body = *node command?(:proc, send_node) || send_node == PROC_NEW_NODE end
def range_with_surrounding_comma(range, side = :both, buffer = nil)
def range_with_surrounding_comma(range, side = :both, buffer = nil) 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
def range_with_surrounding_space(range, side = :both, buffer = nil,
def range_with_surrounding_space(range, side = :both, buffer = nil, 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
def source_range(source_buffer, line_number, column, length = 1)
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 preceding_line_numbers = (1...line_number) line_begin_pos = preceding_line_numbers.reduce(0) do |pos, line| pos + source_buffer.source_line(line).length + 1 end begin_pos = line_begin_pos + column_index end_pos = begin_pos + length Parser::Source::Range.new(source_buffer, begin_pos, end_pos) end
def strip_quotes(str)
def strip_quotes(str) if str[0] == '"' || str[0] == "'" str[0] = '' str[-1] = '' else # we're dealing with %q or %Q str[0, 3] = '' str[-1] = '' end str end
def within_node?(inner, outer)
def within_node?(inner, outer) o = outer.loc.expression i = inner.loc.expression i.begin_pos >= o.begin_pos && i.end_pos <= o.end_pos end