rubocop-rspec 2.21.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a388b40471f85e4da35358c9c9c0ab8bdce272c171b989553a174ea5f2fa04f
-  data.tar.gz: 251c7b2c7f83daeb4f3e3f4e10f1b0f37763088ac792982e27052da26c1645ea
+  metadata.gz: e0eebbfb772c1598b0ee4cfe88c74d8b81171e197dbd4d5dc6020df95005440e
+  data.tar.gz: 2936be502e0062b94a0346bd98696194fd33fe6f7693f8c92bc38a952ee31b26
 SHA512:
-  metadata.gz: 6311a48d125da92639f8bebbeebdd9b16e7968bf2b522d29310c913490977a465aa77112e39497880373be23732a2fb3cfa205b92475e2edd069c1009ae91aac
-  data.tar.gz: fd3d495d5ec63969e2d926c5c151cf888de321b74486644983c6aa72b3c18b071daafe19b0996a0fa476334d00bf05768c09ae4ce03d39bbdf436898b64809c0
+  metadata.gz: 14e3e53093b7e104ab212217fdc8226a909fba9bdd84fa44c22963cf8e62d17ce858a2180b8b5b3727b5dd2a74a9b4c6e2139d8d61cbc6595b2c46f9022214af
+  data.tar.gz: 9408c50d35ae50e1825fef43f2c6a6def0d87e44bfbbd968bb19996b1a867f215df36ab62d451af892e6855c4330c0d4fb9d09b8400ff5f35b4ecef1cfb86adb

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Master (Unreleased)
 
+## 2.23.0 (2023-07-30)
+
+- 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])
+
+## 2.22.0 (2023-05-06)
+
+- Extract factory_bot cops to a separate repository, [`rubocop-factory_bot`](https://github.com/rubocop/rubocop-factory_bot). The `rubocop-factory_bot` repository is a dependency of `rubocop-rspec` and the factory_bot cops are aliased (`RSpec/FactoryBot/Foo` == `FactoryBot/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@ydah])
+
 ## 2.21.0 (2023-05-05)
 
 - Fix a false positive in `RSpec/IndexedLet` with suffixes after index-like numbers. ([@pirj])
@@ -777,6 +795,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@cfabianski]: https://github.com/cfabianski
 [@clupprich]: https://github.com/clupprich
 [@composerinteralia]: https://github.com/composerinteralia
+[@corydiamand]: https://github.com/corydiamand
 [@darhazer]: https://github.com/Darhazer
 [@daveworth]: https://github.com/daveworth
 [@dduugg]: https://github.com/dduugg
@@ -855,6 +874,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@seanpdoyle]: https://github.com/seanpdoyle
 [@sl4vr]: https://github.com/sl4vr
 [@smcgivern]: https://github.com/smcgivern
+[@splattael]: https://github.com/splattael
 [@stephannv]: https://github.com/stephannv
 [@t3h2mas]: https://github.com/t3h2mas
 [@tdeo]: https://github.com/tdeo
@@ -862,6 +882,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@telmofcosta]: https://github.com/telmofcosta
 [@tietew]: https://github.com/Tietew
 [@timrogers]: https://github.com/timrogers
+[@tmaier]: https://github.com/tmaier
 [@topalovic]: https://github.com/topalovic
 [@twalpole]: https://github.com/twalpole
 [@vzvu3k6k]: https://github.com/vzvu3k6k

data/README.md

@@ -17,7 +17,7 @@ gem install rubocop-rspec
 
 or if you use bundler put this in your `Gemfile`
 
-```
+```ruby
 gem 'rubocop-rspec', require: false
 ```
 

data/config/default.yml

@@ -181,10 +181,11 @@ RSpec/BeforeAfterAll:
   Description: Check that before/after(:all) isn't being used.
   Enabled: true
   Exclude:
-    - spec/spec_helper.rb
-    - spec/rails_helper.rb
-    - spec/support/**/*.rb
+    - "**/spec/spec_helper.rb"
+    - "**/spec/rails_helper.rb"
+    - "**/spec/support/**/*.rb"
   VersionAdded: '1.12'
+  VersionChanged: '2.23'
   StyleGuide: https://rspec.rubystyle.guide/#avoid-hooks-with-context-scope
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeforeAfterAll
 
@@ -404,8 +405,9 @@ RSpec/ExpectActual:
   Description: Checks for `expect(...)` calls containing literal values.
   Enabled: true
   Exclude:
-    - spec/routing/**/*
+    - "**/spec/routing/**/*"
   VersionAdded: '1.7'
+  VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectActual
 
 RSpec/ExpectChange:
@@ -513,8 +515,11 @@ RSpec/IndexedLet:
   Description: Do not set up test data using indexes (e.g., `item_1`, `item_2`).
   Enabled: pending
   VersionAdded: '2.20'
+  VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IndexedLet
   Max: 1
+  AllowedIdentifiers: []
+  AllowedPatterns: []
 
 RSpec/InstanceSpy:
   Description: Checks for `instance_double` used with `have_received`.
@@ -725,6 +730,12 @@ RSpec/ReceiveCounts:
   VersionAdded: '1.26'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReceiveCounts
 
+RSpec/ReceiveMessages:
+  Description: Checks for multiple messages stubbed on the same object.
+  Enabled: pending
+  VersionAdded: '2.23'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReceiveMessages
+
 RSpec/ReceiveNever:
   Description: Prefer `not_to receive(...)` over `receive(...).never`.
   Enabled: true
@@ -974,11 +985,11 @@ RSpec/FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: true
   Include:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
+    - "**/spec/factories.rb"
+    - "**/spec/factories/**/*.rb"
+    - "**/features/support/factories/**/*.rb"
   VersionAdded: '1.28'
-  VersionChanged: '2.0'
+  VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/AttributeDefinedStatically
 
 RSpec/FactoryBot/ConsistentParenthesesStyle:
@@ -997,26 +1008,26 @@ RSpec/FactoryBot/CreateList:
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
+    - "**/spec/factories.rb"
+    - "**/spec/factories/**/*.rb"
+    - "**/features/support/factories/**/*.rb"
   EnforcedStyle: create_list
   SupportedStyles:
     - create_list
     - n_times
   VersionAdded: '1.25'
-  VersionChanged: '2.0'
+  VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/CreateList
 
 RSpec/FactoryBot/FactoryClassName:
   Description: Use string value when setting the class attribute explicitly.
   Enabled: true
   Include:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
+    - "**/spec/factories.rb"
+    - "**/spec/factories/**/*.rb"
+    - "**/features/support/factories/**/*.rb"
   VersionAdded: '1.37'
-  VersionChanged: '2.0'
+  VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName
 
 RSpec/FactoryBot/FactoryNameStyle:
@@ -1095,6 +1106,16 @@ RSpec/Rails/MinitestAssertions:
   VersionAdded: '2.17'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/MinitestAssertions
 
+RSpec/Rails/NegationBeValid:
+  Description: Enforces use of `be_invalid` or `not_to` for negated be_valid.
+  EnforcedStyle: not_to
+  SupportedStyles:
+    - not_to
+    - be_invalid
+  Enabled: pending
+  VersionAdded: '2.23'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/NegationBeValid
+
 RSpec/Rails/TravelAround:
   Description: Prefer to travel in `before` rather than `around`.
   Enabled: pending

data/config/obsoletion.yml

@@ -21,3 +21,9 @@ renamed:
   RSpec/Capybara/SpecificFinders: Capybara/SpecificFinders
   RSpec/Capybara/SpecificMatcher: Capybara/SpecificMatcher
   RSpec/Capybara/VisibilityMatcher: Capybara/VisibilityMatcher
+  RSpec/FactoryBot/AttributeDefinedStatically: FactoryBot/AttributeDefinedStatically
+  RSpec/FactoryBot/ConsistentParenthesesStyle: FactoryBot/ConsistentParenthesesStyle
+  RSpec/FactoryBot/CreateList: FactoryBot/CreateList
+  RSpec/FactoryBot/FactoryClassName: FactoryBot/FactoryClassName
+  RSpec/FactoryBot/FactoryNameStyle: FactoryBot/FactoryNameStyle
+  RSpec/FactoryBot/SyntaxMethods: FactoryBot/SyntaxMethods

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

@@ -131,6 +131,7 @@ module RuboCop
           {
             #examples_directly_or_in_block?
             (begin <#examples_directly_or_in_block? ...>)
+            (begin <#examples_in_branches? ...>)
           }
         PATTERN
 
@@ -169,6 +170,8 @@ module RuboCop
         end
 
         def examples_in_branches?(condition_node)
+          return if !condition_node.if_type? && !condition_node.case_type?
+
           condition_node.branches.any? { |branch| examples?(branch) }
         end
 

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

@@ -52,14 +52,21 @@ module RuboCop
 
         # @param text [String]
         def excessive_whitespace?(text)
-          return true if text.start_with?(' ') || text.end_with?(' ')
-
-          text.match?(/[^\n ]  +[^ ]/)
+          text.match?(/
+            # Leading space
+            \A[[:blank:]]
+            |
+            # Trailing space
+            [[:blank:]]\z
+            |
+            # Two or more consecutive spaces, except if they are leading spaces
+            [^[[:space:]]][[:blank:]]{2,}[^[[:blank:]]]
+          /x)
         end
 
         # @param text [String]
         def strip_excessive_whitespace(text)
-          text.strip.gsub(/  +/, ' ')
+          text.strip.gsub(/[[:blank:]]{2,}/, ' ')
         end
 
         # @param node [RuboCop::AST::Node]

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

@@ -24,7 +24,7 @@ module RuboCop
       class ExpectActual < Base
         extend AutoCorrector
 
-        MSG = 'Provide the actual you are testing to `expect(...)`.'
+        MSG = 'Provide the actual value you are testing to `expect(...)`.'
 
         RESTRICT_ON_SEND = Runners.all
 
@@ -77,7 +77,7 @@ module RuboCop
 
         private
 
-        # This is not implement using a NodePattern because it seems
+        # This is not implemented using a NodePattern because it seems
         # to not be able to match against an explicit (nil) sexp
         def literal?(node)
           node && (simple_literal?(node) || complex_literal?(node))

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -4,124 +4,31 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Always declare attribute values as blocks.
-        #
-        # @example
-        #   # bad
-        #   kind [:active, :rejected].sample
-        #
-        #   # good
-        #   kind { [:active, :rejected].sample }
-        #
-        #   # bad
-        #   closed_at 1.day.from_now
-        #
-        #   # good
-        #   closed_at { 1.day.from_now }
-        #
-        #   # bad
-        #   count 1
-        #
-        #   # good
-        #   count { 1 }
-        #
-        class AttributeDefinedStatically < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          MSG = 'Use a block to declare attribute values.'
-
-          # @!method value_matcher(node)
-          def_node_matcher :value_matcher, <<-PATTERN
-            (send _ !#reserved_method? $...)
-          PATTERN
-
-          # @!method factory_attributes(node)
-          def_node_matcher :factory_attributes, <<-PATTERN
-            (block (send _ #attribute_defining_method? ...) _ { (begin $...) $(send ...) } )
-          PATTERN
-
-          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-            attributes = factory_attributes(node) || []
-            attributes = [attributes] unless attributes.is_a?(Array) # rubocop:disable Style/ArrayCoercion, Lint/RedundantCopDisableDirective
-
-            attributes.each do |attribute|
-              next unless offensive_receiver?(attribute.receiver, node)
-              next if proc?(attribute) || association?(attribute.first_argument)
-
-              add_offense(attribute) do |corrector|
-                autocorrect(corrector, attribute)
-              end
-            end
-          end
-
-          private
-
-          def autocorrect(corrector, node)
-            if node.parenthesized?
-              autocorrect_replacing_parens(corrector, node)
-            else
-              autocorrect_without_parens(corrector, node)
-            end
-          end
-
-          def offensive_receiver?(receiver, node)
-            receiver.nil? ||
-              receiver.self_type? ||
-              receiver_matches_first_block_argument?(receiver, node)
-          end
-
-          def receiver_matches_first_block_argument?(receiver, node)
-            first_block_argument = node.arguments.first
-
-            !first_block_argument.nil? &&
-              receiver.lvar_type? &&
-              receiver.node_parts == first_block_argument.node_parts
-          end
-
-          def proc?(attribute)
-            value_matcher(attribute).to_a.all?(&:block_pass_type?)
-          end
-
-          # @!method association?(node)
-          def_node_matcher :association?, '(hash <(pair (sym :factory) _) ...>)'
-
-          def autocorrect_replacing_parens(corrector, node)
-            left_braces, right_braces = braces(node)
-
-            corrector.replace(node.location.begin, " #{left_braces}")
-            corrector.replace(node.location.end, right_braces)
-          end
-
-          def autocorrect_without_parens(corrector, node)
-            left_braces, right_braces = braces(node)
-
-            argument = node.first_argument
-            expression = argument.source_range
-            corrector.insert_before(expression, left_braces)
-            corrector.insert_after(expression, right_braces)
-          end
-
-          def braces(node)
-            if value_hash_without_braces?(node.first_argument)
-              ['{ { ', ' } }']
-            else
-              ['{ ', ' }']
-            end
-          end
-
-          def value_hash_without_braces?(node)
-            node.hash_type? && !node.braces?
-          end
-
-          def reserved_method?(method_name)
-            RuboCop::RSpec::FactoryBot.reserved_methods.include?(method_name)
-          end
-
-          def attribute_defining_method?(method_name)
-            RuboCop::RSpec::FactoryBot.attribute_defining_methods
-              .include?(method_name)
-          end
-        end
+        # @!parse
+        #   # Always declare attribute values as blocks.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   kind [:active, :rejected].sample
+        #   #
+        #   #   # good
+        #   #   kind { [:active, :rejected].sample }
+        #   #
+        #   #   # bad
+        #   #   closed_at 1.day.from_now
+        #   #
+        #   #   # good
+        #   #   closed_at { 1.day.from_now }
+        #   #
+        #   #   # bad
+        #   #   count 1
+        #   #
+        #   #   # good
+        #   #   count { 1 }
+        #   #
+        #   class AttributeDefinedStatically < ::RuboCop::Cop::Base; end
+        AttributeDefinedStatically =
+          ::RuboCop::Cop::FactoryBot::AttributeDefinedStatically
       end
     end
   end

data/lib/rubocop/cop/rspec/factory_bot/consistent_parentheses_style.rb

@@ -4,113 +4,46 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Use a consistent style for parentheses in factory bot calls.
-        #
-        # @example
-        #
-        #   # bad
-        #   create :user
-        #   build(:user)
-        #   create(:login)
-        #   create :login
-        #
-        # @example `EnforcedStyle: require_parentheses` (default)
-        #
-        #   # good
-        #   create(:user)
-        #   create(:user)
-        #   create(:login)
-        #   build(:login)
-        #
-        # @example `EnforcedStyle: omit_parentheses`
-        #
-        #   # good
-        #   create :user
-        #   build :user
-        #   create :login
-        #   create :login
-        #
-        #   # also good
-        #   # when method name and first argument are not on same line
-        #   create(
-        #     :user
-        #   )
-        #   build(
-        #     :user,
-        #     name: 'foo'
-        #   )
-        #
-        class ConsistentParenthesesStyle < ::RuboCop::Cop::Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-          include RuboCop::RSpec::FactoryBot::Language
-          include RuboCop::Cop::Util
-
-          def self.autocorrect_incompatible_with
-            [Style::MethodCallWithArgsParentheses]
-          end
-
-          MSG_REQUIRE_PARENS = 'Prefer method call with parentheses'
-          MSG_OMIT_PARENS = 'Prefer method call without parentheses'
-
-          FACTORY_CALLS = RuboCop::RSpec::FactoryBot::Language::METHODS
-
-          RESTRICT_ON_SEND = FACTORY_CALLS
-
-          # @!method factory_call(node)
-          def_node_matcher :factory_call, <<-PATTERN
-            (send
-              {#factory_bot? nil?} %FACTORY_CALLS
-              {sym str send lvar} _*
-            )
-          PATTERN
-
-          def on_send(node)
-            return if ambiguous_without_parentheses?(node)
-
-            factory_call(node) do
-              return if node.method?(:generate) && node.arguments.count > 1
-
-              if node.parenthesized?
-                process_with_parentheses(node)
-              else
-                process_without_parentheses(node)
-              end
-            end
-          end
-
-          private
-
-          def process_with_parentheses(node)
-            return unless style == :omit_parentheses
-            return unless same_line?(node, node.first_argument)
-
-            add_offense(node.loc.selector,
-                        message: MSG_OMIT_PARENS) do |corrector|
-              remove_parentheses(corrector, node)
-            end
-          end
-
-          def process_without_parentheses(node)
-            return unless style == :require_parentheses
-
-            add_offense(node.loc.selector,
-                        message: MSG_REQUIRE_PARENS) do |corrector|
-              add_parentheses(node, corrector)
-            end
-          end
-
-          AMBIGUOUS_TYPES = %i[send pair array and or if].freeze
-
-          def ambiguous_without_parentheses?(node)
-            node.parent && AMBIGUOUS_TYPES.include?(node.parent.type)
-          end
-
-          def remove_parentheses(corrector, node)
-            corrector.replace(node.location.begin, ' ')
-            corrector.remove(node.location.end)
-          end
-        end
+        # @!parse
+        #   # Use a consistent style for parentheses in factory bot calls.
+        #   #
+        #   # @example
+        #   #
+        #   #   # bad
+        #   #   create :user
+        #   #   build(:user)
+        #   #   create(:login)
+        #   #   create :login
+        #   #
+        #   # @example `EnforcedStyle: require_parentheses` (default)
+        #   #
+        #   #   # good
+        #   #   create(:user)
+        #   #   create(:user)
+        #   #   create(:login)
+        #   #   build(:login)
+        #   #
+        #   # @example `EnforcedStyle: omit_parentheses`
+        #   #
+        #   #   # good
+        #   #   create :user
+        #   #   build :user
+        #   #   create :login
+        #   #   create :login
+        #   #
+        #   #   # also good
+        #   #   # when method name and first argument are not on same line
+        #   #   create(
+        #   #     :user
+        #   #   )
+        #   #   build(
+        #   #     :user,
+        #   #     name: 'foo'
+        #   #   )
+        #   #
+        #   class ConsistentParenthesesStyle < ::RuboCop::Cop::Base; end
+        ConsistentParenthesesStyle =
+          ::RuboCop::Cop::FactoryBot::ConsistentParenthesesStyle
       end
     end
   end