rubocop-rspec 1.42.0 → 1.44.1

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

@@ -3,7 +3,20 @@
 module RuboCop
   module Cop
     module RSpec
-      # Check that the first argument to the top level describe is a constant.
+      # Check that the first argument to the top-level describe is a constant.
+      #
+      # It can be configured to ignore strings when certain metadata is passed.
+      #
+      # Ignores Rails and Aruba `type` metadata by default.
+      #
+      # @example `IgnoredMetadata` configuration
+      #
+      #   # .rubocop.yml
+      #   # RSpec/DescribeClass:
+      #   #   IgnoredMetadata:
+      #   #     type:
+      #   #       - request
+      #   #       - controller
       #
       # @example
       #   # bad
@@ -21,50 +34,47 @@ module RuboCop
       #
       #   describe "A feature example", type: :feature do
       #   end
-      class DescribeClass < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+      class DescribeClass < Base
+        include RuboCop::RSpec::TopLevelGroup
 
         MSG = 'The first argument to describe should be '\
               'the class or module being tested.'
 
-        def_node_matcher :valid_describe?, <<-PATTERN
-          {
-            (send #{RSPEC} :describe const ...)
-            (send #{RSPEC} :describe)
-          }
+        def_node_matcher :example_group_with_ignored_metadata?, <<~PATTERN
+          (send #rspec? :describe ... (hash <#ignored_metadata? ...>))
         PATTERN
 
-        def_node_matcher :describe_with_rails_metadata?, <<-PATTERN
-          (send #{RSPEC} :describe !const ...
-            (hash <#rails_metadata? ...>)
-          )
+        def_node_matcher :not_a_const_described, <<~PATTERN
+          (send #rspec? :describe $[!const !#string_constant?] ...)
         PATTERN
 
-        def_node_matcher :rails_metadata?, <<-PATTERN
-          (pair
-            (sym :type)
-            (sym {
-                   :channel :controller :helper :job :mailer :model :request
-                   :routing :view :feature :system :mailbox
-                 }
-            )
-          )
+        def_node_matcher :sym_pair, <<~PATTERN
+          (pair $sym $sym)
         PATTERN
 
-        def on_top_level_describe(node, (described_value, _))
-          return if shared_group?(root_node)
-          return if valid_describe?(node)
-          return if describe_with_rails_metadata?(node)
-          return if string_constant_describe?(described_value)
+        def on_top_level_group(node)
+          return if example_group_with_ignored_metadata?(node.send_node)
 
-          add_offense(described_value)
+          not_a_const_described(node.send_node) do |described|
+            add_offense(described)
+          end
         end
 
         private
 
-        def string_constant_describe?(described_value)
-          described_value.str_type? &&
-            described_value.value =~ /^((::)?[A-Z]\w*)+$/
+        def ignored_metadata?(node)
+          sym_pair(node) do |key, value|
+            ignored_metadata[key.value.to_s].to_a.include?(value.value.to_s)
+          end
+        end
+
+        def string_constant?(described)
+          described.str_type? &&
+            described.value.match?(/^(?:(?:::)?[A-Z]\w*)+$/)
+        end
+
+        def ignored_metadata
+          cop_config['IgnoredMetadata'] || {}
         end
       end
     end

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

@@ -33,6 +33,11 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
+      #   describe Bacon do
+      #     pending 'will add tests later'
+      #   end
+      #
       # @example configuration
       #
       #   # .rubocop.yml
@@ -57,24 +62,137 @@ 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
+        #     skip
+        #     it 'will be implemented later'
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Array<RuboCop::AST::Node>] matching nodes
+        def_node_matcher :example_or_group_or_include?, <<~PATTERN
+          {
+            #{Examples::ALL.send_pattern}
+            #{Examples::ALL.block_pattern}
+            #{ExampleGroups::ALL.block_pattern}
+            #{Includes::ALL.send_pattern}
+            #{Includes::ALL.block_pattern}
+            (send nil? #custom_include? ...)
+          }
+        PATTERN
+
+        # @!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
+
+        # @!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
           {
-            #{(Examples::ALL + Includes::ALL).send_pattern}
-            (send _ #custom_include? ...)
+            #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)
-          return unless example_group?(node) && !contains_example?(node)
+          return if node.each_ancestor(:def, :defs).any?
+          return if node.each_ancestor(:block).any? { |block| example?(block) }
 
-          add_offense(node.send_node)
+          example_group_body(node) do |body|
+            add_offense(node.send_node) if offensive?(body)
+          end
         end
 
         private
 
+        def offensive?(body)
+          return true unless body
+          return false if conditionals_with_examples?(body)
+
+          if body.if_type?
+            !examples_in_branches?(body)
+          else
+            !examples?(body)
+          end
+        end
+
+        def conditionals_with_examples?(body)
+          return unless body.begin_type?
+
+          body.each_descendant(:if).any? do |if_node|
+            examples_in_branches?(if_node)
+          end
+        end
+
+        def examples_in_branches?(if_node)
+          if_node.branches.any? { |branch| examples?(branch) }
+        end
+
         def custom_include?(method_name)
           custom_include_methods.include?(method_name)
         end

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