lib/rubocop/cop/style/multiline_method_definition_brace_layout.rb


# encoding: utf-8
# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks that the closing brace in a method definition is
      # symmetrical with respect to the opening brace and the method
      # parameters.
      #
      # If a method definition's opening brace is on the same line as the
      # first parameter of the definition, then the closing brace should be
      # on the same line as the last parameter of the definition.
      #
      # If a method definition's opening brace is on a separate line from
      # the first parameter of the definition, then the closing brace should
      # be on the line after the last parameter of the definition.
      #
      # @example
      #
      #     # bad
      #     def foo(a,
      #       b
      #       )
      #     end
      #
      #     # bad
      #     def foo(
      #       a,
      #       b)
      #     end
      #
      #     # good
      #     def foo(a,
      #       b)
      #     end
      #
      #     #good
      #     def foo(
      #       a,
      #       b
      #     )
      #     end
      class MultilineMethodDefinitionBraceLayout < Cop
        include OnMethodDef
        include MultilineLiteralBraceLayout

        SAME_LINE_MESSAGE = 'Closing method definition brace must be on the ' \
          'same line as the last parameter when opening brace is on the same ' \
          'line as the first parameter.'.freeze

        NEW_LINE_MESSAGE = 'Closing method definition brace must be on the ' \
          'line after the last parameter when opening brace is on a separate ' \
          'line from the first parameter.'.freeze

        def on_method_def(_node, _method_name, args, _body)
          check_brace_layout(args)
        end
      end
    end
  end
end