# frozen_string_literal: true module RuboCop module Cop module Layout # This cop checks whether the multiline do end blocks have a newline # after the start of the block. Additionally, it checks whether the block # arguments, if any, are on the same line as the start of the block. # # @example # # bad # blah do |i| foo(i) # bar(i) # end # # # bad # blah do # |i| foo(i) # bar(i) # end # # # good # blah do |i| # foo(i) # bar(i) # end # # # bad # blah { |i| foo(i) # bar(i) # } # # # good # blah { |i| # foo(i) # bar(i) # } class MultilineBlockLayout < Cop MSG = 'Block body expression is on the same line as ' \ 'the block start.'.freeze ARG_MSG = 'Block argument expression is not on the same line as the ' \ 'block start.'.freeze def on_block(node) return if node.single_line? unless args_on_beginning_line?(node) add_offense_for_expression(node, node.arguments, ARG_MSG) end return unless node.body && node.loc.begin.line == node.body.first_line add_offense_for_expression(node, node.body, MSG) end def autocorrect(node) lambda do |corrector| unless args_on_beginning_line?(node) autocorrect_arguments(corrector, node) expr_before_body = node.arguments.source_range.end end return unless node.body expr_before_body ||= node.loc.begin if expr_before_body.line == node.body.first_line autocorrect_body(corrector, node, node.body) end end end private def args_on_beginning_line?(node) !node.arguments? || node.loc.begin.line == node.arguments.loc.last_line end def add_offense_for_expression(node, expr, msg) expression = expr.source_range range = range_between(expression.begin_pos, expression.end_pos) add_offense(node, location: range, message: msg) end def autocorrect_arguments(corrector, node) end_pos = range_with_surrounding_space( range: node.arguments.source_range, side: :right, newlines: false ).end_pos range = range_between(node.loc.begin.end.begin_pos, end_pos) corrector.replace(range, " |#{block_arg_string(node.arguments)}|") end def autocorrect_body(corrector, node, block_body) first_node = if block_body.begin_type? block_body.children.first else block_body end block_start_col = node.source_range.column corrector.insert_before(first_node.source_range, "\n #{' ' * block_start_col}") end def block_arg_string(args) args.children.map do |arg| if arg.mlhs_type? "(#{block_arg_string(arg)})" else arg.source end end.join(', ') end end end end end