rubocop-rspec_rails 2.30.0 → 2.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63cc745325cc4d3036a64bb2978b54cef08693ab2be90cfe0c36bb9a3c6df8cb
-  data.tar.gz: 23bb17ac8270e87d87b7d010e3b76f0b77445b319a4b0b8255b082eed6ca9188
+  metadata.gz: a532f361a0657a600a657dd22a2344028ce648996179c8c4df27ea29302537ac
+  data.tar.gz: f7d10a791b1c5ee7d6a4444ee15eea12622cec6ecfd2174fafe037d37651a6bb
 SHA512:
-  metadata.gz: 2df5e064355ce4bdc2e00d2124d6a85d76006b0dd1f8234a6bbe4e1045c750dd5a6963f040978226c040cce52be31dc6d2eb3950213043103417fd4a371a18b2
-  data.tar.gz: 04371c175f87e01088652c46485b1a41a4e263291bd76eb79adcdae57881691d377984f4e3814be01cdef34f9f3594f554939c8ec728b93792ce1670879f6e17
+  metadata.gz: 976d9b3320ea2923c627597dc7cffb0e0f212ea16430084e60c53345093cebc4dff74e28ee7730900e0955920e2f7fee8f7206c4b583731d9cc58d5c67d67688
+  data.tar.gz: 657c590a5cb85f4f3b97b08f5dfc57409b07392db055ea1f0e2f7a04e78cd6d9920ca21f298c5d9c3120dc971776fb5429213d576cb91e4ae85713da704dc30a

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 2.31.0 (2025-03-10)
+
+- Handle unknown HTTP status codes for `RSpecRails/HttpStatus` cop. ([@viralpraxis])
+- Fix a false negative for `RSpecRails/TravelAround` cop when passed as a proc to a travel method. ([@ydah])
+- Make RuboCop RSpecRails work as a RuboCop plugin. ([@bquorning])
+
 ## 2.30.0 (2024-06-12)
 
 - Fix an runtime error for rubocop-rspec +3.0. ([@bquorning])
@@ -81,4 +87,5 @@
 [@r7kamura]: https://github.com/r7kamura
 [@splattael]: https://github.com/splattael
 [@tmaier]: https://github.com/tmaier
+[@viralpraxis]: https://github.com/viralpraxis
 [@ydah]: https://github.com/ydah

data/README.md

@@ -33,13 +33,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rspec_rails
+plugins: rubocop-rspec_rails
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rspec_rails
 ```
@@ -47,17 +47,20 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec Rails
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-rspec_rails
+rubocop --plugin rubocop-rspec_rails
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec_rails'
+  task.plugins << 'rubocop-rspec_rails'
 end
 ```
 

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

@@ -15,6 +15,7 @@ module RuboCop
       # So, this cop does not check if a method starting with `be_*` is used
       # when setting for `EnforcedStyle: symbolic` or
       # `EnforcedStyle: numeric`.
+      # This cop is also capable of detecting unknown HTTP status codes.
       #
       # @example `EnforcedStyle: symbolic` (default)
       #   # bad
@@ -57,6 +58,12 @@ module RuboCop
       #   it { is_expected.to have_http_status :success }
       #   it { is_expected.to have_http_status :error }
       #
+      # @example
+      #   # bad
+      #   it { is_expected.to have_http_status :oki_doki }
+      #
+      #   # good
+      #   it { is_expected.to have_http_status :ok }
       class HttpStatus < ::RuboCop::Cop::Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
@@ -67,7 +74,7 @@ module RuboCop
           (send nil? :have_http_status ${int sym str})
         PATTERN
 
-        def on_send(node)
+        def on_send(node) # rubocop:disable Metrics/MethodLength
           return unless defined?(::Rack::Utils::SYMBOL_TO_STATUS_CODE)
 
           http_status(node) do |arg|
@@ -78,6 +85,8 @@ module RuboCop
 
             add_offense(checker.offense_range,
                         message: checker.message) do |corrector|
+              next unless checker.autocorrectable?
+
               corrector.replace(checker.offense_range, checker.prefer)
             end
           end
@@ -93,6 +102,10 @@ module RuboCop
             NumericStyleChecker
           when :be_status
             BeStatusStyleChecker
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -100,6 +113,7 @@ module RuboCop
         class StyleCheckerBase
           MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
                 'to describe HTTP status code.'
+          MSG_UNKNOWN_STATUS_CODE = 'Unknown status code.'
           ALLOWED_STATUSES = %i[error success missing redirect].freeze
 
           attr_reader :node
@@ -109,7 +123,11 @@ module RuboCop
           end
 
           def message
-            format(MSG, prefer: prefer, current: current)
+            if autocorrectable?
+              format(MSG, prefer: prefer, current: current)
+            else
+              MSG_UNKNOWN_STATUS_CODE
+            end
           end
 
           def current
@@ -136,6 +154,10 @@ module RuboCop
             !node.sym_type? && !custom_http_status_code?
           end
 
+          def autocorrectable?
+            !!symbol
+          end
+
           def prefer
             symbol.inspect
           end
@@ -157,6 +179,10 @@ module RuboCop
             !node.int_type? && !allowed_symbol?
           end
 
+          def autocorrectable?
+            !!number
+          end
+
           def prefer
             number.to_s
           end
@@ -179,22 +205,30 @@ module RuboCop
               (!node.int_type? && !allowed_symbol?)
           end
 
+          def autocorrectable?
+            !!status_code
+          end
+
           def offense_range
             node.parent
           end
 
           def prefer
+            "be_#{status_code}"
+          end
+
+          private
+
+          def status_code
             if node.sym_type?
-              "be_#{node.value}"
+              node.value
             elsif node.int_type?
-              "be_#{symbol}"
-            elsif node.str_type?
-              "be_#{normalize_str}"
+              symbol
+            else
+              normalize_str
             end
           end
 
-          private
-
           def symbol
             ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
           end
@@ -207,7 +241,7 @@ module RuboCop
             str = node.value.to_s
             if str.match?(/\A\d+\z/)
               ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(str.to_i)
-            else
+            elsif ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key?(str.to_sym)
               str
             end
           end

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

@@ -93,6 +93,7 @@ module RuboCop
 
         # @param [RuboCop::AST::Node] node
         # @return [Parser::Source::Range]
+        # rubocop:disable Metrics/MethodLength
         def remove_range(node)
           if node.left_sibling
             node.source_range.with(
@@ -102,8 +103,13 @@ module RuboCop
             node.source_range.with(
               end_pos: node.right_sibling.source_range.begin_pos
             )
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
+        # rubocop:enable Metrics/MethodLength
 
         # @param [RuboCop::AST::PairNode] node
         # @return [RuboCop::AST::Node]

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

@@ -39,7 +39,9 @@ module RuboCop
           attr_reader :expected, :actual, :failure_message
 
           def self.minitest_assertion
+            # :nocov:
             raise NotImplementedError
+            # :nocov:
           end
 
           def initialize(expected, actual, failure_message)
@@ -62,7 +64,9 @@ module RuboCop
           end
 
           def assertion
+            # :nocov:
             raise NotImplementedError
+            # :nocov:
           end
         end
 

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

@@ -64,6 +64,10 @@ module RuboCop
             be_invalid?(node)
           when :be_invalid
             not_to?(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -81,6 +85,10 @@ module RuboCop
             'not_to'
           when :be_invalid
             'to'
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 
@@ -90,6 +98,10 @@ module RuboCop
             'be_valid'
           when :be_invalid
             'be_invalid'
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
       end

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

@@ -21,8 +21,14 @@ module RuboCop
       #     end
       #   end
       #
+      #   # bad
+      #   around do |example|
+      #     freeze_time(&example)
+      #   end
+      #
       #   # good
       #   before { freeze_time }
+      #
       class TravelAround < ::RuboCop::Cop::Base
         extend AutoCorrector
 
@@ -43,6 +49,13 @@ module RuboCop
           )
         PATTERN
 
+        # @!method extract_travel_with_block_pass(node)
+        def_node_search :extract_travel_with_block_pass, <<~PATTERN
+          $(send _ TRAVEL_METHOD_NAMES
+            (block_pass $lvar)
+          )
+        PATTERN
+
         # @!method match_around_each?(node)
         def_node_matcher :match_around_each?, <<~PATTERN
           (block
@@ -52,29 +65,39 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          run_node = extract_run_in_travel(node)
-          return unless run_node
+          extract_run_in_travel(node) do |run_node|
+            run_in_travel(node, run_node)
+          end
+          extract_travel_with_block_pass(node) do |travel_node, lvar|
+            travel_with_block_pass(travel_node, lvar)
+          end
+        end
+        alias on_numblock on_block
+
+        private
 
+        def run_in_travel(node, run_node)
           around_node = extract_surrounding_around_block(run_node)
           return unless around_node
 
           add_offense(node) do |corrector|
-            autocorrect(corrector, node, run_node, around_node)
+            corrector.replace(node, node.body.source)
+            corrector.insert_before(around_node,
+                                    "before { #{run_node.source} }\n\n")
           end
         end
-        alias on_numblock on_block
 
-        private
+        def travel_with_block_pass(node, lvar)
+          around_node = extract_surrounding_around_block(node)
+          return unless around_node
 
-        def autocorrect(corrector, node, run_node, around_node)
-          corrector.replace(
-            node,
-            node.body.source
-          )
-          corrector.insert_before(
-            around_node,
-            "before { #{run_node.source} }\n\n"
-          )
+          add_offense(node) do |corrector|
+            corrector.replace(node, "#{lvar.name}.run")
+            corrector.insert_before(
+              around_node,
+              "before { #{node.method_name} }\n\n"
+            )
+          end
         end
 
         # @param node [RuboCop::AST::BlockNode]

data/lib/rubocop/rspec_rails/description_extractor.rb

@@ -57,8 +57,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == RSPEC_RAILS_COP_CLASS_NAME ||
-            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
+          [RSPEC_RAILS_COP_CLASS_NAME,
+           RUBOCOP_COP_CLASS_NAME].include?(yardoc.superclass.path)
         end
 
         def abstract?

data/lib/rubocop/rspec_rails/plugin.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RSpecRails
+    # A plugin that integrates RuboCop RSpecRails with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rspec_rails',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rspec_rails',
+          description: 'Code style checking for RSpec Rails files.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/rspec_rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpecRails
     # Version information for the RSpec Rails RuboCop plugin.
     module Version
-      STRING = '2.30.0'
+      STRING = '2.31.0'
     end
   end
 end

data/lib/rubocop-rspec_rails.rb

@@ -6,27 +6,8 @@ require 'yaml'
 require 'rubocop'
 require 'rubocop/rspec/language'
 
+require_relative 'rubocop/rspec_rails/plugin'
 require_relative 'rubocop/rspec_rails/version'
 
 require 'rubocop/cop/rspec/base'
 require_relative 'rubocop/cop/rspec_rails_cops'
-
-project_root = File.join(__dir__, '..')
-RuboCop::ConfigLoader.inject_defaults!(project_root)
-
-# FIXME: This is a workaround for the following issue:
-# https://github.com/rubocop/rubocop-rspec_rails/issues/8
-module RuboCop
-  module Cop
-    class Registry # rubocop:disable Style/Documentation
-      prepend(Module.new do
-        def qualified_cop_name(name, path, warn: true)
-          return super unless name == 'RSpec/Rails/HttpStatus'
-
-          badge = Badge.parse(name)
-          resolve_badge(badge, qualify_badge(badge).first, path)
-        end
-      end)
-    end
-  end
-end

metadata

@@ -1,56 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec_rails
 version: !ruby/object:Gem::Version
-  version: 2.30.0
+  version: 2.31.0
 platform: ruby
 authors:
 - Benjamin Quorning
 - Phil Pirozhkov
 - Maxim Krizhanovsky
 - Yudai Takada
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.61'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.72'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.72'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 1.72.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: |
   Code style checking for RSpec Rails files.
   A plugin for the RuboCop code style enforcing & linting tool.
-email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -74,6 +86,7 @@ files:
 - lib/rubocop/rspec_rails/config_formatter.rb
 - lib/rubocop/rspec_rails/cop/generator.rb
 - lib/rubocop/rspec_rails/description_extractor.rb
+- lib/rubocop/rspec_rails/plugin.rb
 - lib/rubocop/rspec_rails/version.rb
 homepage: https://github.com/rubocop/rubocop-rspec_rails
 licenses:
@@ -82,7 +95,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec_rails/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec_rails/
   rubygems_mfa_required: 'true'
-post_install_message: 
+  default_lint_roller_plugin: RuboCop::RSpecRails::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Code style checking for RSpec Rails files
 test_files: []