rubocop-rspec 1.33.0 → 1.34.0

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

@@ -59,7 +59,6 @@ module RuboCop
 
           add_offense(
             node,
-            location: :expression,
             message: format(MSG, suffix: glob)
           )
         end

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

@@ -44,7 +44,7 @@ module RuboCop
 
         def on_send(node)
           focus_metadata(node) do |focus|
-            add_offense(focus, location: :expression)
+            add_offense(focus)
           end
         end
 

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

@@ -80,7 +80,6 @@ module RuboCop
             style_detected(scope_name)
             add_offense(
               method_send,
-              location: :expression,
               message: explicit_message(scope_name)
             )
           end

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

@@ -43,7 +43,7 @@ module RuboCop
 
           null_double(node) do |var, receiver|
             have_received_usage(node) do |expected|
-              add_offense(receiver, location: :expression) if expected == var
+              add_offense(receiver) if expected == var
             end
           end
         end

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

@@ -68,7 +68,7 @@ module RuboCop
             return if inside_dynamic_class?(ivar)
             return if assignment_only? && !ivar_assigned?(node, name)
 
-            add_offense(ivar, location: :expression)
+            add_offense(ivar)
           end
         end
 

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

@@ -24,7 +24,7 @@ module RuboCop
 
         def on_send(node)
           invalid_predicate_matcher?(node) do |predicate|
-            add_offense(predicate, location: :expression)
+            add_offense(predicate)
           end
         end
 

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

@@ -28,7 +28,7 @@ module RuboCop
 
         def on_send(node)
           example_inclusion_offense(node, alternative_style) do
-            add_offense(node, location: :expression)
+            add_offense(node)
           end
         end
 

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

@@ -34,7 +34,7 @@ module RuboCop
         def on_block(node)
           each?(node) do |arg, body|
             if single_expectation?(body, arg) || only_expectations?(body, arg)
-              add_offense(node.send_node, location: :expression)
+              add_offense(node.send_node)
             end
           end
         end

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

@@ -47,7 +47,6 @@ module RuboCop
             if offending?(sibling)
               add_offense(
                 node,
-                location: :expression,
                 message: format(MSG, offending: sibling.method_name)
               )
             end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that no class, module, or constant is declared.
+      #
+      # Constants, including classes and modules, when declared in a block
+      # scope, are defined in global namespace, and leak between examples.
+      #
+      # If several examples may define a `DummyClass`, instead of being a
+      # blank slate class as it will be in the first example, subsequent
+      # examples will be reopening it and modifying its behaviour in
+      # unpredictable ways.
+      # Even worse when a class that exists in the codebase is reopened.
+      #
+      # Anonymous classes are fine, since they don't result in global
+      # namespace name clashes.
+      #
+      # @see https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants
+      #
+      # @example Constants leak between examples
+      #   # bad
+      #   describe SomeClass do
+      #     OtherClass = Struct.new
+      #     CONSTANT_HERE = 'I leak into global namespace'
+      #   end
+      #
+      #   # good
+      #   describe SomeClass do
+      #     before do
+      #       stub_const('OtherClass', Struct.new)
+      #       stub_const('CONSTANT_HERE', 'I only exist during this example')
+      #     end
+      #   end
+      #
+      # @example
+      #   # bad
+      #   describe SomeClass do
+      #     class FooClass < described_class
+      #       def double_that
+      #         some_base_method * 2
+      #       end
+      #     end
+      #
+      #     it { expect(FooClass.new.double_that).to eq(4) }
+      #   end
+      #
+      #   # good - anonymous class, no constant needs to be defined
+      #   let(:foo_class) do
+      #     Class.new(described_class) do
+      #       def double_that
+      #         some_base_method * 2
+      #       end
+      #     end
+      #
+      #     it { expect(foo_class.new.double_that).to eq(4) }
+      #   end
+      #
+      #   # good - constant is stubbed
+      #   describe SomeClass do
+      #     before do
+      #       foo_class = Class.new(described_class) do
+      #                     def do_something
+      #                     end
+      #                   end
+      #       stub_const('FooClass', foo_class)
+      #     end
+      #
+      #     it { expect(FooClass.new.double_that).to eq(4) }
+      #   end
+      #
+      # @example
+      #   # bad
+      #   describe SomeClass do
+      #     module SomeModule
+      #       class SomeClass
+      #         def do_something
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   describe SomeClass do
+      #     before do
+      #       foo_class = Class.new(described_class) do
+      #                     def do_something
+      #                     end
+      #                   end
+      #       stub_const('SomeModule::SomeClass', foo_class)
+      #     end
+      #   end
+      class LeakyConstantDeclaration < Cop
+        MSG_CONST = 'Stub constant instead of declaring explicitly.'
+        MSG_CLASS = 'Stub class constant instead of declaring explicitly.'
+        MSG_MODULE = 'Stub module constant instead of declaring explicitly.'
+
+        def on_casgn(node)
+          return unless inside_describe_block?(node)
+
+          add_offense(node, message: MSG_CONST)
+        end
+
+        def on_class(node)
+          return unless inside_describe_block?(node)
+
+          add_offense(node, message: MSG_CLASS)
+        end
+
+        def on_module(node)
+          return unless inside_describe_block?(node)
+
+          add_offense(node, message: MSG_MODULE)
+        end
+
+        private
+
+        def inside_describe_block?(node)
+          node.each_ancestor(:block).any?(&method(:in_example_or_shared_group?))
+        end
+
+        def_node_matcher :in_example_or_shared_group?,
+                         (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
+      end
+    end
+  end
+end

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

@@ -73,7 +73,7 @@ module RuboCop
           node.each_child_node do |child|
             next if child.sibling_index < first_example.sibling_index
 
-            add_offense(child, location: :expression) if let?(child)
+            add_offense(child) if let?(child)
           end
         end
 

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

@@ -26,9 +26,7 @@ module RuboCop
       #     expect(Widget.count).to eq(1)
       #   end
       class LetSetup < Cop
-        include RuboCop::RSpec::TopLevelDescribe
-
-        MSG = 'Do not use `let!` for test setup.'
+        MSG = 'Do not use `let!` to setup objects not referenced in tests.'
 
         def_node_search :let_bang, <<-PATTERN
           (block $(send nil? :let! (sym $_)) args ...)
@@ -40,7 +38,7 @@ module RuboCop
           return unless example_group?(node)
 
           unused_let_bang(node) do |let|
-            add_offense(let, location: :expression)
+            add_offense(let)
           end
         end
 

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

@@ -26,8 +26,7 @@ module RuboCop
           return unless example_group?(node)
           return if node.send_node.arguments?
 
-          add_offense(node, location: :expression,
-                            message: format(MSG, method: node.method_name))
+          add_offense(node, message: format(MSG, method: node.method_name))
         end
       end
     end

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

@@ -32,7 +32,7 @@ module RuboCop
           return if single_top_level_describe?
           return unless top_level_nodes.first.equal?(node)
 
-          add_offense(node, location: :expression)
+          add_offense(node)
         end
       end
     end

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

@@ -50,20 +50,20 @@ module RuboCop
 
         MSG = 'Example has too many expectations [%<total>d/%<max>d].'
 
-        def_node_search :with_aggregated_failures?, '(sym :aggregate_failures)'
-        def_node_search :disabled_aggregated_failures?, <<-PATTERN
+        def_node_search :with_aggregate_failures?, '(sym :aggregate_failures)'
+        def_node_search :disabled_aggregate_failures?, <<-PATTERN
           (pair (sym :aggregate_failures) (false))
         PATTERN
 
         def_node_matcher :expect?, Expectations::ALL.send_pattern
-        def_node_matcher :aggregate_failures?, <<-PATTERN
+        def_node_matcher :aggregate_failures_block?, <<-PATTERN
           (block (send _ :aggregate_failures ...) ...)
         PATTERN
 
         def on_block(node)
           return unless example?(node)
 
-          return if example_with_aggregated_failures?(node)
+          return if example_with_aggregate_failures?(node)
 
           expectations_count = to_enum(:find_expectation, node).count
 
@@ -76,19 +76,40 @@ module RuboCop
 
         private
 
-        def example_with_aggregated_failures?(node)
-          example = node.send_node
+        def example_with_aggregate_failures?(example_node)
+          node_with_aggregate_failures = find_aggregate_failures(example_node)
+          return false unless node_with_aggregate_failures
 
-          (aggregated_failures_by_default? ||
-            with_aggregated_failures?(example)) &&
-            !disabled_aggregated_failures?(example)
+          aggregate_failures?(node_with_aggregate_failures)
+        end
+
+        def find_aggregate_failures(example_node)
+          example_node.send_node.each_ancestor(:block)
+            .find { |block_node| aggregate_failures_present?(block_node) }
+        end
+
+        def aggregate_failures_present?(node)
+          metadata(node)&.any?(&method(:with_aggregate_failures?))
+        end
+
+        def aggregate_failures?(example_or_group_node)
+          metadata(example_or_group_node)&.any? do |metadata|
+            with_aggregate_failures?(metadata) &&
+              !disabled_aggregate_failures?(metadata)
+          end
+        end
+
+        def metadata(example_or_group_node)
+          RuboCop::RSpec::Example
+            .new(example_or_group_node)
+            .metadata
         end
 
         def find_expectation(node, &block)
-          yield if expect?(node) || aggregate_failures?(node)
+          yield if expect?(node) || aggregate_failures_block?(node)
 
           # do not search inside of aggregate_failures block
-          return if aggregate_failures?(node)
+          return if aggregate_failures_block?(node)
 
           node.each_child_node do |child|
             find_expectation(child, &block)
@@ -98,7 +119,6 @@ module RuboCop
         def flag_example(node, expectation_count:)
           add_offense(
             node.send_node,
-            location: :expression,
             message: format(
               MSG,
               total: expectation_count,
@@ -110,10 +130,6 @@ module RuboCop
         def max_expectations
           Integer(cop_config.fetch('Max', 1))
         end
-
-        def aggregated_failures_by_default?
-          cop_config.fetch('AggregateFailuresByDefault', false)
-        end
       end
     end
   end

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

@@ -44,7 +44,7 @@ module RuboCop
           subjects = RuboCop::RSpec::ExampleGroup.new(node).subjects
 
           subjects[0...-1].each do |subject|
-            add_offense(subject, location: :expression)
+            add_offense(subject)
           end
         end
 

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

@@ -104,7 +104,6 @@ module RuboCop
             self.max = nesting
             add_offense(
               context.send_node,
-              location: :expression,
               message: message(nesting)
             )
           end

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

@@ -33,7 +33,6 @@ module RuboCop
           find_duplicates(node.body) do |duplicate, name|
             add_offense(
               duplicate,
-              location: :expression,
               message: format(MSG, name: name)
             )
           end

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

@@ -46,7 +46,7 @@ module RuboCop
         def on_send(node)
           return unless pending_block?(node) || skipped_from_metadata?(node)
 
-          add_offense(node, location: :expression)
+          add_offense(node)
         end
 
         private

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

@@ -17,7 +17,6 @@ module RuboCop
           predicate_in_actual?(node) do |predicate|
             add_offense(
               node,
-              location: :expression,
               message: message_inflected(predicate)
             )
           end
@@ -143,7 +142,6 @@ module RuboCop
           predicate_matcher_block?(node) do |_actual, matcher|
             add_offense(
               node,
-              location: :expression,
               message: message_explicit(matcher)
             )
             ignore_node(node.children.first)
@@ -155,7 +153,6 @@ module RuboCop
           predicate_matcher?(node) do |_actual, matcher|
             add_offense(
               node,
-              location: :expression,
               message: message_explicit(matcher)
             )
           end

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

@@ -36,7 +36,7 @@ module RuboCop
           return unless example_group?(node)
 
           repeated_descriptions(node).each do |repeated_description|
-            add_offense(repeated_description, location: :expression)
+            add_offense(repeated_description)
           end
         end
 

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

@@ -22,7 +22,7 @@ module RuboCop
           return unless example_group?(node)
 
           repeated_examples(node).each do |repeated_example|
-            add_offense(repeated_example, location: :expression)
+            add_offense(repeated_example)
           end
         end
 

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

@@ -44,7 +44,7 @@ module RuboCop
           lets.each_with_index do |node, idx|
             next if node.sibling_index == first_let.sibling_index + idx
 
-            add_offense(node, location: :expression)
+            add_offense(node)
           end
         end
       end

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

@@ -29,7 +29,7 @@ module RuboCop
           return unless example_group?(node)
 
           analyzable_hooks(node).each do |repeated_hook|
-            add_offense(repeated_hook, location: :expression)
+            add_offense(repeated_hook)
           end
         end