rubocop-rspec 1.43.2 → 2.0.1

data/lib/rubocop-rspec.rb

@@ -5,26 +5,25 @@ require 'yaml'
 
 require 'rubocop'
 
-require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/node'
-require_relative 'rubocop/rspec/top_level_describe'
 require_relative 'rubocop/rspec/wording'
-require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/language/node_pattern'
-require_relative 'rubocop/rspec/top_level_group'
+require_relative 'rubocop/rspec/language'
+
+require_relative 'rubocop/cop/rspec/mixin/top_level_group'
+require_relative 'rubocop/cop/rspec/mixin/variable'
+require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
+
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/hook'
-require_relative 'rubocop/rspec/variable'
 require_relative 'rubocop/cop/rspec/base'
-require_relative 'rubocop/cop/rspec/cop'
 require_relative 'rubocop/rspec/align_let_brace'
 require_relative 'rubocop/rspec/factory_bot'
-require_relative 'rubocop/rspec/final_end_location'
-require_relative 'rubocop/rspec/empty_line_separation'
 require_relative 'rubocop/rspec/corrector/move_node'
 
 RuboCop::RSpec::Inject.defaults!

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

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.begin) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
+        end
       end
     end
   end

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

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.end) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
+        end
       end
     end
   end

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

@@ -27,11 +27,11 @@ module RuboCop
       #   end
       class AroundBlock < Base
         MSG_NO_ARG     = 'Test object should be passed to around block.'
-        MSG_UNUSED_ARG = 'You should call `%<arg>s.call` '\
+        MSG_UNUSED_ARG = 'You should call `%<arg>s.call` ' \
                          'or `%<arg>s.run`.'
 
         def_node_matcher :hook, <<-PATTERN
-          (block {(send nil? :around) (send nil? :around sym)} (args $...) ...)
+          (block (send nil? :around sym ?) (args $...) ...)
         PATTERN
 
         def_node_search :find_arg_usage, <<-PATTERN

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

@@ -4,69 +4,22 @@ module RuboCop
   module Cop
     module RSpec
       # @abstract parent class to RSpec cops
-      #
-      # The criteria for whether rubocop-rspec analyzes a certain ruby file
-      # is configured via `AllCops/RSpec`. For example, if you want to
-      # customize your project to scan all files within a `test/` directory
-      # then you could add this to your configuration:
-      #
-      # @example configuring analyzed paths
-      #   # .rubocop.yml
-      #   # AllCops:
-      #   #   RSpec:
-      #   #     Patterns:
-      #   #     - '_test.rb$'
-      #   #     - '(?:^|/)test/'
       class Base < ::RuboCop::Cop::Base
         include RuboCop::RSpec::Language
-        include RuboCop::RSpec::Language::NodePattern
+        extend RuboCop::RSpec::Language::NodePattern
 
-        DEFAULT_CONFIGURATION =
-          RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
-
-        DEFAULT_PATTERN_RE = Regexp.union(
-          DEFAULT_CONFIGURATION.fetch('Patterns')
-                               .map(&Regexp.public_method(:new))
-        )
+        exclude_from_registry
 
         # Invoke the original inherited hook so our cops are recognized
         def self.inherited(subclass) # rubocop:disable Lint/MissingSuper
           RuboCop::Cop::Base.inherited(subclass)
         end
 
-        def relevant_file?(file)
-          relevant_rubocop_rspec_file?(file) && super
-        end
-
-        private
-
-        def relevant_rubocop_rspec_file?(file)
-          rspec_pattern.match?(file)
-        end
-
-        def rspec_pattern
-          if rspec_pattern_config?
-            Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
-          else
-            DEFAULT_PATTERN_RE
-          end
-        end
-
-        def all_cops_config
-          config
-            .for_all_cops
-        end
-
-        def rspec_pattern_config?
-          return unless all_cops_config.key?('RSpec')
-
-          all_cops_config.fetch('RSpec').key?('Patterns')
-        end
-
-        def rspec_pattern_config
-          all_cops_config
-            .fetch('RSpec', DEFAULT_CONFIGURATION)
-            .fetch('Patterns')
+        # Set the config for dynamic DSL configuration-aware helpers
+        # that have no other means of accessing the configuration.
+        def on_new_investigation
+          super
+          RuboCop::RSpec::Language.config = config['RSpec']['Language']
         end
       end
     end

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

@@ -20,10 +20,10 @@ module RuboCop
       #   expect(foo).to be(true)
       #
       class Be < Base
-        MSG = 'Don\'t use `be` without an argument.'
+        MSG = "Don't use `be` without an argument."
 
         def_node_matcher :be_without_args, <<-PATTERN
-          (send _ #{Runners::ALL.node_pattern_union} $(send nil? :be))
+          (send _ #Runners.all $(send nil? :be))
         PATTERN
 
         def on_send(node)

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

@@ -24,9 +24,9 @@ module RuboCop
       #     after(:each) { Widget.delete_all }
       #   end
       class BeforeAfterAll < Base
-        MSG = 'Beware of using `%<hook>s` as it may cause state to leak '\
-              'between tests. If you are using `rspec-rails`, and '\
-              '`use_transactional_fixtures` is enabled, then records created '\
+        MSG = 'Beware of using `%<hook>s` as it may cause state to leak ' \
+              'between tests. If you are using `rspec-rails`, and ' \
+              '`use_transactional_fixtures` is enabled, then records created ' \
               'in `%<hook>s` are not automatically rolled back.'
 
         def_node_matcher :before_or_after_all, <<-PATTERN

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -37,13 +37,13 @@ module RuboCop
           # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
           def_node_matcher :as_is_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               ${(send nil? :eq ...) (send nil? :match (regexp ...))})
           PATTERN
 
           def_node_matcher :regexp_str_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               $(send nil? :match (str $_)))
           PATTERN
 

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -55,8 +55,9 @@ module RuboCop
             feature:    :describe
           }.freeze
 
-          def_node_matcher :capybara_speak,
-                           SelectorSet.new(MAP.keys).node_pattern_union
+          def_node_matcher :capybara_speak, <<-PATTERN
+            {#{MAP.keys.map(&:inspect).join(' ')}}
+          PATTERN
 
           def_node_matcher :spec?, <<-PATTERN
             (block

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

@@ -5,6 +5,19 @@ module RuboCop
     module RSpec
       # 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
       #   describe 'Do something' do
@@ -22,41 +35,47 @@ module RuboCop
       #   describe "A feature example", type: :feature do
       #   end
       class DescribeClass < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
-        MSG = 'The first argument to describe should be '\
+        MSG = 'The first argument to describe should be ' \
               'the class or module being tested.'
 
-        def_node_matcher :rails_metadata?, <<-PATTERN
-          (pair
-            (sym :type)
-            (sym { :channel :controller :helper :job :mailer :model :request
-                   :routing :view :feature :system :mailbox })
-          )
-        PATTERN
-
-        def_node_matcher :example_group_with_rails_metadata?, <<~PATTERN
-          (send #rspec? :describe ... (hash <#rails_metadata? ...>))
+        def_node_matcher :example_group_with_ignored_metadata?, <<~PATTERN
+          (send #rspec? :describe ... (hash <#ignored_metadata? ...>))
         PATTERN
 
         def_node_matcher :not_a_const_described, <<~PATTERN
           (send #rspec? :describe $[!const !#string_constant?] ...)
         PATTERN
 
-        def on_top_level_group(top_level_node)
-          return if example_group_with_rails_metadata?(top_level_node.send_node)
+        def_node_matcher :sym_pair, <<~PATTERN
+          (pair $sym $sym)
+        PATTERN
 
-          not_a_const_described(top_level_node.send_node) do |described|
+        def on_top_level_group(node)
+          return if example_group_with_ignored_metadata?(node.send_node)
+
+          not_a_const_described(node.send_node) do |described|
             add_offense(described)
           end
         end
 
         private
 
+        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
   end

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

@@ -17,9 +17,9 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
-        MSG = 'The second argument to describe should be the method '\
+        MSG = 'The second argument to describe should be the method ' \
               "being tested. '#instance' or '.class'."
 
         def_node_matcher :second_argument, <<~PATTERN

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

@@ -65,8 +65,7 @@ module RuboCop
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
-        def_node_matcher :rspec_block?,
-                         RuboCop::RSpec::Language::ALL.block_pattern
+        def_node_matcher :rspec_block?, block_pattern('#ALL.all')
 
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 

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

@@ -22,8 +22,7 @@ module RuboCop
       class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
-        def_node_search :find_rspec_blocks,
-                        ExampleGroups::ALL.block_pattern
+        def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
 
         def on_module(node)
           find_rspec_blocks(node) do

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

@@ -47,7 +47,7 @@ module RuboCop
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
-        def_node_matcher :rspec_method?, ALL.send_pattern
+        def_node_matcher :rspec_method?, send_pattern('#ALL.all')
 
         def on_send(node)
           return unless rspec_method?(node)

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

@@ -5,8 +5,6 @@ module RuboCop
     module RSpec
       # Checks if an example group does not include any tests.
       #
-      # This cop is configurable using the `CustomIncludeMethods` option
-      #
       # @example usage
       #
       #   # bad
@@ -33,30 +31,10 @@ module RuboCop
       #     end
       #   end
       #
-      # @example configuration
-      #
-      #   # .rubocop.yml
-      #   # RSpec/EmptyExampleGroup:
-      #   #   CustomIncludeMethods:
-      #   #   - include_tests
-      #
-      #   # spec_helper.rb
-      #   RSpec.configure do |config|
-      #     config.alias_it_behaves_like_to(:include_tests)
-      #   end
-      #
-      #   # bacon_spec.rb
+      #   # good
       #   describe Bacon do
-      #     let(:bacon)      { Bacon.new(chunkiness) }
-      #     let(:chunkiness) { false                 }
-      #
-      #     context 'extra chunky' do   # not flagged by rubocop
-      #       let(:chunkiness) { true }
-      #
-      #       include_tests 'shared tests'
-      #     end
+      #     pending 'will add tests later'
       #   end
-      #
       class EmptyExampleGroup < Base
         MSG = 'Empty example group detected.'
 
@@ -71,7 +49,7 @@ module RuboCop
         #   @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 $_)
+          (block #{send_pattern('#ExampleGroups.all')} args $_)
         PATTERN
 
         # @!method example_or_group_or_include?(node)
@@ -83,16 +61,17 @@ module RuboCop
         #     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.block_pattern}
-            #{ExampleGroups::ALL.block_pattern}
-            #{Includes::ALL.send_pattern}
-            #{Includes::ALL.block_pattern}
-            (send nil? #custom_include? ...)
+            #{block_pattern(
+              '{#Examples.all #ExampleGroups.all #Includes.all}'
+            )}
+            #{send_pattern('{#Examples.all #Includes.all}')}
           }
         PATTERN
 
@@ -112,7 +91,7 @@ module RuboCop
         #   @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?)
+          (block !#{send_pattern('#Hooks.all')} _ #examples?)
         PATTERN
 
         # @!method examples_directly_or_in_block?(node)
@@ -152,21 +131,37 @@ module RuboCop
         PATTERN
 
         def on_block(node)
+          return if node.each_ancestor(:def, :defs).any?
+          return if node.each_ancestor(:block).any? { |block| example?(block) }
+
           example_group_body(node) do |body|
-            add_offense(node.send_node) unless examples?(body)
+            add_offense(node.send_node) if offensive?(body)
           end
         end
 
         private
 
-        def custom_include?(method_name)
-          custom_include_methods.include?(method_name)
+        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 custom_include_methods
-          cop_config
-            .fetch('CustomIncludeMethods', [])
-            .map(&:to_sym)
+        def examples_in_branches?(if_node)
+          if_node.branches.any? { |branch| examples?(branch) }
         end
       end
     end