rubocop-rspec 1.32.0 → 1.33.0

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

@@ -20,7 +20,7 @@ module RuboCop
       #   describe "A feature example" do
       #   end
       class MissingExampleGroupArgument < Cop
-        MSG = 'The first argument to `%<method>s` should not be empty.'.freeze
+        MSG = 'The first argument to `%<method>s` should not be empty.'
 
         def on_block(node)
           return unless example_group?(node)

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

@@ -26,7 +26,7 @@ module RuboCop
         include RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'Do not use multiple top level describes - '\
-              'try to nest them.'.freeze
+              'try to nest them.'
 
         def on_top_level_describe(node, _args)
           return if single_top_level_describe?

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

@@ -48,7 +48,7 @@ module RuboCop
       class MultipleExpectations < Cop
         include ConfigurableMax
 
-        MSG = 'Example has too many expectations [%<total>d/%<max>d].'.freeze
+        MSG = 'Example has too many expectations [%<total>d/%<max>d].'
 
         def_node_search :with_aggregated_failures?, '(sym :aggregate_failures)'
         def_node_search :disabled_aggregated_failures?, <<-PATTERN

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

@@ -34,7 +34,9 @@ module RuboCop
       #     This is enough of an edge case that people can just move this to
       #     a `before` hook on their own
       class MultipleSubjects < Cop
-        MSG = 'Do not set more than one subject per example group'.freeze
+        include RangeHelp
+
+        MSG = 'Do not set more than one subject per example group'
 
         def on_block(node)
           return unless example_group?(node)
@@ -70,7 +72,9 @@ module RuboCop
 
         def remove_autocorrect(node)
           lambda do |corrector|
-            corrector.remove(node.loc.expression)
+            range = range_by_whole_lines(node.source_range,
+                                         include_final_newline: true)
+            corrector.remove(range)
           end
         end
       end

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

@@ -43,7 +43,7 @@ module RuboCop
       #   end
       class NamedSubject < Cop
         MSG = 'Name your test subject if you need '\
-              'to reference it explicitly.'.freeze
+              'to reference it explicitly.'
 
         def_node_matcher :rspec_block?, <<-PATTERN
           {

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

@@ -89,14 +89,13 @@ module RuboCop
         include ConfigurableMax
         include RuboCop::RSpec::TopLevelDescribe
 
-        MSG = 'Maximum example group nesting exceeded ' \
-              '[%<total>d/%<max>d].'.freeze
+        MSG = 'Maximum example group nesting exceeded [%<total>d/%<max>d].'
 
-        DEPRECATED_MAX_KEY = 'MaxNesting'.freeze
+        DEPRECATED_MAX_KEY = 'MaxNesting'
 
         DEPRECATION_WARNING =
           "Configuration key `#{DEPRECATED_MAX_KEY}` for #{cop_name} is " \
-          'deprecated in favor of `Max`. Please use that instead.'.freeze
+          'deprecated in favor of `Max`. Please use that instead.'
 
         def_node_search :find_contexts, ExampleGroups::ALL.block_pattern
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -16,7 +18,7 @@ module RuboCop
       class NotToNot < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%<replacement>s` over `%<original>s`.'.freeze
+        MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
 
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 

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

@@ -22,7 +22,7 @@ module RuboCop
       #   let(:baz) { baz }
       #   let!(:other) { other }
       class OverwritingSetup < Cop
-        MSG = '`%<name>s` is already defined.'.freeze
+        MSG = '`%<name>s` is already defined.'
 
         def_node_matcher :setup?, (Helpers::ALL + Subject::ALL).block_pattern
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'

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

@@ -26,7 +26,7 @@ module RuboCop
       #   describe MyClass do
       #   end
       class Pending < Cop
-        MSG = 'Pending spec found.'.freeze
+        MSG = 'Pending spec found.'
 
         PENDING_EXAMPLES    = Examples::PENDING + Examples::SKIPPED \
                                 + ExampleGroups::SKIPPED
@@ -37,8 +37,8 @@ module RuboCop
         PENDING_SYMBOL = s(:sym, :pending)
 
         def_node_matcher :metadata, <<-PATTERN
-          {(send {(const nil? :RSpec) nil?} #{SKIPPABLE_SELECTORS} ... (hash $...))
-           (send {(const nil? :RSpec) nil?} #{SKIPPABLE_SELECTORS} $...)}
+          {(send #{RSPEC} #{SKIPPABLE_SELECTORS} ... (hash $...))
+           (send #{RSPEC} #{SKIPPABLE_SELECTORS} $...)}
         PATTERN
 
         def_node_matcher :pending_block?, PENDING_EXAMPLES.send_pattern

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

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
       # A helper for `inflected` style
       module InflectedHelper
+        include RuboCop::RSpec::Language
         extend NodePattern::Macros
 
         MSG_INFLECTED = 'Prefer using `%<matcher_name>s` matcher over ' \
-                        '`%<predicate_name>s`.'.freeze
+                        '`%<predicate_name>s`.'
 
         private
 
@@ -25,7 +28,7 @@ module RuboCop
             (send nil? :expect {
               (block $(send !nil? #predicate? ...) ...)
               $(send !nil? #predicate? ...)})
-            ${:to :not_to :to_not}
+            $#{Runners::ALL.node_pattern_union}
             $#boolean_matcher?)
         PATTERN
 
@@ -86,10 +89,10 @@ module RuboCop
         end
 
         def remove_predicate(corrector, predicate)
-          range = range_between(
-            predicate.loc.dot.begin_pos,
-            predicate.loc.expression.end_pos
+          range = predicate.loc.dot.with(
+            end_pos: predicate.loc.expression.end_pos
           )
+
           corrector.remove(range)
 
           block_range = block_loc(predicate)
@@ -123,10 +126,11 @@ module RuboCop
       # A helper for `explicit` style
       # rubocop:disable Metrics/ModuleLength
       module ExplicitHelper
+        include RuboCop::RSpec::Language
         extend NodePattern::Macros
 
         MSG_EXPLICIT = 'Prefer using `%<predicate_name>s` over ' \
-                       '`%<matcher_name>s` matcher.'.freeze
+                       '`%<matcher_name>s` matcher.'
         BUILT_IN_MATCHERS = %w[
           be_truthy be_falsey be_falsy
           have_attributes have_received
@@ -160,7 +164,7 @@ module RuboCop
         def_node_matcher :predicate_matcher?, <<-PATTERN
           (send
             (send nil? :expect $!nil?)
-            {:to :not_to :to_not}
+            #{Runners::ALL.node_pattern_union}
             {$(send nil? #predicate_matcher_name? ...)
               (block $(send nil? #predicate_matcher_name? ...) ...)})
         PATTERN
@@ -169,7 +173,7 @@ module RuboCop
           (block
             (send
               (send nil? :expect $!nil?)
-              {:to :not_to :to_not}
+              #{Runners::ALL.node_pattern_union}
               $(send nil? #predicate_matcher_name?))
             ...)
         PATTERN
@@ -299,7 +303,6 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include InflectedHelper
         include ExplicitHelper
-        include RangeHelp
 
         def on_send(node)
           case style
@@ -330,8 +333,9 @@ module RuboCop
         #   foo 1, 2
         #      ^^^^^
         def args_loc(send_node)
-          range_between(send_node.loc.selector.end_pos,
-                        send_node.loc.expression.end_pos)
+          send_node.loc.selector.end.with(
+            end_pos: send_node.loc.expression.end_pos
+          )
         end
 
         # returns block location with whitespace
@@ -342,9 +346,8 @@ module RuboCop
           parent = send_node.parent
           return unless parent.block_type?
 
-          range_between(
-            send_node.loc.expression.end_pos,
-            parent.loc.expression.end_pos
+          send_node.loc.expression.end.with(
+            end_pos: parent.loc.expression.end_pos
           )
         end
       end

data/lib/rubocop/cop/rspec/rails/http_status.rb

@@ -67,7 +67,7 @@ module RuboCop
           # :nodoc:
           class SymbolicStyleChecker
             MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
-                  'to describe HTTP status code.'.freeze
+                  'to describe HTTP status code.'
 
             attr_reader :node
             def initialize(node)
@@ -105,7 +105,7 @@ module RuboCop
           # :nodoc:
           class NumericStyleChecker
             MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
-                  'to describe HTTP status code.'.freeze
+                  'to describe HTTP status code.'
 
             WHITELIST_STATUS = %i[error success missing redirect].freeze
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -22,9 +24,7 @@ module RuboCop
       #     expect(foo).to receive(:bar).at_most(:twice).times
       #
       class ReceiveCounts < Cop
-        include RangeHelp
-
-        MSG = 'Use `%<alternative>s` instead of `%<original>s`.'.freeze
+        MSG = 'Use `%<alternative>s` instead of `%<original>s`.'
 
         def_node_matcher :receive_counts, <<-PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
@@ -78,9 +78,8 @@ module RuboCop
         end
 
         def range(node, offending_node)
-          range_between(
-            offending_node.loc.dot.begin_pos,
-            node.loc.expression.end_pos
+          offending_node.loc.dot.with(
+            end_pos: node.loc.expression.end_pos
           )
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -12,9 +14,7 @@ module RuboCop
       #     expect(foo).not_to receive(:bar)
       #
       class ReceiveNever < Cop
-        include RangeHelp
-
-        MSG = 'Use `not_to receive` instead of `never`.'.freeze
+        MSG = 'Use `not_to receive` instead of `never`.'
 
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
@@ -30,10 +30,7 @@ module RuboCop
         def autocorrect(node)
           lambda do |corrector|
             corrector.replace(node.parent.loc.selector, 'not_to')
-            range = range_between(
-              node.loc.dot.begin_pos,
-              node.loc.selector.end_pos
-            )
+            range = node.loc.dot.with(end_pos: node.loc.selector.end_pos)
             corrector.remove(range)
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -28,7 +30,7 @@ module RuboCop
       #     end
       #
       class RepeatedDescription < Cop
-        MSG = "Don't repeat descriptions within an example group.".freeze
+        MSG = "Don't repeat descriptions within an example group."
 
         def on_block(node)
           return unless example_group?(node)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -14,7 +16,7 @@ module RuboCop
       #    end
       #
       class RepeatedExample < Cop
-        MSG = "Don't repeat examples within an example group.".freeze
+        MSG = "Don't repeat examples within an example group."
 
         def on_block(node)
           return unless example_group?(node)

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

@@ -36,8 +36,8 @@ module RuboCop
       class ReturnFromStub < Cop
         include ConfigurableEnforcedStyle
 
-        MSG_AND_RETURN = 'Use `and_return` for static values.'.freeze
-        MSG_BLOCK = 'Use block for static values.'.freeze
+        MSG_AND_RETURN = 'Use `and_return` for static values.'
+        MSG_BLOCK = 'Use block for static values.'
 
         def_node_search :contains_stub?, '(send nil? :receive (...))'
         def_node_search :and_return_value, <<-PATTERN

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

@@ -27,7 +27,7 @@ module RuboCop
       #   end
       #
       class ScatteredLet < Cop
-        MSG = 'Group all let/let! blocks in the example group together.'.freeze
+        MSG = 'Group all let/let! blocks in the example group together.'
 
         def on_block(node)
           return unless example_group_with_body?(node)

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

@@ -23,7 +23,7 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Cop
-        MSG = 'Do not define multiple hooks in the same example group.'.freeze
+        MSG = 'Do not define multiple hooks in the same example group.'
 
         def on_block(node)
           return unless example_group?(node)

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

@@ -52,10 +52,10 @@ module RuboCop
       #
       class SharedContext < Cop
         MSG_EXAMPLES = "Use `shared_examples` when you don't "\
-                       'define context.'.freeze
+                       'define context.'
 
         MSG_CONTEXT  = "Use `shared_context` when you don't "\
-                       'define examples.'.freeze
+                       'define examples.'
 
         examples = (Examples::ALL + Includes::EXAMPLES)
         def_node_search :examples?, examples.send_pattern

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

@@ -21,14 +21,14 @@ module RuboCop
       #   include_examples 'foo bar baz'
       #
       class SharedExamples < Cop
-        def_node_matcher :shared_examples, <<-PATTERN
-          (send
-            {(const nil? :RSpec) nil?}
-            {#{(SharedGroups::ALL + Includes::ALL).node_pattern}} $sym ...)
-        PATTERN
+        def_node_matcher :shared_examples,
+                         (SharedGroups::ALL + Includes::ALL).send_pattern
 
         def on_send(node)
-          shared_examples(node) do |ast_node|
+          shared_examples(node) do
+            ast_node = node.first_argument
+            next unless ast_node&.sym_type?
+
             checker = Checker.new(ast_node)
             add_offense(checker.node, message: checker.message)
           end
@@ -44,7 +44,7 @@ module RuboCop
         # :nodoc:
         class Checker
           MSG = 'Prefer %<prefer>s over `%<current>s` ' \
-                'to titleize shared examples.'.freeze
+                'to titleize shared examples.'
 
           attr_reader :node
           def initialize(node)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -16,7 +18,7 @@ module RuboCop
       #
       class SingleArgumentMessageChain < Cop
         MSG = 'Use `%<recommended>s` instead of calling '\
-              '`%<called>s` with a single argument.'.freeze
+              '`%<called>s` with a single argument.'
 
         def_node_matcher :message_chain, <<-PATTERN
           (send _ {:receive_message_chain :stub_chain} $_)

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

@@ -20,7 +20,7 @@ module RuboCop
       class SubjectStub < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
-        MSG = 'Do not stub your test subject.'.freeze
+        MSG = 'Do not stub your test subject.'
 
         # @!method subject(node)
         #   Find a named or unnamed subject definition

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module RSpec
@@ -29,9 +31,9 @@ module RuboCop
       #
       #     expect { do_something }.not_to raise_error
       class UnspecifiedException < Cop
-        MSG = 'Specify the exception being captured'.freeze
+        MSG = 'Specify the exception being captured'
 
-        def_node_matcher :empty_raise_error_or_exception, <<-PATTERN.freeze
+        def_node_matcher :empty_raise_error_or_exception, <<-PATTERN
           (send
             (block
                 (send nil? :expect) ...)
@@ -54,7 +56,7 @@ module RuboCop
         end
 
         def block_with_args?(node)
-          return unless node && node.block_type?
+          return unless node&.block_type?
 
           node.arguments?
         end