rubocop-rspec 1.42.0 → 1.43.0

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

@@ -16,17 +16,25 @@ module RuboCop
       #
       #   describe MyClass, '.my_class_method' do
       #   end
-      class DescribeMethod < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+      class DescribeMethod < Base
+        include RuboCop::RSpec::TopLevelGroup
 
         MSG = 'The second argument to describe should be the method '\
               "being tested. '#instance' or '.class'."
 
-        def on_top_level_describe(_node, (_, second_arg))
-          return unless second_arg&.str_type?
-          return if second_arg.str_content.start_with?('#', '.')
+        def_node_matcher :second_argument, <<~PATTERN
+          (block
+            (send #rspec? :describe _first_argument $(str _) ...) ...
+          )
+        PATTERN
 
-          add_offense(second_arg)
+        def on_top_level_group(node)
+          second_argument = second_argument(node)
+
+          return unless second_argument
+          return if second_argument.str_content.start_with?('#', '.')
+
+          add_offense(second_argument)
         end
       end
     end

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

@@ -17,11 +17,11 @@ module RuboCop
       #   end
       #
       # @see https://github.com/rspec/rspec-core/issues/1610
-      class DescribeSymbol < Cop
+      class DescribeSymbol < Base
         MSG = 'Avoid describing symbols.'
 
         def_node_matcher :describe_symbol?, <<-PATTERN
-          (send #{RSPEC} :describe $sym ...)
+          (send #rspec? :describe $sym ...)
         PATTERN
 
         def on_send(node)

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

@@ -54,7 +54,7 @@ module RuboCop
       #     end
       #   end
       #
-      class DescribedClass < Cop
+      class DescribedClass < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 
@@ -142,7 +142,7 @@ module RuboCop
           if style == :described_class
             offensive_described_class?(node)
           else
-            node.send_type? && node.method_name == :described_class
+            node.send_type? && node.method?(:described_class)
           end
         end
 

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

@@ -19,7 +19,7 @@ module RuboCop
       #   end
       #
       # @see https://github.com/rubocop-hq/rubocop-rspec/issues/735
-      class DescribedClassModuleWrapping < Cop
+      class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
         def_node_search :find_rspec_blocks,

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

@@ -41,7 +41,7 @@ module RuboCop
       #   describe 'display name presence' do
       #     # ...
       #   end
-      class Dialect < Cop
+      class Dialect < Base
         extend AutoCorrector
         include MethodPreference
 

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

@@ -57,20 +57,104 @@ module RuboCop
       #     end
       #   end
       #
-      class EmptyExampleGroup < Cop
+      class EmptyExampleGroup < Base
         MSG = 'Empty example group detected.'
 
-        def_node_search :contains_example?, <<-PATTERN
+        # @!method example_group_body(node)
+        #   Match example group blocks and yield their body
+        #
+        #   @example source that matches
+        #     describe 'example group' do
+        #       it { is_expected.to be }
+        #     end
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield [RuboCop::AST::Node] example group body
+        def_node_matcher :example_group_body, <<~PATTERN
+          (block #{ExampleGroups::ALL.send_pattern} args $_)
+        PATTERN
+
+        # @!method example_or_group_or_include?(node)
+        #   Match examples, example groups and includes
+        #
+        #   @example source that matches
+        #     it { is_expected.to fly }
+        #     describe('non-empty example groups too') { }
+        #     it_behaves_like 'an animal'
+        #     it_behaves_like('a cat') { let(:food) { 'milk' } }
+        #     it_has_root_access
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :example_or_group_or_include?, <<~PATTERN
           {
-            #{(Examples::ALL + Includes::ALL).send_pattern}
-            (send _ #custom_include? ...)
+            #{Examples::ALL.block_pattern}
+            #{ExampleGroups::ALL.block_pattern}
+            #{Includes::ALL.send_pattern}
+            #{Includes::ALL.block_pattern}
+            (send nil? #custom_include? ...)
           }
         PATTERN
 
-        def on_block(node)
-          return unless example_group?(node) && !contains_example?(node)
+        # @!method examples_inside_block?(node)
+        #   Match examples defined inside a block which is not a hook
+        #
+        #   @example source that matches
+        #     %w(r g b).each do |color|
+        #       it { is_expected.to have_color(color) }
+        #     end
+        #
+        #   @example source that does not match
+        #     before do
+        #       it { is_expected.to fall_into_oblivion }
+        #     end
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :examples_inside_block?, <<~PATTERN
+          (block !#{Hooks::ALL.send_pattern} _ #examples?)
+        PATTERN
 
-          add_offense(node.send_node)
+        # @!method examples_directly_or_in_block?(node)
+        #   Match examples or examples inside blocks
+        #
+        #   @example source that matches
+        #     it { expect(drink).to be_cold }
+        #     context('when winter') { it { expect(drink).to be_hot } }
+        #     (1..5).each { |divisor| it { is_expected.to divide_by(divisor) } }
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :examples_directly_or_in_block?, <<~PATTERN
+          {
+            #example_or_group_or_include?
+            #examples_inside_block?
+          }
+        PATTERN
+
+        # @!method examples?(node)
+        #   Matches examples defined in scopes where they could run
+        #
+        #   @example source that matches
+        #     it { expect(myself).to be_run }
+        #     describe { it { i_run_as_well } }
+        #
+        #   @example source that does not match
+        #     before { it { whatever here wont run anyway } }
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :examples?, <<~PATTERN
+          {
+            #examples_directly_or_in_block?
+            (begin <#examples_directly_or_in_block? ...>)
+          }
+        PATTERN
+
+        def on_block(node)
+          example_group_body(node) do |body|
+            add_offense(node.send_node) unless examples?(body)
+          end
         end
 
         private

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

@@ -22,7 +22,7 @@ module RuboCop
       #     create_feed
       #   end
       #   after(:all) { cleanup_feed }
-      class EmptyHook < Cop
+      class EmptyHook < Base
         extend AutoCorrector
         include RuboCop::Cop::RangeHelp
 

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

@@ -41,22 +41,18 @@ module RuboCop
       #     it { two }
       #   end
       #
-      class EmptyLineAfterExample < Cop
+      class EmptyLineAfterExample < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<example>s`.'
 
         def on_block(node)
           return unless example?(node)
-          return if last_child?(node)
           return if allowed_one_liner?(node)
 
-          missing_separating_line(node) do |location|
-            msg = format(MSG, example: node.method_name)
-            add_offense(location, message: msg) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(node) do |method|
+            format(MSG, example: method)
           end
         end
 

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

@@ -23,21 +23,17 @@ module RuboCop
       #     end
       #   end
       #
-      class EmptyLineAfterExampleGroup < Cop
+      class EmptyLineAfterExampleGroup < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<example_group>s`.'
 
         def on_block(node)
           return unless example_group?(node)
-          return if last_child?(node)
 
-          missing_separating_line(node) do |location|
-            msg = format(MSG, example_group: node.method_name)
-            add_offense(location, message: msg) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(node) do |method|
+            format(MSG, example_group: method)
           end
         end
       end

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

@@ -16,24 +16,21 @@ module RuboCop
       #   let(:something) { other }
       #
       #   it { does_something }
-      class EmptyLineAfterFinalLet < Cop
+      class EmptyLineAfterFinalLet < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
-        MSG = 'Add an empty line after the last `let` block.'
+        MSG = 'Add an empty line after the last `%<let>s`.'
 
         def on_block(node)
           return unless example_group_with_body?(node)
 
-          latest_let = node.body.child_nodes.select { |child| let?(child) }.last
+          final_let = node.body.child_nodes.reverse.find { |child| let?(child) }
 
-          return if latest_let.nil?
-          return if last_child?(latest_let)
+          return if final_let.nil?
 
-          missing_separating_line(latest_let) do |location|
-            add_offense(location) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(final_let) do |method|
+            format(MSG, let: method)
           end
         end
       end

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

@@ -33,21 +33,17 @@ module RuboCop
       #
       #   it { does_something }
       #
-      class EmptyLineAfterHook < Cop
+      class EmptyLineAfterHook < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<hook>s`.'
 
         def on_block(node)
           return unless hook?(node)
-          return if last_child?(node)
 
-          missing_separating_line(node) do |location|
-            msg = format(MSG, hook: node.method_name)
-            add_offense(location, message: msg) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(node) do |method|
+            format(MSG, hook: method)
           end
         end
       end

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

@@ -14,20 +14,17 @@ module RuboCop
       #   subject(:obj) { described_class }
       #
       #   let(:foo) { bar }
-      class EmptyLineAfterSubject < Cop
+      class EmptyLineAfterSubject < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
-        MSG = 'Add empty line after `subject`.'
+        MSG = 'Add an empty line after `%<subject>s`.'
 
         def on_block(node)
           return unless subject?(node) && !in_spec_block?(node)
-          return if last_child?(node)
 
-          missing_separating_line(node) do |location|
-            add_offense(location) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(node) do |method|
+            format(MSG, subject: method)
           end
         end
 

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

@@ -25,7 +25,7 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
-      class ExampleLength < Cop
+      class ExampleLength < Base
         include CodeLength
 
         MSG = 'Example has too many lines [%<total>d/%<max>d].'

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

@@ -47,7 +47,7 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
-      class ExampleWithoutDescription < Cop
+      class ExampleWithoutDescription < Base
         include ConfigurableEnforcedStyle
 
         MSG_DEFAULT_ARGUMENT = 'Omit the argument when you want to ' \

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

@@ -29,7 +29,7 @@ module RuboCop
       #   # good
       #   it 'does things' do
       #   end
-      class ExampleWording < Cop
+      class ExampleWording < Base
         extend AutoCorrector
 
         MSG_SHOULD = 'Do not use should when describing your tests.'
@@ -47,9 +47,9 @@ module RuboCop
 
         def on_block(node)
           it_description(node) do |description_node, message|
-            if message =~ SHOULD_PREFIX
+            if message.match?(SHOULD_PREFIX)
               add_wording_offense(description_node, MSG_SHOULD)
-            elsif message =~ IT_PREFIX
+            elsif message.match?(IT_PREFIX)
               add_wording_offense(description_node, MSG_IT)
             end
           end
@@ -77,7 +77,7 @@ module RuboCop
         def replacement_text(node)
           text = text(node)
 
-          if text =~ SHOULD_PREFIX
+          if text.match?(SHOULD_PREFIX)
             RuboCop::RSpec::Wording.new(
               text,
               ignore:  ignored_words,

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

@@ -16,7 +16,7 @@ module RuboCop
       #   expect(pattern).to eq(/foo/)
       #   expect(name).to eq("John")
       #
-      class ExpectActual < Cop
+      class ExpectActual < Base
         extend AutoCorrector
 
         MSG = 'Provide the actual you are testing to `expect(...)`.'

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

@@ -29,7 +29,7 @@ module RuboCop
       #   expect { run }.to change { Foo.bar(:count) }
       #   expect { run }.to change { user.reload.name }
       #
-      class ExpectChange < Cop
+      class ExpectChange < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 

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

@@ -20,7 +20,7 @@ module RuboCop
       #   it do
       #     expect(something).to eq 'foo'
       #   end
-      class ExpectInHook < Cop
+      class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
         def_node_search :expectation, Expectations::ALL.send_pattern

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

@@ -14,7 +14,7 @@ module RuboCop
       #
       #   # good
       #   expect { my_app.print_report }.to output('Hello World').to_stdout
-      class ExpectOutput < Cop
+      class ExpectOutput < Base
         MSG = 'Use `expect { ... }.to output(...).to_%<name>s` '\
               'instead of mutating $%<name>s.'
 

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         #   # good
         #   count { 1 }
-        class AttributeDefinedStatically < Cop
+        class AttributeDefinedStatically < Base
           extend AutoCorrector
 
           MSG = 'Use a block to declare attribute values.'
@@ -39,7 +39,7 @@ module RuboCop
 
           def on_block(node)
             attributes = factory_attributes(node) || []
-            attributes = [attributes] unless attributes.is_a?(Array)
+            attributes = [attributes] unless attributes.is_a?(Array) # rubocop:disable Style/ArrayCoercion, Lint/RedundantCopDisableDirective
 
             attributes.each do |attribute|
               next unless offensive_receiver?(attribute.receiver, node)
@@ -84,7 +84,7 @@ module RuboCop
           def autocorrect_replacing_parens(corrector, node)
             left_braces, right_braces = braces(node)
 
-            corrector.replace(node.location.begin, ' ' + left_braces)
+            corrector.replace(node.location.begin, " #{left_braces}")
             corrector.replace(node.location.end, right_braces)
           end