rubocop-rspec 1.40.0 → 1.43.2

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

@@ -21,7 +21,9 @@ module RuboCop
       #     end
       #   end
       #
-      class SubjectStub < Cop
+      class SubjectStub < Base
+        include RuboCop::RSpec::TopLevelGroup
+
         MSG = 'Do not stub methods of the object under test.'
 
         # @!method subject(node)
@@ -37,7 +39,7 @@ module RuboCop
         #       name # => :thing
         #     end
         #
-        #   @param node [RuboCop::Node]
+        #   @param node [RuboCop::AST::Node]
         #
         #   @yield [Symbol] subject name
         def_node_matcher :subject, <<-PATTERN
@@ -75,11 +77,7 @@ module RuboCop
             } ...)
         PATTERN
 
-        def on_block(node)
-          return unless example_group?(node)
-          return if (processed_example_groups & node.ancestors).any?
-
-          processed_example_groups << node
+        def on_top_level_group(node)
           @explicit_subjects = find_all_explicit_subjects(node)
 
           find_subject_expectations(node) do |stub|
@@ -89,10 +87,6 @@ module RuboCop
 
         private
 
-        def processed_example_groups
-          @processed_example_groups ||= Set.new
-        end
-
         def find_all_explicit_subjects(node)
           node.each_descendant(:block).with_object({}) do |child, h|
             name = subject(child)

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

@@ -30,7 +30,7 @@ module RuboCop
       #     }.to raise_error(/err/)
       #
       #     expect { do_something }.not_to raise_error
-      class UnspecifiedException < Cop
+      class UnspecifiedException < Base
         MSG = 'Specify the exception being captured'
 
         def_node_matcher :empty_raise_error_or_exception, <<-PATTERN

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

@@ -7,22 +7,22 @@ module RuboCop
       #
       # @example EnforcedStyle: symbols (default)
       #   # bad
-      #   let('user_name') { 'Adam' }
       #   subject('user') { create_user }
+      #   let('user_name') { 'Adam' }
       #
       #   # good
-      #   let(:user_name) { 'Adam' }
       #   subject(:user) { create_user }
+      #   let(:user_name) { 'Adam' }
       #
       # @example EnforcedStyle: strings
       #   # bad
-      #   let(:user_name) { 'Adam' }
       #   subject(:user) { create_user }
+      #   let(:user_name) { 'Adam' }
       #
       #   # good
-      #   let('user_name') { 'Adam' }
       #   subject('user') { create_user }
-      class VariableDefinition < Cop
+      #   let('user_name') { 'Adam' }
+      class VariableDefinition < Base
         include ConfigurableEnforcedStyle
         include RuboCop::RSpec::Variable
 
@@ -44,7 +44,7 @@ module RuboCop
         end
 
         def string?(node)
-          node.str_type? || node.dstr_type?
+          node.str_type?
         end
 
         def symbol?(node)

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

@@ -5,25 +5,43 @@ module RuboCop
     module RSpec
       # Checks that memoized helper names use the configured style.
       #
+      # Variables can be excluded from checking using the `IgnoredPatterns`
+      # option.
+      #
       # @example EnforcedStyle: snake_case (default)
       #   # bad
-      #   let(:userName) { 'Adam' }
-      #   subject(:userName) { 'Adam' }
+      #   subject(:userName1) { 'Adam' }
+      #   let(:userName2) { 'Adam' }
       #
       #   # good
-      #   let(:user_name) { 'Adam' }
-      #   subject(:user_name) { 'Adam' }
+      #   subject(:user_name_1) { 'Adam' }
+      #   let(:user_name_2) { 'Adam' }
       #
       # @example EnforcedStyle: camelCase
       #   # bad
-      #   let(:user_name) { 'Adam' }
-      #   subject(:user_name) { 'Adam' }
+      #   subject(:user_name_1) { 'Adam' }
+      #   let(:user_name_2) { 'Adam' }
       #
       #   # good
-      #   let(:userName) { 'Adam' }
-      #   subject(:userName) { 'Adam' }
-      class VariableName < Cop
+      #   subject(:userName1) { 'Adam' }
+      #   let(:userName2) { 'Adam' }
+      #
+      # @example IgnoredPatterns configuration
+      #
+      #   # rubocop.yml
+      #   # RSpec/VariableName:
+      #   #   EnforcedStyle: snake_case
+      #   #   IgnoredPatterns:
+      #   #     - ^userFood
+      #
+      # @example
+      #   # okay because it matches the `^userFood` regex in `IgnoredPatterns`
+      #   subject(:userFood_1) { 'spaghetti' }
+      #   let(:userFood_2) { 'fettuccine' }
+      #
+      class VariableName < Base
         include ConfigurableNaming
+        include IgnoredPattern
         include RuboCop::RSpec::Variable
 
         MSG = 'Use %<style>s for variable names.'
@@ -31,6 +49,7 @@ module RuboCop
         def on_send(node)
           variable_definition?(node) do |variable|
             return if variable.dstr_type? || variable.dsym_type?
+            return if matches_ignored_pattern?(variable.value)
 
             check_name(node, variable.value, variable.loc.expression)
           end

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

@@ -22,7 +22,7 @@ module RuboCop
       #   let(:foo) do
       #     instance_double("ClassName", method_name: 'returned value')
       #   end
-      class VerifiedDoubles < Cop
+      class VerifiedDoubles < Base
         MSG = 'Prefer using verifying doubles over normal doubles.'
 
         def_node_matcher :unverified_double, <<-PATTERN

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

@@ -11,7 +11,7 @@ module RuboCop
       #
       #   # good
       #   expect(something).to be(1)
-      class VoidExpect < Cop
+      class VoidExpect < Base
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               'Chain the methods or remove it.'
 

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

@@ -11,7 +11,8 @@ module RuboCop
       #
       #   # good
       #   expect(foo).to be(:bar).and_yield(1)
-      class Yield < Cop
+      class Yield < Base
+        extend AutoCorrector
         include RangeHelp
 
         MSG = 'Use `.and_yield`.'
@@ -27,22 +28,24 @@ module RuboCop
 
           block_arg(node.arguments) do |block|
             if calling_block?(node.body, block)
-              add_offense(node, location: block_range(node))
-            end
-          end
-        end
+              range = block_range(node)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            node_range = range_with_surrounding_space(
-              range: block_range(node), side: :left
-            )
-            corrector.replace(node_range, generate_replacement(node.body))
+              add_offense(range) do |corrector|
+                autocorrect(corrector, node, range)
+              end
+            end
           end
         end
 
         private
 
+        def autocorrect(corrector, node, range)
+          corrector.replace(
+            range_with_surrounding_space(range: range, side: :left),
+            generate_replacement(node.body)
+          )
+        end
+
         def calling_block?(node, block)
           if node.begin_type?
             node.each_child_node.all? { |child| block_call?(child, block) }

data/lib/rubocop/cop/rspec_cops.rb

@@ -65,6 +65,7 @@ require_relative 'rspec/message_spies'
 require_relative 'rspec/missing_example_group_argument'
 require_relative 'rspec/multiple_describes'
 require_relative 'rspec/multiple_expectations'
+require_relative 'rspec/multiple_memoized_helpers'
 require_relative 'rspec/multiple_subjects'
 require_relative 'rspec/named_subject'
 require_relative 'rspec/nested_groups'

data/lib/rubocop/rspec/corrector/move_node.rb

@@ -16,19 +16,21 @@ module RuboCop
           @processed_source = processed_source # used by RangeHelp
         end
 
-        def move_before(other) # rubocop:disable Metrics/AbcSize
+        def move_before(other)
           position = other.loc.expression
-          indent = "\n" + ' ' * other.loc.column
+          indent = ' ' * other.loc.column
+          newline_indent = "\n#{indent}"
 
-          corrector.insert_before(position, source(original) + indent)
+          corrector.insert_before(position, source(original) + newline_indent)
           corrector.remove(node_range_with_surrounding_space(original))
         end
 
         def move_after(other)
           position = final_end_location(other)
-          indent = "\n" + ' ' * other.loc.column
+          indent = ' ' * other.loc.column
+          newline_indent = "\n#{indent}"
 
-          corrector.insert_after(position, indent + source(original))
+          corrector.insert_after(position, newline_indent + source(original))
           corrector.remove(node_range_with_surrounding_space(original))
         end
 

data/lib/rubocop/rspec/description_extractor.rb

@@ -21,7 +21,7 @@ module RuboCop
 
       # Decorator of a YARD code object for working with documented rspec cops
       class CodeObject
-        COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Cop'
+        COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
         RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'
 
         def initialize(yardoc)

data/lib/rubocop/rspec/{blank_line_separation.rb → empty_line_separation.rb}

@@ -2,12 +2,23 @@
 
 module RuboCop
   module RSpec
-    # Helps determine the offending location if there is not a blank line
+    # Helps determine the offending location if there is not an empty line
     # following the node. Allows comments to follow directly after.
-    module BlankLineSeparation
+    module EmptyLineSeparation
       include FinalEndLocation
       include RuboCop::Cop::RangeHelp
 
+      def missing_separating_line_offense(node)
+        return if last_child?(node)
+
+        missing_separating_line(node) do |location|
+          msg = yield(node.method_name)
+          add_offense(location, message: msg) do |corrector|
+            corrector.insert_after(location.end, "\n")
+          end
+        end
+      end
+
       def missing_separating_line(node)
         line = final_end_location(node).line
 
@@ -32,14 +43,6 @@ module RuboCop
 
         node.equal?(node.parent.children.last)
       end
-
-      def autocorrect(node)
-        lambda do |corrector|
-          missing_separating_line(node) do |location|
-            corrector.insert_after(location.end, "\n")
-          end
-        end
-      end
     end
   end
 end

data/lib/rubocop/rspec/example_group.rb

@@ -14,72 +14,44 @@ module RuboCop
         ExampleGroups::ALL + SharedGroups::ALL + Includes::ALL
       ).block_pattern
 
+      def lets
+        find_all_in_scope(node, :let?)
+      end
+
       def subjects
-        subjects_in_scope(node)
+        find_all_in_scope(node, :subject?)
       end
 
       def examples
-        examples_in_scope(node).map(&Example.public_method(:new))
+        find_all_in_scope(node, :example?).map(&Example.public_method(:new))
       end
 
       def hooks
-        hooks_in_scope(node).map(&Hook.public_method(:new))
+        find_all_in_scope(node, :hook?).map(&Hook.public_method(:new))
       end
 
       private
 
-      def subjects_in_scope(node)
-        node.each_child_node.flat_map do |child|
-          find_subjects(child)
-        end
-      end
-
-      def find_subjects(node)
-        return [] if scope_change?(node)
-
-        if subject?(node)
-          [node]
-        else
-          subjects_in_scope(node)
-        end
-      end
-
-      def hooks_in_scope(node)
-        node.each_child_node.flat_map do |child|
-          find_hooks(child)
-        end
-      end
-
-      def find_hooks(node)
-        return [] if scope_change?(node) || example?(node)
-
-        if hook?(node)
-          [node]
-        else
-          hooks_in_scope(node)
-        end
-      end
-
-      def examples_in_scope(node, &blk)
-        node.each_child_node.flat_map do |child|
-          find_examples(child, &blk)
-        end
-      end
-
-      # Recursively search for examples within the current scope
+      # Recursively search for predicate within the current scope
       #
-      # Searches node for examples and halts when a scope change is detected
+      # Searches node and halts when a scope change is detected
       #
-      # @param node [RuboCop::Node] node to recursively search for examples
+      # @param node [RuboCop::AST::Node] node to recursively search
       #
-      # @return [Array<RuboCop::Node>] discovered example nodes
-      def find_examples(node)
-        return [] if scope_change?(node)
+      # @return [Array<RuboCop::AST::Node>] discovered nodes
+      def find_all_in_scope(node, predicate)
+        node.each_child_node.flat_map do |child|
+          find_all(child, predicate)
+        end
+      end
 
-        if example?(node)
+      def find_all(node, predicate)
+        if public_send(predicate, node)
           [node]
+        elsif scope_change?(node) || example?(node)
+          []
         else
-          examples_in_scope(node)
+          find_all_in_scope(node, predicate)
         end
       end
     end

data/lib/rubocop/rspec/factory_bot.rb

@@ -4,7 +4,13 @@ module RuboCop
   module RSpec
     # RuboCop FactoryBot project namespace
     module FactoryBot
-      ATTRIBUTE_DEFINING_METHODS = %i[factory trait transient ignore].freeze
+      ATTRIBUTE_DEFINING_METHODS = %i[
+        factory
+        ignore
+        trait
+        traits_for_enum
+        transient
+      ].freeze
 
       UNPROXIED_METHODS = %i[
         __send__

data/lib/rubocop/rspec/language.rb

@@ -4,8 +4,6 @@ module RuboCop
   module RSpec
     # RSpec public API methods that are commonly used in cops
     module Language
-      RSPEC = '{(const {nil? cbase} :RSpec) nil?}'
-
       # Set of method selectors
       class SelectorSet
         def initialize(selectors)
@@ -29,7 +27,7 @@ module RuboCop
         end
 
         def block_pass_pattern
-          "(send #{RSPEC} #{node_pattern_union} _ block_pass)"
+          "(send #rspec? #{node_pattern_union} _ block_pass)"
         end
 
         def block_or_block_pass_pattern
@@ -37,7 +35,11 @@ module RuboCop
         end
 
         def send_pattern
-          "(send #{RSPEC} #{node_pattern_union} ...)"
+          "(send #rspec? #{node_pattern_union} ...)"
+        end
+
+        def send_or_block_or_block_pass_pattern
+          "{#{send_pattern} #{block_pattern} #{block_pass_pattern}}"
         end
 
         def node_pattern_union

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -7,10 +7,16 @@ module RuboCop
       module NodePattern
         extend RuboCop::NodePattern::Macros
 
+        def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
+
         def_node_matcher :example_group?, ExampleGroups::ALL.block_pattern
+        def_node_matcher :shared_group?, SharedGroups::ALL.block_pattern
+
+        spec_groups = ExampleGroups::ALL + SharedGroups::ALL
+        def_node_matcher :spec_group?, spec_groups.block_pattern
 
         def_node_matcher :example_group_with_body?, <<-PATTERN
-          (block #{ExampleGroups::ALL.send_pattern} args [!nil?])
+          (block #{ExampleGroups::ALL.send_pattern} args !nil?)
         PATTERN
 
         def_node_matcher :example?, Examples::ALL.block_pattern
@@ -19,6 +25,9 @@ module RuboCop
 
         def_node_matcher :let?, Helpers::ALL.block_or_block_pass_pattern
 
+        def_node_matcher :include?,
+                         Includes::ALL.send_or_block_or_block_pass_pattern
+
         def_node_matcher :subject?, Subject::ALL.block_pattern
       end
     end