rubocop-rspec 1.38.1 → 1.43.0

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

@@ -26,7 +26,9 @@ module RuboCop
       #     let!(:baz) { 3 }
       #   end
       #
-      class ScatteredLet < Cop
+      class ScatteredLet < Base
+        extend AutoCorrector
+
         MSG = 'Group all let/let! blocks in the example group together.'
 
         def on_block(node)
@@ -44,9 +46,17 @@ module RuboCop
           lets.each_with_index do |node, idx|
             next if node.sibling_index == first_let.sibling_index + idx
 
-            add_offense(node)
+            add_offense(node) do |corrector|
+              RuboCop::RSpec::Corrector::MoveNode.new(
+                node, corrector, processed_source
+              ).move_after(first_let)
+            end
           end
         end
+
+        def find_first_let(node)
+          node.children.find { |child| let?(child) }
+        end
       end
     end
   end

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

@@ -22,7 +22,7 @@ module RuboCop
       #     end
       #   end
       #
-      class ScatteredSetup < Cop
+      class ScatteredSetup < Base
         MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
               'example group (also defined on %<lines>s).'
 

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

@@ -50,7 +50,9 @@ module RuboCop
       #     end
       #   end
       #
-      class SharedContext < Cop
+      class SharedContext < Base
+        extend AutoCorrector
+
         MSG_EXAMPLES = "Use `shared_examples` when you don't "\
                        'define context.'
 
@@ -68,22 +70,14 @@ module RuboCop
 
         def on_block(node)
           context_with_only_examples(node) do
-            add_shared_item_offense(node.send_node, MSG_EXAMPLES)
+            add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
+              corrector.replace(node.send_node.loc.selector, 'shared_examples')
+            end
           end
 
           examples_with_only_context(node) do
-            add_shared_item_offense(node.send_node, MSG_CONTEXT)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            context_with_only_examples(node.parent) do
-              corrector.replace(node.loc.selector, 'shared_examples')
-            end
-
-            examples_with_only_context(node.parent) do
-              corrector.replace(node.loc.selector, 'shared_context')
+            add_offense(node.send_node, message: MSG_CONTEXT) do |corrector|
+              corrector.replace(node.send_node.loc.selector, 'shared_context')
             end
           end
         end
@@ -97,13 +91,6 @@ module RuboCop
         def examples_with_only_context(node)
           shared_example(node) { yield if context?(node) && !examples?(node) }
         end
-
-        def add_shared_item_offense(node, message)
-          add_offense(
-            node,
-            message: message
-          )
-        end
       end
     end
   end

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

@@ -20,7 +20,9 @@ module RuboCop
       #   shared_examples_for 'foo bar baz'
       #   include_examples 'foo bar baz'
       #
-      class SharedExamples < Cop
+      class SharedExamples < Base
+        extend AutoCorrector
+
         def_node_matcher :shared_examples,
                          (SharedGroups::ALL + Includes::ALL).send_pattern
 
@@ -30,14 +32,9 @@ module RuboCop
             next unless ast_node&.sym_type?
 
             checker = Checker.new(ast_node)
-            add_offense(checker.node, message: checker.message)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            checker = Checker.new(node)
-            corrector.replace(node.loc.expression, checker.preferred_style)
+            add_offense(checker.node, message: checker.message) do |corrector|
+              corrector.replace(checker.node, checker.preferred_style)
+            end
           end
         end
 
@@ -47,6 +44,7 @@ module RuboCop
                 'to titleize shared examples.'
 
           attr_reader :node
+
           def initialize(node)
             @node = node
           end

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

@@ -16,7 +16,9 @@ module RuboCop
       #   allow(foo).to receive(:bar, :baz)
       #   allow(foo).to receive("bar.baz")
       #
-      class SingleArgumentMessageChain < Cop
+      class SingleArgumentMessageChain < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<recommended>s` instead of calling '\
               '`%<called>s` with a single argument.'
 
@@ -30,22 +32,23 @@ module RuboCop
           message_chain(node) do |arg|
             return if valid_usage?(arg)
 
-            add_offense(node, location: :selector)
-          end
-        end
+            method = node.method_name
+            msg = format(MSG, recommended: replacement(method), called: method)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, replacement(node.method_name))
-            message_chain(node) do |arg|
-              autocorrect_hash_arg(corrector, arg) if single_key_hash?(arg)
-              autocorrect_array_arg(corrector, arg) if arg.array_type?
+            add_offense(node.loc.selector, message: msg) do |corrector|
+              autocorrect(corrector, node, method, arg)
             end
           end
         end
 
         private
 
+        def autocorrect(corrector, node, method, arg)
+          corrector.replace(node.loc.selector, replacement(method))
+          autocorrect_hash_arg(corrector, arg) if single_key_hash?(arg)
+          autocorrect_array_arg(corrector, arg) if arg.array_type?
+        end
+
         def valid_usage?(node)
           return true unless node.literal? || node.array_type?
 
@@ -63,7 +66,7 @@ module RuboCop
         def autocorrect_hash_arg(corrector, arg)
           key, value = *arg.children.first
 
-          corrector.replace(arg.loc.expression, key_to_arg(key))
+          corrector.replace(arg, key_to_arg(key))
           corrector.insert_after(arg.parent.loc.end,
                                  ".and_return(#{value.source})")
         end
@@ -71,7 +74,7 @@ module RuboCop
         def autocorrect_array_arg(corrector, arg)
           value = arg.children.first
 
-          corrector.replace(arg.loc.expression, value.source)
+          corrector.replace(arg, value.source)
         end
 
         def key_to_arg(node)
@@ -82,12 +85,6 @@ module RuboCop
         def replacement(method)
           method.equal?(:receive_message_chain) ? 'receive' : 'stub'
         end
-
-        def message(node)
-          method = node.method_name
-
-          format(MSG, recommended: replacement(method), called: method)
-        end
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module RuboCop
   module Cop
     module RSpec
@@ -19,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)
@@ -35,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
@@ -73,72 +77,40 @@ module RuboCop
             } ...)
         PATTERN
 
-        def on_block(node)
-          return unless example_group?(node)
+        def on_top_level_group(node)
+          @explicit_subjects = find_all_explicit_subjects(node)
 
-          find_subject_stub(node) do |stub|
+          find_subject_expectations(node) do |stub|
             add_offense(stub)
           end
         end
 
         private
 
-        # Find subjects within tree and then find (send) nodes for that subject
-        #
-        # @param node [RuboCop::Node] example group
-        #
-        # @yield [RuboCop::Node] message expectations for subject
-        def find_subject_stub(node, &block)
-          find_subject(node) do |subject_name, context|
-            find_subject_expectation(context, subject_name, &block)
-          end
-        end
-
-        # Find a subject message expectation
-        #
-        # @param node [RuboCop::Node]
-        # @param subject_name [Symbol] name of subject
-        #
-        # @yield [RuboCop::Node] message expectation
-        def find_subject_expectation(node, subject_name, &block)
-          # Do not search node if it is an example group with its own subject.
-          return if example_group?(node) && redefines_subject?(node)
-
-          # Yield the current node if it is a message expectation.
-          yield(node) if message_expectation?(node, subject_name)
+        def find_all_explicit_subjects(node)
+          node.each_descendant(:block).with_object({}) do |child, h|
+            name = subject(child)
+            next unless name
 
-          # Recurse through node's children looking for a message expectation.
-          node.each_child_node do |child|
-            find_subject_expectation(child, subject_name, &block)
-          end
-        end
+            outer_example_group = child.each_ancestor.find do |a|
+              example_group?(a)
+            end
 
-        # Check if node's children contain a subject definition
-        #
-        # @param node [RuboCop::Node]
-        #
-        # @return [Boolean]
-        def redefines_subject?(node)
-          node.each_child_node.any? do |child|
-            subject(child) || redefines_subject?(child)
+            h[outer_example_group] ||= []
+            h[outer_example_group] << name
           end
         end
 
-        # Find a subject definition
-        #
-        # @param node [RuboCop::Node]
-        # @param parent [RuboCop::Node,nil]
-        #
-        # @yieldparam subject_name [Symbol] name of subject being defined
-        # @yieldparam parent [RuboCop::Node] parent of subject definition
-        def find_subject(node, parent: nil, &block)
-          # An implicit subject is defined by RSpec when no subject is declared
-          subject_name = subject(node) || :subject
+        def find_subject_expectations(node, subject_names = [], &block)
+          subject_names = @explicit_subjects[node] if @explicit_subjects[node]
 
-          yield(subject_name, parent) if parent
+          expectation_detected = (subject_names + [:subject]).any? do |name|
+            message_expectation?(node, name)
+          end
+          return yield(node) if expectation_detected
 
           node.each_child_node do |child|
-            find_subject(child, parent: node, &block)
+            find_subject_expectations(child, subject_names, &block)
           end
         end
       end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that memoized helpers names are symbols or strings.
+      #
+      # @example EnforcedStyle: symbols (default)
+      #   # bad
+      #   subject('user') { create_user }
+      #   let('user_name') { 'Adam' }
+      #
+      #   # good
+      #   subject(:user) { create_user }
+      #   let(:user_name) { 'Adam' }
+      #
+      # @example EnforcedStyle: strings
+      #   # bad
+      #   subject(:user) { create_user }
+      #   let(:user_name) { 'Adam' }
+      #
+      #   # good
+      #   subject('user') { create_user }
+      #   let('user_name') { 'Adam' }
+      class VariableDefinition < Base
+        include ConfigurableEnforcedStyle
+        include RuboCop::RSpec::Variable
+
+        MSG = 'Use %<style>s for variable names.'
+
+        def on_send(node)
+          variable_definition?(node) do |variable|
+            if style_violation?(variable)
+              add_offense(variable, message: format(MSG, style: style))
+            end
+          end
+        end
+
+        private
+
+        def style_violation?(variable)
+          style == :symbols && string?(variable) ||
+            style == :strings && symbol?(variable)
+        end
+
+        def string?(node)
+          node.str_type?
+        end
+
+        def symbol?(node)
+          node.sym_type? || node.dsym_type?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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
+      #   subject(:userName1) { 'Adam' }
+      #   let(:userName2) { 'Adam' }
+      #
+      #   # good
+      #   subject(:user_name_1) { 'Adam' }
+      #   let(:user_name_2) { 'Adam' }
+      #
+      # @example EnforcedStyle: camelCase
+      #   # bad
+      #   subject(:user_name_1) { 'Adam' }
+      #   let(:user_name_2) { 'Adam' }
+      #
+      #   # good
+      #   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.'
+
+        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
+        end
+
+        private
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end