rubocop-rspec 2.15.0 → 2.17.0

data/lib/rubocop/cop/rspec/mixin/metadata.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helper methods to find RSpec metadata.
+      module Metadata
+        extend RuboCop::NodePattern::Macros
+
+        include RuboCop::RSpec::Language
+
+        # @!method rspec_metadata(node)
+        def_node_matcher :rspec_metadata, <<~PATTERN
+          (block
+            (send
+              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all} _ ${send str sym}* (hash $...)?)
+            ...)
+        PATTERN
+
+        # @!method rspec_configure(node)
+        def_node_matcher :rspec_configure, <<~PATTERN
+          (block (send #rspec? :configure) (args (arg $_)) ...)
+        PATTERN
+
+        # @!method metadata_in_block(node)
+        def_node_search :metadata_in_block, <<~PATTERN
+          (send (lvar %) #Hooks.all _ ${send str sym}* (hash $...)?)
+        PATTERN
+
+        def on_block(node)
+          rspec_configure(node) do |block_var|
+            metadata_in_block(node, block_var) do |symbols, pairs|
+              on_metadata(symbols, pairs.flatten)
+            end
+          end
+
+          rspec_metadata(node) do |symbols, pairs|
+            on_metadata(symbols, pairs.flatten)
+          end
+        end
+        alias on_numblock on_block
+
+        def on_metadata(_symbols, _pairs)
+          raise ::NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for pending or skipped examples without reason.
+      #
+      # @example
+      #   # bad
+      #   pending 'does something' do
+      #   end
+      #
+      #   # bad
+      #   it 'does something', :pending do
+      #   end
+      #
+      #   # bad
+      #   it 'does something' do
+      #     pending
+      #   end
+      #
+      #   # bad
+      #   xdescribe 'something' do
+      #   end
+      #
+      #   # bad
+      #   skip 'does something' do
+      #   end
+      #
+      #   # bad
+      #   it 'does something', :skip do
+      #   end
+      #
+      #   # bad
+      #   it 'does something' do
+      #     skip
+      #   end
+      #
+      #   # bad
+      #   it 'does something'
+      #
+      #   # good
+      #   it 'does something' do
+      #     pending 'reason'
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     skip 'reason'
+      #   end
+      #
+      #   # good
+      #   it 'does something', pending: 'reason' do
+      #   end
+      #
+      #   # good
+      #   it 'does something', skip: 'reason' do
+      #   end
+      class PendingWithoutReason < Base
+        MSG = 'Give the reason for pending or skip.'
+
+        # @!method pending_by_example_method?(node)
+        def_node_matcher :pending_by_example_method?, block_pattern(<<~PATTERN)
+          #Examples.pending
+        PATTERN
+
+        # @!method pending_by_metadata_without_reason?(node)
+        def_node_matcher :pending_by_metadata_without_reason?, <<~PATTERN
+          (send #rspec? {#ExampleGroups.all #Examples.all} ... {<(sym :pending) ...> (hash <(pair (sym :pending) true) ...>)})
+        PATTERN
+
+        # @!method skipped_by_example_method?(node)
+        def_node_matcher :skipped_by_example_method?, block_pattern(<<~PATTERN)
+          #Examples.skipped
+        PATTERN
+
+        # @!method skipped_by_example_group_method?(node)
+        def_node_matcher(
+          :skipped_by_example_group_method?,
+          block_pattern(<<~PATTERN)
+            #ExampleGroups.skipped
+          PATTERN
+        )
+
+        # @!method skipped_by_metadata_without_reason?(node)
+        def_node_matcher :skipped_by_metadata_without_reason?, <<~PATTERN
+          (send #rspec? {#ExampleGroups.all #Examples.all} ... {<(sym :skip) ...> (hash <(pair (sym :skip) true) ...>)})
+        PATTERN
+
+        # @!method without_reason?(node)
+        def_node_matcher :without_reason?, <<~PATTERN
+          (send nil? ${:pending :skip})
+        PATTERN
+
+        def on_send(node)
+          if pending_without_reason?(node)
+            add_offense(node, message: 'Give the reason for pending.')
+          elsif skipped_without_reason?(node)
+            add_offense(node, message: 'Give the reason for skip.')
+          elsif without_reason?(node) && example?(node.parent)
+            add_offense(node,
+                        message: "Give the reason for #{node.method_name}.")
+          end
+        end
+
+        private
+
+        def pending_without_reason?(node)
+          pending_by_example_method?(node.block_node) ||
+            pending_by_metadata_without_reason?(node)
+        end
+
+        def skipped_without_reason?(node)
+          skipped_by_example_group_method?(node.block_node) ||
+            skipped_by_example_method?(node.block_node) ||
+            skipped_by_metadata_without_reason?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -179,7 +179,8 @@ module RuboCop
 
           return false if allowed_explicit_matchers.include?(name)
 
-          name.start_with?('be_', 'have_') && !name.end_with?('?')
+          name.start_with?('be_', 'have_') && !name.end_with?('?') ||
+            %w[include respond_to].include?(name)
         end
 
         def message_explicit(matcher)
@@ -283,6 +284,8 @@ module RuboCop
         include InflectedHelper
         include ExplicitHelper
 
+        RESTRICT_ON_SEND = Runners.all
+
         def on_send(node)
           case style
           when :inflected

data/lib/rubocop/cop/rspec/rails/have_http_status.rb

@@ -13,20 +13,23 @@ module RuboCop
         #   # good
         #   expect(response).to have_http_status(200)
         #
-        class HaveHttpStatus < Base
+        class HaveHttpStatus < ::RuboCop::Cop::Base
           extend AutoCorrector
 
           MSG =
             'Prefer `expect(response).%<to>s have_http_status(%<status>i)` ' \
             'over `expect(response.status).%<to>s %<match>s`.'
 
+          RUNNERS = %i[to to_not not_to].to_set
+          RESTRICT_ON_SEND = RUNNERS
+
           # @!method match_status(node)
           def_node_matcher :match_status, <<-PATTERN
             (send
               (send nil? :expect
                 $(send (send nil? :response) :status)
               )
-              $#Runners.all
+              $RUNNERS
               $(send nil? {:be :eq :eql :equal} (int $_))
             )
           PATTERN

data/lib/rubocop/cop/rspec/rails/inferred_spec_type.rb

@@ -33,7 +33,7 @@ module RuboCop
         #
         # @example `Inferences` configuration
         #   # .rubocop.yml
-        #   # RSpec/InferredSpecType:
+        #   # RSpec/Rails/InferredSpecType:
         #   #   Inferences:
         #   #     services: service
         #

data/lib/rubocop/cop/rspec/rails/minitest_assertions.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Check if using Minitest matchers.
+        #
+        # @example
+        #   # bad
+        #   assert_equal(a, b)
+        #   assert_equal a, b, "must be equal"
+        #   refute_equal(a, b)
+        #
+        #   # good
+        #   expect(a).to eq(b)
+        #   expect(a).to(eq(b), "must be equal")
+        #   expect(a).not_to eq(b)
+        #
+        class MinitestAssertions < Base
+          extend AutoCorrector
+
+          MSG = 'Use `%<prefer>s`.'
+          RESTRICT_ON_SEND = %i[assert_equal refute_equal].freeze
+
+          # @!method minitest_assertion(node)
+          def_node_matcher :minitest_assertion, <<-PATTERN
+          (send nil? {:assert_equal :refute_equal} $_ $_ $_?)
+          PATTERN
+
+          def on_send(node)
+            minitest_assertion(node) do |expected, actual, failure_message|
+              prefer = replacement(node, expected, actual,
+                                   failure_message.first)
+              add_offense(node, message: message(prefer)) do |corrector|
+                corrector.replace(node, prefer)
+              end
+            end
+          end
+
+          private
+
+          def replacement(node, expected, actual, failure_message)
+            runner = node.method?(:assert_equal) ? 'to' : 'not_to'
+            if failure_message.nil?
+              "expect(#{expected.source}).#{runner} eq(#{actual.source})"
+            else
+              "expect(#{expected.source}).#{runner}(eq(#{actual.source}), " \
+                "#{failure_message.source})"
+            end
+          end
+
+          def message(prefer)
+            format(MSG, prefer: prefer)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -41,6 +41,8 @@ module RuboCop
           end
         end
 
+        private
+
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks

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

@@ -18,45 +18,12 @@ module RuboCop
       #
       class SortMetadata < Base
         extend AutoCorrector
+        include Metadata
         include RangeHelp
 
         MSG = 'Sort metadata alphabetically.'
 
-        # @!method rspec_metadata(node)
-        def_node_matcher :rspec_metadata, <<~PATTERN
-          (block
-            (send
-              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all} _ ${send str sym}* (hash $...)?)
-            ...)
-        PATTERN
-
-        # @!method rspec_configure(node)
-        def_node_matcher :rspec_configure, <<~PATTERN
-          (block (send #rspec? :configure) (args (arg $_)) ...)
-        PATTERN
-
-        # @!method metadata_in_block(node)
-        def_node_search :metadata_in_block, <<~PATTERN
-          (send (lvar %) #Hooks.all _ ${send str sym}* (hash $...)?)
-        PATTERN
-
-        def on_block(node)
-          rspec_configure(node) do |block_var|
-            metadata_in_block(node, block_var) do |symbols, pairs|
-              investigate(symbols, pairs.flatten)
-            end
-          end
-
-          rspec_metadata(node) do |symbols, pairs|
-            investigate(symbols, pairs.flatten)
-          end
-        end
-
-        alias on_numblock on_block
-
-        private
-
-        def investigate(symbols, pairs)
+        def on_metadata(symbols, pairs)
           return if sorted?(symbols, pairs)
 
           crime_scene = crime_scene(symbols, pairs)
@@ -65,6 +32,8 @@ module RuboCop
           end
         end
 
+        private
+
         def crime_scene(symbols, pairs)
           metadata = symbols + pairs
 

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

@@ -91,7 +91,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @yield [RuboCop::AST::Node] matcher
         def_node_matcher :matcher_with_return_block, <<~PATTERN
-          (block #message_expectation? args _)  # receive(:foo) { 'bar' }
+          (block #message_expectation? (args) _)  # receive(:foo) { 'bar' }
         PATTERN
 
         # @!method matcher_with_hash(node)
@@ -133,6 +133,8 @@ module RuboCop
           }
         PATTERN
 
+        RESTRICT_ON_SEND = %i[to].freeze
+
         def on_send(node)
           expectation(node, &method(:on_expectation))
         end

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

@@ -12,7 +12,6 @@ module RuboCop
       #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
       # @see https://penelope.zone/2015/12/27/introducing-rspec-smells-and-where-to-find-them.html#smell-1-stubjec
-      # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
       #
       # @example
       #   # bad

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

@@ -50,6 +50,8 @@ module RuboCop
           add_offense(node.children.last)
         end
 
+        private
+
         def empty_exception_matcher?(node)
           empty_raise_error_or_exception(node) && !block_with_args?(node.parent)
         end

data/lib/rubocop/cop/rspec_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
+require_relative 'rspec/capybara/match_style'
 require_relative 'rspec/capybara/negation_matcher'
 require_relative 'rspec/capybara/specific_actions'
 require_relative 'rspec/capybara/specific_finders'
@@ -12,6 +13,7 @@ require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/consistent_parentheses_style'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
+require_relative 'rspec/factory_bot/factory_name_style'
 require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
@@ -22,6 +24,7 @@ rescue LoadError
   # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
 end
 require_relative 'rspec/rails/inferred_spec_type'
+require_relative 'rspec/rails/minitest_assertions'
 
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
@@ -42,6 +45,7 @@ require_relative 'rspec/describe_symbol'
 require_relative 'rspec/described_class'
 require_relative 'rspec/described_class_module_wrapping'
 require_relative 'rspec/dialect'
+require_relative 'rspec/duplicated_metadata'
 require_relative 'rspec/empty_example_group'
 require_relative 'rspec/empty_hook'
 require_relative 'rspec/empty_line_after_example'
@@ -87,6 +91,7 @@ require_relative 'rspec/no_expectation_example'
 require_relative 'rspec/not_to_not'
 require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'
+require_relative 'rspec/pending_without_reason'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
 require_relative 'rspec/receive_never'

data/lib/rubocop/rspec/config_formatter.rb

@@ -9,7 +9,7 @@ module RuboCop
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
       AMENDMENTS = %(Metrics/BlockLength)
-      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
+      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
         @config       = config
@@ -47,7 +47,7 @@ module RuboCop
       end
 
       def reference(cop)
-        COP_DOC_BASE_URL + cop.sub('RSpec/', '')
+        COP_DOC_BASE_URL + cop
       end
 
       attr_reader :config, :descriptions

data/lib/rubocop/rspec/description_extractor.rb

@@ -21,7 +21,8 @@ module RuboCop
 
       # Decorator of a YARD code object for working with documented rspec cops
       class CodeObject
-        COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
+        RSPEC_COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
+        RUBOCOP_COP_CLASS_NAME = 'RuboCop::Cop::Base'
         RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'
 
         def initialize(yardoc)
@@ -32,10 +33,7 @@ module RuboCop
         #
         # @return [Boolean]
         def rspec_cop?
-          class_documentation? &&
-            rspec_cop_namespace? &&
-            cop_subclass? &&
-            !abstract?
+          cop_subclass? && !abstract? && rspec_cop_namespace?
         end
 
         # Configuration for the documented cop that would live in default.yml
@@ -55,10 +53,6 @@ module RuboCop
           yardoc.docstring.split("\n\n").first.to_s
         end
 
-        def class_documentation?
-          yardoc.type.equal?(:class)
-        end
-
         def rspec_cop_namespace?
           documented_constant.start_with?(RSPEC_NAMESPACE)
         end
@@ -68,7 +62,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == COP_CLASS_NAME
+          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
+            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
         end
 
         def abstract?

data/lib/rubocop/rspec/language.rb

@@ -160,8 +160,12 @@ module RuboCop
 
       module Runners # :nodoc:
         ALL = %i[to to_not not_to].freeze
-        def self.all(element)
-          ALL.include?(element)
+        class << self
+          def all(element = nil)
+            return ALL if element.nil?
+
+            ALL.include?(element)
+          end
         end
       end
 

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '2.15.0'
+      STRING = '2.17.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -6,34 +6,39 @@ require 'yaml'
 require 'rubocop'
 
 require_relative 'rubocop/rspec'
-require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
+require_relative 'rubocop/rspec/language/node_pattern'
 require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
-require_relative 'rubocop/rspec/language/node_pattern'
+
+# Dependent on `RuboCop::RSpec::Language::NodePattern`.
 require_relative 'rubocop/rspec/language'
 
 require_relative 'rubocop/rspec/factory_bot/language'
 
-require_relative 'rubocop/cop/rspec/mixin/top_level_group'
-require_relative 'rubocop/cop/rspec/mixin/variable'
+require_relative 'rubocop/cop/rspec/mixin/capybara_help'
+require_relative 'rubocop/cop/rspec/mixin/css_selector'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
-require_relative 'rubocop/cop/rspec/mixin/comments_help'
-require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
+require_relative 'rubocop/cop/rspec/mixin/metadata'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
-require_relative 'rubocop/cop/rspec/mixin/css_selector'
 require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
-require_relative 'rubocop/cop/rspec/mixin/capybara_help'
+require_relative 'rubocop/cop/rspec/mixin/top_level_group'
+require_relative 'rubocop/cop/rspec/mixin/variable'
+
+# Dependent on `RuboCop::Cop::RSpec::FinalEndLocation`.
+require_relative 'rubocop/cop/rspec/mixin/comments_help'
+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/cop/rspec/base'
 require_relative 'rubocop/rspec/align_let_brace'
-require_relative 'rubocop/rspec/factory_bot'
+require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/corrector/move_node'
+require_relative 'rubocop/rspec/example'
+require_relative 'rubocop/rspec/example_group'
+require_relative 'rubocop/rspec/factory_bot'
+require_relative 'rubocop/rspec/hook'
 
 RuboCop::RSpec::Inject.defaults!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.17.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -58,6 +58,7 @@ files:
 - lib/rubocop/cop/rspec/before_after_all.rb
 - lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb
+- lib/rubocop/cop/rspec/capybara/match_style.rb
 - lib/rubocop/cop/rspec/capybara/negation_matcher.rb
 - lib/rubocop/cop/rspec/capybara/specific_actions.rb
 - lib/rubocop/cop/rspec/capybara/specific_finders.rb
@@ -73,6 +74,7 @@ files:
 - lib/rubocop/cop/rspec/described_class.rb
 - lib/rubocop/cop/rspec/described_class_module_wrapping.rb
 - lib/rubocop/cop/rspec/dialect.rb
+- lib/rubocop/cop/rspec/duplicated_metadata.rb
 - lib/rubocop/cop/rspec/empty_example_group.rb
 - lib/rubocop/cop/rspec/empty_hook.rb
 - lib/rubocop/cop/rspec/empty_line_after_example.rb
@@ -92,6 +94,7 @@ files:
 - lib/rubocop/cop/rspec/factory_bot/consistent_parentheses_style.rb
 - lib/rubocop/cop/rspec/factory_bot/create_list.rb
 - lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb
+- lib/rubocop/cop/rspec/factory_bot/factory_name_style.rb
 - lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb
 - lib/rubocop/cop/rspec/file_path.rb
 - lib/rubocop/cop/rspec/focus.rb
@@ -119,6 +122,7 @@ files:
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/inside_example_group.rb
+- lib/rubocop/cop/rspec/mixin/metadata.rb
 - lib/rubocop/cop/rspec/mixin/namespace.rb
 - lib/rubocop/cop/rspec/mixin/skip_or_pending.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
@@ -133,11 +137,13 @@ files:
 - lib/rubocop/cop/rspec/not_to_not.rb
 - lib/rubocop/cop/rspec/overwriting_setup.rb
 - lib/rubocop/cop/rspec/pending.rb
+- lib/rubocop/cop/rspec/pending_without_reason.rb
 - lib/rubocop/cop/rspec/predicate_matcher.rb
 - lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
 - lib/rubocop/cop/rspec/rails/have_http_status.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/rails/inferred_spec_type.rb
+- lib/rubocop/cop/rspec/rails/minitest_assertions.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
@@ -203,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files