rubocop 0.87.1

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks that the closing brace in an array literal is either
+      # on the same line as the last array element or on a new line.
+      #
+      # When using the `symmetrical` (default) style:
+      #
+      # If an array's opening brace is on the same line as the first element
+      # of the array, then the closing brace should be on the same line as
+      # the last element of the array.
+      #
+      # If an array's opening brace is on the line above the first element
+      # of the array, then the closing brace should be on the line below
+      # the last element of the array.
+      #
+      # When using the `new_line` style:
+      #
+      # The closing brace of a multi-line array literal must be on the line
+      # after the last element of the array.
+      #
+      # When using the `same_line` style:
+      #
+      # The closing brace of a multi-line array literal must be on the same
+      # line as the last element of the array.
+      #
+      # @example EnforcedStyle: symmetrical (default)
+      #     # bad
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # bad
+      #     [
+      #       :a,
+      #       :b ]
+      #
+      #     # good
+      #     [ :a,
+      #       :b ]
+      #
+      #     # good
+      #     [
+      #       :a,
+      #       :b
+      #     ]
+      #
+      # @example EnforcedStyle: new_line
+      #     # bad
+      #     [
+      #       :a,
+      #       :b ]
+      #
+      #     # bad
+      #     [ :a,
+      #       :b ]
+      #
+      #     # good
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # good
+      #     [
+      #       :a,
+      #       :b
+      #     ]
+      #
+      # @example EnforcedStyle: same_line
+      #     # bad
+      #     [ :a,
+      #       :b
+      #     ]
+      #
+      #     # bad
+      #     [
+      #       :a,
+      #       :b
+      #     ]
+      #
+      #     # good
+      #     [
+      #       :a,
+      #       :b ]
+      #
+      #     # good
+      #     [ :a,
+      #       :b ]
+      class MultilineArrayBraceLayout < Cop
+        include MultilineLiteralBraceLayout
+
+        SAME_LINE_MESSAGE = 'The closing array brace must be on the same ' \
+          'line as the last array element when the opening brace is on the ' \
+          'same line as the first array element.'
+
+        NEW_LINE_MESSAGE = 'The closing array brace must be on the line ' \
+          'after the last array element when the opening brace is on a ' \
+          'separate line from the first array element.'
+
+        ALWAYS_NEW_LINE_MESSAGE = 'The closing array brace must be on the ' \
+          'line after the last array element.'
+
+        ALWAYS_SAME_LINE_MESSAGE = 'The closing array brace must be on the ' \
+          'same line as the last array element.'
+
+        def on_array(node)
+          check_brace_layout(node)
+        end
+
+        def autocorrect(node)
+          MultilineLiteralBraceCorrector.new(node, processed_source)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop ensures that each item in a multi-line array
+      # starts on a separate line.
+      #
+      # @example
+      #
+      #   # bad
+      #   [
+      #     a, b,
+      #     c
+      #   ]
+      #
+      #   # good
+      #   [
+      #     a,
+      #     b,
+      #     c
+      #   ]
+      class MultilineArrayLineBreaks < Cop
+        include MultilineElementLineBreaks
+
+        MSG = 'Each item in a multi-line array must start ' \
+          'on a separate line.'
+
+        def on_array(node)
+          check_line_breaks(node, node.children)
+        end
+
+        def autocorrect(node)
+          EmptyLineCorrector.insert_before(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks whether the multiline assignments have a newline
+      # after the assignment operator.
+      #
+      # @example EnforcedStyle: new_line (default)
+      #   # bad
+      #   foo = if expression
+      #     'bar'
+      #   end
+      #
+      #   # good
+      #   foo =
+      #     if expression
+      #       'bar'
+      #     end
+      #
+      #   # good
+      #   foo =
+      #     begin
+      #       compute
+      #     rescue => e
+      #       nil
+      #     end
+      #
+      # @example EnforcedStyle: same_line
+      #   # good
+      #   foo = if expression
+      #     'bar'
+      #   end
+      class MultilineAssignmentLayout < Cop
+        include CheckAssignment
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        NEW_LINE_OFFENSE = 'Right hand side of multi-line assignment is on ' \
+          'the same line as the assignment operator `=`.'
+
+        SAME_LINE_OFFENSE = 'Right hand side of multi-line assignment is not ' \
+          'on the same line as the assignment operator `=`.'
+
+        def check_assignment(node, rhs)
+          return if node.send_type? && node.loc.operator&.source != '='
+          return unless rhs
+          return unless supported_types.include?(rhs.type)
+          return if rhs.first_line == rhs.last_line
+
+          check_by_enforced_style(node, rhs)
+        end
+
+        def check_by_enforced_style(node, rhs)
+          case style
+          when :new_line
+            check_new_line_offense(node, rhs)
+          when :same_line
+            check_same_line_offense(node, rhs)
+          end
+        end
+
+        def check_new_line_offense(node, rhs)
+          return unless node.loc.operator.line == rhs.first_line
+
+          add_offense(node, message: NEW_LINE_OFFENSE)
+        end
+
+        def check_same_line_offense(node, rhs)
+          return unless node.loc.operator.line != rhs.first_line
+
+          add_offense(node, message: SAME_LINE_OFFENSE)
+        end
+
+        def autocorrect(node)
+          case style
+          when :new_line
+            ->(corrector) { corrector.insert_after(node.loc.operator, "\n") }
+          when :same_line
+            range = range_between(node.loc.operator.end_pos,
+                                  extract_rhs(node).source_range.begin_pos)
+
+            ->(corrector) { corrector.replace(range, ' ') }
+          end
+        end
+
+        private
+
+        def supported_types
+          @supported_types ||= cop_config['SupportedTypes'].map(&:to_sym)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,154 @@
+# 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. Putting block arguments on separate lines, because the whole
+      # line would otherwise be too long, is accepted.
+      #
+      # @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)
+      #   }
+      #
+      #   # good
+      #   blah { |
+      #     long_list,
+      #     of_parameters,
+      #     that_would_not,
+      #     fit_on_one_line
+      #   |
+      #     foo(i)
+      #     bar(i)
+      #   }
+      class MultilineBlockLayout < Cop
+        include RangeHelp
+
+        MSG = 'Block body expression is on the same line as ' \
+              'the block start.'
+        ARG_MSG = 'Block argument expression is not on the same line as the ' \
+                  'block start.'
+        PIPE_SIZE = '|'.length
+
+        def on_block(node)
+          return if node.single_line?
+
+          unless args_on_beginning_line?(node) ||
+                 line_break_necessary_in_args?(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 line_break_necessary_in_args?(node)
+          needed_length = node.source_range.column +
+                          node.source.lines.first.length +
+                          block_arg_string(node, node.arguments).length +
+                          PIPE_SIZE
+          needed_length > max_line_length
+        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, node.arguments)}|")
+        end
+
+        def autocorrect_body(corrector, node, block_body)
+          first_node = if block_body.begin_type? && !block_body.source.start_with?('(')
+                         block_body.children.first
+                       else
+                         block_body
+                       end
+
+          block_start_col = node.source_range.column
+
+          corrector.insert_before(first_node,
+                                  "\n  #{' ' * block_start_col}")
+        end
+
+        def block_arg_string(node, args)
+          arg_string = args.children.map do |arg|
+            if arg.mlhs_type?
+              "(#{block_arg_string(node, arg)})"
+            else
+              arg.source
+            end
+          end.join(', ')
+          arg_string += ',' if include_trailing_comma?(node.arguments)
+          arg_string
+        end
+
+        def include_trailing_comma?(args)
+          arg_count = args.each_descendant(:arg).to_a.size
+          arg_count == 1 && args.source.include?(',')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks that the closing brace in a hash literal is either
+      # on the same line as the last hash element, or a new line.
+      #
+      # When using the `symmetrical` (default) style:
+      #
+      # If a hash's opening brace is on the same line as the first element
+      # of the hash, then the closing brace should be on the same line as
+      # the last element of the hash.
+      #
+      # If a hash's opening brace is on the line above the first element
+      # of the hash, then the closing brace should be on the line below
+      # the last element of the hash.
+      #
+      # When using the `new_line` style:
+      #
+      # The closing brace of a multi-line hash literal must be on the line
+      # after the last element of the hash.
+      #
+      # When using the `same_line` style:
+      #
+      # The closing brace of a multi-line hash literal must be on the same
+      # line as the last element of the hash.
+      #
+      # @example EnforcedStyle: symmetrical (default)
+      #
+      #     # bad
+      #     { a: 1,
+      #       b: 2
+      #     }
+      #     # bad
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     { a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2
+      #     }
+      #
+      # @example EnforcedStyle: new_line
+      #     # bad
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # bad
+      #     { a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     { a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2
+      #     }
+      #
+      # @example EnforcedStyle: same_line
+      #     # bad
+      #     { a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # bad
+      #     {
+      #       a: 1,
+      #       b: 2
+      #     }
+      #
+      #     # good
+      #     {
+      #       a: 1,
+      #       b: 2 }
+      #
+      #     # good
+      #     { a: 1,
+      #       b: 2 }
+      class MultilineHashBraceLayout < Cop
+        include MultilineLiteralBraceLayout
+
+        SAME_LINE_MESSAGE = 'Closing hash brace must be on the same line as ' \
+          'the last hash element when opening brace is on the same line as ' \
+          'the first hash element.'
+
+        NEW_LINE_MESSAGE = 'Closing hash brace must be on the line after ' \
+          'the last hash element when opening brace is on a separate line ' \
+          'from the first hash element.'
+
+        ALWAYS_NEW_LINE_MESSAGE = 'Closing hash brace must be on the line ' \
+          'after the last hash element.'
+
+        ALWAYS_SAME_LINE_MESSAGE = 'Closing hash brace must be on the same ' \
+          'line as the last hash element.'
+
+        def on_hash(node)
+          check_brace_layout(node)
+        end
+
+        def autocorrect(node)
+          MultilineLiteralBraceCorrector.new(node, processed_source)
+        end
+      end
+    end
+  end
+end