rubocop-rspec 1.41.0 → 1.42.0

data/lib/rubocop/cop/rspec/empty_line_after_hook.rb

@@ -34,6 +34,7 @@ module RuboCop
       #   it { does_something }
       #
       class EmptyLineAfterHook < Cop
+        extend AutoCorrector
         include RuboCop::RSpec::BlankLineSeparation
 
         MSG = 'Add an empty line after `%<hook>s`.'
@@ -43,11 +44,10 @@ module RuboCop
           return if last_child?(node)
 
           missing_separating_line(node) do |location|
-            add_offense(
-              node,
-              location: location,
-              message: format(MSG, hook: node.method_name)
-            )
+            msg = format(MSG, hook: node.method_name)
+            add_offense(location, message: msg) do |corrector|
+              corrector.insert_after(location.end, "\n")
+            end
           end
         end
       end

data/lib/rubocop/cop/rspec/empty_line_after_subject.rb

@@ -15,6 +15,7 @@ module RuboCop
       #
       #   let(:foo) { bar }
       class EmptyLineAfterSubject < Cop
+        extend AutoCorrector
         include RuboCop::RSpec::BlankLineSeparation
 
         MSG = 'Add empty line after `subject`.'
@@ -24,7 +25,9 @@ module RuboCop
           return if last_child?(node)
 
           missing_separating_line(node) do |location|
-            add_offense(node, location: location)
+            add_offense(location) do |corrector|
+              corrector.insert_after(location.end, "\n")
+            end
           end
         end
 

data/lib/rubocop/cop/rspec/example_wording.rb

@@ -30,6 +30,8 @@ module RuboCop
       #   it 'does things' do
       #   end
       class ExampleWording < Cop
+        extend AutoCorrector
+
         MSG_SHOULD = 'Do not use should when describing your tests.'
         MSG_IT     = "Do not repeat 'it' when describing your tests."
 
@@ -53,16 +55,13 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(docstring(node), replacement_text(node))
-          end
-        end
-
         private
 
         def add_wording_offense(node, message)
-          add_offense(node, location: docstring(node), message: message)
+          docstring = docstring(node)
+          add_offense(docstring, message: message) do |corrector|
+            corrector.replace(docstring, replacement_text(node))
+          end
         end
 
         def docstring(node)

data/lib/rubocop/cop/rspec/expect_actual.rb

@@ -17,6 +17,8 @@ module RuboCop
       #   expect(name).to eq("John")
       #
       class ExpectActual < Cop
+        extend AutoCorrector
+
         MSG = 'Provide the actual you are testing to `expect(...)`.'
 
         SIMPLE_LITERALS = %i[
@@ -55,17 +57,12 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          expect_literal(node) do |argument|
-            add_offense(node, location: argument.source_range)
-          end
-        end
-
-        def autocorrect(node)
-          actual, matcher, expected = expect_literal(node)
-          lambda do |corrector|
-            return unless SUPPORTED_MATCHERS.include?(matcher)
+          expect_literal(node) do |actual, matcher, expected|
+            add_offense(actual.source_range) do |corrector|
+              next unless SUPPORTED_MATCHERS.include?(matcher)
 
-            swap(corrector, actual, expected)
+              swap(corrector, actual, expected)
+            end
           end
         end
 

data/lib/rubocop/cop/rspec/expect_change.rb

@@ -30,6 +30,7 @@ module RuboCop
       #   expect { run }.to change { user.reload.name }
       #
       class ExpectChange < Cop
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
 
         MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'
@@ -51,10 +52,11 @@ module RuboCop
           return unless style == :block
 
           expect_change_with_arguments(node) do |receiver, message|
-            add_offense(
-              node,
-              message: format(MSG_CALL, obj: receiver, attr: message)
-            )
+            msg = format(MSG_CALL, obj: receiver, attr: message)
+            add_offense(node, message: msg) do |corrector|
+              replacement = "change { #{receiver}.#{message} }"
+              corrector.replace(node, replacement)
+            end
           end
         end
 
@@ -62,37 +64,10 @@ module RuboCop
           return unless style == :method_call
 
           expect_change_with_block(node) do |receiver, message|
-            add_offense(
-              node,
-              message: format(MSG_BLOCK, obj: receiver, attr: message)
-            )
-          end
-        end
-
-        def autocorrect(node)
-          if style == :block
-            autocorrect_method_call_to_block(node)
-          else
-            autocorrect_block_to_method_call(node)
-          end
-        end
-
-        private
-
-        def autocorrect_method_call_to_block(node)
-          lambda do |corrector|
-            expect_change_with_arguments(node) do |receiver, message|
-              replacement = "change { #{receiver}.#{message} }"
-              corrector.replace(node.loc.expression, replacement)
-            end
-          end
-        end
-
-        def autocorrect_block_to_method_call(node)
-          lambda do |corrector|
-            expect_change_with_block(node) do |receiver, message|
+            msg = format(MSG_BLOCK, obj: receiver, attr: message)
+            add_offense(node, message: msg) do |corrector|
               replacement = "change(#{receiver}, :#{message})"
-              corrector.replace(node.loc.expression, replacement)
+              corrector.replace(node, replacement)
             end
           end
         end

data/lib/rubocop/cop/rspec/expect_in_hook.rb

@@ -30,8 +30,8 @@ module RuboCop
           return if node.body.nil?
 
           expectation(node.body) do |expect|
-            add_offense(expect, location: :selector,
-                                message: message(expect, node))
+            add_offense(expect.loc.selector,
+                        message: message(expect, node))
           end
         end
 

data/lib/rubocop/cop/rspec/expect_output.rb

@@ -27,7 +27,7 @@ module RuboCop
           name = variable_name[1..-1]
           return unless name.eql?('stdout') || name.eql?('stderr')
 
-          add_offense(node, location: :name, message: format(MSG, name: name))
+          add_offense(node.loc.name, message: format(MSG, name: name))
         end
 
         private

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -25,6 +25,8 @@ module RuboCop
         #   # good
         #   count { 1 }
         class AttributeDefinedStatically < Cop
+          extend AutoCorrector
+
           MSG = 'Use a block to declare attribute values.'
 
           def_node_matcher :value_matcher, <<-PATTERN
@@ -43,20 +45,22 @@ module RuboCop
               next unless offensive_receiver?(attribute.receiver, node)
               next if proc?(attribute) || association?(attribute.first_argument)
 
-              add_offense(attribute)
+              add_offense(attribute) do |corrector|
+                autocorrect(corrector, attribute)
+              end
             end
           end
 
-          def autocorrect(node)
+          private
+
+          def autocorrect(corrector, node)
             if node.parenthesized?
-              autocorrect_replacing_parens(node)
+              autocorrect_replacing_parens(corrector, node)
             else
-              autocorrect_without_parens(node)
+              autocorrect_without_parens(corrector, node)
             end
           end
 
-          private
-
           def offensive_receiver?(receiver, node)
             receiver.nil? ||
               receiver.self_type? ||
@@ -77,24 +81,20 @@ module RuboCop
 
           def_node_matcher :association?, '(hash <(pair (sym :factory) _) ...>)'
 
-          def autocorrect_replacing_parens(node)
+          def autocorrect_replacing_parens(corrector, node)
             left_braces, right_braces = braces(node)
 
-            lambda do |corrector|
-              corrector.replace(node.location.begin, ' ' + left_braces)
-              corrector.replace(node.location.end, right_braces)
-            end
+            corrector.replace(node.location.begin, ' ' + left_braces)
+            corrector.replace(node.location.end, right_braces)
           end
 
-          def autocorrect_without_parens(node)
+          def autocorrect_without_parens(corrector, node)
             left_braces, right_braces = braces(node)
 
-            lambda do |corrector|
-              argument = node.first_argument
-              expression = argument.location.expression
-              corrector.insert_before(expression, left_braces)
-              corrector.insert_after(expression, right_braces)
-            end
+            argument = node.first_argument
+            expression = argument.location.expression
+            corrector.insert_before(expression, left_braces)
+            corrector.insert_after(expression, right_braces)
           end
 
           def braces(node)

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -25,6 +25,7 @@ module RuboCop
         #   # good
         #   3.times { create :user }
         class CreateList < Cop
+          extend AutoCorrector
           include ConfigurableEnforcedStyle
 
           MSG_CREATE_LIST = 'Prefer create_list.'
@@ -51,26 +52,19 @@ module RuboCop
             return unless n_times_block_without_arg?(node)
             return unless contains_only_factory?(node.body)
 
-            add_offense(node.send_node, message: MSG_CREATE_LIST)
+            add_offense(node.send_node, message: MSG_CREATE_LIST) do |corrector|
+              CreateListCorrector.new(node.send_node).call(corrector)
+            end
           end
 
           def on_send(node)
             return unless style == :n_times
 
             factory_list_call(node) do |_receiver, _factory, count, _|
-              add_offense(
-                node,
-                location: :selector,
-                message: format(MSG_N_TIMES, number: count)
-              )
-            end
-          end
-
-          def autocorrect(node)
-            if style == :create_list
-              CreateListCorrector.new(node)
-            else
-              TimesCorrector.new(node)
+              message = format(MSG_N_TIMES, number: count)
+              add_offense(node.loc.selector, message: message) do |corrector|
+                TimesCorrector.new(node).call(corrector)
+              end
             end
           end
 
@@ -115,7 +109,7 @@ module RuboCop
 
             def call(corrector)
               replacement = generate_n_times_block(node)
-              corrector.replace(node.loc.expression, replacement)
+              corrector.replace(node, replacement)
             end
 
             private
@@ -148,7 +142,7 @@ module RuboCop
                               call_replacement(node)
                             end
 
-              corrector.replace(node.loc.expression, replacement)
+              corrector.replace(node, replacement)
             end
 
             private

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -20,6 +20,8 @@ module RuboCop
         #   factory :foo, class: 'Foo' do
         #   end
         class FactoryClassName < Cop
+          extend AutoCorrector
+
           MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
                 'constant.'
           ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
@@ -32,13 +34,10 @@ module RuboCop
             class_name(node) do |cn|
               next if allowed?(cn.const_name)
 
-              add_offense(cn, message: format(MSG, class_name: cn.const_name))
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "'#{node.source}'")
+              msg = format(MSG, class_name: cn.const_name)
+              add_offense(cn, message: msg) do |corrector|
+                corrector.replace(cn, "'#{cn.source}'")
+              end
             end
           end
 

data/lib/rubocop/cop/rspec/hook_argument.rb

@@ -58,6 +58,7 @@ module RuboCop
       #     # ...
       #   end
       class HookArgument < Cop
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
 
         IMPLICIT_MSG = 'Omit the default `%<scope>p` ' \
@@ -78,18 +79,11 @@ module RuboCop
             return check_implicit(method_send) unless scope_name
 
             style_detected(scope_name)
-            add_offense(
-              method_send,
-              message: explicit_message(scope_name)
-            )
-          end
-        end
-
-        def autocorrect(node)
-          scope = implicit_style? ? '' : "(#{style.inspect})"
-
-          lambda do |corrector|
-            corrector.replace(argument_range(node), scope)
+            msg = explicit_message(scope_name)
+            add_offense(method_send, message: msg) do |corrector|
+              scope = implicit_style? ? '' : "(#{style.inspect})"
+              corrector.replace(argument_range(method_send), scope)
+            end
           end
         end
 
@@ -99,11 +93,11 @@ module RuboCop
           style_detected(:implicit)
           return if implicit_style?
 
-          add_offense(
-            method_send,
-            location: :selector,
-            message: format(EXPLICIT_MSG, scope: style)
-          )
+          msg = explicit_message(nil)
+          add_offense(method_send.loc.selector, message: msg) do |corrector|
+            scope = "(#{style.inspect})"
+            corrector.replace(argument_range(method_send), scope)
+          end
         end
 
         def explicit_message(scope)

data/lib/rubocop/cop/rspec/hooks_before_examples.rb

@@ -24,6 +24,8 @@ module RuboCop
       #   end
       #
       class HooksBeforeExamples < Cop
+        extend AutoCorrector
+
         MSG = 'Move `%<hook>s` above the examples in the group.'
 
         def_node_matcher :example_or_group?, <<-PATTERN
@@ -39,15 +41,6 @@ module RuboCop
           check_hooks(node.body) if multiline_block?(node.body)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            first_example = find_first_example(node.parent)
-            RuboCop::RSpec::Corrector::MoveNode.new(
-              node, corrector, processed_source
-            ).move_before(first_example)
-          end
-        end
-
         private
 
         def multiline_block?(block)
@@ -62,16 +55,22 @@ module RuboCop
             next if child.sibling_index < first_example.sibling_index
             next unless hook?(child)
 
-            add_offense(
-              child,
-              message: format(MSG, hook: child.method_name)
-            )
+            msg = format(MSG, hook: child.method_name)
+            add_offense(child, message: msg) do |corrector|
+              autocorrect(corrector, child, first_example)
+            end
           end
         end
 
         def find_first_example(node)
           node.children.find { |sibling| example_or_group?(sibling) }
         end
+
+        def autocorrect(corrector, node, first_example)
+          RuboCop::RSpec::Corrector::MoveNode.new(
+            node, corrector, processed_source
+          ).move_before(first_example)
+        end
       end
     end
   end