rubocop-rspec 2.27.1 → 2.29.0

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

@@ -4,98 +4,35 @@ module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Enforces use of `be_invalid` or `not_to` for negated be_valid.
-        #
-        # @safety
-        #   This cop is unsafe because it cannot guarantee that
-        #   the test target is an instance of `ActiveModel::Validations``.
-        #
-        # @example EnforcedStyle: not_to (default)
-        #   # bad
-        #   expect(foo).to be_invalid
-        #
-        #   # good
-        #   expect(foo).not_to be_valid
-        #
-        #   # good (with method chain)
-        #   expect(foo).to be_invalid.and be_odd
-        #
-        # @example EnforcedStyle: be_invalid
-        #   # bad
-        #   expect(foo).not_to be_valid
-        #
-        #   # good
-        #   expect(foo).to be_invalid
-        #
-        #   # good (with method chain)
-        #   expect(foo).to be_invalid.or be_even
-        #
-        class NegationBeValid < Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-
-          MSG = 'Use `expect(...).%<runner>s %<matcher>s`.'
-          RESTRICT_ON_SEND = %i[be_valid be_invalid].freeze
-
-          # @!method not_to?(node)
-          def_node_matcher :not_to?, <<~PATTERN
-            (send ... :not_to (send nil? :be_valid ...))
-          PATTERN
-
-          # @!method be_invalid?(node)
-          def_node_matcher :be_invalid?, <<~PATTERN
-            (send ... :to (send nil? :be_invalid ...))
-          PATTERN
-
-          def on_send(node)
-            return unless offense?(node.parent)
-
-            add_offense(offense_range(node),
-                        message: message(node.method_name)) do |corrector|
-              corrector.replace(node.parent.loc.selector, replaced_runner)
-              corrector.replace(node.loc.selector, replaced_matcher)
-            end
-          end
-
-          private
-
-          def offense?(node)
-            case style
-            when :not_to
-              be_invalid?(node)
-            when :be_invalid
-              not_to?(node)
-            end
-          end
-
-          def offense_range(node)
-            node.parent.loc.selector.with(end_pos: node.loc.selector.end_pos)
-          end
-
-          def message(_matcher)
-            format(MSG,
-                   runner: replaced_runner,
-                   matcher: replaced_matcher)
-          end
-
-          def replaced_runner
-            case style
-            when :not_to
-              'not_to'
-            when :be_invalid
-              'to'
-            end
-          end
-
-          def replaced_matcher
-            case style
-            when :not_to
-              'be_valid'
-            when :be_invalid
-              'be_invalid'
-            end
-          end
-        end
+        # @!parse
+        #   # Enforces use of `be_invalid` or `not_to` for negated be_valid.
+        #   #
+        #   # @safety
+        #   #   This cop is unsafe because it cannot guarantee that
+        #   #   the test target is an instance of `ActiveModel::Validations``.
+        #   #
+        #   # @example EnforcedStyle: not_to (default)
+        #   #   # bad
+        #   #   expect(foo).to be_invalid
+        #   #
+        #   #   # good
+        #   #   expect(foo).not_to be_valid
+        #   #
+        #   #   # good (with method chain)
+        #   #   expect(foo).to be_invalid.and be_odd
+        #   #
+        #   # @example EnforcedStyle: be_invalid
+        #   #   # bad
+        #   #   expect(foo).not_to be_valid
+        #   #
+        #   #   # good
+        #   #   expect(foo).to be_invalid
+        #   #
+        #   #   # good (with method chain)
+        #   #   expect(foo).to be_invalid.or be_even
+        #   #
+        #   class NegationBeValid < RuboCop::Cop::RSpec::Base; end
+        NegationBeValid = ::RuboCop::Cop::RSpecRails::NegationBeValid
       end
     end
   end

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

@@ -4,88 +4,30 @@ module RuboCop
   module Cop
     module RSpec
       module Rails
-        # Prefer to travel in `before` rather than `around`.
-        #
-        # @safety
-        #   This cop is unsafe because the automatic `travel_back` is only run
-        #   on test cases that are considered as Rails related.
-        #
-        #   And also, this cop's autocorrection is unsafe because the order of
-        #   execution will change if other steps exist before traveling in
-        #   `around`.
-        #
-        # @example
-        #   # bad
-        #   around do |example|
-        #     freeze_time do
-        #       example.run
-        #     end
-        #   end
-        #
-        #   # good
-        #   before { freeze_time }
-        class TravelAround < Base
-          extend AutoCorrector
-
-          MSG = 'Prefer to travel in `before` rather than `around`.'
-
-          TRAVEL_METHOD_NAMES = %i[
-            freeze_time
-            travel
-            travel_to
-          ].to_set.freeze
-
-          # @!method extract_run_in_travel(node)
-          def_node_matcher :extract_run_in_travel, <<~PATTERN
-            (block
-              $(send nil? TRAVEL_METHOD_NAMES ...)
-              (args ...)
-              (send _ :run)
-            )
-          PATTERN
-
-          # @!method match_around_each?(node)
-          def_node_matcher :match_around_each?, <<~PATTERN
-            (block
-              (send _ :around (sym :each)?)
-              ...
-            )
-          PATTERN
-
-          def on_block(node)
-            run_node = extract_run_in_travel(node)
-            return unless 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)
-            end
-          end
-          alias on_numblock on_block
-
-          private
-
-          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"
-            )
-          end
-
-          # @param node [RuboCop::AST::BlockNode]
-          # @return [RuboCop::AST::BlockNode, nil]
-          def extract_surrounding_around_block(node)
-            node.each_ancestor(:block).find do |ancestor|
-              match_around_each?(ancestor)
-            end
-          end
-        end
+        # @!parse
+        #   # Prefer to travel in `before` rather than `around`.
+        #   #
+        #   # @safety
+        #   #   This cop is unsafe because the automatic `travel_back` is only
+        #   #   run on test cases that are considered as Rails related.
+        #   #
+        #   #   And also, this cop's autocorrection is unsafe because the order
+        #   #   of execution will change if other steps exist before traveling
+        #   #   in `around`.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   around do |example|
+        #   #     freeze_time do
+        #   #       example.run
+        #   #     end
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   before { freeze_time }
+        #   #
+        #   class TravelAround < RuboCop::Cop::RSpec::Base; end
+        TravelAround = ::RuboCop::Cop::RSpecRails::TravelAround
       end
     end
   end

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

@@ -7,13 +7,13 @@ module RuboCop
       #
       # @example
       #
-      #    it 'is valid' do
-      #      expect(user).to be_valid
-      #    end
+      #   it 'is valid' do
+      #     expect(user).to be_valid
+      #   end
       #
-      #    it 'validates the user' do
-      #      expect(user).to be_valid
-      #    end
+      #   it 'validates the user' do
+      #     expect(user).to be_valid
+      #   end
       #
       class RepeatedExample < Base
         MSG = "Don't repeat examples within an example group."

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Description should be descriptive.
+      #
+      # If example group or example contains only `execute string`, numbers
+      # and regular expressions, the description is not clear.
+      #
+      # @example
+      #   # bad
+      #   describe `time` do
+      #    # ...
+      #   end
+      #
+      #   # bad
+      #   context /when foo/ do
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   it 10000 do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   describe Foo do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   describe '#foo' do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   context "when #{foo} is bar" do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     # ...
+      #   end
+      #
+      class UndescriptiveLiteralsDescription < Base
+        MSG = 'Description should be descriptive.'
+
+        # @!method example_groups_or_example?(node)
+        def_node_matcher :example_groups_or_example?, <<~PATTERN
+          (block (send #rspec? {#ExampleGroups.all #Examples.all} $_) ...)
+        PATTERN
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          example_groups_or_example?(node) do |arg|
+            add_offense(arg) if offense?(arg)
+          end
+        end
+
+        private
+
+        def offense?(node)
+          %i[xstr int regexp].include?(node.type)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -18,14 +18,10 @@ require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
 require_relative 'rspec/rails/have_http_status'
-require_relative 'rspec/rails/negation_be_valid'
-begin
-  require_relative 'rspec/rails/http_status'
-rescue LoadError
-  # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
-end
+require_relative 'rspec/rails/http_status'
 require_relative 'rspec/rails/inferred_spec_type'
 require_relative 'rspec/rails/minitest_assertions'
+require_relative 'rspec/rails/negation_be_valid'
 require_relative 'rspec/rails/travel_around'
 
 require_relative 'rspec/align_left_let_brace'
@@ -58,6 +54,7 @@ require_relative 'rspec/empty_line_after_final_let'
 require_relative 'rspec/empty_line_after_hook'
 require_relative 'rspec/empty_line_after_subject'
 require_relative 'rspec/empty_metadata'
+require_relative 'rspec/empty_output'
 require_relative 'rspec/eq'
 require_relative 'rspec/example_length'
 require_relative 'rspec/example_without_description'
@@ -128,6 +125,7 @@ require_relative 'rspec/spec_file_path_suffix'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'
+require_relative 'rspec/undescriptive_literals_description'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'
 require_relative 'rspec/variable_name'

data/lib/rubocop/rspec/config_formatter.rb

@@ -22,6 +22,13 @@ module RuboCop
         RSpec/FactoryBot/FactoryClassName
         RSpec/FactoryBot/FactoryNameStyle
         RSpec/FactoryBot/SyntaxMethods
+        RSpec/Rails/AvoidSetupHook
+        RSpec/Rails/HaveHttpStatus
+        RSpec/Rails/HttpStatus
+        RSpec/Rails/InferredSpecType
+        RSpec/Rails/MinitestAssertions
+        RSpec/Rails/NegationBeValid
+        RSpec/Rails/TravelAround
       )
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'

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.27.1'
+      STRING = '2.29.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -39,6 +39,9 @@ require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
+# need after `require 'rubocop/cop/rspec/base'``
+require 'rubocop-rspec_rails'
+
 RuboCop::RSpec::Inject.defaults!
 
 require_relative 'rubocop/cop/rspec_cops'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.27.1
+  version: 2.29.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.28'
 description: |
   Code style checking for RSpec files.
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -113,6 +127,7 @@ files:
 - lib/rubocop/cop/rspec/empty_line_after_hook.rb
 - lib/rubocop/cop/rspec/empty_line_after_subject.rb
 - lib/rubocop/cop/rspec/empty_metadata.rb
+- lib/rubocop/cop/rspec/empty_output.rb
 - lib/rubocop/cop/rspec/eq.rb
 - lib/rubocop/cop/rspec/example_length.rb
 - lib/rubocop/cop/rspec/example_without_description.rb
@@ -207,6 +222,7 @@ files:
 - lib/rubocop/cop/rspec/stubbed_mock.rb
 - lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
+- lib/rubocop/cop/rspec/undescriptive_literals_description.rb
 - lib/rubocop/cop/rspec/unspecified_exception.rb
 - lib/rubocop/cop/rspec/variable_definition.rb
 - lib/rubocop/cop/rspec/variable_name.rb
@@ -238,7 +254,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -253,8 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []