rubocop-rspec 2.24.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cd039667fb1c9cab8a794b4d4d028a1acdef5cc9033aa37fd37b8ddc6fa00c0
-  data.tar.gz: c80d4491b4e9d124346195d38f73a3b13d251a4259fa459783d6dbb471ed9925
+  metadata.gz: afb5cf0c88af50530fc023549eb7e9083db3ca2314553f1fca912ea2a3c47bdb
+  data.tar.gz: ba30f926d9cd3056e786f724140ac4358af527496b2e783fcc5c8e541adc9d13
 SHA512:
-  metadata.gz: eccda68a017df50004a38d6e55c6fbabeef13fa20aa37941aec18042adcace438c5cdd6ef821daed30cd17cb2884af79bf2a882f7da875e7190ed437c2e061b9
-  data.tar.gz: '0832c87dd57fba0540c7d624b6bf5e38046b8a9bdc7ee82ee1c1a065a7d4bd6ba3f7949da6a9592d01de3ad8406bd8cc8433d309717cd5993314eaeecac076bb'
+  metadata.gz: cd7955549b3b95b481eb5dea24b98f72e1b802546f8e090695a782a20b0ee8d1d0bcca9a6089f3a46718c5a14967de6c8473709ecea72d8aa5eae85e2cb5bd6f
+  data.tar.gz: 2beb193cf65884c363c2ece1a3a7ba5db39eecc3a579724bd39f29696ab29276def06261363b6a6290d378743e0b79d414e056b65f0a8a9e2e4215a417d9b978

data/CHANGELOG.md

@@ -2,9 +2,19 @@
 
 ## Master (Unreleased)
 
+## 2.25.0 (2023-10-27)
+
+- Add support single quoted string and percent string and heredoc for `RSpec/Rails/HttpStatus`. ([@ydah])
+- Change to be inline disable for `RSpec/SpecFilePathFormat` like `RSpec/FilePath`. ([@ydah])
+- Fix a false positive for `RSpec/MetadataStyle` with example groups having multiple string arguments. ([@franzliedke])
+
+## 2.24.1 (2023-09-23)
+
+- Fix an error when using `RSpec/FilePath` and revert to enabled by default. If you have already moved to `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`, disable `RSpec/FilePath` explicitly as `Enabled: false`. The `RSpec/FilePath` before migration and the `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat` as the target are available respectively. ([@ydah])
+
 ## 2.24.0 (2023-09-08)
 
-- Split `RSpec/FilePath` into `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`. `RSpec/FilePath` cop is enabled by default, the two new cops are pending and need to be enabled explicitly. ([@ydah])
+- Split `RSpec/FilePath` into `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`. `RSpec/FilePath` cop is disabled by default and the two new cops are pending and need to be enabled explicitly. ([@ydah])
 - Add new `RSpec/Eq` cop. ([@ydah])
 - Add `RSpec/MetadataStyle` and `RSpec/EmptyMetadata` cops. ([@r7kamura])
 - Add support `RSpec/Rails/HttpStatus` when `have_http_status` with string argument. ([@ydah])
@@ -19,7 +29,7 @@
 
 ## 2.23.1 (2023-08-07)
 
-- Mark to `Safe: false` for `RSpec/Rails/NegationBeValid`  cop. ([@ydah])
+- Mark to `Safe: false` for `RSpec/Rails/NegationBeValid` cop. ([@ydah])
 - Declare autocorrect as unsafe for `RSpec/ReceiveMessages`. ([@bquorning])
 
 ## 2.23.0 (2023-07-30)
@@ -28,13 +38,13 @@
 - 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])
+- 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])
+- 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])
+- Update `RSpec/Focus` to support `shared_context` and `shared_examples`. ([@tmaier])
 
 ## 2.22.0 (2023-05-06)
 
@@ -56,9 +66,9 @@
 - Add support `be_status` style for `RSpec/Rails/HttpStatus`. ([@ydah])
 - Add support for shared example groups to `RSpec/EmptyLineAfterExampleGroup`. ([@pirj])
 - Add support for `RSpec/HaveHttpStatus` when using `response.code`. ([@ydah])
-- Fix order of expected and actual in correction for `RSpec/Rails/MinitestAssertions` ([@mvz])
+- Fix order of expected and actual in correction for `RSpec/Rails/MinitestAssertions`. ([@mvz])
 - Fix a false positive for `RSpec/DescribedClassModuleWrapping` when RSpec.describe numblock is nested within a module. ([@ydah])
-- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on ([@dmitrytsepelev])
+- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on. ([@dmitrytsepelev])
 - Fix a false positive for `RSpec/PendingWithoutReason` when pending/skip has a reason inside an example group. ([@ydah])
 - Fix a false negative for `RSpec/RedundantAround` when redundant numblock `around`. ([@ydah])
 - Change `RSpec/ContainExactly` to ignore calls with no arguments, and change `RSpec/MatchArray` to ignore calls with an empty array literal argument. ([@ydah], [@bquorning])
@@ -111,7 +121,7 @@
 - Improved processing speed for `RSpec/Be`, `RSpec/ExpectActual`, `RSpec/ImplicitExpect`, `RSpec/MessageSpies`, `RSpec/PredicateMatcher` and `RSpec/Rails/HaveHttpStatus`. ([@ydah])
 - Fix wrong autocorrection in `n_times` style on `RSpec/FactoryBot/CreateList`. ([@r7kamura])
 - Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` when using `generate` with multiple arguments. ([@ydah])
-- Mark `RSpec/BeEq` as `Safe: false` ([@r7kamura])
+- Mark `RSpec/BeEq` as `Safe: false`. ([@r7kamura])
 - Add `RSpec/DuplicatedMetadata` cop. ([@r7kamura])
 - Mark `RSpec/BeEql` as `Safe: false`. ([@r7kamura])
 - Add `RSpec/PendingWithoutReason` cop. ([@r7kamura])
@@ -144,8 +154,8 @@
 - Fix a false positive for `RSpec/Capybara/SpecificMatcher` when `have_css("a")` without attribute. ([@ydah])
 - Update `RSpec/ExampleWording` cop to raise error for insufficient descriptions. ([@akrox58])
 - Add new `RSpec/Capybara/NegationMatcher` cop. ([@ydah])
-- Add `AllowedPatterns` configuration option to `RSpec/NoExpectationExample`.  ([@ydah])
-- Improve `RSpec/NoExpectationExample` cop to ignore examples skipped or pending via metadata.  ([@pirj])
+- Add `AllowedPatterns` configuration option to `RSpec/NoExpectationExample`. ([@ydah])
+- Improve `RSpec/NoExpectationExample` cop to ignore examples skipped or pending via metadata. ([@pirj])
 - Add `RSpec/FactoryBot/ConsistentParenthesesStyle` cop. ([@Liberatys])
 - Add `RSpec/Rails/InferredSpecType` cop. ([@r7kamura])
 - Add new `RSpec/Capybara/SpecificActions` cop. ([@ydah])
@@ -461,7 +471,7 @@
 - Add config to `RSpec/VerifiedDoubles` to enforcement of verification on unnamed doubles. ([@BrentWheeldon])
 - Fix `FactoryBot/AttributeDefinedStatically` not working when there is a non-symbol key. ([@vzvu3k6k])
 - Fix false positive in `RSpec/ImplicitSubject` when `is_expected` is used inside `its()` block. ([@Darhazer])
-- Add `single_statement_only` style to  `RSpec/ImplicitSubject` as a more relaxed alternative to `single_line_only`. ([@Darhazer])
+- Add `single_statement_only` style to `RSpec/ImplicitSubject` as a more relaxed alternative to `single_line_only`. ([@Darhazer])
 - Add `RSpec/UnspecifiedException` as a default cop to encourage more-specific `expect{}.to raise_error(ExceptionType)`, or `raise_exception` style handling of exceptions. ([@daveworth])
 
 ## 1.29.1 (2018-09-01)
@@ -496,14 +506,14 @@
 
 ## 1.26.0 (2018-06-06)
 
-- Fix false positive in `RSpec/EmptyExampleGroup` cop when methods named like a RSpec method are used.  ([@Darhazer])
+- Fix false positive in `RSpec/EmptyExampleGroup` cop when methods named like a RSpec method are used. ([@Darhazer])
 - Fix `Capybara/FeatureMethods` not working when there is require before the spec. ([@Darhazer])
 - Fix `RSpec/EmptyLineAfterFinalLet`: allow a comment to be placed after latest let, requiring empty line after the comment. ([@Darhazer])
 - Add `RSpec/ReceiveCounts` cop to enforce usage of :once and :twice matchers. ([@Darhazer])
 
 ## 1.25.1 (2018-04-10)
 
-- Fix false positive in `RSpec/Pending` cop when pending is used as a method name.  ([@Darhazer])
+- Fix false positive in `RSpec/Pending` cop when pending is used as a method name. ([@Darhazer])
 - Fix `FactoryBot/DynamicAttributeDefinedStatically` false positive when using symbol proc argument for a sequence. ([@tdeo])
 
 ## 1.25.0 (2018-04-07)
@@ -511,7 +521,7 @@
 - Add `RSpec/SharedExamples` cop to enforce consistent usage of string to titleize shared examples. ([@anthony-robin])
 - Add `RSpec/Be` cop to enforce passing argument to the generic `be` matcher. ([@Darhazer])
 - Fix false positives in `StaticAttributeDefinedDynamically` and `ReturnFromStub` when a const is used in an array or hash. ([@Darhazer])
-- Add `RSpec/Pending` cop to enforce no existing pending or skipped examples.  This is disabled by default. ([@patrickomatic])
+- Add `RSpec/Pending` cop to enforce no existing pending or skipped examples. This is disabled by default. ([@patrickomatic])
 - Fix `RSpec/NestedGroups` cop support --auto-gen-config. ([@walf443])
 - Fix false positives in `Capybara/FeatureMethods` when feature methods are used as property names in a factory. ([@Darhazer])
 - Allow configuring enabled methods in `Capybara/FeatureMethods`. ([@Darhazer])
@@ -835,6 +845,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@faucct]: https://github.com/faucct
 [@foton]: https://github.com/foton
 [@francois-ferrandis]: https://github.com/francois-ferrandis
+[@franzliedke]: https://github.com/franzliedke
 [@g-rath]: https://github.com/G-Rath
 [@geniou]: https://github.com/geniou
 [@gsamokovarov]: https://github.com/gsamokovarov

data/config/default.yml

@@ -448,7 +448,7 @@ RSpec/ExpectOutput:
 
 RSpec/FilePath:
   Description: Checks that spec file paths are consistent and well-formed.
-  Enabled: false
+  Enabled: true
   Include:
     - "**/*_spec*rb*"
     - "**/spec/**/*"

data/config/obsoletion.yml

@@ -27,9 +27,3 @@ renamed:
   RSpec/FactoryBot/FactoryClassName: FactoryBot/FactoryClassName
   RSpec/FactoryBot/FactoryNameStyle: FactoryBot/FactoryNameStyle
   RSpec/FactoryBot/SyntaxMethods: FactoryBot/SyntaxMethods
-
-split:
-  RSpec/FilePath:
-    alternatives:
-      - RSpec/SpecFilePathFormat
-      - RSpec/SpecFilePathSuffix

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

@@ -26,11 +26,12 @@ module RuboCop
       #     expect(result).to be(true)
       #   end
       #
-      # You can set literals you want to fold with `CountAsOne`.
-      # Available are: 'array', 'hash', and 'heredoc'. Each literal
-      # will be counted as one line regardless of its actual size.
+      # You can set constructs you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', 'heredoc', and 'method_call'.
+      # Each construct will be counted as one line regardless of
+      # its actual size.
       #
-      # @example CountAsOne: ['array', 'heredoc']
+      # @example CountAsOne: ['array', 'heredoc', 'method_call']
       #
       #   it do
       #     array = [         # +1
@@ -46,7 +47,12 @@ module RuboCop
       #       Heredoc
       #       content.
       #     HEREDOC
-      #   end                 # 5 points
+      #
+      #     foo(            # +1
+      #       1,
+      #       2
+      #     )
+      #   end               # 6 points
       #
       class ExampleLength < Base
         include CodeLength

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

@@ -5,6 +5,12 @@ module RuboCop
     module RSpec
       # Checks that spec file paths are consistent and well-formed.
       #
+      # This cop is deprecated.
+      # We plan to remove it in the next major version update to 3.0.
+      # The migration targets are `RSpec/SpecFilePathSuffix`
+      # and `RSpec/SpecFilePathFormat`.
+      # If you are using this cop, please plan for migration.
+      #
       # By default, this checks that spec file paths are consistent with the
       # test subject and enforces that it reflects the described
       # class/module and its optionally called out method.

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

@@ -45,6 +45,11 @@ module RuboCop
         PATTERN
 
         def on_metadata(symbols, hash)
+          # RSpec example groups accept two string arguments. In such a case,
+          # the rspec_metadata matcher will interpret the second string
+          # argument as a metadata symbol.
+          symbols.shift if symbols.first&.str_type?
+
           symbols.each do |symbol|
             on_metadata_symbol(symbol)
           end

data/lib/rubocop/cop/rspec/mixin/metadata.rb

@@ -30,12 +30,12 @@ module RuboCop
         def on_block(node)
           rspec_configure(node) do |block_var|
             metadata_in_block(node, block_var) do |metadata_arguments|
-              on_matadata_arguments(metadata_arguments)
+              on_metadata_arguments(metadata_arguments)
             end
           end
 
           rspec_metadata(node) do |metadata_arguments|
-            on_matadata_arguments(metadata_arguments)
+            on_metadata_arguments(metadata_arguments)
           end
         end
         alias on_numblock on_block
@@ -46,7 +46,7 @@ module RuboCop
 
         private
 
-        def on_matadata_arguments(metadata_arguments)
+        def on_metadata_arguments(metadata_arguments)
           *symbols, last = metadata_arguments
           hash = nil
           case last&.type

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

@@ -66,6 +66,8 @@ module RuboCop
 
           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?
 
@@ -105,6 +107,10 @@ module RuboCop
               format(MSG, prefer: prefer, current: current)
             end
 
+            def current
+              offense_range.source
+            end
+
             def offense_range
               node
             end
@@ -129,10 +135,6 @@ module RuboCop
               symbol.inspect
             end
 
-            def current
-              node.value.inspect
-            end
-
             private
 
             def symbol
@@ -140,7 +142,7 @@ module RuboCop
             end
 
             def number
-              node.source.delete('"').to_i
+              node.value.to_i
             end
           end
 
@@ -154,10 +156,6 @@ module RuboCop
               number.to_s
             end
 
-            def current
-              symbol.inspect
-            end
-
             private
 
             def symbol
@@ -190,10 +188,6 @@ module RuboCop
               end
             end
 
-            def current
-              offense_range.source
-            end
-
             private
 
             def symbol
@@ -201,15 +195,15 @@ module RuboCop
             end
 
             def number
-              node.source.to_i
+              node.value.to_i
             end
 
             def normalize_str
-              normalized = node.source.delete('"')
-              if normalized.match?(/\A\d+\z/)
-                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(normalized.to_i)
+              str = node.value.to_s
+              if str.match?(/\A\d+\z/)
+                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(str.to_i)
               else
-                normalized
+                str
               end
             end
           end

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

@@ -41,7 +41,7 @@ module RuboCop
 
         # @!method example_group_arguments(node)
         def_node_matcher :example_group_arguments, <<~PATTERN
-          (block (send #rspec? #ExampleGroups.all $_ $...) ...)
+          (block $(send #rspec? #ExampleGroups.all $_ $...) ...)
         PATTERN
 
         # @!method metadata_key_value(node)
@@ -50,16 +50,16 @@ module RuboCop
         def on_top_level_example_group(node)
           return unless top_level_groups.one?
 
-          example_group_arguments(node) do |class_name, arguments|
+          example_group_arguments(node) do |send_node, class_name, arguments|
             next if !class_name.const_type? || ignore_metadata?(arguments)
 
-            ensure_correct_file_path(class_name, arguments)
+            ensure_correct_file_path(send_node, class_name, arguments)
           end
         end
 
         private
 
-        def ensure_correct_file_path(class_name, arguments)
+        def ensure_correct_file_path(send_node, class_name, arguments)
           pattern = correct_path_pattern(class_name, arguments)
           return if filename_ends_with?(pattern)
 
@@ -67,7 +67,7 @@ module RuboCop
           # expression pattern to resemble a glob pattern for clearer error
           # messages.
           suffix = pattern.sub('.*', '*').sub('[^/]*', '*').sub('\.', '.')
-          add_global_offense(format(MSG, suffix: suffix))
+          add_offense(send_node, message: format(MSG, suffix: suffix))
         end
 
         def ignore_metadata?(arguments)

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

@@ -52,7 +52,7 @@ module RuboCop
           return true unless parent
           return true if parent.begin_type?
 
-          true if parent.block_type? && parent.body == expect
+          parent.block_type? && parent.body == expect
         end
       end
     end

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.24.0'
+      STRING = '2.25.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.25.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
 - !ruby/object:Gem::Dependency
   name: rubocop-capybara
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files