# frozen_string_literal: true module RuboCop module Cop module Layout # This cop checks the indentation of the first parameter in a method call. # Parameters after the first one are checked by Layout/AlignParameters, # not by this cop. # # @example # # # bad # some_method( # first_param, # second_param) # # foo = some_method( # first_param, # second_param) # # foo = some_method(nested_call( # nested_first_param), # second_param) # # foo = some_method( # nested_call( # nested_first_param), # second_param) # # some_method nested_call( # nested_first_param), # second_param # # # Style: consistent # # # good # some_method( # first_param, # second_param) # # foo = some_method( # first_param, # second_param) # # foo = some_method(nested_call( # nested_first_param), # second_param) # # foo = some_method( # nested_call( # nested_first_param), # second_param) # # some_method nested_call( # nested_first_param), # second_param # # # Style: consistent_relative_to_receiver # # # good # some_method( # first_param, # second_param) # # foo = some_method( # first_param, # second_param) # # foo = some_method(nested_call( # nested_first_param), # second_param) # # foo = some_method( # nested_call( # nested_first_param), # second_param) # # some_method nested_call( # nested_first_param), # second_params # # # Style: special_for_inner_method_call # # # good # some_method( # first_param, # second_param) # # foo = some_method( # first_param, # second_param) # # foo = some_method(nested_call( # nested_first_param), # second_param) # # foo = some_method( # nested_call( # nested_first_param), # second_param) # # some_method nested_call( # nested_first_param), # second_param # # # Style: special_for_inner_method_call_in_parentheses # # # good # some_method( # first_param, # second_param) # # foo = some_method( # first_param, # second_param) # # foo = some_method(nested_call( # nested_first_param), # second_param) # # foo = some_method( # nested_call( # nested_first_param), # second_param) # # some_method nested_call( # nested_first_param), # second_param # class FirstParameterIndentation < Cop include Alignment include ConfigurableEnforcedStyle include RangeHelp MSG = 'Indent the first parameter one step more than %s.'.freeze def on_send(node) return if !node.arguments? || node.operator_method? indent = base_indentation(node) + configured_indentation_width check_alignment([node.first_argument], indent) end def autocorrect(node) AlignmentCorrector.correct(processed_source, node, column_delta) end private def message(arg_node) return 'Bad indentation of the first parameter.' unless arg_node send_node = arg_node.parent text = base_range(send_node, arg_node).source.strip base = if text !~ /\n/ && special_inner_call_indentation?(send_node) "`#{text}`" elsif text.lines.reverse_each.first =~ /^\s*#/ 'the start of the previous line (not counting the comment)' else 'the start of the previous line' end format(MSG, base: base) end def base_indentation(node) if special_inner_call_indentation?(node) column_of(base_range(node, node.first_argument)) else previous_code_line(node.first_argument.first_line) =~ /\S/ end end def special_inner_call_indentation?(node) return false if style == :consistent return true if style == :consistent_relative_to_receiver parent = node.parent return false unless eligible_method_call?(parent) return false if !parent.parenthesized? && style == :special_for_inner_method_call_in_parentheses # The node must begin inside the parent, otherwise node is the first # part of a chained method call. node.source_range.begin_pos > parent.source_range.begin_pos end def_node_matcher :eligible_method_call?, <<-PATTERN (send _ !:[]= ...) PATTERN def base_range(send_node, arg_node) range_between(send_node.source_range.begin_pos, arg_node.source_range.begin_pos) end # Returns the column of the given range. For single line ranges, this # is simple. For ranges with line breaks, we look a the last code line. def column_of(range) source = range.source.strip if source.include?("\n") previous_code_line(range.line + source.count("\n") + 1) =~ /\S/ else display_column(range) end end # Takes the line number of a given code line and returns a string # containing the previous line that's not a comment line or a blank # line. def previous_code_line(line_number) @comment_lines ||= processed_source .comments .select { |c| begins_its_line?(c.loc.expression) } .map { |c| c.loc.line } line = '' while line.blank? || @comment_lines.include?(line_number) line_number -= 1 line = processed_source.lines[line_number - 1] end line end end end end end