rubocop-rspec_rails 2.28.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53524a3483350f80d17572e3e221a777dabb1421999fbbcb37ad30cb182358b1
+  data.tar.gz: af8ff0697f66b78c197fc34e8dbd207e75a64473075ccb1b65d00650582d80d5
+SHA512:
+  metadata.gz: 6b42314769301898bd8723c2c8d5e29eee29cb1952b70e3e4abb892f75e8a13c2129933a3a99de8247510030f208925ab70c5a0a1f1ebaf950595a5c7d540152
+  data.tar.gz: 9ad058ef82208bb685249e7ed847da8fc4b06b6718033d9153adc6544d28845e91454524531a72f67f25497325876ed140d543e7173b839f72d12044ef37c429

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+## Master (Unreleased)
+
+## 2.28.0 (2024-03-28)
+
+- Extracted from `rubocop-rspec` into a separate repository. ([@ydah])
+
+## Previously (see [rubocop-rspec's changelist](https://github.com/rubocop/rubocop-rspec/blob/v2.27.1/CHANGELOG.md) for details)
+
+- Add support for `assert_true`, `assert_false`, `assert_not_equal`, `assert_not_nil`, `*_empty`, `*_predicate`, `*_kind_of`, `*_in_delta`, `*_match`, `*_instance_of` and `*_includes` assertions in `RSpec/Rails/MinitestAssertions`. ([@ydah], [@G-Rath])
+- Add configuration option `ResponseMethods` to `RSpec/Rails/HaveHttpStatus`. ([@ydah])
+- Add support single quoted string and percent string and heredoc for `RSpec/Rails/HttpStatus`. ([@ydah])
+- Add support `RSpec/Rails/HttpStatus` when `have_http_status` with string argument. ([@ydah])
+- Mark to `Safe: false` for `RSpec/Rails/NegationBeValid` cop. ([@ydah])
+- Add new `RSpec/Rails/NegationBeValid` cop. ([@ydah])
+- Fix a false negative for `RSpec/ExcessiveDocstringSpacing` when finds description with em space. ([@ydah])
+- Fix a false positive for `RSpec/EmptyExampleGroup` when example group with examples defined in `if` branch inside iterator. ([@ydah])
+- Update the message output of `RSpec/ExpectActual` to include the word 'value'. ([@corydiamand])
+- Fix a false negative for `RSpec/Pending` when `it` without body. ([@ydah])
+- Add new `RSpec/ReceiveMessages` cop. ([@ydah])
+- Change default.yml path to use `**/spec/*` instead of `spec/*`. ([@ydah])
+- Add `AllowedIdentifiers` and `AllowedPatterns` configuration option to `RSpec/IndexedLet`. ([@ydah])
+- Fix `RSpec/NamedSubject` when block has no body. ([@splattael])
+- Fix `RSpec/LetBeforeExamples` autocorrect incompatible with `RSpec/ScatteredLet` autocorrect. ([@ydah])
+- Update `RSpec/Focus` to support `shared_context` and `shared_examples`. ([@tmaier])
+- Fix an error for `RSpec/Rails/HaveHttpStatus` with comparison with strings containing non-numeric characters. ([@ydah])
+- Add support `be_status` style for `RSpec/Rails/HttpStatus`. ([@ydah])
+- Fix order of expected and actual in correction for `RSpec/Rails/MinitestAssertions`. ([@mvz])
+- Add `RSpec/Rails/TravelAround` cop. ([@r7kamura])
+- Add new `RSpec/Rails/MinitestAssertions` cop. ([@ydah])
+- Improved processing speed for `RSpec/Be`, `RSpec/ExpectActual`, `RSpec/ImplicitExpect`, `RSpec/MessageSpies`, `RSpec/PredicateMatcher` and `RSpec/Rails/HaveHttpStatus`. ([@ydah])
+- Fix an error for `RSpec/Rails/InferredSpecType` with redundant type before other Hash metadata. ([@ydah])
+- Add `RSpec/Rails/InferredSpecType` cop. ([@r7kamura])
+- Add new `RSpec/Rails/HaveHttpStatus` cop. ([@akiomik])
+- Exclude unrelated Rails directories from `RSpec/DescribeClass`. ([@MothOnMars])
+- Add `RSpec/Rails/AvoidSetupHook` cop. ([@paydaylight])
+- Change namespace of several cops (`Capybara/*` -> `RSpec/Capybara/*`, `FactoryBot/*` -> `RSpec/FactoryBot/*`, `Rails/*` -> `RSpec/Rails/*`). ([@pirj], [@bquorning])
+- The `Rails/HttpStatus` cop is unavailable if the `rack` gem cannot be loaded. ([@bquorning])
+- Fix `Rails/HttpStatus` not working with custom HTTP status codes. ([@bquorning])
+- Add `RSpec/Rails/HttpStatus` cop to enforce consistent usage of the status format (numeric or symbolic). ([@anthony-robin], [@jojos003])
+
+<!-- Contributors (alphabetically) -->
+
+[@akiomik]: https://github.com/akiomik
+[@anthony-robin]: https://github.com/anthony-robin
+[@bquorning]: https://github.com/bquorning
+[@corydiamand]: https://github.com/corydiamand
+[@g-rath]: https://github.com/G-Rath
+[@jojos003]: https://github.com/jojos003
+[@mothonmars]: https://github.com/MothOnMars
+[@mvz]: https://github.com/mvz
+[@paydaylight]: https://github.com/paydaylight
+[@pirj]: https://github.com/pirj
+[@r7kamura]: https://github.com/r7kamura
+[@splattael]: https://github.com/splattael
+[@tmaier]: https://github.com/tmaier
+[@ydah]: https://github.com/ydah

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# The RuboCop Community Code of Conduct
+
+**Note:** We have picked the following code of conduct based on [Ruby's own
+code of conduct](https://www.ruby-lang.org/en/conduct/).
+
+This document provides a few simple community guidelines for a safe, respectful,
+productive, and collaborative place for any person who is willing to contribute
+to the RuboCop community. It applies to all "collaborative spaces", which are
+defined as community communications channels (such as mailing lists, submitted
+patches, commit comments, etc.).
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal
+  attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always
+  assume good intentions.
+- Behaviour which can be reasonably considered harassment will not be tolerated.

data/MIT-LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2014 Ian MacLeod <ian@nevir.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# RuboCop RSpec Rails
+
+[![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
+[![Gem Version](https://badge.fury.io/rb/rubocop-rspec_rails.svg)](https://rubygems.org/gems/rubocop-rspec_rails)
+![CI](https://github.com/rubocop/rubocop-rspec_rails/workflows/CI/badge.svg)
+
+[RSpec Rails](https://rspec.info/)-specific analysis for your projects, as an extension to
+[RuboCop](https://github.com/rubocop/rubocop).
+
+## Installation
+
+Just install the `rubocop-rspec_rails` gem
+
+```bash
+gem install rubocop-rspec_rails
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-rspec_rails', require: false
+```
+
+## Usage
+
+You need to tell RuboCop to load the RSpec Rails extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-rspec_rails
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-rspec
+  - rubocop-rspec_rails
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop RSpec Rails
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-rspec_rails
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec_rails'
+end
+```
+
+## Documentation
+
+You can read more about RuboCop RSpec Rails in its [official manual](https://docs.rubocop.org/rubocop-rspec_rails).
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/rspec_rails`](lib/rubocop/cop/rspec_rails), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the RSpec Rails cops just like any other
+cop. For example:
+
+```yaml
+RSpecRails/AvoidSetupHook:
+  Exclude:
+    - spec/my_poorly_named_spec_file.rb
+```
+
+## Contributing
+
+Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
+
+## License
+
+`rubocop-rspec_rails` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.

data/config/default.yml

@@ -0,0 +1,83 @@
+---
+RSpecRails:
+  Enabled: true
+  DocumentationBaseURL: https://docs.rubocop.org/rubocop-rspec_rails
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+
+RSpecRails/AvoidSetupHook:
+  Description: Checks that tests use RSpec `before` hook over Rails `setup` method.
+  Enabled: pending
+  VersionAdded: '2.4'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/AvoidSetupHook
+
+RSpecRails/HaveHttpStatus:
+  Description: Checks that tests use `have_http_status` instead of equality matchers.
+  Enabled: pending
+  ResponseMethods:
+    - response
+    - last_response
+  SafeAutoCorrect: false
+  VersionAdded: '2.12'
+  VersionChanged: '2.27'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/HaveHttpStatus
+
+RSpecRails/HttpStatus:
+  Description: Enforces use of symbolic or numeric value to describe HTTP status.
+  Enabled: true
+  EnforcedStyle: symbolic
+  SupportedStyles:
+    - numeric
+    - symbolic
+    - be_status
+  VersionAdded: '1.23'
+  VersionChanged: '2.20'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/HttpStatus
+
+RSpecRails/InferredSpecType:
+  Description: Identifies redundant spec type.
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.14'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/InferredSpecType
+  Inferences:
+    channels: channel
+    controllers: controller
+    features: feature
+    generator: generator
+    helpers: helper
+    jobs: job
+    mailboxes: mailbox
+    mailers: mailer
+    models: model
+    requests: request
+    integration: request
+    api: request
+    routing: routing
+    system: system
+    views: view
+
+RSpecRails/MinitestAssertions:
+  Description: Check if using Minitest-like matchers.
+  Enabled: pending
+  VersionAdded: '2.17'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/MinitestAssertions
+
+RSpecRails/NegationBeValid:
+  Description: Enforces use of `be_invalid` or `not_to` for negated be_valid.
+  Safe: false
+  EnforcedStyle: not_to
+  SupportedStyles:
+    - not_to
+    - be_invalid
+  Enabled: pending
+  VersionAdded: '2.23'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/NegationBeValid
+
+RSpecRails/TravelAround:
+  Description: Prefer to travel in `before` rather than `around`.
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.19'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec_rails/RuboCop/Cop/RSpecRails/TravelAround

data/lib/rubocop/cop/rspec_rails/avoid_setup_hook.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpecRails
+      # 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
+        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
+    end
+  end
+end

data/lib/rubocop/cop/rspec_rails/have_http_status.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpecRails
+      # 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
+    end
+  end
+end

data/lib/rubocop/cop/rspec_rails/http_status.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require 'rack/utils'
+
+module RuboCop
+  module Cop
+    module RSpecRails
+      # 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
+        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
+    end
+  end
+end