rubocop-rspec 2.21.0 → 3.0.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 |send_node, class_name, arguments|
+            next if !class_name.const_type? || ignore_metadata?(arguments)
+
+            ensure_correct_file_path(send_node, class_name, arguments)
+          end
+        end
+
+        private
+
+        def ensure_correct_file_path(send_node, 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_offense(send_node, message: 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

@@ -31,7 +31,7 @@ module RuboCop
         #
         #   @param node [RuboCop::AST::Node]
         #   @return [Array<RuboCop::AST::Node>] matching nodes
-        def_node_matcher :message_expectation?, <<-PATTERN
+        def_node_matcher :message_expectation?, <<~PATTERN
           {
             (send nil? { :receive :receive_message_chain } ...)  # receive(:foo)
             (send (send nil? :receive ...) :with ...)            # receive(:foo).with('bar')
@@ -136,7 +136,9 @@ module RuboCop
         RESTRICT_ON_SEND = %i[to].freeze
 
         def on_send(node)
-          expectation(node, &method(:on_expectation))
+          expectation(node) do |expectation, method_name, matcher|
+            on_expectation(expectation, method_name, matcher)
+          end
         end
 
         private

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

@@ -68,7 +68,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #
         #   @yield [Symbol] subject name
-        def_node_matcher :subject?, <<-PATTERN
+        def_node_matcher :subject?, <<~PATTERN
           (block
             (send nil?
               { #Subjects.all (sym $_) | $#Subjects.all }
@@ -77,7 +77,7 @@ module RuboCop
 
         # @!method let?(node)
         #   Find a memoized helper
-        def_node_matcher :let?, <<-PATTERN
+        def_node_matcher :let?, <<~PATTERN
           (block
             (send nil? :let (sym $_)
             ) args ...)
@@ -94,7 +94,7 @@ module RuboCop
         #     expect(foo).to receive(:bar).with(1)
         #     expect(foo).to receive(:bar).with(1).and_return(2)
         #
-        def_node_matcher :message_expectation?, <<-PATTERN
+        def_node_matcher :message_expectation?, <<~PATTERN
           (send
             {
               (send nil? { :expect :allow } (send nil? %))
@@ -106,15 +106,15 @@ module RuboCop
         PATTERN
 
         # @!method message_expectation_matcher?(node)
-        def_node_search :message_expectation_matcher?, <<-PATTERN
+        def_node_search :message_expectation_matcher?, <<~PATTERN
           (send nil? {
             :receive :receive_messages :receive_message_chain :have_received
             } ...)
         PATTERN
 
         def on_top_level_group(node)
-          @explicit_subjects = find_all_explicit(node, &method(:subject?))
-          @subject_overrides = find_all_explicit(node, &method(:let?))
+          @explicit_subjects = find_all_explicit(node) { |n| subject?(n) }
+          @subject_overrides = find_all_explicit(node) { |n| let?(n) }
 
           find_subject_expectations(node) do |stub|
             add_offense(stub)

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Description should be descriptive.
+      #
+      # If example group or example contains only `execute string`, numbers
+      # and regular expressions, the description is not clear.
+      #
+      # @example
+      #   # bad
+      #   describe `time` do
+      #    # ...
+      #   end
+      #
+      #   # bad
+      #   context /when foo/ do
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   it 10000 do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   describe Foo do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   describe '#foo' do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   context "when #{foo} is bar" do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     # ...
+      #   end
+      #
+      class UndescriptiveLiteralsDescription < Base
+        MSG = 'Description should be descriptive.'
+
+        # @!method example_groups_or_example?(node)
+        def_node_matcher :example_groups_or_example?, <<~PATTERN
+          (block (send #rspec? {#ExampleGroups.all #Examples.all} $_) ...)
+        PATTERN
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          example_groups_or_example?(node) do |arg|
+            add_offense(arg) if offense?(arg)
+          end
+        end
+
+        private
+
+        def offense?(node)
+          %i[xstr int regexp].include?(node.type)
+        end
+      end
+    end
+  end
+end

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

@@ -35,7 +35,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[to].freeze
 
         # @!method empty_raise_error_or_exception(node)
-        def_node_matcher :empty_raise_error_or_exception, <<-PATTERN
+        def_node_matcher :empty_raise_error_or_exception, <<~PATTERN
           (send
             (block
                 (send nil? :expect) ...)
@@ -57,7 +57,7 @@ module RuboCop
         end
 
         def block_with_args?(node)
-          return unless node&.block_type?
+          return false unless node&.block_type?
 
           node.arguments?
         end

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

@@ -35,7 +35,7 @@ module RuboCop
           return unless inside_example_group?(node)
 
           variable_definition?(node) do |variable|
-            next unless style_violation?(variable)
+            next unless style_offense?(variable)
 
             add_offense(
               variable,
@@ -59,9 +59,9 @@ module RuboCop
           end
         end
 
-        def style_violation?(variable)
-          style == :symbols && string?(variable) ||
-            style == :strings && symbol?(variable)
+        def style_offense?(variable)
+          (style == :symbols && string?(variable)) ||
+            (style == :strings && symbol?(variable))
         end
 
         def string?(node)

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`.
@@ -79,8 +79,8 @@ module RuboCop
             expression = class_reference.source_range
 
             add_offense(expression, message: message) do |corrector|
-              violation = class_reference.source
-              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.gsub(/^['"]|['"]$/, '')
+            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
@@ -28,7 +28,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[double spy].freeze
 
         # @!method unverified_double(node)
-        def_node_matcher :unverified_double, <<-PATTERN
+        def_node_matcher :unverified_double, <<~PATTERN
           {(send nil? {:double :spy} $...)}
         PATTERN
 

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

@@ -18,12 +18,12 @@ module RuboCop
         RESTRICT_ON_SEND = %i[expect].freeze
 
         # @!method expect?(node)
-        def_node_matcher :expect?, <<-PATTERN
+        def_node_matcher :expect?, <<~PATTERN
           (send nil? :expect ...)
         PATTERN
 
         # @!method expect_block?(node)
-        def_node_matcher :expect_block?, <<-PATTERN
+        def_node_matcher :expect_block?, <<~PATTERN
           (block #expect? (args) _body)
         PATTERN
 
@@ -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
+
+          parent.block_type? && parent.body == expect
         end
       end
     end

data/lib/rubocop/cop/rspec_cops.rb

@@ -1,32 +1,5 @@
 # frozen_string_literal: true
 
-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'
-require_relative 'rspec/capybara/specific_matcher'
-require_relative 'rspec/capybara/visibility_matcher'
-
-require_relative 'rspec/factory_bot/attribute_defined_statically'
-require_relative 'rspec/factory_bot/consistent_parentheses_style'
-require_relative 'rspec/factory_bot/create_list'
-require_relative 'rspec/factory_bot/factory_class_name'
-require_relative 'rspec/factory_bot/factory_name_style'
-require_relative 'rspec/factory_bot/syntax_methods'
-
-require_relative 'rspec/rails/avoid_setup_hook'
-require_relative 'rspec/rails/have_http_status'
-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'
@@ -56,6 +29,9 @@ 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/empty_output'
+require_relative 'rspec/eq'
 require_relative 'rspec/example_length'
 require_relative 'rspec/example_without_description'
 require_relative 'rspec/example_wording'
@@ -63,8 +39,8 @@ require_relative 'rspec/excessive_docstring_spacing'
 require_relative 'rspec/expect_actual'
 require_relative 'rspec/expect_change'
 require_relative 'rspec/expect_in_hook'
+require_relative 'rspec/expect_in_let'
 require_relative 'rspec/expect_output'
-require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
@@ -75,6 +51,7 @@ require_relative 'rspec/implicit_subject'
 require_relative 'rspec/indexed_let'
 require_relative 'rspec/instance_spy'
 require_relative 'rspec/instance_variable'
+require_relative 'rspec/is_expected_specify'
 require_relative 'rspec/it_behaves_like'
 require_relative 'rspec/iterated_expectation'
 require_relative 'rspec/leading_subject'
@@ -85,7 +62,9 @@ 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/missing_expectation_target_method'
 require_relative 'rspec/multiple_describes'
 require_relative 'rspec/multiple_expectations'
 require_relative 'rspec/multiple_memoized_helpers'
@@ -99,13 +78,17 @@ 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/redundant_predicate_matcher'
+require_relative 'rspec/remove_const'
 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/repeated_include_example'
+require_relative 'rspec/repeated_subject_call'
 require_relative 'rspec/return_from_stub'
 require_relative 'rspec/scattered_let'
 require_relative 'rspec/scattered_setup'
@@ -114,9 +97,12 @@ 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'
+require_relative 'rspec/undescriptive_literals_description'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'
 require_relative 'rspec/variable_name'

data/lib/rubocop/rspec/concept.rb

@@ -5,7 +5,6 @@ module RuboCop
     # Wrapper for RSpec DSL methods
     class Concept
       extend RuboCop::NodePattern::Macros
-      extend Language::NodePattern
       include Language
 
       def initialize(node)

data/lib/rubocop/rspec/config_formatter.rb

@@ -7,16 +7,7 @@ module RuboCop
     # Builds a YAML config file from two config hashes
     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
-      )
+      SUBDEPARTMENTS = [].freeze
       AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
@@ -38,7 +29,6 @@ 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/cop/generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/language.rb

@@ -13,7 +13,6 @@ module RuboCop
     # using the configured aliases.
     module Language
       extend RuboCop::NodePattern::Macros
-      extend NodePattern
 
       class << self
         attr_accessor :config
@@ -42,7 +41,7 @@ module RuboCop
       PATTERN
 
       # @!method example_group_with_body?(node)
-      def_node_matcher :example_group_with_body?, <<-PATTERN
+      def_node_matcher :example_group_with_body?, <<~PATTERN
         (block (send #rspec? #ExampleGroups.all ...) args !nil?)
       PATTERN
 
@@ -50,15 +49,15 @@ module RuboCop
       def_node_matcher :example?, '(block (send nil? #Examples.all ...) ...)'
 
       # @!method hook?(node)
-      def_node_matcher :hook?, <<-PATTERN
-      {
-        (numblock (send nil? #Hooks.all ...) ...)
-        (block (send nil? #Hooks.all ...) ...)
-      }
+      def_node_matcher :hook?, <<~PATTERN
+        {
+          (numblock (send nil? #Hooks.all ...) ...)
+          (block (send nil? #Hooks.all ...) ...)
+        }
       PATTERN
 
       # @!method let?(node)
-      def_node_matcher :let?, <<-PATTERN
+      def_node_matcher :let?, <<~PATTERN
         {
           (block (send nil? #Helpers.all ...) ...)
           (send nil? #Helpers.all _ block_pass)
@@ -66,7 +65,7 @@ module RuboCop
       PATTERN
 
       # @!method include?(node)
-      def_node_matcher :include?, <<-PATTERN
+      def_node_matcher :include?, <<~PATTERN
         {
           (block (send nil? #Includes.all ...) ...)
           (send nil? #Includes.all ...)

data/lib/rubocop/rspec/node.rb

@@ -9,7 +9,7 @@ module RuboCop
       def recursive_literal_or_const?
         case type
         when :begin, :pair, *AST::Node::COMPOSITE_LITERALS
-          children.all?(&:recursive_literal_or_const?)
+          children.compact.all?(&:recursive_literal_or_const?)
         else
           literal? || const_type?
         end

data/lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb

@@ -21,7 +21,7 @@ RSpec.shared_context 'with default RSpec/Language config' do
     when Array
       object.map { |item| deep_dup(item) }
     when Hash
-      object.transform_values(&method(:deep_dup))
+      object.transform_values { |value| deep_dup(value) }
     else
       object # only collections undergo modifications and need duping
     end

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.21.0'
+      STRING = '3.0.1'
     end
   end
 end