rubocop 0.87.1

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

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks the indentation of the right hand side operand in
+      # binary operations that span more than one line.
+      #
+      # The `aligned` style checks that operators are aligned if they are part
+      # of an `if` or `while` condition, a `return` statement, etc. In other
+      # contexts, the second operand should be indented regardless of enforced
+      # style.
+      #
+      # @example EnforcedStyle: aligned (default)
+      #   # bad
+      #   if a +
+      #       b
+      #     something &&
+      #     something_else
+      #   end
+      #
+      #   # good
+      #   if a +
+      #      b
+      #     something &&
+      #       something_else
+      #   end
+      #
+      # @example EnforcedStyle: indented
+      #   # bad
+      #   if a +
+      #      b
+      #     something &&
+      #     something_else
+      #   end
+      #
+      #   # good
+      #   if a +
+      #       b
+      #     something &&
+      #       something_else
+      #   end
+      #
+      class MultilineOperationIndentation < Cop
+        include ConfigurableEnforcedStyle
+        include Alignment
+        include MultilineExpressionIndentation
+
+        def on_and(node)
+          check_and_or(node)
+        end
+
+        def on_or(node)
+          check_and_or(node)
+        end
+
+        def validate_config
+          return unless style == :aligned && cop_config['IndentationWidth']
+
+          raise ValidationError, 'The `Layout/MultilineOperationIndentation`' \
+                                ' 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?(node)
+          return false if node.send_type? && node.unary_operation?
+
+          !node.loc.dot # Don't check method calls with dot operator.
+        end
+
+        def check_and_or(node)
+          lhs, rhs = *node
+          range = offending_range(node, lhs, rhs.source_range, style)
+          check(range, node, lhs, rhs.source_range)
+        end
+
+        def offending_range(node, lhs, rhs, given_style)
+          return false unless begins_its_line?(rhs)
+          return false if not_for_this_cop?(node)
+
+          correct_column = if should_align?(node, rhs, given_style)
+                             node.loc.column
+                           else
+                             indentation(lhs) + correct_indentation(node)
+                           end
+          @column_delta = correct_column - rhs.column
+          rhs if @column_delta.nonzero?
+        end
+
+        def should_align?(node, rhs, given_style)
+          assignment_node = part_of_assignment_rhs(node, rhs)
+          if assignment_node
+            assignment_rhs = CheckAssignment.extract_rhs(assignment_node)
+            return true if begins_its_line?(assignment_rhs.source_range)
+          end
+
+          given_style == :aligned &&
+            (kw_node_with_special_indentation(node) ||
+             assignment_node ||
+             argument_in_method_call(node, :with_or_without_parentheses))
+        end
+
+        def message(node, lhs, rhs)
+          what = operation_description(node, rhs)
+          if should_align?(node, rhs, style)
+            "Align the operands of #{what} spanning multiple lines."
+          else
+            used_indentation = rhs.column - indentation(lhs)
+            "Use #{correct_indentation(node)} (not #{used_indentation}) " \
+              "spaces for indenting #{what} spanning multiple lines."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Here we check if the parameters on a multi-line method call or
+      # definition are aligned.
+      #
+      # To set the alignment of the first argument, use the cop
+      # FirstParameterIndentation.
+      #
+      # @example EnforcedStyle: with_first_parameter (default)
+      #   # good
+      #
+      #   def foo(bar,
+      #           baz)
+      #     123
+      #   end
+      #
+      #   def foo(
+      #     bar,
+      #     baz
+      #   )
+      #     123
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo(bar,
+      #        baz)
+      #     123
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo(
+      #     bar,
+      #        baz)
+      #     123
+      #   end
+      #
+      # @example EnforcedStyle: with_fixed_indentation
+      #   # good
+      #
+      #   def foo(bar,
+      #     baz)
+      #     123
+      #   end
+      #
+      #   def foo(
+      #     bar,
+      #     baz
+      #   )
+      #     123
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo(bar,
+      #           baz)
+      #     123
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo(
+      #     bar,
+      #        baz)
+      #     123
+      #   end
+      class ParameterAlignment < Cop
+        include Alignment
+
+        ALIGN_PARAMS_MSG = 'Align the parameters of a method definition if ' \
+          'they span more than one line.'
+
+        FIXED_INDENT_MSG = 'Use one level of indentation for parameters ' \
+          'following the first line of a multi-line method definition.'
+
+        def on_def(node)
+          return if node.arguments.size < 2
+
+          check_alignment(node.arguments, base_column(node, node.arguments))
+        end
+        alias on_defs on_def
+
+        def autocorrect(node)
+          AlignmentCorrector.correct(processed_source, node, column_delta)
+        end
+
+        private
+
+        def message(_node)
+          fixed_indentation? ? FIXED_INDENT_MSG : ALIGN_PARAMS_MSG
+        end
+
+        def fixed_indentation?
+          cop_config['EnforcedStyle'] == 'with_fixed_indentation'
+        end
+
+        def base_column(node, args)
+          if fixed_indentation?
+            lineno = target_method_lineno(node)
+            line = node.source_range.source_buffer.source_line(lineno)
+            indentation_of_line = /\S.*/.match(line).begin(0)
+            indentation_of_line + configured_indentation_width
+          else
+            display_column(args.first.source_range)
+          end
+        end
+
+        def target_method_lineno(node)
+          node.loc.keyword.line
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks whether the rescue and ensure keywords are aligned
+      # properly.
+      #
+      # @example
+      #
+      #   # bad
+      #   begin
+      #     something
+      #     rescue
+      #     puts 'error'
+      #   end
+      #
+      #   # good
+      #   begin
+      #     something
+      #   rescue
+      #     puts 'error'
+      #   end
+      class RescueEnsureAlignment < Cop
+        include RangeHelp
+
+        MSG = '`%<kw_loc>s` at %<kw_loc_line>d, %<kw_loc_column>d is not ' \
+              'aligned with `%<beginning>s` at ' \
+              '%<begin_loc_line>d, %<begin_loc_column>d.'
+        ANCESTOR_TYPES = %i[kwbegin def defs class module].freeze
+        RUBY_2_5_ANCESTOR_TYPES = (ANCESTOR_TYPES + %i[block]).freeze
+        ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS = %i[def defs].freeze
+        ALTERNATIVE_ACCESS_MODIFIERS = %i[public_class_method
+                                          private_class_method].freeze
+
+        def on_resbody(node)
+          check(node) unless modifier?(node)
+        end
+
+        def on_ensure(node)
+          check(node)
+        end
+
+        def autocorrect(node)
+          whitespace = whitespace_range(node)
+          # Some inline node is sitting before current node.
+          return nil unless whitespace.source.strip.empty?
+
+          alignment_node = alignment_node(node)
+          return false if alignment_node.nil?
+
+          new_column = alignment_node.loc.column
+          ->(corrector) { corrector.replace(whitespace, ' ' * new_column) }
+        end
+
+        def investigate(processed_source)
+          @modifier_locations =
+            processed_source.tokens.each_with_object([]) do |token, locations|
+              next unless token.rescue_modifier?
+
+              locations << token.pos
+            end
+        end
+
+        private
+
+        # Check alignment of node with rescue or ensure modifiers.
+
+        def check(node)
+          alignment_node = alignment_node(node)
+          return if alignment_node.nil?
+
+          alignment_loc = alignment_node.loc.expression
+          kw_loc        = node.loc.keyword
+
+          return if
+            alignment_loc.column == kw_loc.column ||
+            alignment_loc.line   == kw_loc.line
+
+          add_offense(
+            node,
+            location: kw_loc,
+            message: format_message(alignment_node, alignment_loc, kw_loc)
+          )
+        end
+
+        def format_message(alignment_node, alignment_loc, kw_loc)
+          format(
+            MSG,
+            kw_loc: kw_loc.source,
+            kw_loc_line: kw_loc.line,
+            kw_loc_column: kw_loc.column,
+            beginning: alignment_source(alignment_node, alignment_loc),
+            begin_loc_line: alignment_loc.line,
+            begin_loc_column: alignment_loc.column
+          )
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def alignment_source(node, starting_loc)
+          ending_loc =
+            case node.type
+            when :block, :kwbegin
+              node.loc.begin
+            when :def, :defs, :class, :module,
+                 :lvasgn, :ivasgn, :cvasgn, :gvasgn, :casgn
+              node.loc.name
+            when :masgn
+              mlhs_node, = *node
+              mlhs_node.loc.expression
+            else
+              # It is a wrapper with access modifier.
+              node.child_nodes.first.loc.name
+            end
+
+          range_between(starting_loc.begin_pos, ending_loc.end_pos).source
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        # We will use ancestor or wrapper with access modifier.
+
+        def alignment_node(node)
+          ancestor_node = ancestor_node(node)
+
+          return ancestor_node if ancestor_node.nil? ||
+                                  ancestor_node.kwbegin_type?
+
+          assignment_node = assignment_node(ancestor_node)
+          return assignment_node if same_line?(ancestor_node, assignment_node)
+
+          access_modifier_node = access_modifier_node(ancestor_node)
+          return access_modifier_node unless access_modifier_node.nil?
+
+          ancestor_node
+        end
+
+        def ancestor_node(node)
+          ancestor_types =
+            if target_ruby_version >= 2.5
+              RUBY_2_5_ANCESTOR_TYPES
+            else
+              ANCESTOR_TYPES
+            end
+
+          node.each_ancestor(*ancestor_types).first
+        end
+
+        def assignment_node(node)
+          assignment_node = node.ancestors.first
+          return nil unless
+            assignment_node&.assignment?
+
+          assignment_node
+        end
+
+        def access_modifier_node(node)
+          return nil unless
+            ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS.include?(node.type)
+
+          access_modifier_node = node.ancestors.first
+          return nil unless access_modifier?(access_modifier_node)
+
+          access_modifier_node
+        end
+
+        def modifier?(node)
+          return false unless @modifier_locations.respond_to?(:include?)
+
+          @modifier_locations.include?(node.loc.keyword)
+        end
+
+        def whitespace_range(node)
+          begin_pos      = node.loc.keyword.begin_pos
+          current_column = node.loc.keyword.column
+
+          range_between(begin_pos - current_column, begin_pos)
+        end
+
+        def access_modifier?(node)
+          return true if node.respond_to?(:access_modifier?) &&
+                         node.access_modifier?
+
+          return true if node.respond_to?(:method_name) &&
+                         ALTERNATIVE_ACCESS_MODIFIERS.include?(node.method_name)
+
+          false
+        end
+      end
+    end
+  end
+end