rubocop-rspec 2.25.0 → 2.27.1

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

@@ -3,9 +3,13 @@
 module RuboCop
   module Cop
     module RSpec
-      # Enforces use of string to titleize shared examples.
+      # Checks for consistent style for shared example names.
       #
-      # @example
+      # Enforces either `string` or `symbol` for shared example names.
+      #
+      # This cop can be configured using the `EnforcedStyle` option
+      #
+      # @example `EnforcedStyle: string` (default)
       #   # bad
       #   it_behaves_like :foo_bar_baz
       #   it_should_behave_like :foo_bar_baz
@@ -20,33 +24,66 @@ module RuboCop
       #   shared_examples_for 'foo bar baz'
       #   include_examples 'foo bar baz'
       #
+      # @example `EnforcedStyle: symbol`
+      #   # bad
+      #   it_behaves_like 'foo bar baz'
+      #   it_should_behave_like 'foo bar baz'
+      #   shared_examples 'foo bar baz'
+      #   shared_examples_for 'foo bar baz'
+      #   include_examples 'foo bar baz'
+      #
+      #   # good
+      #   it_behaves_like :foo_bar_baz
+      #   it_should_behave_like :foo_bar_baz
+      #   shared_examples :foo_bar_baz
+      #   shared_examples_for :foo_bar_baz
+      #   include_examples :foo_bar_baz
+      #
       class SharedExamples < Base
         extend AutoCorrector
+        include ConfigurableEnforcedStyle
 
         # @!method shared_examples(node)
         def_node_matcher :shared_examples, <<~PATTERN
           {
-            (send #rspec? #SharedGroups.all ...)
-            (send nil? #Includes.all ...)
+            (send #rspec? #SharedGroups.all $_ ...)
+            (send nil? #Includes.all $_ ...)
           }
         PATTERN
 
         def on_send(node)
-          shared_examples(node) do
-            ast_node = node.first_argument
-            next unless ast_node&.sym_type?
+          shared_examples(node) do |ast_node|
+            next unless offense?(ast_node)
 
-            checker = Checker.new(ast_node)
-            add_offense(checker.node, message: checker.message) do |corrector|
-              corrector.replace(checker.node, checker.preferred_style)
+            checker = new_checker(ast_node)
+            add_offense(ast_node, message: checker.message) do |corrector|
+              corrector.replace(ast_node, checker.preferred_style)
             end
           end
         end
 
+        private
+
+        def offense?(ast_node)
+          if style == :symbol
+            ast_node.str_type?
+          else # string
+            ast_node.sym_type?
+          end
+        end
+
+        def new_checker(ast_node)
+          if style == :symbol
+            SymbolChecker.new(ast_node)
+          else # string
+            StringChecker.new(ast_node)
+          end
+        end
+
         # :nodoc:
-        class Checker
+        class SymbolChecker
           MSG = 'Prefer %<prefer>s over `%<current>s` ' \
-                'to titleize shared examples.'
+                'to symbolize shared examples.'
 
           attr_reader :node
 
@@ -55,22 +92,31 @@ module RuboCop
           end
 
           def message
-            format(MSG, prefer: preferred_style, current: symbol.inspect)
+            format(MSG, prefer: preferred_style, current: node.value.inspect)
           end
 
           def preferred_style
-            string = symbol.to_s.tr('_', ' ')
-            wrap_with_single_quotes(string)
+            ":#{node.value.to_s.downcase.tr(' ', '_')}"
           end
+        end
+
+        # :nodoc:
+        class StringChecker
+          MSG = 'Prefer %<prefer>s over `%<current>s` ' \
+                'to titleize shared examples.'
 
-          private
+          attr_reader :node
 
-          def symbol
-            node.value
+          def initialize(node)
+            @node = node
           end
 
-          def wrap_with_single_quotes(string)
-            "'#{string}'"
+          def message
+            format(MSG, prefer: preferred_style, current: node.value.inspect)
+          end
+
+          def preferred_style
+            "'#{node.value.to_s.tr('_', ' ')}'"
           end
         end
       end

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

@@ -24,7 +24,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[receive_message_chain stub_chain].freeze
 
         # @!method message_chain(node)
-        def_node_matcher :message_chain, <<-PATTERN
+        def_node_matcher :message_chain, <<~PATTERN
           (send _ {:receive_message_chain :stub_chain} $_)
         PATTERN
 
@@ -81,8 +81,7 @@ module RuboCop
         end
 
         def key_to_arg(node)
-          key, = *node # rubocop:disable InternalAffairs/NodeDestructuring
-          node.sym_type? ? ":#{key}" : node.source
+          node.sym_type? ? ":#{node.value}" : node.source
         end
 
         def replacement(method)

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

@@ -60,8 +60,8 @@ module RuboCop
         end
 
         def style_offense?(variable)
-          style == :symbols && string?(variable) ||
-            style == :strings && symbol?(variable)
+          (style == :symbols && string?(variable)) ||
+            (style == :strings && symbol?(variable))
         end
 
         def string?(node)

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
 

data/lib/rubocop/cop/rspec_cops.rb

@@ -78,6 +78,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'
@@ -106,11 +107,14 @@ 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'

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.25.0'
+      STRING = '2.27.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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.27.1
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -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
@@ -139,6 +139,7 @@ files:
 - lib/rubocop/cop/rspec/indexed_let.rb
 - lib/rubocop/cop/rspec/instance_spy.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
+- lib/rubocop/cop/rspec/is_expected_specify.rb
 - lib/rubocop/cop/rspec/it_behaves_like.rb
 - lib/rubocop/cop/rspec/iterated_expectation.rb
 - lib/rubocop/cop/rspec/leading_subject.rb
@@ -185,11 +186,14 @@ 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
 - lib/rubocop/cop/rspec/repeated_example_group_description.rb
 - lib/rubocop/cop/rspec/repeated_include_example.rb
+- lib/rubocop/cop/rspec/repeated_subject_call.rb
 - lib/rubocop/cop/rspec/return_from_stub.rb
 - lib/rubocop/cop/rspec/scattered_let.rb
 - lib/rubocop/cop/rspec/scattered_setup.rb
@@ -249,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files