rubocop 0.78.0

data/lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks that the closing brace in a method call is either
+      # on the same line as the last method argument, or a new line.
+      #
+      # When using the `symmetrical` (default) style:
+      #
+      # If a method call's opening brace is on the same line as the first
+      # argument of the call, then the closing brace should be on the same
+      # line as the last argument of the call.
+      #
+      # If an method call's opening brace is on the line above the first
+      # argument of the call, then the closing brace should be on the line
+      # below the last argument of the call.
+      #
+      # When using the `new_line` style:
+      #
+      # The closing brace of a multi-line method call must be on the line
+      # after the last argument of the call.
+      #
+      # When using the `same_line` style:
+      #
+      # The closing brace of a multi-line method call must be on the same
+      # line as the last argument of the call.
+      #
+      # @example EnforcedStyle: symmetrical (default)
+      #   # bad
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # bad
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b)
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      # @example EnforcedStyle: new_line
+      #   # bad
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # bad
+      #   foo(a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      # @example EnforcedStyle: same_line
+      #   # bad
+      #   foo(a,
+      #     b
+      #   )
+      #
+      #   # bad
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      #   # good
+      #   foo(
+      #     a,
+      #     b)
+      #
+      #   # good
+      #   foo(a,
+      #     b)
+      class MultilineMethodCallBraceLayout < Cop
+        include MultilineLiteralBraceLayout
+
+        SAME_LINE_MESSAGE = 'Closing method call brace must be on the ' \
+          'same line as the last argument when opening brace is on the same ' \
+          'line as the first argument.'
+
+        NEW_LINE_MESSAGE = 'Closing method call brace must be on the ' \
+          'line after the last argument when opening brace is on a separate ' \
+          'line from the first argument.'
+
+        ALWAYS_NEW_LINE_MESSAGE = 'Closing method call brace must be on ' \
+          'the line after the last argument.'
+
+        ALWAYS_SAME_LINE_MESSAGE = 'Closing method call brace must be on ' \
+          'the same line as the last argument.'
+
+        def on_send(node)
+          check_brace_layout(node)
+        end
+
+        def autocorrect(node)
+          MultilineLiteralBraceCorrector.new(node, processed_source)
+        end
+
+        private
+
+        def children(node)
+          node.arguments
+        end
+
+        def ignored_literal?(node)
+          single_line_ignoring_receiver?(node) || super
+        end
+
+        def single_line_ignoring_receiver?(node)
+          return false unless node.loc.begin && node.loc.end
+
+          node.loc.begin.line == node.loc.end.line
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/multiline_method_call_indentation.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks the indentation of the method name part in method calls
+      # that span more than one line.
+      #
+      # @example EnforcedStyle: aligned (default)
+      #   # bad
+      #   while myvariable
+      #   .b
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   while myvariable
+      #         .b
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   Thing.a
+      #        .b
+      #        .c
+      #
+      # @example EnforcedStyle: indented
+      #   # good
+      #   while myvariable
+      #     .b
+      #
+      #     # do something
+      #   end
+      #
+      # @example EnforcedStyle: indented_relative_to_receiver
+      #   # good
+      #   while myvariable
+      #           .a
+      #           .b
+      #
+      #     # do something
+      #   end
+      #
+      #   # good
+      #   myvariable = Thing
+      #                  .a
+      #                  .b
+      #                  .c
+      class MultilineMethodCallIndentation < Cop
+        include ConfigurableEnforcedStyle
+        include Alignment
+        include MultilineExpressionIndentation
+
+        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
+
+        def autocorrect(node)
+          AlignmentCorrector.correct(processed_source, node, @column_delta)
+        end
+
+        private
+
+        def relevant_node?(send_node)
+          send_node.loc.dot # Only check method calls with dot operator
+        end
+
+        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 extra_indentation(given_style)
+          if given_style == :indented_relative_to_receiver
+            configured_indentation_width
+          else
+            0
+          end
+        end
+
+        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 should_indent_relative_to_receiver?
+          @base && style == :indented_relative_to_receiver
+        end
+
+        def should_align_with_base?
+          @base && style != :indented_relative_to_receiver
+        end
+
+        def relative_to_receiver_message(rhs)
+          "Indent `#{rhs.source}` #{configured_indentation_width} spaces " \
+            "more than `#{base_source}` on line #{@base.line}."
+        end
+
+        def align_with_base_message(rhs)
+          "Align `#{rhs.source}` with `#{base_source}` on line #{@base.line}."
+        end
+
+        def base_source
+          @base.source[/[^\n]*/]
+        end
+
+        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 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 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
+
+        # a.b
+        #  .c
+        def semantic_alignment_base(node, rhs)
+          return unless rhs.source.start_with?('.')
+
+          node = semantic_alignment_node(node)
+          return unless node&.loc&.selector
+
+          node.loc.dot.join(node.loc.selector)
+        end
+
+        # a
+        #   .b
+        #   .c
+        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
+        end
+
+        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 operation_rhs(node)
+          operation_rhs = node.receiver.each_ancestor(:send).find do |rhs|
+            operator_rhs?(rhs, node.receiver)
+          end
+
+          return unless operation_rhs
+
+          yield operation_rhs.first_argument
+        end
+
+        def operator_rhs?(node, receiver)
+          node.operator_method? && node.arguments? &&
+            within_node?(receiver, node.first_argument)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks that the closing brace in a method definition is either
+      # on the same line as the last method parameter, or a new line.
+      #
+      # When using the `symmetrical` (default) style:
+      #
+      # 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 an method definition's opening brace is on the line above the first
+      # parameter of the definition, then the closing brace should be on the
+      # line below the last parameter of the definition.
+      #
+      # When using the `new_line` style:
+      #
+      # The closing brace of a multi-line method definition must be on the line
+      # after the last parameter of the definition.
+      #
+      # When using the `same_line` style:
+      #
+      # The closing brace of a multi-line method definition must be on the same
+      # line as the last parameter of the definition.
+      #
+      # @example EnforcedStyle: symmetrical (default)
+      #   # bad
+      #   def foo(a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # bad
+      #   def foo(
+      #     a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b
+      #   )
+      #   end
+      #
+      # @example EnforcedStyle: new_line
+      #   # bad
+      #   def foo(
+      #     a,
+      #     b)
+      #   end
+      #
+      #   # bad
+      #   def foo(a,
+      #     b)
+      #   end
+      #
+      #   # good
+      #   def foo(a,
+      #     b
+      #   )
+      #   end
+      #
+      #   # good
+      #   def foo(
+      #     a,
+      #     b
+      #   )
+      #   end
+      #
+      # @example EnforcedStyle: same_line
+      #   # 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 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.'
+
+        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.'
+
+        ALWAYS_NEW_LINE_MESSAGE = 'Closing method definition brace must be ' \
+          'on the line after the last parameter.'
+
+        ALWAYS_SAME_LINE_MESSAGE = 'Closing method definition brace must be ' \
+          'on the same line as the last parameter.'
+
+        def on_def(node)
+          check_brace_layout(node.arguments)
+        end
+        alias on_defs on_def
+
+        def autocorrect(node)
+          MultilineLiteralBraceCorrector.new(node, processed_source)
+        end
+      end
+    end
+  end
+end