rubocop 0.75.1 → 0.93.1

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

@@ -20,8 +20,9 @@ module RuboCop
       #     # ...
       #
       #   end
-      class EmptyLinesAroundMethodBody < Cop
+      class EmptyLinesAroundMethodBody < Base
         include EmptyLinesAroundBody
+        extend AutoCorrector
 
         KIND = 'method'
 
@@ -30,10 +31,6 @@ module RuboCop
         end
         alias on_defs on_def
 
-        def autocorrect(node)
-          EmptyLineCorrector.correct(node)
-        end
-
         private
 
         def style

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

@@ -44,18 +44,15 @@ module RuboCop
       #       # ...
       #     end
       #   end
-      class EmptyLinesAroundModuleBody < Cop
+      class EmptyLinesAroundModuleBody < Base
         include EmptyLinesAroundBody
+        extend AutoCorrector
 
         KIND = 'module'
 
         def on_module(node)
           check(node, node.body)
         end
-
-        def autocorrect(node)
-          EmptyLineCorrector.correct(node)
-        end
       end
     end
   end

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

@@ -17,6 +17,11 @@ module RuboCop
       # If it's set to `start_of_line`, the `end` shall be aligned with the
       # start of the line where the matching keyword appears.
       #
+      # This `Layout/EndAlignment` cop aligns with keywords (e.g. `if`, `while`, `case`)
+      # by default. On the other hand, `Layout/BeginEndAlignment` cop aligns with
+      # `EnforcedStyleAlignWith: start_of_line` by default due to `||= begin` tends
+      # to align with the start of the line. These style can be configured by each cop.
+      #
       # @example EnforcedStyleAlignWith: keyword (default)
       #   # bad
       #
@@ -67,10 +72,11 @@ module RuboCop
       #   variable =
       #     if true
       #     end
-      class EndAlignment < Cop
+      class EndAlignment < Base
         include CheckAssignment
         include EndKeywordAlignment
         include RangeHelp
+        extend AutoCorrector
 
         def on_class(node)
           check_other_alignment(node)
@@ -100,14 +106,12 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          AlignmentCorrector.align_end(processed_source,
-                                       node,
-                                       alignment_node(node))
-        end
-
         private
 
+        def autocorrect(corrector, node)
+          AlignmentCorrector.align_end(corrector, processed_source, node, alignment_node(node))
+        end
+
         def check_assignment(node, rhs)
           # If there are method calls chained to the right hand side of the
           # assignment, we let rhs be the receiver of those method calls before
@@ -150,9 +154,10 @@ module RuboCop
         end
 
         def alignment_node(node)
-          if style == :keyword
+          case style
+          when :keyword
             node
-          elsif style == :variable
+          when :variable
             alignment_node_for_variable_style(node)
           else
             start_line_range(node)
@@ -173,16 +178,6 @@ module RuboCop
             node
           end
         end
-
-        def start_line_range(node)
-          expr   = node.source_range
-          buffer = expr.source_buffer
-          source = buffer.source_line(expr.line)
-          range  = buffer.line_range(expr.line)
-
-          range_between(range.begin_pos + (source =~ /\S/),
-                        range.begin_pos + (source =~ /\s*\z/))
-        end
       end
     end
   end

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

@@ -45,9 +45,7 @@ module RuboCop
         MSG_MISSING = 'Carriage return character missing.'
 
         def investigate(processed_source)
-          last_token = processed_source.tokens.last
-          last_line =
-            last_token ? last_token.line : processed_source.lines.length
+          last_line = last_line(processed_source)
 
           processed_source.raw_source.each_line.with_index do |line, index|
             break if index >= last_line
@@ -67,7 +65,7 @@ module RuboCop
 
         # If there is no LF on the last line, we don't care if there's no CR.
         def unimportant_missing_cr?(index, last_line, line)
-          style == :crlf && index == last_line - 1 && line !~ /\n$/
+          style == :crlf && index == last_line - 1 && !/\n$/.match?(line)
         end
 
         def offense_message(line)
@@ -77,10 +75,17 @@ module RuboCop
                               style
                             end
           case effective_style
-          when :lf then MSG_DETECTED if line =~ /\r$/
-          else MSG_MISSING if line !~ /\r$/
+          when :lf then MSG_DETECTED if line.end_with?("\r", "\r\n")
+          else MSG_MISSING unless line.end_with?("\r\n")
           end
         end
+
+        private
+
+        def last_line(processed_source)
+          last_token = processed_source.tokens.last
+          last_token ? last_token.line : processed_source.lines.length
+        end
       end
     end
   end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module RuboCop
   module Cop
     module Layout
@@ -30,7 +28,8 @@ module RuboCop
       #   object.method(arg)         # this is a comment
       #   another_object.method(arg) # this is another comment
       #   some_object.method(arg)    # this is some comment
-      class ExtraSpacing < Cop
+      class ExtraSpacing < Base
+        extend AutoCorrector
         include PrecedingFollowingAlignment
         include RangeHelp
 
@@ -38,9 +37,10 @@ module RuboCop
         MSG_UNALIGNED_ASGN = '`=` is not aligned with the %<location>s ' \
                              'assignment.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
+          @aligned_comments = aligned_locations(processed_source.comments.map(&:loc))
           @corrected = Set.new if force_equal_sign_alignment?
 
           processed_source.tokens.each_cons(2) do |token1, token2|
@@ -48,18 +48,20 @@ module RuboCop
           end
         end
 
-        def autocorrect(range)
-          lambda do |corrector|
-            if range.source.end_with?('=')
-              align_equal_signs(range, corrector)
-            else
-              corrector.remove(range)
-            end
+        private
+
+        def aligned_locations(locs)
+          return [] if locs.empty?
+
+          aligned = Set[locs.first.line, locs.last.line]
+          locs.each_cons(3) do |before, loc, after|
+            col = loc.column
+            aligned << loc.line if col == before.column || # rubocop:disable Style/MultipleComparison
+                                   col == after.column
           end
+          aligned
         end
 
-        private
-
         def check_tokens(ast, token1, token2)
           return if token2.type == :tNL
 
@@ -74,7 +76,9 @@ module RuboCop
           return unless aligned_with_preceding_assignment(token) == :no
 
           message = format(MSG_UNALIGNED_ASGN, location: 'preceding')
-          add_offense(token.pos, location: token.pos, message: message)
+          add_offense(token.pos, message: message) do |corrector|
+            align_equal_signs(token.pos, corrector)
+          end
         end
 
         def check_other(token1, token2, ast)
@@ -84,7 +88,9 @@ module RuboCop
           extra_space_range(token1, token2) do |range|
             next if ignored_range?(ast, range.begin_pos)
 
-            add_offense(range, location: range, message: MSG_UNNECESSARY)
+            add_offense(range, message: MSG_UNNECESSARY) do |corrector|
+              corrector.remove(range)
+            end
           end
         end
 
@@ -102,7 +108,7 @@ module RuboCop
 
         def aligned_tok?(token)
           if token.comment?
-            aligned_comments?(token)
+            @aligned_comments.include?(token.line)
           else
             aligned_with_something?(token.pos)
           end
@@ -114,7 +120,7 @@ module RuboCop
 
         # Returns an array of ranges that should not be reported. It's the
         # extra spaces between the keys and values in a multiline hash,
-        # since those are handled by the Style/AlignHash cop.
+        # since those are handled by the Layout/HashAlignment cop.
         def ignored_ranges(ast)
           return [] unless ast
 
@@ -126,26 +132,6 @@ module RuboCop
           end.compact
         end
 
-        def aligned_comments?(comment_token)
-          ix = processed_source.comments.index do |comment|
-            comment.loc.expression.begin_pos == comment_token.begin_pos
-          end
-          aligned_with_previous_comment?(ix) || aligned_with_next_comment?(ix)
-        end
-
-        def aligned_with_previous_comment?(index)
-          index.positive? && comment_column(index - 1) == comment_column(index)
-        end
-
-        def aligned_with_next_comment?(index)
-          index < processed_source.comments.length - 1 &&
-            comment_column(index + 1) == comment_column(index)
-        end
-
-        def comment_column(index)
-          processed_source.comments[index].loc.column
-        end
-
         def force_equal_sign_alignment?
           cop_config['ForceEqualSignAlignment']
         end

data/lib/rubocop/cop/layout/{indent_first_argument.rb → first_argument_indentation.rb}

@@ -2,14 +2,13 @@
 
 module RuboCop
   module Cop
-    # rubocop:disable Metrics/LineLength
     module Layout
       # This cop checks the indentation of the first argument in a method call.
-      # Arguments after the first one are checked by Layout/AlignArguments,
+      # Arguments after the first one are checked by Layout/ArgumentAlignment,
       # not by this cop.
       #
-      # For indenting the first parameter of method *definitions*, check out
-      # Layout/IndentFirstParameter.
+      # For indenting the first parameter of method _definitions_, check out
+      # Layout/FirstParameterIndentation.
       #
       # @example
       #
@@ -142,8 +141,7 @@ module RuboCop
       #     nested_first_param),
       #   second_param
       #
-      class IndentFirstArgument < Cop
-        # rubocop:enable Metrics/LineLength
+      class FirstArgumentIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp
@@ -170,7 +168,7 @@ module RuboCop
 
           send_node = arg_node.parent
           text = base_range(send_node, arg_node).source.strip
-          base = if text !~ /\n/ && special_inner_call_indentation?(send_node)
+          base = if !/\n/.match?(text) && special_inner_call_indentation?(send_node)
                    "`#{text}`"
                  elsif comment_line?(text.lines.reverse_each.first)
                    'the start of the previous line (not counting the comment)'
@@ -228,18 +226,24 @@ module RuboCop
         # containing the previous line that's not a comment line or a blank
         # line.
         def previous_code_line(line_number)
+          line = ''
+          while line.blank? || comment_lines.include?(line_number)
+            line_number -= 1
+            line = processed_source.lines[line_number - 1]
+          end
+          line
+        end
+
+        def comment_lines
           @comment_lines ||=
             processed_source
             .comments
             .select { |c| begins_its_line?(c.loc.expression) }
             .map { |c| c.loc.line }
+        end
 
-          line = ''
-          while line.blank? || @comment_lines.include?(line_number)
-            line_number -= 1
-            line = processed_source.lines[line_number - 1]
-          end
-          line
+        def on_new_investigation
+          @comment_lines = nil
         end
       end
     end

data/lib/rubocop/cop/layout/{indent_first_array_element.rb → first_array_element_indentation.rb}

@@ -5,7 +5,7 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the first element in an array literal
       # where the opening bracket and the first element are on separate lines.
-      # The other elements' indentations are handled by the AlignArray cop.
+      # The other elements' indentations are handled by the ArrayAlignment cop.
       #
       # By default, array literals that are arguments in a method call with
       # parentheses, and where the opening square bracket of the array is on the
@@ -22,7 +22,7 @@ module RuboCop
       # @example EnforcedStyle: special_inside_parentheses (default)
       #   # The `special_inside_parentheses` style enforces that the first
       #   # element in an array literal where the opening bracket and first
-      #   # element are on seprate lines is indented one step (two spaces) more
+      #   # element are on separate lines is indented one step (two spaces) more
       #   # than the position inside the opening parenthesis.
       #
       #   #bad
@@ -44,7 +44,7 @@ module RuboCop
       # @example EnforcedStyle: consistent
       #   # The `consistent` style enforces that the first element in an array
       #   # literal where the opening bracket and the first element are on
-      #   # seprate lines is indented the same as an array literal which is not
+      #   # separate lines is indented the same as an array literal which is not
       #   # defined inside a method call.
       #
       #   #bad
@@ -79,7 +79,7 @@ module RuboCop
       #   and_now_for_something = [
       #                             :completely_different
       #                           ]
-      class IndentFirstArrayElement < Cop
+      class FirstArrayElementIndentation < Cop
         include Alignment
         include ConfigurableEnforcedStyle
         include MultilineElementIndentation
@@ -125,21 +125,13 @@ module RuboCop
 
         def check_right_bracket(right_bracket, left_bracket, left_parenthesis)
           # if the right bracket is on the same line as the last value, accept
-          return if right_bracket.source_line[0...right_bracket.column] =~ /\S/
+          return if /\S/.match?(right_bracket.source_line[0...right_bracket.column])
 
           expected_column = base_column(left_bracket, left_parenthesis)
           @column_delta = expected_column - right_bracket.column
           return if @column_delta.zero?
 
-          msg = if style == :align_brackets
-                  'Indent the right bracket the same as the left bracket.'
-                elsif style == :special_inside_parentheses && left_parenthesis
-                  'Indent the right bracket the same as the first position ' \
-                  'after the preceding left parenthesis.'
-                else
-                  'Indent the right bracket the same as the start of the line' \
-                  ' where the left bracket is.'
-                end
+          msg = msg(left_parenthesis)
           add_offense(right_bracket, location: right_bracket, message: msg)
         end
 
@@ -161,6 +153,18 @@ module RuboCop
             base_description: base_description
           )
         end
+
+        def msg(left_parenthesis)
+          if style == :align_brackets
+            'Indent the right bracket the same as the left bracket.'
+          elsif style == :special_inside_parentheses && left_parenthesis
+            'Indent the right bracket the same as the first position ' \
+            'after the preceding left parenthesis.'
+          else
+            'Indent the right bracket the same as the start of the line' \
+            ' where the left bracket is.'
+          end
+        end
       end
     end
   end

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

@@ -17,8 +17,9 @@ module RuboCop
       #       :a,
       #       :b]
       #
-      class FirstArrayElementLineBreak < Cop
+      class FirstArrayElementLineBreak < Base
         include FirstElementLineBreak
+        extend AutoCorrector
 
         MSG = 'Add a line break before the first element of a ' \
               'multi-line array.'
@@ -29,15 +30,11 @@ module RuboCop
           check_children_line_break(node, node.children)
         end
 
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
-        end
-
         private
 
         def assignment_on_same_line?(node)
           source = node.source_range.source_line[0...node.loc.column]
-          source =~ /\s*\=\s*$/
+          /\s*=\s*$/.match?(source)
         end
       end
     end