rubocop-rspec 1.37.1 → 1.41.0

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

@@ -40,20 +40,21 @@ module RuboCop
         MSG_BLOCK = 'Use block for static values.'
 
         def_node_search :contains_stub?, '(send nil? :receive (...))'
+        def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'
         def_node_search :and_return_value, <<-PATTERN
           $(send _ :and_return $(...))
         PATTERN
 
         def on_send(node)
-          return unless contains_stub?(node)
           return unless style == :block
+          return unless contains_stub?(node)
 
           check_and_return_call(node)
         end
 
         def on_block(node)
-          return unless contains_stub?(node)
           return unless style == :and_return
+          return unless stub_with_block?(node)
 
           check_block_body(node)
         end

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

@@ -35,6 +35,15 @@ module RuboCop
           check_let_declarations(node.body)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            first_let = find_first_let(node.parent)
+            RuboCop::RSpec::Corrector::MoveNode.new(
+              node, corrector, processed_source
+            ).move_after(first_let)
+          end
+        end
+
         private
 
         def check_let_declarations(body)
@@ -47,6 +56,10 @@ module RuboCop
             add_offense(node)
           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

@@ -23,25 +23,43 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Cop
-        MSG = 'Do not define multiple hooks in the same example group.'
+        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
+              'example group (also defined on %<lines>s).'
 
         def on_block(node)
           return unless example_group?(node)
 
-          analyzable_hooks(node).each do |repeated_hook|
-            add_offense(repeated_hook)
+          repeated_hooks(node).each do |occurrences|
+            lines = occurrences.map(&:first_line)
+
+            occurrences.each do |occurrence|
+              lines_except_current = lines - [occurrence.first_line]
+              message = format(MSG, hook_name: occurrences.first.method_name,
+                               lines: lines_msg(lines_except_current))
+              add_offense(occurrence, message: message)
+            end
           end
         end
 
-        def analyzable_hooks(node)
-          RuboCop::RSpec::ExampleGroup.new(node)
+        def repeated_hooks(node)
+          hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks
-            .select { |hook| hook.knowable_scope? && hook.valid_scope? }
-            .group_by { |hook| [hook.name, hook.scope] }
+            .select(&:knowable_scope?)
+            .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
             .reject(&:one?)
-            .flatten
-            .map(&:to_node)
+
+          hooks.map do |hook|
+            hook.map(&:to_node)
+          end
+        end
+
+        def lines_msg(numbers)
+          if numbers.size == 1
+            "line #{numbers.first}"
+          else
+            "lines #{numbers.join(', ')}"
+          end
         end
       end
     end

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

@@ -47,6 +47,7 @@ module RuboCop
                 'to titleize shared examples.'
 
           attr_reader :node
+
           def initialize(node)
             @node = node
           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
@@ -20,6 +22,8 @@ module RuboCop
       #   end
       #
       class SubjectStub < Cop
+        include RuboCop::RSpec::TopLevelGroup
+
         MSG = 'Do not stub methods of the object under test.'
 
         # @!method subject(node)
@@ -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/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
+      #   let('user_name') { 'Adam' }
+      #   subject('user') { create_user }
+      #
+      #   # good
+      #   let(:user_name) { 'Adam' }
+      #   subject(:user) { create_user }
+      #
+      # @example EnforcedStyle: strings
+      #   # bad
+      #   let(:user_name) { 'Adam' }
+      #   subject(:user) { create_user }
+      #
+      #   # good
+      #   let('user_name') { 'Adam' }
+      #   subject('user') { create_user }
+      class VariableDefinition < Cop
+        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? || node.dstr_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,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that memoized helper names use the configured style.
+      #
+      # @example EnforcedStyle: snake_case (default)
+      #   # bad
+      #   let(:userName) { 'Adam' }
+      #   subject(:userName) { 'Adam' }
+      #
+      #   # good
+      #   let(:user_name) { 'Adam' }
+      #   subject(:user_name) { 'Adam' }
+      #
+      # @example EnforcedStyle: camelCase
+      #   # bad
+      #   let(:user_name) { 'Adam' }
+      #   subject(:user_name) { 'Adam' }
+      #
+      #   # good
+      #   let(:userName) { 'Adam' }
+      #   subject(:userName) { 'Adam' }
+      class VariableName < Cop
+        include ConfigurableNaming
+        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?
+
+            check_name(node, variable.value, variable.loc.expression)
+          end
+        end
+
+        private
+
+        def message(style)
+          format(MSG, style: style)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -2,6 +2,7 @@
 
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
+require_relative 'rspec/capybara/visibility_matcher'
 
 require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
@@ -9,7 +10,7 @@ require_relative 'rspec/factory_bot/factory_class_name'
 
 begin
   require_relative 'rspec/rails/http_status'
-rescue LoadError # rubocop:disable Lint/SuppressedException
+rescue LoadError
   # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
 end
 
@@ -29,6 +30,7 @@ require_relative 'rspec/described_class'
 require_relative 'rspec/described_class_module_wrapping'
 require_relative 'rspec/dialect'
 require_relative 'rspec/empty_example_group'
+require_relative 'rspec/empty_hook'
 require_relative 'rspec/empty_line_after_example'
 require_relative 'rspec/empty_line_after_example_group'
 require_relative 'rspec/empty_line_after_final_let'
@@ -74,6 +76,8 @@ require_relative 'rspec/receive_counts'
 require_relative 'rspec/receive_never'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
+require_relative 'rspec/repeated_example_group_body'
+require_relative 'rspec/repeated_example_group_description'
 require_relative 'rspec/return_from_stub'
 require_relative 'rspec/scattered_let'
 require_relative 'rspec/scattered_setup'
@@ -82,6 +86,8 @@ require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
 require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
+require_relative 'rspec/variable_definition'
+require_relative 'rspec/variable_name'
 require_relative 'rspec/verified_doubles'
 require_relative 'rspec/void_expect'
 require_relative 'rspec/yield'

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Corrector
+      # Helper methods to move a node
+      class MoveNode
+        include RuboCop::Cop::RangeHelp
+        include RuboCop::RSpec::FinalEndLocation
+
+        attr_reader :original, :corrector, :processed_source
+
+        def initialize(node, corrector, processed_source)
+          @original = node
+          @corrector = corrector
+          @processed_source = processed_source # used by RangeHelp
+        end
+
+        def move_before(other) # rubocop:disable Metrics/AbcSize
+          position = other.loc.expression
+          indent = "\n" + ' ' * other.loc.column
+
+          corrector.insert_before(position, source(original) + indent)
+          corrector.remove(node_range_with_surrounding_space(original))
+        end
+
+        def move_after(other)
+          position = final_end_location(other)
+          indent = "\n" + ' ' * other.loc.column
+
+          corrector.insert_after(position, indent + source(original))
+          corrector.remove(node_range_with_surrounding_space(original))
+        end
+
+        private
+
+        def source(node)
+          node_range(node).source
+        end
+
+        def node_range(node)
+          node.loc.expression.with(end_pos: final_end_location(node).end_pos)
+        end
+
+        def node_range_with_surrounding_space(node)
+          range = node_range(node)
+          range_by_whole_lines(range, include_final_newline: true)
+        end
+      end
+    end
+  end
+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_NAMES = %w[RuboCop::Cop RuboCop::Cop::RSpec::Cop].freeze
+        COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Cop'
         RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'
 
         def initialize(yardoc)
@@ -68,11 +68,7 @@ module RuboCop
         end
 
         def cop_subclass?
-          # YARD superclass resolution is a bit flaky: All classes loaded before
-          # RuboCop::Cop::WorkaroundCop are shown as having RuboCop::Cop as
-          # superclass, while all the following classes are listed as having
-          # RuboCop::Cop::RSpec::Cop as their superclass.
-          COP_CLASS_NAMES.include?(yardoc.superclass.path)
+          yardoc.superclass.path == COP_CLASS_NAME
         end
 
         def abstract?

data/lib/rubocop/rspec/example.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec examples
     class Example < Concept
-      def_node_matcher :extract_doc_string,     '(send _ _ $str ...)'
+      def_node_matcher :extract_doc_string,     '(send _ _ $_ ...)'
       def_node_matcher :extract_metadata,       '(send _ _ _ $...)'
       def_node_matcher :extract_implementation, '(block send args $_)'