lib/rubocop/cop/layout/first_method_parameter_line_break.rb


# frozen_string_literal: true

module RuboCop
  module Cop
    module Layout
      # Checks for a line break before the first parameter in a
      # multi-line method parameter definition.
      #
      # @example AllowMultilineFinalElement: false (default)
      #
      #     # bad
      #     def method(foo, bar,
      #         baz)
      #       do_something
      #     end
      #
      #     # bad
      #     def method(foo, bar, baz = {
      #       :a => "b",
      #     })
      #       do_something
      #     end
      #
      #     # good
      #     def method(
      #         foo, bar,
      #         baz)
      #       do_something
      #     end
      #
      #     # good
      #     def method(
      #       foo, bar, baz = {
      #       :a => "b",
      #     })
      #       do_something
      #     end
      #
      #     # ignored
      #     def method foo,
      #         bar
      #       do_something
      #     end
      #
      # @example AllowMultilineFinalElement: true
      #
      #     # bad
      #     def method(foo, bar,
      #         baz)
      #       do_something
      #     end
      #
      #     # good
      #     def method(foo, bar, baz = {
      #       :a => "b",
      #     })
      #       do_something
      #     end
      #
      #     # good
      #     def method(
      #         foo, bar,
      #         baz)
      #       do_something
      #     end
      #
      #     # ignored
      #     def method foo,
      #         bar
      #       do_something
      #     end
      #
      class FirstMethodParameterLineBreak < Base
        include FirstElementLineBreak
        extend AutoCorrector

        MSG = 'Add a line break before the first parameter of a multi-line method parameter list.'

        def on_def(node)
          check_method_line_break(node, node.arguments, ignore_last: ignore_last_element?)
        end
        alias on_defs on_def

        private

        def ignore_last_element?
          !!cop_config['AllowMultilineFinalElement']
        end
      end
    end
  end
end