rubocop-rspec 2.21.0 → 2.23.0

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

@@ -17,7 +17,7 @@ module RuboCop
       # Anonymous classes are fine, since they don't result in global
       # namespace name clashes.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants
+      # @see https://rspec.info/features/3-12/rspec-mocks/mutating-constants
       #
       # @example Constants leak between examples
       #   # bad

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

@@ -51,6 +51,10 @@ module RuboCop
           }
         PATTERN
 
+        def self.autocorrect_incompatible_with
+          [RSpec::ScatteredLet]
+        end
+
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 

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

@@ -145,7 +145,7 @@ module RuboCop
         end
 
         def find_subject(block_node)
-          block_node.body.child_nodes.find { |send_node| subject?(send_node) }
+          block_node.body&.child_nodes&.find { |send_node| subject?(send_node) }
         end
       end
     end

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

@@ -41,10 +41,15 @@ module RuboCop
         def_node_matcher :skippable?, <<~PATTERN
           {
             (send #rspec? #ExampleGroups.regular ...)
-            (send nil? #Examples.regular ...)
+            #skippable_example?
           }
         PATTERN
 
+        # @!method skippable_example?(node)
+        def_node_matcher :skippable_example?, <<~PATTERN
+          (send nil? #Examples.regular ...)
+        PATTERN
+
         # @!method pending_block?(node)
         def_node_matcher :pending_block?, <<~PATTERN
           {
@@ -62,7 +67,12 @@ module RuboCop
         private
 
         def skipped?(node)
-          skippable?(node) && skipped_in_metadata?(node)
+          skippable?(node) && skipped_in_metadata?(node) ||
+            skipped_regular_example_without_body?(node)
+        end
+
+        def skipped_regular_example_without_body?(node)
+          skippable_example?(node) && !node.block_node
         end
       end
     end

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

@@ -74,7 +74,7 @@ module RuboCop
             name[0..-2]
           when 'exist?', 'exists?'
             'exist'
-          when /^has_/
+          when /\Ahas_/
             name.sub('has_', 'have_')[0..-2]
           else
             "be_#{name[0..-2]}"
@@ -240,10 +240,10 @@ module RuboCop
             'include?'
           when 'respond_to'
             'respond_to?'
-          when /^have_(.+)/
+          when /\Ahave_(.+)/
             "has_#{Regexp.last_match(1)}?"
           else
-            "#{matcher[/^be_(.+)/, 1]}?"
+            "#{matcher[/\Abe_(.+)/, 1]}?"
           end
         end
         # rubocop:enable Metrics/MethodLength

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Enforces use of `be_invalid` or `not_to` for negated be_valid.
+        #
+        # @example EnforcedStyle: not_to (default)
+        #   # bad
+        #   expect(foo).to be_invalid
+        #
+        #   # good
+        #   expect(foo).not_to be_valid
+        #
+        # @example EnforcedStyle: be_invalid
+        #   # bad
+        #   expect(foo).not_to be_valid
+        #
+        #   # good
+        #   expect(foo).to be_invalid
+        #
+        class NegationBeValid < Base
+          extend AutoCorrector
+          include ConfigurableEnforcedStyle
+
+          MSG = 'Use `expect(...).%<runner>s %<matcher>s`.'
+          RESTRICT_ON_SEND = %i[be_valid be_invalid].freeze
+
+          # @!method not_to?(node)
+          def_node_matcher :not_to?, <<~PATTERN
+            (send ... :not_to (send nil? :be_valid ...))
+          PATTERN
+
+          # @!method be_invalid?(node)
+          def_node_matcher :be_invalid?, <<~PATTERN
+            (send ... :to (send nil? :be_invalid ...))
+          PATTERN
+
+          def on_send(node)
+            return unless offense?(node.parent)
+
+            add_offense(offense_range(node),
+                        message: message(node.method_name)) do |corrector|
+              corrector.replace(node.parent.loc.selector, replaced_runner)
+              corrector.replace(node.loc.selector, replaced_matcher)
+            end
+          end
+
+          private
+
+          def offense?(node)
+            case style
+            when :not_to
+              be_invalid?(node)
+            when :be_invalid
+              not_to?(node)
+            end
+          end
+
+          def offense_range(node)
+            node.parent.loc.selector.with(end_pos: node.loc.selector.end_pos)
+          end
+
+          def message(_matcher)
+            format(MSG,
+                   runner: replaced_runner,
+                   matcher: replaced_matcher)
+          end
+
+          def replaced_runner
+            case style
+            when :not_to
+              'not_to'
+            when :be_invalid
+              'to'
+            end
+          end
+
+          def replaced_matcher
+            case style
+            when :not_to
+              'be_valid'
+            when :be_invalid
+              'be_invalid'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for multiple messages stubbed on the same object.
+      #
+      # @example
+      #   # bad
+      #   before do
+      #     allow(Service).to receive(:foo).and_return(bar)
+      #     allow(Service).to receive(:baz).and_return(qux)
+      #   end
+      #
+      #   # good
+      #   before do
+      #     allow(Service).to receive_messages(foo: bar, baz: qux)
+      #   end
+      #
+      #   # good - ignore same message
+      #   before do
+      #     allow(Service).to receive(:foo).and_return(bar)
+      #     allow(Service).to receive(:foo).and_return(qux)
+      #   end
+      #
+      class ReceiveMessages < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `receive_messages` instead of multiple stubs on lines ' \
+              '%<loc>s.'
+
+        # @!method allow_receive_message?(node)
+        def_node_matcher :allow_receive_message?, <<~PATTERN
+          (send (send nil? :allow ...) :to (send (send nil? :receive (sym _)) :and_return !#heredoc?))
+        PATTERN
+
+        # @!method allow_argument(node)
+        def_node_matcher :allow_argument, <<~PATTERN
+          (send (send nil? :allow $_ ...) ...)
+        PATTERN
+
+        # @!method receive_node(node)
+        def_node_search :receive_node, <<~PATTERN
+          $(send (send nil? :receive ...) ...)
+        PATTERN
+
+        # @!method receive_arg(node)
+        def_node_search :receive_arg, <<~PATTERN
+          (send (send nil? :receive $_) ...)
+        PATTERN
+
+        # @!method receive_and_return_argument(node)
+        def_node_matcher :receive_and_return_argument, <<~PATTERN
+          (send (send nil? :allow ...) :to (send (send nil? :receive (sym $_)) :and_return $_))
+        PATTERN
+
+        def on_begin(node)
+          repeated_receive_message(node).each do |item, repeated_lines, args|
+            next if repeated_lines.empty?
+
+            register_offense(item, repeated_lines, args)
+          end
+        end
+
+        private
+
+        def repeated_receive_message(node)
+          node
+            .children
+            .select { |child| allow_receive_message?(child) }
+            .group_by { |child| allow_argument(child) }
+            .values
+            .reject(&:one?)
+            .flat_map { |items| add_repeated_lines_and_arguments(items) }
+        end
+
+        def add_repeated_lines_and_arguments(items)
+          uniq_items = uniq_items(items)
+          repeated_lines = uniq_items.map(&:first_line)
+          uniq_items.map do |item|
+            [item, repeated_lines - [item.first_line], arguments(uniq_items)]
+          end
+        end
+
+        def uniq_items(items)
+          items.select do |item|
+            items.none? do |i|
+              receive_arg(item).first == receive_arg(i).first &&
+                !same_line?(item, i)
+            end
+          end
+        end
+
+        def arguments(items)
+          items.map do |item|
+            receive_and_return_argument(item) do |receive_arg, return_arg|
+              "#{normalize_receive_arg(receive_arg)}: " \
+                "#{normalize_return_arg(return_arg)}"
+            end
+          end
+        end
+
+        def normalize_receive_arg(receive_arg)
+          if requires_quotes?(receive_arg)
+            "'#{receive_arg}'"
+          else
+            receive_arg
+          end
+        end
+
+        def normalize_return_arg(return_arg)
+          if return_arg.hash_type? && !return_arg.braces?
+            "{ #{return_arg.source} }"
+          else
+            return_arg.source
+          end
+        end
+
+        def register_offense(item, repeated_lines, args)
+          add_offense(item, message: message(repeated_lines)) do |corrector|
+            if item.loc.line < repeated_lines.min
+              replace_to_receive_messages(corrector, item, args)
+            else
+              corrector.remove(item_range_by_whole_lines(item))
+            end
+          end
+        end
+
+        def message(repeated_lines)
+          format(MSG, loc: repeated_lines)
+        end
+
+        def replace_to_receive_messages(corrector, item, args)
+          receive_node(item) do |node|
+            corrector.replace(node,
+                              "receive_messages(#{args.join(', ')})")
+          end
+        end
+
+        def item_range_by_whole_lines(item)
+          range_by_whole_lines(item.source_range, include_final_newline: true)
+        end
+
+        def heredoc?(node)
+          (node.str_type? || node.dstr_type?) && node.heredoc?
+        end
+
+        def requires_quotes?(value)
+          value.match?(/^:".*?"|=$/)
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module RuboCop
       #
       # Only investigates references that are one of the supported styles.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+      # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.

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

@@ -5,7 +5,7 @@ module RuboCop
     module RSpec
       # Prefer using verifying doubles over normal doubles.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+      # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
       # @example
       #   # bad

data/lib/rubocop/cop/rspec_cops.rb

@@ -18,6 +18,7 @@ require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
 require_relative 'rspec/rails/have_http_status'
+require_relative 'rspec/rails/negation_be_valid'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
@@ -99,6 +100,7 @@ require_relative 'rspec/pending'
 require_relative 'rspec/pending_without_reason'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
+require_relative 'rspec/receive_messages'
 require_relative 'rspec/receive_never'
 require_relative 'rspec/redundant_around'
 require_relative 'rspec/repeated_description'

data/lib/rubocop/rspec/config_formatter.rb

@@ -16,6 +16,12 @@ module RuboCop
         RSpec/Capybara/SpecificFinders
         RSpec/Capybara/SpecificMatcher
         RSpec/Capybara/VisibilityMatcher
+        RSpec/FactoryBot/AttributeDefinedStatically
+        RSpec/FactoryBot/ConsistentParenthesesStyle
+        RSpec/FactoryBot/CreateList
+        RSpec/FactoryBot/FactoryClassName
+        RSpec/FactoryBot/FactoryNameStyle
+        RSpec/FactoryBot/SyntaxMethods
       )
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'

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.21.0'
+      STRING = '2.23.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -5,6 +5,7 @@ require 'yaml'
 
 require 'rubocop'
 require 'rubocop-capybara'
+require 'rubocop-factory_bot'
 
 require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/inject'
@@ -16,8 +17,6 @@ require_relative 'rubocop/rspec/wording'
 # Dependent on `RuboCop::RSpec::Language::NodePattern`.
 require_relative 'rubocop/rspec/language'
 
-require_relative 'rubocop/rspec/factory_bot/language'
-
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
 require_relative 'rubocop/cop/rspec/mixin/location_help'
@@ -37,7 +36,6 @@ 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.21.0
+  version: 2.23.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -40,6 +40,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
 description: |2
       Code style checking for RSpec files.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -161,8 +175,10 @@ files:
 - 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/rails/negation_be_valid.rb
 - lib/rubocop/cop/rspec/rails/travel_around.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
+- lib/rubocop/cop/rspec/receive_messages.rb
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/redundant_around.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
@@ -197,8 +213,6 @@ files:
 - lib/rubocop/rspec/description_extractor.rb
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
-- lib/rubocop/rspec/factory_bot.rb
-- lib/rubocop/rspec/factory_bot/language.rb
 - lib/rubocop/rspec/hook.rb
 - lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb

data/lib/rubocop/rspec/factory_bot/language.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    module FactoryBot
-      # Contains node matchers for common FactoryBot DSL.
-      module Language
-        extend RuboCop::NodePattern::Macros
-
-        METHODS = %i[
-          attributes_for
-          attributes_for_list
-          attributes_for_pair
-          build
-          build_list
-          build_pair
-          build_stubbed
-          build_stubbed_list
-          build_stubbed_pair
-          create
-          create_list
-          create_pair
-          generate
-          generate_list
-          null
-          null_list
-          null_pair
-        ].to_set.freeze
-
-        # @!method factory_bot?(node)
-        def_node_matcher :factory_bot?, <<~PATTERN
-          (const {nil? cbase} {:FactoryGirl :FactoryBot})
-        PATTERN
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/factory_bot.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # RuboCop FactoryBot project namespace
-    module FactoryBot
-      ATTRIBUTE_DEFINING_METHODS = %i[
-        factory
-        ignore
-        trait
-        traits_for_enum
-        transient
-      ].freeze
-
-      UNPROXIED_METHODS = %i[
-        __send__
-        __id__
-        nil?
-        send
-        object_id
-        extend
-        instance_eval
-        initialize
-        block_given?
-        raise
-        caller
-        method
-      ].freeze
-
-      DEFINITION_PROXY_METHODS = %i[
-        add_attribute
-        after
-        association
-        before
-        callback
-        ignore
-        initialize_with
-        sequence
-        skip_create
-        to_create
-      ].freeze
-
-      RESERVED_METHODS =
-        DEFINITION_PROXY_METHODS +
-        UNPROXIED_METHODS +
-        ATTRIBUTE_DEFINING_METHODS
-
-      private_constant(
-        :ATTRIBUTE_DEFINING_METHODS,
-        :UNPROXIED_METHODS,
-        :DEFINITION_PROXY_METHODS,
-        :RESERVED_METHODS
-      )
-
-      def self.attribute_defining_methods
-        ATTRIBUTE_DEFINING_METHODS
-      end
-
-      def self.reserved_methods
-        RESERVED_METHODS
-      end
-    end
-  end
-end