rubocop-rspec 2.27.1 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629669f9a1d9d41dae7bc62c630f3a6cdae80623d3213c8e79ac8eb207f79e59
-  data.tar.gz: 5005161c3684fcd8b794284bcaeedc50253a545d649be9e0e0a82958fdd125b0
+  metadata.gz: 3bec4edcf5bcf8c729a8c897b3de5b80b68c08de7ee3b2a25cfa23518db43390
+  data.tar.gz: '0848c7f26310108d511c7986127016963432371d6554c679a8fb318387c05998'
 SHA512:
-  metadata.gz: 8af331d4b31697228397a1122cbe331223d3f040f44d2260e5148d73177df5ba08ae2aea1d481b27f698b5d59c9522d1c5f4c5e08e14b473a548de75ccf218c6
-  data.tar.gz: 0f86ea257bcd14e73c57b2e431f618e0959cf9dbeca6e22c4b75bd8d4945f670d8fdb65212ff12969b351b62c35f845ca28041d4b1b30627e7d64dda5932b365
+  metadata.gz: 72958ac870b50c4b3c5b91be2f18ab88d6b2abf64af255e56451c0a6f58b3fd570dd2a3452e7326af58af57cce9347e370978bd21685f6470bba50ea8d93b195
+  data.tar.gz: 34dc88c068186ac780e2c3e4ebc3048159c236acc4b685fd6630cd59de0910a3f4f181a310d0e2ff7d1b5f9a2609219118119ff23dee212b870b24f685aef195

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master (Unreleased)
 
+## 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/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/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/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::RSpecRails::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::RSpecRails::Base; end
+        HttpStatus = ::RuboCop::Cop::RSpecRails::HttpStatus
       end
     end
   end

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

@@ -4,141 +4,58 @@ module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Identifies redundant spec type.
-        #
-        # After setting up rspec-rails, you will have enabled
-        # `config.infer_spec_type_from_file_location!` by default in
-        # spec/rails_helper.rb. This cop works in conjunction with this config.
-        # If you disable this config, disable this cop as well.
-        #
-        # @safety
-        #   This cop is marked as unsafe because
-        #   `config.infer_spec_type_from_file_location!` may not be enabled.
-        #
-        # @example
-        #   # bad
-        #   # spec/models/user_spec.rb
-        #   RSpec.describe User, type: :model do
-        #   end
-        #
-        #   # good
-        #   # spec/models/user_spec.rb
-        #   RSpec.describe User do
-        #   end
-        #
-        #   # good
-        #   # spec/models/user_spec.rb
-        #   RSpec.describe User, type: :common do
-        #   end
-        #
-        # @example `Inferences` configuration
-        #   # .rubocop.yml
-        #   # RSpec/Rails/InferredSpecType:
-        #   #   Inferences:
-        #   #     services: service
-        #
-        #   # bad
-        #   # spec/services/user_spec.rb
-        #   RSpec.describe User, type: :service do
-        #   end
-        #
-        #   # good
-        #   # spec/services/user_spec.rb
-        #   RSpec.describe User do
-        #   end
-        #
-        #   # good
-        #   # spec/services/user_spec.rb
-        #   RSpec.describe User, type: :common do
-        #   end
-        class InferredSpecType < Base
-          extend AutoCorrector
-
-          MSG = 'Remove redundant spec type.'
-
-          # @param [RuboCop::AST::BlockNode] node
-          def on_block(node)
-            return unless example_group?(node)
-
-            pair_node = describe_with_type(node)
-            return unless pair_node
-            return unless inferred_type?(pair_node)
-
-            removable_node = detect_removable_node(pair_node)
-            add_offense(removable_node) do |corrector|
-              autocorrect(corrector, removable_node)
-            end
-          end
-          alias on_numblock on_block
-
-          private
-
-          # @!method describe_with_type(node)
-          #   @param [RuboCop::AST::BlockNode] node
-          #   @return [RuboCop::AST::PairNode, nil]
-          def_node_matcher :describe_with_type, <<~PATTERN
-            (block
-              (send #rspec? #ExampleGroups.all
-                ...
-                (hash <$(pair (sym :type) sym) ...>)
-              )
-              ...
-            )
-          PATTERN
-
-          # @param [RuboCop::AST::Corrector] corrector
-          # @param [RuboCop::AST::Node] node
-          def autocorrect(corrector, node)
-            corrector.remove(remove_range(node))
-          end
-
-          # @param [RuboCop::AST::Node] node
-          # @return [Parser::Source::Range]
-          def remove_range(node)
-            if node.left_sibling
-              node.source_range.with(
-                begin_pos: node.left_sibling.source_range.end_pos
-              )
-            elsif node.right_sibling
-              node.source_range.with(
-                end_pos: node.right_sibling.source_range.begin_pos
-              )
-            end
-          end
-
-          # @param [RuboCop::AST::PairNode] node
-          # @return [RuboCop::AST::Node]
-          def detect_removable_node(node)
-            if node.parent.pairs.size == 1
-              node.parent
-            else
-              node
-            end
-          end
-
-          # @return [String]
-          def file_path
-            processed_source.file_path
-          end
-
-          # @param [RuboCop::AST::PairNode] node
-          # @return [Boolean]
-          def inferred_type?(node)
-            inferred_type_from_file_path.inspect == node.value.source
-          end
-
-          # @return [Symbol, nil]
-          def inferred_type_from_file_path
-            inferences.find do |prefix, type|
-              break type.to_sym if file_path.include?("spec/#{prefix}/")
-            end
-          end
-
-          # @return [Hash]
-          def inferences
-            cop_config['Inferences'] || {}
-          end
-        end
+        # @!parse
+        #   # Identifies redundant spec type.
+        #   #
+        #   # After setting up rspec-rails, you will have enabled
+        #   # `config.infer_spec_type_from_file_location!` by default in
+        #   # spec/rails_helper.rb. This cop works in conjunction with
+        #   # this config.
+        #   # If you disable this config, disable this cop as well.
+        #   #
+        #   # @safety
+        #   #   This cop is marked as unsafe because
+        #   #   `config.infer_spec_type_from_file_location!` may not be enabled.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   # spec/models/user_spec.rb
+        #   #   RSpec.describe User, type: :model do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   # spec/models/user_spec.rb
+        #   #   RSpec.describe User do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   # spec/models/user_spec.rb
+        #   #   RSpec.describe User, type: :common do
+        #   #   end
+        #   #
+        #   # @example `Inferences` configuration
+        #   #   # .rubocop.yml
+        #   #   # RSpec/Rails/InferredSpecType:
+        #   #   #   Inferences:
+        #   #   #     services: service
+        #   #
+        #   #   # bad
+        #   #   # spec/services/user_spec.rb
+        #   #   RSpec.describe User, type: :service do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   # spec/services/user_spec.rb
+        #   #   RSpec.describe User do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   # spec/services/user_spec.rb
+        #   #   RSpec.describe User, type: :common do
+        #   #   end
+        #   #
+        #   class InferredSpecType < RuboCop::Cop::RSpecRails::Base; end
+        InferredSpecType = ::RuboCop::Cop::RSpecRails::InferredSpecType
       end
     end
   end