rubocop-rspec 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4786aaf8f829745dafce927499fd98671a0b8ab08a61a9c99eafc26fb7235926
-  data.tar.gz: 38e23b1194fb915f42f4399fe6be1b6c950de10d367300a01226549e15747f93
+  metadata.gz: 2d9511a08dde997c269b9bfe065a23b16296a607ce561a68bbe09ccd5eb37dee
+  data.tar.gz: 7966471067098d603c1098e544ad9c573e63037398126fbb9838aefbec992e25
 SHA512:
-  metadata.gz: 39bb13d4cfe09307955f392935c626fb8b920e2b38a33323464e15fb9a7248c88db27259cab8c118df4ebb5888c11973e04e2e5f3ce58e64e1f18486801ac3c7
-  data.tar.gz: 51fa7212f5b0576b0fbfcf88c57cff79612934695f8f8f1b6c3106006b5e6dd1eff08c06cfe60fcd8a994e3eccd51810c61b208e398b708090f3e257d0bed3e8
+  metadata.gz: 8020a1e38b6c8bf50ebccd9524d9fd513193ec2bdb9829edb1832d456abbdf57bc8386a51f58b6b19ea335de5991c6dec182a428f9579dfc91d7871990f83c54
+  data.tar.gz: 91aaec82daf89de819e93f4cadea65928b0b2178465db8997c0f928feaf4d5a11a3ecd1e927ab401e50aed1081dcdde41499101b6f5b166ae380bfbf4c1bfd89

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master (Unreleased)
 
+## 2.9.0 (2022-02-28)
+
+* Add new `RSpec/BeNil` cop. ([@bquorning][])
+* Add new `RSpec/BeEq` cop. ([@bquorning][])
+
 ## 2.8.0 (2022-01-24)
 
 * Fix `RSpec/FactoryBot/SyntaxMethods` and `RSpec/Capybara/FeatureMethods` to inspect shared groups. ([@pirj][])

data/config/default.yml

@@ -142,12 +142,24 @@ RSpec/Be:
   StyleGuide: https://rspec.rubystyle.guide/#be-matcher
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Be
 
+RSpec/BeEq:
+  Description: Check for expectations where `be(...)` can replace `eq(...)`.
+  Enabled: pending
+  VersionAdded: 2.9.0
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeEq
+
 RSpec/BeEql:
   Description: Check for expectations where `be(...)` can replace `eql(...)`.
   Enabled: true
   VersionAdded: '1.7'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeEql
 
+RSpec/BeNil:
+  Description: Check that `be_nil` is used instead of `be(nil)`.
+  Enabled: pending
+  VersionAdded: 2.9.0
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeNil
+
 RSpec/BeforeAfterAll:
   Description: Check that before/after(:all) isn't being used.
   Enabled: true

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for expectations where `be(...)` can replace `eq(...)`.
+      #
+      # The `be` matcher compares by identity while the `eq` matcher compares
+      # using `==`. Booleans and nil can be compared by identity and therefore
+      # the `be` matcher is preferable as it is a more strict test.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to eq(true)
+      #   expect(foo).to eq(false)
+      #   expect(foo).to eq(nil)
+      #
+      #   # good
+      #   expect(foo).to be(true)
+      #   expect(foo).to be(false)
+      #   expect(foo).to be(nil)
+      #
+      class BeEq < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `be` over `eq`.'
+        RESTRICT_ON_SEND = %i[eq].freeze
+
+        # @!method eq_type_with_identity?(node)
+        def_node_matcher :eq_type_with_identity?, <<-PATTERN
+          (send nil? :eq {true false nil})
+        PATTERN
+
+        def on_send(node)
+          return unless eq_type_with_identity?(node)
+
+          add_offense(node.loc.selector) do |corrector|
+            corrector.replace(node.loc.selector, 'be')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -43,7 +43,7 @@ module RuboCop
 
         # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<-PATTERN
-          (send _ :to $(send nil? :eql {true false int float sym nil_type?}))
+          (send _ :to $(send nil? :eql {true false int float sym nil}))
         PATTERN
 
         def on_send(node)

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that `be_nil` is used instead of `be(nil)`.
+      #
+      # RSpec has a built-in `be_nil` matcher specifically for expecting `nil`.
+      # For consistent specs, we recommend using that instead of `be(nil)`.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to be(nil)
+      #
+      #   # good
+      #   expect(foo).to be_nil
+      #
+      class BeNil < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `be_nil` over `be(nil)`.'
+        RESTRICT_ON_SEND = %i[be].freeze
+
+        # @!method nil_value_expectation?(node)
+        def_node_matcher :nil_value_expectation?, <<-PATTERN
+          (send nil? :be nil)
+        PATTERN
+
+        def on_send(node)
+          return unless nil_value_expectation?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(node.loc.expression, 'be_nil')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -21,7 +21,9 @@ require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'
 require_relative 'rspec/around_block'
 require_relative 'rspec/be'
+require_relative 'rspec/be_eq'
 require_relative 'rspec/be_eql'
+require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'

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.8.0'
+      STRING = '2.9.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -135,7 +135,9 @@ files:
 - lib/rubocop/cop/rspec/around_block.rb
 - lib/rubocop/cop/rspec/base.rb
 - lib/rubocop/cop/rspec/be.rb
+- lib/rubocop/cop/rspec/be_eq.rb
 - lib/rubocop/cop/rspec/be_eql.rb
+- lib/rubocop/cop/rspec/be_nil.rb
 - lib/rubocop/cop/rspec/before_after_all.rb
 - lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb