rubocop-rspec 2.16.0 → 2.24.1

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -4,52 +4,25 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Use string value when setting the class attribute explicitly.
-        #
-        # This cop would promote faster tests by lazy-loading of
-        # application files. Also, this could help you suppress potential bugs
-        # in combination with external libraries by avoiding a preload of
-        # application files from the factory files.
-        #
-        # @example
-        #   # bad
-        #   factory :foo, class: Foo do
-        #   end
-        #
-        #   # good
-        #   factory :foo, class: 'Foo' do
-        #   end
-        #
-        class FactoryClassName < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
-                'constant.'
-          ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
-          RESTRICT_ON_SEND = %i[factory].freeze
-
-          # @!method class_name(node)
-          def_node_matcher :class_name, <<~PATTERN
-            (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))
-          PATTERN
-
-          def on_send(node)
-            class_name(node) do |cn|
-              next if allowed?(cn.const_name)
-
-              msg = format(MSG, class_name: cn.const_name)
-              add_offense(cn, message: msg) do |corrector|
-                corrector.replace(cn, "'#{cn.source}'")
-              end
-            end
-          end
-
-          private
-
-          def allowed?(const_name)
-            ALLOWED_CONSTANTS.include?(const_name)
-          end
-        end
+        # @!parse
+        #   # Use string value when setting the class attribute explicitly.
+        #   #
+        #   # This cop would promote faster tests by lazy-loading of
+        #   # application files. Also, this could help you suppress potential
+        #   # bugs in combination with external libraries by avoiding a preload
+        #   # of application files from the factory files.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   factory :foo, class: Foo do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   factory :foo, class: 'Foo' do
+        #   #   end
+        #   #
+        #   class FactoryClassName < ::RuboCop::Cop::Base; end
+        FactoryClassName = ::RuboCop::Cop::FactoryBot::FactoryClassName
       end
     end
   end

data/lib/rubocop/cop/rspec/factory_bot/factory_name_style.rb

@@ -4,70 +4,29 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Checks for name style for argument of FactoryBot::Syntax::Methods.
-        #
-        # @example EnforcedStyle: symbol (default)
-        #   # bad
-        #   create('user')
-        #   build "user", username: "NAME"
-        #
-        #   # good
-        #   create(:user)
-        #   build :user, username: "NAME"
-        #
-        # @example EnforcedStyle: string
-        #   # bad
-        #   create(:user)
-        #   build :user, username: "NAME"
-        #
-        #   # good
-        #   create('user')
-        #   build "user", username: "NAME"
-        #
-        class FactoryNameStyle < ::RuboCop::Cop::Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-          include RuboCop::RSpec::FactoryBot::Language
-
-          MSG = 'Use %<prefer>s to refer to a factory.'
-          FACTORY_CALLS = RuboCop::RSpec::FactoryBot::Language::METHODS
-          RESTRICT_ON_SEND = FACTORY_CALLS
-
-          # @!method factory_call(node)
-          def_node_matcher :factory_call, <<-PATTERN
-          (send
-            {#factory_bot? nil?} %FACTORY_CALLS
-            ${str sym} ...
-          )
-          PATTERN
-
-          def on_send(node)
-            factory_call(node) do |name|
-              if offense_for_symbol_style?(name)
-                register_offense(name, name.value.to_sym.inspect)
-              elsif offense_for_string_style?(name)
-                register_offense(name, name.value.to_s.inspect)
-              end
-            end
-          end
-
-          private
-
-          def offense_for_symbol_style?(name)
-            name.str_type? && style == :symbol
-          end
-
-          def offense_for_string_style?(name)
-            name.sym_type? && style == :string
-          end
-
-          def register_offense(name, prefer)
-            add_offense(name,
-                        message: format(MSG, prefer: style.to_s)) do |corrector|
-              corrector.replace(name, prefer)
-            end
-          end
-        end
+        # @!parse
+        #   # Checks for name style for argument of FactoryBot::Syntax::Methods.
+        #   #
+        #   # @example EnforcedStyle: symbol (default)
+        #   #   # bad
+        #   #   create('user')
+        #   #   build "user", username: "NAME"
+        #   #
+        #   #   # good
+        #   #   create(:user)
+        #   #   build :user, username: "NAME"
+        #   #
+        #   # @example EnforcedStyle: string
+        #   #   # bad
+        #   #   create(:user)
+        #   #   build :user, username: "NAME"
+        #   #
+        #   #   # good
+        #   #   create('user')
+        #   #   build "user", username: "NAME"
+        #   #
+        #   class FactoryNameStyle < ::RuboCop::Cop::Base; end
+        FactoryNameStyle = ::RuboCop::Cop::FactoryBot::FactoryNameStyle
       end
     end
   end

data/lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb

@@ -4,85 +4,51 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
-        #
-        # @safety
-        #   The autocorrection is marked as unsafe because the cop
-        #   cannot verify whether you already include
-        #   `FactoryBot::Syntax::Methods` in your test suite.
-        #
-        #   If you're using Rails, add the following configuration to
-        #   `spec/support/factory_bot.rb` and be sure to require that file in
-        #   `rails_helper.rb`:
-        #
-        #   [source,ruby]
-        #   ----
-        #   RSpec.configure do |config|
-        #     config.include FactoryBot::Syntax::Methods
-        #   end
-        #   ----
-        #
-        #   If you're not using Rails:
-        #
-        #   [source,ruby]
-        #   ----
-        #   RSpec.configure do |config|
-        #     config.include FactoryBot::Syntax::Methods
-        #
-        #     config.before(:suite) do
-        #       FactoryBot.find_definitions
-        #     end
-        #   end
-        #   ----
-        #
-        # @example
-        #   # bad
-        #   FactoryBot.create(:bar)
-        #   FactoryBot.build(:bar)
-        #   FactoryBot.attributes_for(:bar)
-        #
-        #   # good
-        #   create(:bar)
-        #   build(:bar)
-        #   attributes_for(:bar)
-        #
-        class SyntaxMethods < Base
-          extend AutoCorrector
-          include InsideExampleGroup
-          include RangeHelp
-          include RuboCop::RSpec::FactoryBot::Language
-
-          MSG = 'Use `%<method>s` from `FactoryBot::Syntax::Methods`.'
-
-          RESTRICT_ON_SEND = RuboCop::RSpec::FactoryBot::Language::METHODS
-
-          def on_send(node)
-            return unless factory_bot?(node.receiver)
-            return unless inside_example_group?(node)
-
-            message = format(MSG, method: node.method_name)
-
-            add_offense(crime_scene(node), message: message) do |corrector|
-              corrector.remove(offense(node))
-            end
-          end
-
-          private
-
-          def crime_scene(node)
-            range_between(
-              node.loc.expression.begin_pos,
-              node.loc.selector.end_pos
-            )
-          end
-
-          def offense(node)
-            range_between(
-              node.loc.expression.begin_pos,
-              node.loc.selector.begin_pos
-            )
-          end
-        end
+        # @!parse
+        #   # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
+        #   #
+        #   # @safety
+        #   #   The autocorrection is marked as unsafe because the cop
+        #   #   cannot verify whether you already include
+        #   #   `FactoryBot::Syntax::Methods` in your test suite.
+        #   #
+        #   #   If you're using Rails, add the following configuration to
+        #   #   `spec/support/factory_bot.rb` and be sure to require that file
+        #   #   in `rails_helper.rb`:
+        #   #
+        #   #   [source,ruby]
+        #   #   ----
+        #   #   RSpec.configure do |config|
+        #   #     config.include FactoryBot::Syntax::Methods
+        #   #   end
+        #   #   ----
+        #   #
+        #   #   If you're not using Rails:
+        #   #
+        #   #   [source,ruby]
+        #   #   ----
+        #   #   RSpec.configure do |config|
+        #   #     config.include FactoryBot::Syntax::Methods
+        #   #
+        #   #     config.before(:suite) do
+        #   #       FactoryBot.find_definitions
+        #   #     end
+        #   #   end
+        #   #   ----
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   FactoryBot.create(:bar)
+        #   #   FactoryBot.build(:bar)
+        #   #   FactoryBot.attributes_for(:bar)
+        #   #
+        #   #   # good
+        #   #   create(:bar)
+        #   #   build(:bar)
+        #   #   attributes_for(:bar)
+        #   #
+        #   class SyntaxMethods < ::RuboCop::Cop::Base; end
+        SyntaxMethods = ::RuboCop::Cop::FactoryBot::SyntaxMethods
       end
     end
   end

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

@@ -5,8 +5,14 @@ module RuboCop
     module RSpec
       # Checks that spec file paths are consistent and well-formed.
       #
+      # This cop is deprecated.
+      # We plan to remove it in the next major version update to 3.0.
+      # The migration targets are `RSpec/SpecFilePathSuffix`
+      # and `RSpec/SpecFilePathFormat`.
+      # If you are using this cop, please plan for migration.
+      #
       # By default, this checks that spec file paths are consistent with the
-      # test subject and and enforces that it reflects the described
+      # test subject and enforces that it reflects the described
       # class/module and its optionally called out method.
       #
       # With the configuration option `IgnoreMethods` the called out method will
@@ -165,7 +171,7 @@ module RuboCop
         end
 
         def expanded_file_path
-          File.expand_path(processed_source.buffer.name)
+          File.expand_path(processed_source.file_path)
         end
       end
     end

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

@@ -34,6 +34,18 @@ module RuboCop
       #   # good
       #   describe 'test' do; end
       #
+      #   # bad
+      #   shared_examples 'test', focus: true do; end
+      #
+      #   # good
+      #   shared_examples 'test' do; end
+      #
+      #   # bad
+      #   shared_context 'test', focus: true do; end
+      #
+      #   # good
+      #   shared_context 'test' do; end
+      #
       #   # bad (does not support autocorrection)
       #   focus 'test' do; end
       #
@@ -51,6 +63,7 @@ module RuboCop
             #Examples.regular
             #Examples.skipped
             #Examples.pending
+            #SharedGroups.all
           }
         PATTERN
 
@@ -61,12 +74,13 @@ module RuboCop
         PATTERN
 
         # @!method focused_block?(node)
-        def_node_matcher :focused_block?,
-                         send_pattern(<<~PATTERN)
-                           {#ExampleGroups.focused #Examples.focused}
-                         PATTERN
+        def_node_matcher :focused_block?, <<~PATTERN
+          (send #rspec? {#ExampleGroups.focused #Examples.focused} ...)
+        PATTERN
 
         def on_send(node)
+          return if node.chained? || node.each_ancestor(:def, :defs).any?
+
           focus_metadata(node) do |focus|
             add_offense(focus) do |corrector|
               if focus.pair_type? || focus.str_type? || focus.sym_type?
@@ -88,7 +102,7 @@ module RuboCop
 
         def with_surrounding(focus)
           range_with_space =
-            range_with_surrounding_space(focus.loc.expression, side: :left)
+            range_with_surrounding_space(focus.source_range, side: :left)
 
           range_with_surrounding_comma(range_with_space, :left)
         end

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

@@ -83,8 +83,7 @@ module RuboCop
             style_detected(scope_name)
             msg = explicit_message(scope_name)
             add_offense(method_send, message: msg) do |corrector|
-              scope = implicit_style? ? '' : "(#{style.inspect})"
-              corrector.replace(argument_range(method_send), scope)
+              autocorrect(corrector, node, method_send)
             end
           end
         end
@@ -93,6 +92,13 @@ module RuboCop
 
         private
 
+        def autocorrect(corrector, _node, method_send)
+          scope = implicit_style? ? '' : "(#{style.inspect})"
+          corrector.replace(
+            LocationHelp.arguments_with_whitespace(method_send), scope
+          )
+        end
+
         def check_implicit(method_send)
           style_detected(:implicit)
           return if implicit_style?
@@ -100,7 +106,10 @@ module RuboCop
           msg = explicit_message(nil)
           add_offense(method_send.loc.selector, message: msg) do |corrector|
             scope = "(#{style.inspect})"
-            corrector.replace(argument_range(method_send), scope)
+            corrector.replace(
+              LocationHelp.arguments_with_whitespace(method_send),
+              scope
+            )
           end
         end
 
@@ -119,12 +128,6 @@ module RuboCop
         def hook(node, &block)
           scoped_hook(node, &block) || unscoped_hook(node, &block)
         end
-
-        def argument_range(send_node)
-          send_node.loc.selector.end.with(
-            end_pos: send_node.loc.expression.end_pos
-          )
-        end
       end
     end
   end

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

@@ -30,9 +30,11 @@ module RuboCop
         # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
-            #{block_pattern('{#ExampleGroups.all #Examples.all}')}
-            #{numblock_pattern('{#ExampleGroups.all #Examples.all}')}
-            #{send_pattern('#Includes.examples')}
+            ({block numblock} {
+              (send #rspec? #ExampleGroups.all ...)
+              (send nil? #Examples.all ...)
+            } ...)
+            (send nil? #Includes.examples ...)
           }
         PATTERN
 

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Do not set up test data using indexes (e.g., `item_1`, `item_2`).
+      #
+      # It makes reading the test harder because it's not clear what exactly
+      # is tested by this particular example.
+      #
+      # The configurable options `AllowedIdentifiers` and `AllowedPatterns`
+      # will also read those set in `Naming/VariableNumber`.
+      #
+      # @example `Max: 1 (default)`
+      #   # bad
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
+      #   let(:item1) { create(:item) }
+      #   let(:item2) { create(:item) }
+      #
+      #   # good
+      #
+      #   let(:visible_item) { create(:item, visible: true) }
+      #   let(:invisible_item) { create(:item, visible: false) }
+      #
+      # @example `Max: 2`
+      #   # bad
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #   let(:item_3) { create(:item) }
+      #
+      #   # good
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
+      # @example `AllowedIdentifiers: ['item_1', 'item_2']`
+      #   # good
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
+      # @example `AllowedPatterns: ['item']`
+      #   # good
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
+      class IndexedLet < Base
+        include AllowedIdentifiers
+        include AllowedPattern
+
+        MSG = 'This `let` statement uses index in its name. Please give it ' \
+              'a meaningful name.'
+
+        # @!method let_name(node)
+        def_node_matcher :let_name, <<~PATTERN
+          {
+            (block (send nil? #Helpers.all ({str sym} $_) ...) ...)
+            (send nil? #Helpers.all ({str sym} $_) block_pass)
+          }
+        PATTERN
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless spec_group?(node)
+
+          children = node.body&.child_nodes
+          return unless children
+
+          filter_indexed_lets(children).each do |let_node|
+            add_offense(let_node)
+          end
+        end
+
+        private
+
+        SUFFIX_INDEX_REGEX = /_?\d+$/.freeze
+        INDEX_REGEX = /\d+/.freeze
+
+        def filter_indexed_lets(candidates)
+          candidates
+            .filter { |node| indexed_let?(node) }
+            .group_by { |node| let_name_stripped_index(node) }
+            .values
+            .filter { |lets| lets.length > cop_config['Max'] }
+            .flatten
+        end
+
+        def indexed_let?(node)
+          let?(node) &&
+            SUFFIX_INDEX_REGEX.match?(let_name(node)) &&
+            !allowed_identifier?(let_name(node).to_s) &&
+            !matches_allowed_pattern?(let_name(node).to_s)
+        end
+
+        def let_name_stripped_index(node)
+          let_name(node).to_s.gsub(INDEX_REGEX, '')
+        end
+
+        def cop_config_patterns_values
+          Array(config.for_cop('Naming/VariableNumber')
+            .fetch('AllowedPatterns', [])) +
+            Array(cop_config.fetch('AllowedPatterns', []))
+        end
+
+        def allowed_identifiers
+          Array(config.for_cop('Naming/VariableNumber')
+            .fetch('AllowedIdentifiers', [])) +
+            Array(cop_config.fetch('AllowedIdentifiers', []))
+        end
+      end
+    end
+  end
+end

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

@@ -48,7 +48,7 @@ module RuboCop
       class InstanceVariable < Base
         include TopLevelGroup
 
-        MSG = 'Avoid instance variables – use let, ' \
+        MSG = 'Avoid instance variables - use let, ' \
               'a method call, or a local variable (if possible).'
 
         # @!method dynamic_class?(node)

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

@@ -17,7 +17,7 @@ module RuboCop
       # Anonymous classes are fine, since they don't result in global
       # namespace name clashes.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants
+      # @see https://rspec.info/features/3-12/rspec-mocks/mutating-constants
       #
       # @example Constants leak between examples
       #   # bad

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

@@ -38,19 +38,23 @@ module RuboCop
         # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
-            #{block_pattern('{#ExampleGroups.all #Examples.all}')}
-            #{send_pattern('#Includes.examples')}
+            (block (send nil? {#ExampleGroups.all #Examples.all} ...) ...)
+            (send nil? #Includes.examples ...)
           }
         PATTERN
 
         # @!method include_examples?(node)
         def_node_matcher :include_examples?, <<~PATTERN
           {
-            #{block_pattern(':include_examples')}
-            #{send_pattern(':include_examples')}
+            (block (send nil? :include_examples ...) ...)
+            (send nil? :include_examples ...)
           }
         PATTERN
 
+        def self.autocorrect_incompatible_with
+          [RSpec::ScatteredLet]
+        end
+
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 

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

@@ -29,14 +29,12 @@ module RuboCop
         MSG = 'Do not use `let!` to setup objects not referenced in tests.'
 
         # @!method example_or_shared_group_or_including?(node)
-        def_node_matcher :example_or_shared_group_or_including?,
-                         block_pattern(<<~PATTERN)
-                           {
-                             #SharedGroups.all
-                             #ExampleGroups.all
-                             #Includes.all
-                           }
-                         PATTERN
+        def_node_matcher :example_or_shared_group_or_including?, <<~PATTERN
+          (block {
+            (send #rspec? {#SharedGroups.all #ExampleGroups.all} ...)
+            (send nil? #Includes.all ...)
+          } ...)
+        PATTERN
 
         # @!method let_bang(node)
         def_node_matcher :let_bang, <<-PATTERN