class RuboCop::Cop::Layout::MultilineMethodCallIndentation
.c
.b
.a
myvariable = Thing
# good
end
# do something
.b
.a
while myvariable
# good
@example EnforcedStyle: indented_relative_to_receiver
end
# do something
.b
while myvariable
# good
@example EnforcedStyle: indented
.c
.b
Thing.a
# good
end
# do something
.b
while myvariable
# good
end
# do something
.b
while myvariable
# bad
@example EnforcedStyle: aligned (default)
that span more than one line.
This cop checks the indentation of the method name part in method calls
def align_with_base_message(rhs)
def align_with_base_message(rhs) "Align `#{rhs.source}` with `#{base_source}` on line #{@base.line}." end
def alignment_base(node, rhs, given_style)
def alignment_base(node, rhs, given_style) case given_style when :aligned semantic_alignment_base(node, rhs) || syntactic_alignment_base(node, rhs) when :indented nil when :indented_relative_to_receiver receiver_alignment_base(node) end end
def autocorrect(node)
def autocorrect(node) AlignmentCorrector.correct(processed_source, node, @column_delta) end
def base_source
def base_source @base.source[/[^\n]*/] end
def extra_indentation(given_style)
def extra_indentation(given_style) if given_style == :indented_relative_to_receiver configured_indentation_width else 0 end end
def message(node, lhs, rhs)
def message(node, lhs, rhs) if should_indent_relative_to_receiver? relative_to_receiver_message(rhs) elsif should_align_with_base? align_with_base_message(rhs) else no_base_message(lhs, rhs, node) end end
def no_base_message(lhs, rhs, node)
def no_base_message(lhs, rhs, node) used_indentation = rhs.column - indentation(lhs) what = operation_description(node, rhs) "Use #{correct_indentation(node)} (not #{used_indentation}) " \ "spaces for indenting #{what} spanning multiple lines." end
def offending_range(node, lhs, rhs, given_style)
def offending_range(node, lhs, rhs, given_style) return false unless begins_its_line?(rhs) return false if not_for_this_cop?(node) @base = alignment_base(node, rhs, given_style) correct_column = if @base @base.column + extra_indentation(given_style) else indentation(lhs) + correct_indentation(node) end @column_delta = correct_column - rhs.column rhs if @column_delta.nonzero? end
def operation_rhs(node)
def operation_rhs(node) receiver, = *node operation_rhs = receiver.each_ancestor(:send).find do |rhs| operator_rhs?(rhs, receiver) end return unless operation_rhs yield operation_rhs.first_argument end
def operator_rhs?(node, receiver)
def operator_rhs?(node, receiver) node.operator_method? && node.arguments? && within_node?(receiver, node.first_argument) end
def receiver_alignment_base(node)
.b
a
def receiver_alignment_base(node) node = node.receiver while node.receiver node = node.parent node = node.parent until node.loc.dot node.receiver.source_range if node end
def relative_to_receiver_message(rhs)
def relative_to_receiver_message(rhs) "Indent `#{rhs.source}` #{configured_indentation_width} spaces " \ "more than `#{base_source}` on line #{@base.line}." end
def relevant_node?(send_node)
def relevant_node?(send_node) send_node.loc.dot # Only check method calls with dot operator end
def semantic_alignment_base(node, rhs)
a.b
def semantic_alignment_base(node, rhs) return unless rhs.source.start_with?('.') node = semantic_alignment_node(node) return unless node && node.loc.selector node.loc.dot.join(node.loc.selector) end
def semantic_alignment_node(node)
def semantic_alignment_node(node) return if argument_in_method_call(node, :with_parentheses) # descend to root of method chain node = node.receiver while node.receiver # ascend to first call which has a dot node = node.parent node = node.parent until node.loc.dot return if node.loc.dot.line != node.first_line node end
def should_align_with_base?
def should_align_with_base? @base && style != :indented_relative_to_receiver end
def should_indent_relative_to_receiver?
def should_indent_relative_to_receiver? @base && style == :indented_relative_to_receiver end
def syntactic_alignment_base(lhs, rhs)
def syntactic_alignment_base(lhs, rhs) # a if b # .c kw_node_with_special_indentation(lhs) do |base| return indented_keyword_expression(base).source_range end # a = b # .c part_of_assignment_rhs(lhs, rhs) do |base| return assignment_rhs(base).source_range end # a + b # .c operation_rhs(lhs) do |base| return base.source_range end end
def validate_config
def validate_config return unless style == :aligned && cop_config['IndentationWidth'] raise ValidationError, 'The `Layout/MultilineMethodCallIndentation`' \ ' cop only accepts an `IndentationWidth` ' \ 'configuration parameter when ' \ '`EnforcedStyle` is `indented`.' end