rubocop-rspec 2.23.0 → 2.26.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')

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,7 +106,7 @@ 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
             } ...)

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

@@ -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

@@ -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

@@ -57,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'
@@ -86,6 +88,7 @@ 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'
@@ -103,6 +106,8 @@ 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'
@@ -116,6 +121,8 @@ 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/language.rb

@@ -42,7 +42,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 +50,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 +66,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/version.rb

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

data/lib/rubocop/rspec/wording.rb

@@ -6,6 +6,8 @@ module RuboCop
     class Wording
       SHOULDNT_PREFIX    = /\Ashould(?:n't| not)\b/i.freeze
       SHOULDNT_BE_PREFIX = /#{SHOULDNT_PREFIX} be\b/i.freeze
+      WILL_NOT_PREFIX    = /\Awill not\b/i.freeze
+      WONT_PREFIX        = /\Awon't\b/i.freeze
       ES_SUFFIX_PATTERN  = /(?:o|s|x|ch|sh|z)\z/i.freeze
       IES_SUFFIX_PATTERN = /[^aeou]y\z/i.freeze
 
@@ -15,16 +17,22 @@ module RuboCop
         @replacements = replace
       end
 
+      # rubocop:disable Metrics/MethodLength
       def rewrite
         case text
         when SHOULDNT_BE_PREFIX
           replace_prefix(SHOULDNT_BE_PREFIX, 'is not')
         when SHOULDNT_PREFIX
           replace_prefix(SHOULDNT_PREFIX, 'does not')
+        when WILL_NOT_PREFIX
+          replace_prefix(WILL_NOT_PREFIX, 'does not')
+        when WONT_PREFIX
+          replace_prefix(WONT_PREFIX, 'does not')
         else
           remove_should_and_pluralize
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/rubocop-rspec.rb

@@ -17,6 +17,7 @@ require_relative 'rubocop/rspec/wording'
 # Dependent on `RuboCop::RSpec::Language::NodePattern`.
 require_relative 'rubocop/rspec/language'
 
+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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 2.26.1
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-30 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
 - !ruby/object:Gem::Dependency
   name: rubocop-capybara
   requirement: !ruby/object:Gem::Requirement
@@ -54,9 +54,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.22'
-description: |2
-      Code style checking for RSpec files.
-      A plugin for the RuboCop code style enforcing & linting tool.
+description: |
+  Code style checking for RSpec files.
+  A plugin for the RuboCop code style enforcing & linting tool.
 email:
 - johncbackus@gmail.com
 - ian@nevir.net
@@ -112,6 +112,8 @@ files:
 - lib/rubocop/cop/rspec/empty_line_after_final_let.rb
 - lib/rubocop/cop/rspec/empty_line_after_hook.rb
 - lib/rubocop/cop/rspec/empty_line_after_subject.rb
+- lib/rubocop/cop/rspec/empty_metadata.rb
+- lib/rubocop/cop/rspec/eq.rb
 - lib/rubocop/cop/rspec/example_length.rb
 - lib/rubocop/cop/rspec/example_without_description.rb
 - lib/rubocop/cop/rspec/example_wording.rb
@@ -147,9 +149,11 @@ files:
 - lib/rubocop/cop/rspec/message_chain.rb
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
+- lib/rubocop/cop/rspec/metadata_style.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
 - lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
+- lib/rubocop/cop/rspec/mixin/file_help.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/inside_example_group.rb
 - lib/rubocop/cop/rspec/mixin/location_help.rb
@@ -181,6 +185,8 @@ files:
 - lib/rubocop/cop/rspec/receive_messages.rb
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/redundant_around.rb
+- lib/rubocop/cop/rspec/redundant_predicate_matcher.rb
+- lib/rubocop/cop/rspec/remove_const.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
 - lib/rubocop/cop/rspec/repeated_example.rb
 - lib/rubocop/cop/rspec/repeated_example_group_body.rb
@@ -194,6 +200,8 @@ files:
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
 - lib/rubocop/cop/rspec/skip_block_inside_example.rb
 - lib/rubocop/cop/rspec/sort_metadata.rb
+- lib/rubocop/cop/rspec/spec_file_path_format.rb
+- lib/rubocop/cop/rspec/spec_file_path_suffix.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
 - lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
@@ -243,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files