rubocop 0.89.1 → 0.90.0

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

@@ -88,8 +88,9 @@ module RuboCop
       #     # good
       #     { a: 1,
       #       b: 2 }
-      class MultilineHashBraceLayout < Cop
+      class MultilineHashBraceLayout < Base
         include MultilineLiteralBraceLayout
+        extend AutoCorrector
 
         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 ' \
@@ -108,10 +109,6 @@ module RuboCop
         def on_hash(node)
           check_brace_layout(node)
         end
-
-        def autocorrect(node)
-          MultilineLiteralBraceCorrector.new(node, processed_source)
-        end
       end
     end
   end

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

@@ -20,8 +20,9 @@ module RuboCop
       #     b: 2,
       #     c: 3
       #   }
-      class MultilineHashKeyLineBreaks < Cop
+      class MultilineHashKeyLineBreaks < Base
         include MultilineElementLineBreaks
+        extend AutoCorrector
 
         MSG = 'Each key in a multi-line hash must start on a ' \
           'separate line.'
@@ -35,10 +36,6 @@ module RuboCop
           check_line_breaks(node, node.children) if node.loc.begin
         end
 
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
-        end
-
         private
 
         def starts_with_curly_brace?(node)

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

@@ -19,8 +19,9 @@ module RuboCop
       #     b,
       #     c
       #   )
-      class MultilineMethodArgumentLineBreaks < Cop
-        include(MultilineElementLineBreaks)
+      class MultilineMethodArgumentLineBreaks < Base
+        include MultilineElementLineBreaks
+        extend AutoCorrector
 
         MSG = 'Each argument in a multi-line method call must start ' \
           'on a separate line.'
@@ -36,16 +37,11 @@ module RuboCop
           #
           # ...then each key/value pair is treated as a method 'argument'
           # when determining where line breaks should appear.
-          if (last_arg = args.last)
-            args = args[0...-1] + last_arg.children if last_arg.hash_type? && !last_arg.braces?
-          end
+          last_arg = args.last
+          args = args[0...-1] + last_arg.children if last_arg&.hash_type? && !last_arg&.braces?
 
           check_line_breaks(node, args)
         end
-
-        def autocorrect(node)
-          EmptyLineCorrector.insert_before(node)
-        end
       end
     end
   end

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

@@ -88,8 +88,9 @@ module RuboCop
       #   # good
       #   foo(a,
       #     b)
-      class MultilineMethodCallBraceLayout < Cop
+      class MultilineMethodCallBraceLayout < Base
         include MultilineLiteralBraceLayout
+        extend AutoCorrector
 
         SAME_LINE_MESSAGE = 'Closing method call brace must be on the ' \
           'same line as the last argument when opening brace is on the same ' \
@@ -109,10 +110,6 @@ module RuboCop
           check_brace_layout(node)
         end
 
-        def autocorrect(node)
-          MultilineLiteralBraceCorrector.new(node, processed_source)
-        end
-
         private
 
         def children(node)

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

@@ -100,8 +100,9 @@ module RuboCop
       #   def foo(a,
       #     b)
       #   end
-      class MultilineMethodDefinitionBraceLayout < Cop
+      class MultilineMethodDefinitionBraceLayout < Base
         include MultilineLiteralBraceLayout
+        extend AutoCorrector
 
         SAME_LINE_MESSAGE = 'Closing method definition brace must be on the ' \
           'same line as the last parameter when opening brace is on the same ' \
@@ -121,10 +122,6 @@ module RuboCop
           check_brace_layout(node.arguments)
         end
         alias on_defs on_def
-
-        def autocorrect(node)
-          MultilineLiteralBraceCorrector.new(node, processed_source)
-        end
       end
     end
   end

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

@@ -21,8 +21,9 @@ module RuboCop
       #   rescue
       #     puts 'error'
       #   end
-      class RescueEnsureAlignment < Cop
+      class RescueEnsureAlignment < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = '`%<kw_loc>s` at %<kw_loc_line>d, %<kw_loc_column>d is not ' \
               'aligned with `%<beginning>s` at ' \
@@ -41,19 +42,7 @@ module RuboCop
           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)
+        def on_new_investigation
           @modifier_locations =
             processed_source.tokens.each_with_object([]) do |token, locations|
               next unless token.rescue_modifier?
@@ -73,15 +62,23 @@ module RuboCop
           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
+          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)
-          )
+            kw_loc, message: format_message(alignment_node, alignment_loc, kw_loc)
+          ) do |corrector|
+            autocorrect(corrector, node, alignment_node)
+          end
+        end
+
+        def autocorrect(corrector, node, alignment_node)
+          whitespace = whitespace_range(node)
+          # Some inline node is sitting before current node.
+          return nil unless whitespace.source.strip.empty?
+
+          new_column = alignment_node.loc.column
+
+          corrector.replace(whitespace, ' ' * new_column)
         end
 
         def format_message(alignment_node, alignment_loc, kw_loc)

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

@@ -13,7 +13,9 @@ module RuboCop
       #
       #   # good
       #   def f(a:, b: 2); {a: 3}; end
-      class SpaceAfterColon < Cop
+      class SpaceAfterColon < Base
+        extend AutoCorrector
+
         MSG = 'Space missing after colon.'
 
         def on_pair(node)
@@ -21,7 +23,7 @@ module RuboCop
 
           colon = node.loc.operator
 
-          add_offense(colon, location: colon) unless followed_by_space?(colon)
+          register_offense(colon) unless followed_by_space?(colon)
         end
 
         def on_kwoptarg(node)
@@ -29,15 +31,17 @@ module RuboCop
           # optional keyword argument's name, so must construct one.
           colon = node.loc.name.end.resize(1)
 
-          add_offense(colon, location: colon) unless followed_by_space?(colon)
-        end
-
-        def autocorrect(range)
-          ->(corrector) { corrector.insert_after(range, ' ') }
+          register_offense(colon) unless followed_by_space?(colon)
         end
 
         private
 
+        def register_offense(colon)
+          add_offense(colon) do |corrector|
+            corrector.insert_after(colon, ' ')
+          end
+        end
+
         def followed_by_space?(colon)
           /\s/.match?(colon.source_buffer.source[colon.end_pos])
         end

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

@@ -14,12 +14,9 @@ module RuboCop
       #   # good
       #   [1, 2]
       #   { foo:bar, }
-      class SpaceAfterComma < Cop
+      class SpaceAfterComma < Base
         include SpaceAfterPunctuation
-
-        def autocorrect(comma)
-          PunctuationCorrector.add_space(comma)
-        end
+        extend AutoCorrector
 
         def space_style_before_rcurly
           cfg = config.for_cop('Layout/SpaceInsideHashLiteralBraces')

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

@@ -14,8 +14,9 @@ module RuboCop
       #   # good
       #   def func(x) end
       #   def method=(y) end
-      class SpaceAfterMethodName < Cop
+      class SpaceAfterMethodName < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Do not put a space between a method name and the opening ' \
               'parenthesis.'
@@ -29,13 +30,11 @@ module RuboCop
                                                 expr.begin_pos)
           return unless pos_before_left_paren.source.start_with?(' ')
 
-          add_offense(pos_before_left_paren, location: pos_before_left_paren)
+          add_offense(pos_before_left_paren) do |corrector|
+            corrector.remove(pos_before_left_paren)
+          end
         end
         alias on_defs on_def
-
-        def autocorrect(pos_before_left_paren)
-          ->(corrector) { corrector.remove(pos_before_left_paren) }
-        end
       end
     end
   end

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

@@ -11,29 +11,27 @@ module RuboCop
       #
       #   # good
       #   !something
-      class SpaceAfterNot < Cop
+      class SpaceAfterNot < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Do not leave space between `!` and its argument.'
 
         def on_send(node)
           return unless node.prefix_bang? && whitespace_after_operator?(node)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            corrector.remove(
+              range_between(node.loc.selector.end_pos, node.receiver.source_range.begin_pos)
+            )
+          end
         end
 
+        private
+
         def whitespace_after_operator?(node)
           node.receiver.loc.column - node.loc.column > 1
         end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(
-              range_between(node.loc.selector.end_pos,
-                            node.receiver.source_range.begin_pos)
-            )
-          end
-        end
       end
     end
   end

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

@@ -11,12 +11,9 @@ module RuboCop
       #
       #   # good
       #   x = 1; y = 2
-      class SpaceAfterSemicolon < Cop
+      class SpaceAfterSemicolon < Base
         include SpaceAfterPunctuation
-
-        def autocorrect(semicolon)
-          PunctuationCorrector.add_space(semicolon)
-        end
+        extend AutoCorrector
 
         def space_style_before_rcurly
           cfg = config.for_cop('Layout/SpaceInsideBlockBraces')

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

@@ -27,10 +27,11 @@ module RuboCop
       #   def some_method(arg1=:default, arg2=nil, arg3=[])
       #     # do something...
       #   end
-      class SpaceAroundEqualsInParameterDefault < Cop
+      class SpaceAroundEqualsInParameterDefault < Base
         include SurroundingSpace
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Surrounding space %<type>s in default value assignment.'
 
@@ -40,13 +41,6 @@ module RuboCop
           check_optarg(arg, equals, value)
         end
 
-        def autocorrect(range)
-          m = range.source.match(/=\s*(\S+)/)
-          rest = m ? m.captures[0] : ''
-          replacement = style == :space ? ' = ' : '='
-          ->(corrector) { corrector.replace(range, replacement + rest) }
-        end
-
         private
 
         def check_optarg(arg, equals, value)
@@ -65,14 +59,25 @@ module RuboCop
         def incorrect_style_detected(arg, value, space_on_both_sides,
                                      no_surrounding_space)
           range = range_between(arg.end_pos, value.begin_pos)
-          add_offense(range, location: range) do
-            if style == :space && no_surrounding_space ||
-               style == :no_space && space_on_both_sides
-              opposite_style_detected
-            else
-              unrecognized_style_detected
-            end
+
+          if style == :space && no_surrounding_space ||
+             style == :no_space && space_on_both_sides
+            return unless opposite_style_detected
+          else
+            return unless unrecognized_style_detected
           end
+
+          add_offense(range) do |corrector|
+            autocorrect(corrector, range)
+          end
+        end
+
+        def autocorrect(corrector, range)
+          m = range.source.match(/=\s*(\S+)/)
+          rest = m ? m.captures[0] : ''
+          replacement = style == :space ? ' = ' : '='
+
+          corrector.replace(range, replacement + rest)
         end
 
         def space_on_both_sides?(arg, equals)

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

@@ -24,7 +24,9 @@ module RuboCop
       #   end
       #
       #   something = 123 if test
-      class SpaceAroundKeyword < Cop
+      class SpaceAroundKeyword < Base
+        extend AutoCorrector
+
         MSG_BEFORE = 'Space before keyword `%<range>s` is missing.'
         MSG_AFTER = 'Space after keyword `%<range>s` is missing.'
 
@@ -129,14 +131,6 @@ module RuboCop
           check(node, [:keyword].freeze)
         end
 
-        def autocorrect(range)
-          if space_before_missing?(range)
-            ->(corrector) { corrector.insert_before(range, ' ') }
-          else
-            ->(corrector) { corrector.insert_after(range, ' ') }
-          end
-        end
-
         private
 
         def check(node, locations, begin_keyword = DO)
@@ -162,8 +156,11 @@ module RuboCop
 
         def check_end(node, range, begin_keyword)
           return if begin_keyword == DO && !do?(node)
+          return unless space_before_missing?(range)
 
-          offense(range, MSG_BEFORE) if space_before_missing?(range)
+          add_offense(range, message: format(MSG_BEFORE, range: range.source)) do |corrector|
+            corrector.insert_before(range, ' ')
+          end
         end
 
         def do?(node)
@@ -171,15 +168,17 @@ module RuboCop
         end
 
         def check_keyword(node, range)
-          offense(range, MSG_BEFORE) if space_before_missing?(range) &&
-                                        !preceded_by_operator?(node, range)
-          offense(range, MSG_AFTER) if space_after_missing?(range)
-        end
+          if space_before_missing?(range) && !preceded_by_operator?(node, range)
+            add_offense(range, message: format(MSG_BEFORE, range: range.source)) do |corrector|
+              corrector.insert_before(range, ' ')
+            end
+          end
 
-        def offense(range, msg)
-          add_offense(range,
-                      location: range,
-                      message: format(msg, range: range.source))
+          return unless space_after_missing?(range)
+
+          add_offense(range, message: format(MSG_AFTER, range: range.source)) do |corrector|
+            corrector.insert_after(range, ' ')
+          end
         end
 
         def space_before_missing?(range)

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

@@ -48,10 +48,11 @@ module RuboCop
       #
       #   # good
       #   a ** b
-      class SpaceAroundOperators < Cop
+      class SpaceAroundOperators < Base
         include PrecedingFollowingAlignment
         include RangeHelp
         include RationalLiteral
+        extend AutoCorrector
 
         IRREGULAR_METHODS = %i[[] ! []=].freeze
         EXCESSIVE_SPACE = '  '
@@ -132,18 +133,6 @@ module RuboCop
         alias on_and_asgn on_assignment
         alias on_op_asgn  on_special_asgn
 
-        def autocorrect(range)
-          lambda do |corrector|
-            if /\*\*/.match?(range.source) && !space_around_exponent_operator?
-              corrector.replace(range, '**')
-            elsif range.source.end_with?("\n")
-              corrector.replace(range, " #{range.source.strip}\n")
-            else
-              enclose_operator_with_space(corrector, range)
-            end
-          end
-        end
-
         private
 
         def regular_operator?(send_node)
@@ -161,7 +150,9 @@ module RuboCop
           return if with_space.source.start_with?("\n")
 
           offense(type, operator, with_space, right_operand) do |msg|
-            add_offense(with_space, location: operator, message: msg)
+            add_offense(operator, message: msg) do |corrector|
+              autocorrect(corrector, with_space)
+            end
           end
         end
 
@@ -170,14 +161,24 @@ module RuboCop
           yield msg if msg
         end
 
+        def autocorrect(corrector, range)
+          if /\*\*/.match?(range.source) && !space_around_exponent_operator?
+            corrector.replace(range, '**')
+          elsif range.source.end_with?("\n")
+            corrector.replace(range, " #{range.source.strip}\n")
+          else
+            enclose_operator_with_space(corrector, range)
+          end
+        end
+
         def enclose_operator_with_space(corrector, range)
           operator = range.source
 
           # If `ForceEqualSignAlignment` is true, `Layout/ExtraSpacing` cop
           # inserts spaces before operator. If `Layout/SpaceAroundOperators` cop
           # inserts a space, it collides and raises the infinite loop error.
-          if force_equal_sign_alignment?
-            corrector.insert_after(range, ' ') unless operator.end_with?(' ')
+          if force_equal_sign_alignment? && !operator.end_with?(' ')
+            corrector.insert_after(range, ' ')
           else
             corrector.replace(range, " #{operator.strip} ")
           end