rubocop-rspec 2.28.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bec4edcf5bcf8c729a8c897b3de5b80b68c08de7ee3b2a25cfa23518db43390
-  data.tar.gz: '0848c7f26310108d511c7986127016963432371d6554c679a8fb318387c05998'
+  metadata.gz: 17925b2c404825ce202d012a1b5176358a7328cbdf5c956426b2be463c07707a
+  data.tar.gz: bf216b0348237ccb7020b7dad2cb79c700c46f7bdbc85bdf65c5a2740aea12e8
 SHA512:
-  metadata.gz: 72958ac870b50c4b3c5b91be2f18ab88d6b2abf64af255e56451c0a6f58b3fd570dd2a3452e7326af58af57cce9347e370978bd21685f6470bba50ea8d93b195
-  data.tar.gz: 34dc88c068186ac780e2c3e4ebc3048159c236acc4b685fd6630cd59de0910a3f4f181a310d0e2ff7d1b5f9a2609219118119ff23dee212b870b24f685aef195
+  metadata.gz: fb4265f89166d4df1e75b2eef2a2b3d709e93834511dde371765cf21d0efb7af158bc2a165b98dc0106ffb979003b2d924543074c00268445df924a6d3ec8cc0
+  data.tar.gz: 90fc7033f83e79d3aa77eab277247ce0c6b66b20db115d24834ed28940f584c656eb6588f93250e1abea901ad4b83cac012d0339e64b4a5633b48abed9c4b568

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 2.29.0 (2024-04-04)
+
+- Fix an autocorrect error for `RSpec/ExpectActual`. ([@bquorning])
+- Add new `RSpec/UndescriptiveLiteralsDescription` cop. ([@ydah])
+- Add new `RSpec/EmptyOutput` cop. ([@bquorning])
+
 ## 2.28.0 (2024-03-30)
 
 - Extract RSpec Rails cops to a separate repository, [`rubocop-rspec_rails`](https://github.com/rubocop/rubocop-rspec_rails). The `rubocop-rspec_rails` repository is a dependency of `rubocop-rspec` and the cops related to rspec-rails are aliased (`RSpec/Rails/Foo` == `RSpecRails/Foo`) until v3.0 is released, so the change will be invisible to users until then. ([@ydah])

data/config/default.yml

@@ -366,6 +366,12 @@ RSpec/EmptyMetadata:
   VersionAdded: '2.24'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyMetadata
 
+RSpec/EmptyOutput:
+  Description: Check that the `output` matcher is not called with an empty string.
+  Enabled: pending
+  VersionAdded: "<<next>>"
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyOutput
+
 RSpec/Eq:
   Description: Use `eq` instead of `be ==` to compare objects.
   Enabled: pending
@@ -932,6 +938,12 @@ RSpec/SubjectStub:
   StyleGuide: https://rspec.rubystyle.guide/#dont-stub-subject
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SubjectStub
 
+RSpec/UndescriptiveLiteralsDescription:
+  Description: Description should be descriptive.
+  Enabled: pending
+  VersionAdded: '2.29'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/UndescriptiveLiteralsDescription
+
 RSpec/UnspecifiedException:
   Description: Checks for a specified error in checking raised errors.
   Enabled: true

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      #  Checks for empty before and after hooks.
+      # Checks for empty before and after hooks.
       #
       # @example
       #   # bad

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that the `output` matcher is not called with an empty string.
+      #
+      # @example
+      #   # bad
+      #   expect { foo }.to output('').to_stdout
+      #   expect { bar }.not_to output('').to_stderr
+      #
+      #   # good
+      #   expect { foo }.not_to output.to_stdout
+      #   expect { bar }.to output.to_stderr
+      #
+      class EmptyOutput < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<runner>s` instead of matching on an empty output.'
+        RESTRICT_ON_SEND = Runners.all
+
+        # @!method matching_empty_output(node)
+        def_node_matcher :matching_empty_output, <<~PATTERN
+          (send
+            (block
+              (send nil? :expect) ...
+            )
+            #Runners.all
+            (send $(send nil? :output (str empty?)) ...)
+          )
+        PATTERN
+
+        def on_send(send_node)
+          matching_empty_output(send_node) do |node|
+            runner = send_node.method?(:to) ? 'not_to' : 'to'
+            message = format(MSG, runner: runner)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(send_node.loc.selector, runner)
+              corrector.replace(node, 'output')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -58,22 +58,27 @@ module RuboCop
           (send
             (send nil? :expect $#literal?)
             #Runners.all
-            {
+            ${
               (send (send nil? $:be) :== $_)
               (send nil? $_ $_ ...)
             }
           )
         PATTERN
 
-        def on_send(node)
-          expect_literal(node) do |actual, matcher, expected|
+        def on_send(node) # rubocop:disable Metrics/MethodLength
+          expect_literal(node) do |actual, send_node, matcher, expected|
             next if SKIPPED_MATCHERS.include?(matcher)
 
             add_offense(actual.source_range) do |corrector|
               next unless CORRECTABLE_MATCHERS.include?(matcher)
               next if literal?(expected)
 
-              swap(corrector, actual, expected)
+              corrector.replace(actual, expected.source)
+              if matcher == :be
+                corrector.replace(expected, actual.source)
+              else
+                corrector.replace(send_node, "#{matcher}(#{actual.source})")
+              end
             end
           end
         end
@@ -94,11 +99,6 @@ module RuboCop
           COMPLEX_LITERALS.include?(node.type) &&
             node.each_child_node.all?(&method(:literal?))
         end
-
-        def swap(corrector, actual, expected)
-          corrector.replace(actual, expected.source)
-          corrector.replace(expected, actual.source)
-        end
       end
     end
   end

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

@@ -31,7 +31,7 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: true` (default)
-      #  # good - the cop ignores when RSpec aggregates failures
+      #   # good - the cop ignores when RSpec aggregates failures
       #   describe UserCreator do
       #     it 'builds a user', :aggregate_failures do
       #       expect(user.name).to eq("John")
@@ -40,7 +40,7 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: false`
-      #  # Detected as an offense
+      #   # Detected as an offense
       #   describe UserCreator do
       #     it 'builds a user', aggregate_failures: false do
       #       expect(user.name).to eq("John")

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

@@ -19,7 +19,7 @@ module RuboCop
         #   #     allow(foo).to receive(:bar)
         #   #   end
         #   #
-        #   class AvoidSetupHook < RuboCop::Cop::RSpecRails::Base; end
+        #   class AvoidSetupHook < RuboCop::Cop::RSpec::Base; end
         AvoidSetupHook = ::RuboCop::Cop::RSpecRails::AvoidSetupHook
       end
     end

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

@@ -53,7 +53,7 @@ module RuboCop
         #   #   it { is_expected.to have_http_status :success }
         #   #   it { is_expected.to have_http_status :error }
         #   #
-        #   class HttpStatus < RuboCop::Cop::RSpecRails::Base; end
+        #   class HttpStatus < RuboCop::Cop::RSpec::Base; end
         HttpStatus = ::RuboCop::Cop::RSpecRails::HttpStatus
       end
     end

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

@@ -54,7 +54,7 @@ module RuboCop
         #   #   RSpec.describe User, type: :common do
         #   #   end
         #   #
-        #   class InferredSpecType < RuboCop::Cop::RSpecRails::Base; end
+        #   class InferredSpecType < RuboCop::Cop::RSpec::Base; end
         InferredSpecType = ::RuboCop::Cop::RSpecRails::InferredSpecType
       end
     end

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

@@ -31,7 +31,7 @@ module RuboCop
         #   #   expect(a).to be(true)
         #   #   expect(a).to be(false)
         #   #
-        #   class MinitestAssertions < RuboCop::Cop::RSpecRails::Base; end
+        #   class MinitestAssertions < RuboCop::Cop::RSpec::Base; end
         MinitestAssertions = ::RuboCop::Cop::RSpecRails::MinitestAssertions
       end
     end

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

@@ -31,7 +31,7 @@ module RuboCop
         #   #   # good (with method chain)
         #   #   expect(foo).to be_invalid.or be_even
         #   #
-        #   class NegationBeValid < RuboCop::Cop::RSpecRails::Base; end
+        #   class NegationBeValid < RuboCop::Cop::RSpec::Base; end
         NegationBeValid = ::RuboCop::Cop::RSpecRails::NegationBeValid
       end
     end

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

@@ -26,7 +26,7 @@ module RuboCop
         #   #   # good
         #   #   before { freeze_time }
         #   #
-        #   class TravelAround < RuboCop::Cop::RSpecRails::Base; end
+        #   class TravelAround < RuboCop::Cop::RSpec::Base; end
         TravelAround = ::RuboCop::Cop::RSpecRails::TravelAround
       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

@@ -54,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'
@@ -124,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/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '2.28.0'
+      STRING = '2.29.0'
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.29.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -127,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
@@ -221,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
@@ -252,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
@@ -267,8 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []