rubocop-rspec 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a953b5fa50cd545314cbe25e453b476b670cd2a4eb2d60c75109354ed7c333c
-  data.tar.gz: be5782eb1c0f8e4ca86b28ed39fba908719afe73dd544a161885719485853a89
+  metadata.gz: 35d3cf723ee0c50db00cbc5e63f5d9bf142186843fd56a86248dfb284c65180c
+  data.tar.gz: 8d0c0e01c405332eac2075b60d518a71e82a7d54f4b41ef111f5ef2b869e1f88
 SHA512:
-  metadata.gz: e859b8c055f4502d3156595c8293decfe10883a6bea0f61a21558b9acc771b1231699439611a3da3ccb0841495ad7c1a5af3ec1c6d3e948fbb29b70a0b77289d
-  data.tar.gz: a817dcdbcd1850d4888f4d5fc58837a1c8c59fa754f10dff0aa3eebf24013e88230d84719592115b3339551ac2c932240d01bac1b8a5094982943f1a9e960908
+  metadata.gz: 2e28be09b6cc11154b903ef574ef44487c44ade441f79b1172569d66cecd2c027d525dbcefbe755d7a0f2c872491a018fb24cd026453dc13ac764bcae7312abc
+  data.tar.gz: 3062cea8205acc5e020c404034c8c2590c6c5c089649c62280887b0bc20ca3b4b38048a983b2947f9ed10bc1824992955c6a58736db53f071c72a3fdde9363f8

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 2.4.0 (2021-06-09)
+
+* Update `RSpec/FilePath` to check suffix when given a non-constant top-level node (e.g. features). ([@topalovic][])
+* Add missing documentation for `single_statement_only` style of `RSpec/ImplicitSubject` cop. ([@tejasbubane][])
+* Fix an exception in `DescribedClass` when accessing a constant on a variable in a spec that is nested in a namespace. ([@rrosenblum][])
+* Add new `RSpec/IdenticalEqualityAssertion` cop. ([@tejasbubane][])
+* Add `RSpec/Rails/AvoidSetupHook` cop. ([@paydaylight][])
+* Fix false negative in `RSpec/ExpectChange` cop with block style and chained method call. ([@tejasbubane][])
+
 ## 2.3.0 (2021-04-28)
 
 * Allow `RSpec/ContextWording` to accept multi-word prefixes. ([@hosamaly][])
@@ -613,3 +622,6 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@hosamaly]: https://github.com/hosamaly
 [@stephannv]: https://github.com/stephannv
 [@Tietew]: https://github.com/Tietew
+[@rrosenblum]: https://github.com/rrosenblum
+[@paydaylight]: https://github.com/paydaylight
+[@topalovic]: https://github.com/topalovic

data/config/default.yml

@@ -351,6 +351,12 @@ RSpec/HooksBeforeExamples:
   VersionAdded: '1.29'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/HooksBeforeExamples
 
+RSpec/IdenticalEqualityAssertion:
+  Description: Checks for equality assertions with identical expressions on both sides.
+  Enabled: pending
+  VersionAdded: '2.4'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IdenticalEqualityAssertion
+
 RSpec/ImplicitBlockExpectation:
   Description: Check that implicit block expectation syntax is not used.
   Enabled: true
@@ -753,6 +759,12 @@ RSpec/FactoryBot/FactoryClassName:
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName
 
+RSpec/Rails/AvoidSetupHook:
+  Description: Checks that tests use RSpec `before` hook over Rails `setup` method.
+  Enabled: pending
+  VersionAdded: '2.4'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/AvoidSetupHook
+
 RSpec/Rails/HttpStatus:
   Description: Enforces use of symbolic or numeric value to describe HTTP status.
   Enabled: true

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

@@ -203,7 +203,7 @@ module RuboCop
             [name]
           elsif namespace.const_type?
             [*const_name(namespace), name]
-          elsif namespace.lvar_type? || namespace.cbase_type?
+          elsif %i[lvar cbase send].include?(namespace.type)
             [nil, name]
           end
         end

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

@@ -39,7 +39,7 @@ module RuboCop
 
         # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
-          (send nil? :change ({const send} nil? $_) (sym $_))
+          (send nil? :change $_ (sym $_))
         PATTERN
 
         # @!method expect_change_with_block(node)
@@ -55,9 +55,9 @@ module RuboCop
           return unless style == :block
 
           expect_change_with_arguments(node) do |receiver, message|
-            msg = format(MSG_CALL, obj: receiver, attr: message)
+            msg = format(MSG_CALL, obj: receiver.source, attr: message)
             add_offense(node, message: msg) do |corrector|
-              replacement = "change { #{receiver}.#{message} }"
+              replacement = "change { #{receiver.source}.#{message} }"
               corrector.replace(node, replacement)
             end
           end

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

@@ -61,10 +61,10 @@ module RuboCop
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
-        # @!method const_described(node)
-        def_node_matcher :const_described, <<~PATTERN
+        # @!method example_group(node)
+        def_node_matcher :example_group, <<~PATTERN
           (block
-            $(send #rspec? _example_group $(const ...) $...) ...
+            $(send #rspec? _example_group $_ $...) ...
           )
         PATTERN
 
@@ -74,17 +74,17 @@ module RuboCop
         def on_top_level_example_group(node)
           return unless top_level_groups.one?
 
-          const_described(node) do |send_node, described_class, arguments|
+          example_group(node) do |send_node, example_group, arguments|
             next if routing_spec?(arguments)
 
-            ensure_correct_file_path(send_node, described_class, arguments)
+            ensure_correct_file_path(send_node, example_group, arguments)
           end
         end
 
         private
 
-        def ensure_correct_file_path(send_node, described_class, arguments)
-          pattern = pattern_for(described_class, arguments.first)
+        def ensure_correct_file_path(send_node, example_group, arguments)
+          pattern = pattern_for(example_group, arguments.first)
           return if filename_ends_with?(pattern)
 
           # For the suffix shown in the offense message, modify the regular
@@ -99,11 +99,13 @@ module RuboCop
           args.any?(&method(:routing_metadata?))
         end
 
-        def pattern_for(described_class, method_name)
-          return pattern_for_spec_suffix_only? if spec_suffix_only?
+        def pattern_for(example_group, method_name)
+          if spec_suffix_only? || !example_group.const_type?
+            return pattern_for_spec_suffix_only?
+          end
 
           [
-            expected_path(described_class),
+            expected_path(example_group),
             name_pattern(method_name),
             '[^/]*_spec\.rb'
           ].join

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for equality assertions with identical expressions on both sides.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo.bar).to eq(foo.bar)
+      #   expect(foo.bar).to eql(foo.bar)
+      #
+      #   # good
+      #   expect(foo.bar).to eq(2)
+      #   expect(foo.bar).to eql(2)
+      #
+      class IdenticalEqualityAssertion < Base
+        MSG = 'Identical expressions on both sides of the equality ' \
+              'may indicate a flawed test.'
+        RESTRICT_ON_SEND = %i[to].freeze
+
+        # @!method equality_check?(node)
+        def_node_matcher :equality_check?, <<~PATTERN
+          (send (send nil? :expect $_) :to
+            {(send nil? {:eql :eq :be} $_)
+             (send (send nil? :be) :== $_)})
+        PATTERN
+
+        def on_send(node)
+          equality_check?(node) do |left, right|
+            add_offense(node) if left == right
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module RuboCop
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
-      # @example `EnforcedStyle: single_line_only`
+      # @example `EnforcedStyle: single_line_only` (default)
       #   # bad
       #   it do
       #     is_expected.to be_truthy
@@ -19,6 +19,22 @@ module RuboCop
       #     expect(subject).to be_truthy
       #   end
       #
+      # @example `EnforcedStyle: single_statement_only`
+      #   # bad
+      #   it do
+      #     foo = 1
+      #     is_expected.to be_truthy
+      #   end
+      #
+      #   # good
+      #   it do
+      #     foo = 1
+      #     expect(subject).to be_truthy
+      #   end
+      #   it do
+      #     is_expected.to be_truthy
+      #   end
+      #
       # @example `EnforcedStyle: disallow`
       #   # bad
       #   it { is_expected.to be_truthy }

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Checks that tests use RSpec `before` hook over Rails `setup` method.
+        #
+        # @example
+        #
+        #   # bad
+        #   setup do
+        #     allow(foo).to receive(:bar)
+        #   end
+        #
+        #   # good
+        #   before do
+        #     allow(foo).to receive(:bar)
+        #   end
+        #
+        class AvoidSetupHook < Base
+          extend AutoCorrector
+
+          MSG = 'Use `before` instead of `setup`.'
+
+          # @!method setup_call(node)
+          def_node_matcher :setup_call, <<-PATTERN
+            (block
+              $(send nil? :setup)
+              (args) _)
+          PATTERN
+
+          def on_block(node)
+            setup_call(node) do |setup|
+              add_offense(node) do |corrector|
+                corrector.replace setup, 'before'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -8,6 +8,7 @@ require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
 
+require_relative 'rspec/rails/avoid_setup_hook'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
@@ -47,6 +48,7 @@ require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
+require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'

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.3.0'
+      STRING = '2.4.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -183,6 +183,7 @@ files:
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/hooks_before_examples.rb
+- lib/rubocop/cop/rspec/identical_equality_assertion.rb
 - lib/rubocop/cop/rspec/implicit_block_expectation.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
 - lib/rubocop/cop/rspec/implicit_subject.rb
@@ -213,6 +214,7 @@ files:
 - lib/rubocop/cop/rspec/overwriting_setup.rb
 - lib/rubocop/cop/rspec/pending.rb
 - lib/rubocop/cop/rspec/predicate_matcher.rb
+- lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb