rubocop-rspec 2.16.0 → 2.24.1

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that spec file paths are consistent and well-formed.
+      #
+      # @example
+      #   # bad
+      #   whatever_spec.rb         # describe MyClass
+      #   my_class_spec.rb         # describe MyClass, '#method'
+      #
+      #   # good
+      #   my_class_spec.rb         # describe MyClass
+      #   my_class_method_spec.rb  # describe MyClass, '#method'
+      #   my_class/method_spec.rb  # describe MyClass, '#method'
+      #
+      # @example `CustomTransform: {RuboCop=>rubocop, RSpec=>rspec}` (default)
+      #   # good
+      #   rubocop_spec.rb          # describe RuboCop
+      #   rspec_spec.rb            # describe RSpec
+      #
+      # @example `IgnoreMethods: false` (default)
+      #   # bad
+      #   my_class_spec.rb         # describe MyClass, '#method'
+      #
+      # @example `IgnoreMethods: true`
+      #   # good
+      #   my_class_spec.rb         # describe MyClass, '#method'
+      #
+      # @example `IgnoreMetadata: {type=>routing}` (default)
+      #   # good
+      #   whatever_spec.rb         # describe MyClass, type: :routing do; end
+      #
+      class SpecFilePathFormat < Base
+        include TopLevelGroup
+        include Namespace
+        include FileHelp
+
+        MSG = 'Spec path should end with `%<suffix>s`.'
+
+        # @!method example_group_arguments(node)
+        def_node_matcher :example_group_arguments, <<~PATTERN
+          (block (send #rspec? #ExampleGroups.all $_ $...) ...)
+        PATTERN
+
+        # @!method metadata_key_value(node)
+        def_node_search :metadata_key_value, '(pair (sym $_key) (sym $_value))'
+
+        def on_top_level_example_group(node)
+          return unless top_level_groups.one?
+
+          example_group_arguments(node) do |class_name, arguments|
+            next if !class_name.const_type? || ignore_metadata?(arguments)
+
+            ensure_correct_file_path(class_name, arguments)
+          end
+        end
+
+        private
+
+        def ensure_correct_file_path(class_name, arguments)
+          pattern = correct_path_pattern(class_name, arguments)
+          return if filename_ends_with?(pattern)
+
+          # For the suffix shown in the offense message, modify the regular
+          # expression pattern to resemble a glob pattern for clearer error
+          # messages.
+          suffix = pattern.sub('.*', '*').sub('[^/]*', '*').sub('\.', '.')
+          add_global_offense(format(MSG, suffix: suffix))
+        end
+
+        def ignore_metadata?(arguments)
+          arguments.any? do |argument|
+            metadata_key_value(argument).any? do |key, value|
+              ignore_metadata.values_at(key.to_s).include?(value.to_s)
+            end
+          end
+        end
+
+        def correct_path_pattern(class_name, arguments)
+          path = [expected_path(class_name)]
+          path << '.*' unless ignore?(arguments.first)
+          path << [name_pattern(arguments.first), '[^/]*_spec\.rb']
+          path.join
+        end
+
+        def name_pattern(method_name)
+          return if ignore?(method_name)
+
+          method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')
+        end
+
+        def ignore?(method_name)
+          !method_name&.str_type? || ignore_methods?
+        end
+
+        def expected_path(constant)
+          constants = namespace(constant) + constant.const_name.split('::')
+
+          File.join(
+            constants.map do |name|
+              custom_transform.fetch(name) { camel_to_snake_case(name) }
+            end
+          )
+        end
+
+        def camel_to_snake_case(string)
+          string
+            .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
+            .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
+            .downcase
+        end
+
+        def custom_transform
+          cop_config.fetch('CustomTransform', {})
+        end
+
+        def ignore_methods?
+          cop_config['IgnoreMethods']
+        end
+
+        def ignore_metadata
+          cop_config.fetch('IgnoreMetadata', {})
+        end
+
+        def filename_ends_with?(pattern)
+          expanded_file_path.match?("#{pattern}$")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that spec file paths suffix are consistent and well-formed.
+      #
+      # @example
+      #   # bad
+      #   my_class/foo_specorb.rb   # describe MyClass
+      #   spec/models/user.rb       # describe User
+      #   spec/models/user_specxrb  # describe User
+      #
+      #   # good
+      #   my_class_spec.rb          # describe MyClass
+      #
+      #   # good - shared examples are allowed
+      #   spec/models/user.rb       # shared_examples_for 'foo'
+      #
+      class SpecFilePathSuffix < Base
+        include TopLevelGroup
+        include FileHelp
+
+        MSG = 'Spec path should end with `_spec.rb`.'
+
+        def on_top_level_example_group(node)
+          example_group?(node) do
+            add_global_offense(MSG) unless correct_path?
+          end
+        end
+
+        private
+
+        def correct_path?
+          expanded_file_path.end_with?('_spec.rb')
+        end
+      end
+    end
+  end
+end

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

@@ -91,7 +91,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @yield [RuboCop::AST::Node] matcher
         def_node_matcher :matcher_with_return_block, <<~PATTERN
-          (block #message_expectation? args _)  # receive(:foo) { 'bar' }
+          (block #message_expectation? (args) _)  # receive(:foo) { 'bar' }
         PATTERN
 
         # @!method matcher_with_hash(node)

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

@@ -12,7 +12,6 @@ module RuboCop
       #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
       # @see https://penelope.zone/2015/12/27/introducing-rspec-smells-and-where-to-find-them.html#smell-1-stubjec
-      # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
       #
       # @example
       #   # bad

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

@@ -27,12 +27,15 @@ module RuboCop
         extend AutoCorrector
         include ConfigurableEnforcedStyle
         include Variable
+        include InsideExampleGroup
 
         MSG = 'Use %<style>s for variable names.'
 
         def on_send(node)
+          return unless inside_example_group?(node)
+
           variable_definition?(node) do |variable|
-            next unless style_violation?(variable)
+            next unless style_offense?(variable)
 
             add_offense(
               variable,
@@ -56,7 +59,7 @@ module RuboCop
           end
         end
 
-        def style_violation?(variable)
+        def style_offense?(variable)
           style == :symbols && string?(variable) ||
             style == :strings && symbol?(variable)
         end

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

@@ -42,15 +42,18 @@ module RuboCop
         include ConfigurableNaming
         include AllowedPattern
         include Variable
+        include InsideExampleGroup
 
         MSG = 'Use %<style>s for variable names.'
 
         def on_send(node)
+          return unless inside_example_group?(node)
+
           variable_definition?(node) do |variable|
             return if variable.dstr_type? || variable.dsym_type?
             return if matches_allowed_pattern?(variable.value)
 
-            check_name(node, variable.value, variable.loc.expression)
+            check_name(node, variable.value, variable.source_range)
           end
         end
 

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

@@ -7,7 +7,7 @@ module RuboCop
       #
       # Only investigates references that are one of the supported styles.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+      # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.
@@ -76,11 +76,11 @@ module RuboCop
             break correct_style_detected unless opposing_style?(class_reference)
 
             message = format(MSG, style: style)
-            expression = class_reference.loc.expression
+            expression = class_reference.source_range
 
             add_offense(expression, message: message) do |corrector|
-              violation = class_reference.children.last.to_s
-              corrector.replace(expression, correct_style(violation))
+              offense = class_reference.source
+              corrector.replace(expression, correct_style(offense))
 
               opposite_style_detected
             end
@@ -98,11 +98,11 @@ module RuboCop
           class_reference_style != style
         end
 
-        def correct_style(violation)
+        def correct_style(offense)
           if style == :string
-            "'#{violation}'"
+            "'#{offense}'"
           else
-            violation
+            offense.gsub(/^['"]|['"]$/, '')
           end
         end
       end

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

@@ -5,7 +5,7 @@ module RuboCop
     module RSpec
       # Prefer using verifying doubles over normal doubles.
       #
-      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
+      # @see https://rspec.info/features/3-12/rspec-mocks/verifying-doubles
       #
       # @example
       #   # bad

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

@@ -51,7 +51,8 @@ module RuboCop
           parent = expect.parent
           return true unless parent
           return true if parent.begin_type?
-          return true if parent.block_type? && parent.body == expect
+
+          true if parent.block_type? && parent.body == expect
         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/match_style'
 require_relative 'rspec/capybara/negation_matcher'
 require_relative 'rspec/capybara/specific_actions'
 require_relative 'rspec/capybara/specific_finders'
@@ -17,24 +18,29 @@ require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
 require_relative 'rspec/rails/have_http_status'
+require_relative 'rspec/rails/negation_be_valid'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
   # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
 end
 require_relative 'rspec/rails/inferred_spec_type'
+require_relative 'rspec/rails/minitest_assertions'
+require_relative 'rspec/rails/travel_around'
 
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'
 require_relative 'rspec/around_block'
 require_relative 'rspec/be'
+require_relative 'rspec/be_empty'
 require_relative 'rspec/be_eq'
 require_relative 'rspec/be_eql'
 require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/change_by_zero'
 require_relative 'rspec/class_check'
+require_relative 'rspec/contain_exactly'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'
 require_relative 'rspec/describe_class'
@@ -51,6 +57,8 @@ require_relative 'rspec/empty_line_after_example_group'
 require_relative 'rspec/empty_line_after_final_let'
 require_relative 'rspec/empty_line_after_hook'
 require_relative 'rspec/empty_line_after_subject'
+require_relative 'rspec/empty_metadata'
+require_relative 'rspec/eq'
 require_relative 'rspec/example_length'
 require_relative 'rspec/example_without_description'
 require_relative 'rspec/example_wording'
@@ -67,6 +75,7 @@ require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'
+require_relative 'rspec/indexed_let'
 require_relative 'rspec/instance_spy'
 require_relative 'rspec/instance_variable'
 require_relative 'rspec/it_behaves_like'
@@ -75,9 +84,11 @@ require_relative 'rspec/leading_subject'
 require_relative 'rspec/leaky_constant_declaration'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
+require_relative 'rspec/match_array'
 require_relative 'rspec/message_chain'
 require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'
+require_relative 'rspec/metadata_style'
 require_relative 'rspec/missing_example_group_argument'
 require_relative 'rspec/multiple_describes'
 require_relative 'rspec/multiple_expectations'
@@ -92,7 +103,9 @@ require_relative 'rspec/pending'
 require_relative 'rspec/pending_without_reason'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
+require_relative 'rspec/receive_messages'
 require_relative 'rspec/receive_never'
+require_relative 'rspec/redundant_around'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
 require_relative 'rspec/repeated_example_group_body'
@@ -104,7 +117,10 @@ require_relative 'rspec/scattered_setup'
 require_relative 'rspec/shared_context'
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
+require_relative 'rspec/skip_block_inside_example'
 require_relative 'rspec/sort_metadata'
+require_relative 'rspec/spec_file_path_format'
+require_relative 'rspec/spec_file_path_suffix'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'

data/lib/rubocop/rspec/config_formatter.rb

@@ -8,6 +8,21 @@ module RuboCop
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
+      EXTRACTED_COPS = %(
+        RSpec/Capybara/CurrentPathExpectation
+        RSpec/Capybara/MatchStyle
+        RSpec/Capybara/NegationMatcher
+        RSpec/Capybara/SpecificActions
+        RSpec/Capybara/SpecificFinders
+        RSpec/Capybara/SpecificMatcher
+        RSpec/Capybara/VisibilityMatcher
+        RSpec/FactoryBot/AttributeDefinedStatically
+        RSpec/FactoryBot/ConsistentParenthesesStyle
+        RSpec/FactoryBot/CreateList
+        RSpec/FactoryBot/FactoryClassName
+        RSpec/FactoryBot/FactoryNameStyle
+        RSpec/FactoryBot/SyntaxMethods
+      )
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
@@ -29,6 +44,7 @@ module RuboCop
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
           next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
+          next if EXTRACTED_COPS.include?(cop)
 
           replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))

data/lib/rubocop/rspec/example_group.rb

@@ -10,14 +10,12 @@ module RuboCop
       #
       #   Selectors which indicate that we should stop searching
       #
-      def_node_matcher :scope_change?,
-                       block_pattern(<<~PATTERN)
-                         {
-                           #SharedGroups.all
-                           #ExampleGroups.all
-                           #Includes.all
-                         }
-                       PATTERN
+      def_node_matcher :scope_change?, <<~PATTERN
+        (block {
+          (send #rspec? {#SharedGroups.all #ExampleGroups.all} ...)
+          (send nil? #Includes.all ...)
+        } ...)
+      PATTERN
 
       def lets
         find_all_in_scope(node, :let?)

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

@@ -4,18 +4,44 @@ module RuboCop
   module RSpec
     module Language
       # Helper methods to detect RSpec DSL used with send and block
+      # @deprecated Prefer using Node Pattern directly
+      #   Use `'(block (send nil? #Example.all ...) ...)'` instead of
+      #   `block_pattern('#Example.all')`
       module NodePattern
+        # @deprecated Prefer using Node Pattern directly
         def send_pattern(string)
+          deprecation_warning __method__
           "(send #rspec? #{string} ...)"
         end
 
+        # @deprecated Prefer using Node Pattern directly
         def block_pattern(string)
+          deprecation_warning __method__
           "(block #{send_pattern(string)} ...)"
         end
 
+        # @deprecated Prefer using Node Pattern directly
         def numblock_pattern(string)
+          deprecation_warning __method__
           "(numblock #{send_pattern(string)} ...)"
         end
+
+        # @deprecated Prefer using Node Pattern directly
+        def block_or_numblock_pattern(string)
+          deprecation_warning __method__
+          "{#{block_pattern(string)} #{numblock_pattern(string)}}"
+        end
+
+        private
+
+        def deprecation_warning(method)
+          # Only warn in derived extensions' specs
+          return unless defined?(::RSpec)
+
+          Kernel.warn <<~MESSAGE, uplevel: 2
+            Usage of #{method} is deprecated. Use node pattern explicitly.
+          MESSAGE
+        end
       end
     end
   end

data/lib/rubocop/rspec/language.rb

@@ -20,52 +20,61 @@ module RuboCop
       end
 
       # @!method rspec?(node)
-      def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
+      def_node_matcher :rspec?, '{#explicit_rspec? nil?}'
+
+      # @!method explicit_rspec?(node)
+      def_node_matcher :explicit_rspec?, '(const {nil? cbase} :RSpec)'
 
       # @!method example_group?(node)
-      def_node_matcher :example_group?, block_pattern('#ExampleGroups.all')
+      def_node_matcher :example_group?, <<~PATTERN
+        ({block numblock} (send #rspec? #ExampleGroups.all ...) ...)
+      PATTERN
 
       # @!method shared_group?(node)
-      def_node_matcher :shared_group?, block_pattern('#SharedGroups.all')
+      def_node_matcher :shared_group?,
+                       '(block (send #rspec? #SharedGroups.all ...) ...)'
 
       # @!method spec_group?(node)
-      def_node_matcher :spec_group?,
-                       block_pattern('{#SharedGroups.all #ExampleGroups.all}')
+      def_node_matcher :spec_group?, <<~PATTERN
+        ({block numblock} (send #rspec?
+             {#SharedGroups.all #ExampleGroups.all}
+          ...) ...)
+      PATTERN
 
       # @!method example_group_with_body?(node)
       def_node_matcher :example_group_with_body?, <<-PATTERN
-        (block #{send_pattern('#ExampleGroups.all')} args !nil?)
+        (block (send #rspec? #ExampleGroups.all ...) args !nil?)
       PATTERN
 
       # @!method example?(node)
-      def_node_matcher :example?, block_pattern('#Examples.all')
+      def_node_matcher :example?, '(block (send nil? #Examples.all ...) ...)'
 
       # @!method hook?(node)
       def_node_matcher :hook?, <<-PATTERN
-        {
-          #{block_pattern('#Hooks.all')}
-          #{numblock_pattern('#Hooks.all')}
-        }
+      {
+        (numblock (send nil? #Hooks.all ...) ...)
+        (block (send nil? #Hooks.all ...) ...)
+      }
       PATTERN
 
       # @!method let?(node)
       def_node_matcher :let?, <<-PATTERN
         {
-          #{block_pattern('#Helpers.all')}
-          (send #rspec? #Helpers.all _ block_pass)
+          (block (send nil? #Helpers.all ...) ...)
+          (send nil? #Helpers.all _ block_pass)
         }
       PATTERN
 
       # @!method include?(node)
       def_node_matcher :include?, <<-PATTERN
         {
-          #{send_pattern('#Includes.all')}
-          #{block_pattern('#Includes.all')}
+          (block (send nil? #Includes.all ...) ...)
+          (send nil? #Includes.all ...)
         }
       PATTERN
 
       # @!method subject?(node)
-      def_node_matcher :subject?, block_pattern('#Subjects.all')
+      def_node_matcher :subject?, '(block (send nil? #Subjects.all ...) ...)'
 
       module ExampleGroups # :nodoc:
         class << self

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '2.16.0'
+      STRING = '2.24.1'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -4,6 +4,8 @@ require 'pathname'
 require 'yaml'
 
 require 'rubocop'
+require 'rubocop-capybara'
+require 'rubocop-factory_bot'
 
 require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/inject'
@@ -15,12 +17,10 @@ require_relative 'rubocop/rspec/wording'
 # Dependent on `RuboCop::RSpec::Language::NodePattern`.
 require_relative 'rubocop/rspec/language'
 
-require_relative 'rubocop/rspec/factory_bot/language'
-
-require_relative 'rubocop/cop/rspec/mixin/capybara_help'
-require_relative 'rubocop/cop/rspec/mixin/css_selector'
+require_relative 'rubocop/cop/rspec/mixin/file_help'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
+require_relative 'rubocop/cop/rspec/mixin/location_help'
 require_relative 'rubocop/cop/rspec/mixin/metadata'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
 require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
@@ -37,7 +37,6 @@ require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/corrector/move_node'
 require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
-require_relative 'rubocop/rspec/factory_bot'
 require_relative 'rubocop/rspec/hook'
 
 RuboCop::RSpec::Inject.defaults!