rubocop-rspec 2.27.1 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629669f9a1d9d41dae7bc62c630f3a6cdae80623d3213c8e79ac8eb207f79e59
-  data.tar.gz: 5005161c3684fcd8b794284bcaeedc50253a545d649be9e0e0a82958fdd125b0
+  metadata.gz: 17925b2c404825ce202d012a1b5176358a7328cbdf5c956426b2be463c07707a
+  data.tar.gz: bf216b0348237ccb7020b7dad2cb79c700c46f7bdbc85bdf65c5a2740aea12e8
 SHA512:
-  metadata.gz: 8af331d4b31697228397a1122cbe331223d3f040f44d2260e5148d73177df5ba08ae2aea1d481b27f698b5d59c9522d1c5f4c5e08e14b473a548de75ccf218c6
-  data.tar.gz: 0f86ea257bcd14e73c57b2e431f618e0959cf9dbeca6e22c4b75bd8d4945f670d8fdb65212ff12969b351b62c35f845ca28041d4b1b30627e7d64dda5932b365
+  metadata.gz: fb4265f89166d4df1e75b2eef2a2b3d709e93834511dde371765cf21d0efb7af158bc2a165b98dc0106ffb979003b2d924543074c00268445df924a6d3ec8cc0
+  data.tar.gz: 90fc7033f83e79d3aa77eab277247ce0c6b66b20db115d24834ed28940f584c656eb6588f93250e1abea901ad4b83cac012d0339e64b4a5633b48abed9c4b568

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master (Unreleased)
 
+## 2.29.0 (2024-04-04)
+
+- Fix an autocorrect error for `RSpec/ExpectActual`. ([@bquorning])
+- Add new `RSpec/UndescriptiveLiteralsDescription` cop. ([@ydah])
+- Add new `RSpec/EmptyOutput` cop. ([@bquorning])
+
+## 2.28.0 (2024-03-30)
+
+- Extract RSpec Rails cops to a separate repository, [`rubocop-rspec_rails`](https://github.com/rubocop/rubocop-rspec_rails). The `rubocop-rspec_rails` repository is a dependency of `rubocop-rspec` and the cops related to rspec-rails are aliased (`RSpec/Rails/Foo` == `RSpecRails/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@ydah])
+
 ## 2.27.1 (2024-03-03)
 
 - Fix a false positive for `RSpec/RepeatedSubjectCall` when `subject.method_call`. ([@ydah])

data/config/default.yml

@@ -366,6 +366,12 @@ RSpec/EmptyMetadata:
   VersionAdded: '2.24'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyMetadata
 
+RSpec/EmptyOutput:
+  Description: Check that the `output` matcher is not called with an empty string.
+  Enabled: pending
+  VersionAdded: "<<next>>"
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyOutput
+
 RSpec/Eq:
   Description: Use `eq` instead of `be ==` to compare objects.
   Enabled: pending
@@ -932,6 +938,12 @@ RSpec/SubjectStub:
   StyleGuide: https://rspec.rubystyle.guide/#dont-stub-subject
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SubjectStub
 
+RSpec/UndescriptiveLiteralsDescription:
+  Description: Description should be descriptive.
+  Enabled: pending
+  VersionAdded: '2.29'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/UndescriptiveLiteralsDescription
+
 RSpec/UnspecifiedException:
   Description: Checks for a specified error in checking raised errors.
   Enabled: true

data/config/obsoletion.yml

@@ -27,3 +27,10 @@ renamed:
   RSpec/FactoryBot/FactoryClassName: FactoryBot/FactoryClassName
   RSpec/FactoryBot/FactoryNameStyle: FactoryBot/FactoryNameStyle
   RSpec/FactoryBot/SyntaxMethods: FactoryBot/SyntaxMethods
+  RSpec/Rails/AvoidSetupHook: RSpecRails/AvoidSetupHook
+  RSpec/Rails/HaveHttpStatus: RSpecRails/HaveHttpStatus
+  RSpec/Rails/HttpStatus: RSpecRails/HttpStatus
+  RSpec/Rails/InferredSpecType: RSpecRails/InferredSpecType
+  RSpec/Rails/MinitestAssertions: RSpecRails/MinitestAssertions
+  RSpec/Rails/NegationBeValid: RSpecRails/NegationBeValid
+  RSpec/Rails/TravelAround: RSpecRails/TravelAround

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      #  Checks for empty before and after hooks.
+      # Checks for empty before and after hooks.
       #
       # @example
       #   # bad

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that the `output` matcher is not called with an empty string.
+      #
+      # @example
+      #   # bad
+      #   expect { foo }.to output('').to_stdout
+      #   expect { bar }.not_to output('').to_stderr
+      #
+      #   # good
+      #   expect { foo }.not_to output.to_stdout
+      #   expect { bar }.to output.to_stderr
+      #
+      class EmptyOutput < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<runner>s` instead of matching on an empty output.'
+        RESTRICT_ON_SEND = Runners.all
+
+        # @!method matching_empty_output(node)
+        def_node_matcher :matching_empty_output, <<~PATTERN
+          (send
+            (block
+              (send nil? :expect) ...
+            )
+            #Runners.all
+            (send $(send nil? :output (str empty?)) ...)
+          )
+        PATTERN
+
+        def on_send(send_node)
+          matching_empty_output(send_node) do |node|
+            runner = send_node.method?(:to) ? 'not_to' : 'to'
+            message = format(MSG, runner: runner)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(send_node.loc.selector, runner)
+              corrector.replace(node, 'output')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -58,22 +58,27 @@ module RuboCop
           (send
             (send nil? :expect $#literal?)
             #Runners.all
-            {
+            ${
               (send (send nil? $:be) :== $_)
               (send nil? $_ $_ ...)
             }
           )
         PATTERN
 
-        def on_send(node)
-          expect_literal(node) do |actual, matcher, expected|
+        def on_send(node) # rubocop:disable Metrics/MethodLength
+          expect_literal(node) do |actual, send_node, matcher, expected|
             next if SKIPPED_MATCHERS.include?(matcher)
 
             add_offense(actual.source_range) do |corrector|
               next unless CORRECTABLE_MATCHERS.include?(matcher)
               next if literal?(expected)
 
-              swap(corrector, actual, expected)
+              corrector.replace(actual, expected.source)
+              if matcher == :be
+                corrector.replace(expected, actual.source)
+              else
+                corrector.replace(send_node, "#{matcher}(#{actual.source})")
+              end
             end
           end
         end
@@ -94,11 +99,6 @@ module RuboCop
           COMPLEX_LITERALS.include?(node.type) &&
             node.each_child_node.all?(&method(:literal?))
         end
-
-        def swap(corrector, actual, expected)
-          corrector.replace(actual, expected.source)
-          corrector.replace(expected, actual.source)
-        end
       end
     end
   end

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

@@ -26,7 +26,7 @@ module RuboCop
       # @example with AssignmentOnly configuration
       #   # rubocop.yml
       #   # RSpec/InstanceVariable:
-      #   #   AssignmentOnly: false
+      #   #   AssignmentOnly: true
       #
       #   # bad
       #   describe MyClass do

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

@@ -31,7 +31,7 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: true` (default)
-      #  # good - the cop ignores when RSpec aggregates failures
+      #   # good - the cop ignores when RSpec aggregates failures
       #   describe UserCreator do
       #     it 'builds a user', :aggregate_failures do
       #       expect(user.name).to eq("John")
@@ -40,7 +40,7 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: false`
-      #  # Detected as an offense
+      #   # Detected as an offense
       #   describe UserCreator do
       #     it 'builds a user', aggregate_failures: false do
       #       expect(user.name).to eq("John")

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

@@ -4,39 +4,23 @@ module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Checks that tests use RSpec `before` hook over Rails `setup` method.
-        #
-        # @example
-        #   # bad
-        #   setup do
-        #     allow(foo).to receive(:bar)
-        #   end
-        #
-        #   # good
-        #   before do
-        #     allow(foo).to receive(:bar)
-        #   end
-        #
-        class AvoidSetupHook < Base
-          extend AutoCorrector
-
-          MSG = 'Use `before` instead of `setup`.'
-
-          # @!method setup_call(node)
-          def_node_matcher :setup_call, <<~PATTERN
-            (block
-              $(send nil? :setup)
-              (args) _)
-          PATTERN
-
-          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-            setup_call(node) do |setup|
-              add_offense(node) do |corrector|
-                corrector.replace setup, 'before'
-              end
-            end
-          end
-        end
+        # @!parse
+        #   # Checks that tests use RSpec `before` hook over Rails `setup`
+        #   # method.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   setup do
+        #   #     allow(foo).to receive(:bar)
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   before do
+        #   #     allow(foo).to receive(:bar)
+        #   #   end
+        #   #
+        #   class AvoidSetupHook < RuboCop::Cop::RSpec::Base; end
+        AvoidSetupHook = ::RuboCop::Cop::RSpecRails::AvoidSetupHook
       end
     end
   end

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

@@ -4,75 +4,31 @@ module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Checks that tests use `have_http_status` instead of equality matchers.
-        #
-        # @example ResponseMethods: ['response', 'last_response'] (default)
-        #   # bad
-        #   expect(response.status).to be(200)
-        #   expect(last_response.code).to eq("200")
-        #
-        #   # good
-        #   expect(response).to have_http_status(200)
-        #   expect(last_response).to have_http_status(200)
-        #
-        # @example ResponseMethods: ['foo_response']
-        #   # bad
-        #   expect(foo_response.status).to be(200)
-        #
-        #   # good
-        #   expect(foo_response).to have_http_status(200)
-        #
-        #   # also good
-        #   expect(response).to have_http_status(200)
-        #   expect(last_response).to have_http_status(200)
-        #
-        class HaveHttpStatus < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          MSG =
-            'Prefer `expect(%<response>s).%<to>s ' \
-            'have_http_status(%<status>s)` over `%<bad_code>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_methods?) {:status :code})
-              )
-              $RUNNERS
-              $(send nil? {:be :eq :eql :equal} ({int str} $_))
-            )
-          PATTERN
-
-          def on_send(node) # rubocop:disable Metrics/MethodLength
-            match_status(node) do
-              |response_status, response_method, to, match, status|
-              return unless status.to_s.match?(/\A\d+\z/)
-
-              message = format(MSG, response: response_method.method_name,
-                                    to: to, status: status,
-                                    bad_code: node.source)
-              add_offense(node, message: message) do |corrector|
-                corrector.replace(response_status, response_method.method_name)
-                corrector.replace(match.loc.selector, 'have_http_status')
-                corrector.replace(match.first_argument, status.to_s)
-              end
-            end
-          end
-
-          private
-
-          def response_methods?(name)
-            response_methods.include?(name.to_s)
-          end
-
-          def response_methods
-            cop_config.fetch('ResponseMethods', [])
-          end
-        end
+        # @!parse
+        #   # Checks that tests use `have_http_status` instead of equality matchers.
+        #   #
+        #   # @example ResponseMethods: ['response', 'last_response'] (default)
+        #   #   # bad
+        #   #   expect(response.status).to be(200)
+        #   #   expect(last_response.code).to eq("200")
+        #   #
+        #   #   # good
+        #   #   expect(response).to have_http_status(200)
+        #   #   expect(last_response).to have_http_status(200)
+        #   #
+        #   # @example ResponseMethods: ['foo_response']
+        #   #   # bad
+        #   #   expect(foo_response.status).to be(200)
+        #   #
+        #   #   # good
+        #   #   expect(foo_response).to have_http_status(200)
+        #   #
+        #   #   # also good
+        #   #   expect(response).to have_http_status(200)
+        #   #   expect(last_response).to have_http_status(200)
+        #   #
+        #   class HaveHttpStatus < ::RuboCop::Cop::Base; end
+        HaveHttpStatus = ::RuboCop::Cop::RSpecRails::HaveHttpStatus
       end
     end
   end

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

@@ -1,213 +1,60 @@
 # frozen_string_literal: true
 
-require 'rack/utils'
-
 module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Enforces use of symbolic or numeric value to describe HTTP status.
-        #
-        # This cop inspects only `have_http_status` calls.
-        # So, this cop does not check if a method starting with `be_*` is used
-        # when setting for `EnforcedStyle: symbolic` or
-        # `EnforcedStyle: numeric`.
-        #
-        # @example `EnforcedStyle: symbolic` (default)
-        #   # bad
-        #   it { is_expected.to have_http_status 200 }
-        #   it { is_expected.to have_http_status 404 }
-        #   it { is_expected.to have_http_status "403" }
-        #
-        #   # good
-        #   it { is_expected.to have_http_status :ok }
-        #   it { is_expected.to have_http_status :not_found }
-        #   it { is_expected.to have_http_status :forbidden }
-        #   it { is_expected.to have_http_status :success }
-        #   it { is_expected.to have_http_status :error }
-        #
-        # @example `EnforcedStyle: numeric`
-        #   # bad
-        #   it { is_expected.to have_http_status :ok }
-        #   it { is_expected.to have_http_status :not_found }
-        #   it { is_expected.to have_http_status "forbidden" }
-        #
-        #   # good
-        #   it { is_expected.to have_http_status 200 }
-        #   it { is_expected.to have_http_status 404 }
-        #   it { is_expected.to have_http_status 403 }
-        #   it { is_expected.to have_http_status :success }
-        #   it { is_expected.to have_http_status :error }
-        #
-        # @example `EnforcedStyle: be_status`
-        #   # bad
-        #   it { is_expected.to have_http_status :ok }
-        #   it { is_expected.to have_http_status :not_found }
-        #   it { is_expected.to have_http_status "forbidden" }
-        #   it { is_expected.to have_http_status 200 }
-        #   it { is_expected.to have_http_status 404 }
-        #   it { is_expected.to have_http_status "403" }
-        #
-        #   # good
-        #   it { is_expected.to be_ok }
-        #   it { is_expected.to be_not_found }
-        #   it { is_expected.to have_http_status :success }
-        #   it { is_expected.to have_http_status :error }
-        #
-        class HttpStatus < Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-          RESTRICT_ON_SEND = %i[have_http_status].freeze
-
-          # @!method http_status(node)
-          def_node_matcher :http_status, <<~PATTERN
-            (send nil? :have_http_status ${int sym str})
-          PATTERN
-
-          def on_send(node)
-            http_status(node) do |arg|
-              return if arg.str_type? && arg.heredoc?
-
-              checker = checker_class.new(arg)
-              return unless checker.offensive?
-
-              add_offense(checker.offense_range,
-                          message: checker.message) do |corrector|
-                corrector.replace(checker.offense_range, checker.prefer)
-              end
-            end
-          end
-
-          private
-
-          def checker_class
-            case style
-            when :symbolic
-              SymbolicStyleChecker
-            when :numeric
-              NumericStyleChecker
-            when :be_status
-              BeStatusStyleChecker
-            end
-          end
-
-          # :nodoc:
-          class StyleCheckerBase
-            MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
-                  'to describe HTTP status code.'
-            ALLOWED_STATUSES = %i[error success missing redirect].freeze
-
-            attr_reader :node
-
-            def initialize(node)
-              @node = node
-            end
-
-            def message
-              format(MSG, prefer: prefer, current: current)
-            end
-
-            def current
-              offense_range.source
-            end
-
-            def offense_range
-              node
-            end
-
-            def allowed_symbol?
-              node.sym_type? && ALLOWED_STATUSES.include?(node.value)
-            end
-
-            def custom_http_status_code?
-              node.int_type? &&
-                !::Rack::Utils::SYMBOL_TO_STATUS_CODE.value?(node.source.to_i)
-            end
-          end
-
-          # :nodoc:
-          class SymbolicStyleChecker < StyleCheckerBase
-            def offensive?
-              !node.sym_type? && !custom_http_status_code?
-            end
-
-            def prefer
-              symbol.inspect
-            end
-
-            private
-
-            def symbol
-              ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
-            end
-
-            def number
-              node.value.to_i
-            end
-          end
-
-          # :nodoc:
-          class NumericStyleChecker < StyleCheckerBase
-            def offensive?
-              !node.int_type? && !allowed_symbol?
-            end
-
-            def prefer
-              number.to_s
-            end
-
-            private
-
-            def symbol
-              node.value
-            end
-
-            def number
-              ::Rack::Utils::SYMBOL_TO_STATUS_CODE[symbol.to_sym]
-            end
-          end
-
-          # :nodoc:
-          class BeStatusStyleChecker < StyleCheckerBase
-            def offensive?
-              (!node.sym_type? && !custom_http_status_code?) ||
-                (!node.int_type? && !allowed_symbol?)
-            end
-
-            def offense_range
-              node.parent
-            end
-
-            def prefer
-              if node.sym_type?
-                "be_#{node.value}"
-              elsif node.int_type?
-                "be_#{symbol}"
-              elsif node.str_type?
-                "be_#{normalize_str}"
-              end
-            end
-
-            private
-
-            def symbol
-              ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
-            end
-
-            def number
-              node.value.to_i
-            end
-
-            def normalize_str
-              str = node.value.to_s
-              if str.match?(/\A\d+\z/)
-                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(str.to_i)
-              else
-                str
-              end
-            end
-          end
-        end
+        # @!parse
+        #   # Enforces use of symbolic or numeric value to describe HTTP status.
+        #   #
+        #   # This cop inspects only `have_http_status` calls.
+        #   # So, this cop does not check if a method starting with `be_*` is
+        #   # used when setting for `EnforcedStyle: symbolic` or
+        #   # `EnforcedStyle: numeric`.
+        #   #
+        #   # @example `EnforcedStyle: symbolic` (default)
+        #   #   # bad
+        #   #   it { is_expected.to have_http_status 200 }
+        #   #   it { is_expected.to have_http_status 404 }
+        #   #   it { is_expected.to have_http_status "403" }
+        #   #
+        #   #   # good
+        #   #   it { is_expected.to have_http_status :ok }
+        #   #   it { is_expected.to have_http_status :not_found }
+        #   #   it { is_expected.to have_http_status :forbidden }
+        #   #   it { is_expected.to have_http_status :success }
+        #   #   it { is_expected.to have_http_status :error }
+        #   #
+        #   # @example `EnforcedStyle: numeric`
+        #   #   # bad
+        #   #   it { is_expected.to have_http_status :ok }
+        #   #   it { is_expected.to have_http_status :not_found }
+        #   #   it { is_expected.to have_http_status "forbidden" }
+        #   #
+        #   #   # good
+        #   #   it { is_expected.to have_http_status 200 }
+        #   #   it { is_expected.to have_http_status 404 }
+        #   #   it { is_expected.to have_http_status 403 }
+        #   #   it { is_expected.to have_http_status :success }
+        #   #   it { is_expected.to have_http_status :error }
+        #   #
+        #   # @example `EnforcedStyle: be_status`
+        #   #   # bad
+        #   #   it { is_expected.to have_http_status :ok }
+        #   #   it { is_expected.to have_http_status :not_found }
+        #   #   it { is_expected.to have_http_status "forbidden" }
+        #   #   it { is_expected.to have_http_status 200 }
+        #   #   it { is_expected.to have_http_status 404 }
+        #   #   it { is_expected.to have_http_status "403" }
+        #   #
+        #   #   # good
+        #   #   it { is_expected.to be_ok }
+        #   #   it { is_expected.to be_not_found }
+        #   #   it { is_expected.to have_http_status :success }
+        #   #   it { is_expected.to have_http_status :error }
+        #   #
+        #   class HttpStatus < RuboCop::Cop::RSpec::Base; end
+        HttpStatus = ::RuboCop::Cop::RSpecRails::HttpStatus
       end
     end
   end