rubocop-rspec 1.38.0 → 1.42.0

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/yield.rb

@@ -12,6 +12,7 @@ module RuboCop
       #   # good
       #   expect(foo).to be(:bar).and_yield(1)
       class Yield < Cop
+        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

@@ -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'
@@ -84,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/blank_line_separation.rb

@@ -32,14 +32,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/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 $_)'
 

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::Node] node to recursively search
       #
-      # @return [Array<RuboCop::Node>] discovered example nodes
-      def find_examples(node)
-        return [] if scope_change?(node)
+      # @return [Array<RuboCop::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

@@ -28,6 +28,14 @@ module RuboCop
           "(block #{send_pattern} ...)"
         end
 
+        def block_pass_pattern
+          "(send #{RSPEC} #{node_pattern_union} _ block_pass)"
+        end
+
+        def block_or_block_pass_pattern
+          "{#{block_pattern} #{block_pass_pattern}}"
+        end
+
         def send_pattern
           "(send #{RSPEC} #{node_pattern_union} ...)"
         end

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

@@ -8,6 +8,10 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
 
         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?])
@@ -17,7 +21,7 @@ module RuboCop
 
         def_node_matcher :hook?, Hooks::ALL.block_pattern
 
-        def_node_matcher :let?, Helpers::ALL.block_pattern
+        def_node_matcher :let?, Helpers::ALL.block_or_block_pass_pattern
 
         def_node_matcher :subject?, Subject::ALL.block_pattern
       end

data/lib/rubocop/rspec/top_level_group.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Helper methods for top level example group cops
+    module TopLevelGroup
+      extend RuboCop::NodePattern::Macros
+      include RuboCop::RSpec::Language
+
+      def_node_matcher :example_or_shared_group?,
+                       (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
+
+      def on_block(node)
+        return unless respond_to?(:on_top_level_group)
+        return unless top_level_group?(node)
+
+        on_top_level_group(node)
+      end
+
+      private
+
+      def top_level_group?(node)
+        top_level_groups.include?(node)
+      end
+
+      def top_level_groups
+        @top_level_groups ||=
+          top_level_nodes.select { |n| example_or_shared_group?(n) }
+      end
+
+      def top_level_nodes
+        if root_node.begin_type?
+          root_node.children
+        else
+          [root_node]
+        end
+      end
+
+      def root_node
+        processed_source.ast
+      end
+    end
+  end
+end