rubocop-rspec 2.24.1 → 2.26.0

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

@@ -37,7 +37,7 @@ module RuboCop
         PATTERN
 
         # @!method let_bang(node)
-        def_node_matcher :let_bang, <<-PATTERN
+        def_node_matcher :let_bang, <<~PATTERN
           {
             (block $(send nil? :let! {(sym $_) (str $_)}) ...)
             $(send nil? :let! {(sym $_) (str $_)} block_pass)

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

@@ -33,7 +33,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[to].freeze
 
         # @!method message_expectation(node)
-        def_node_matcher :message_expectation, <<-PATTERN
+        def_node_matcher :message_expectation, <<~PATTERN
           (send $(send nil? {:expect :allow} ...) :to #receive_message?)
         PATTERN
 

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

@@ -45,6 +45,11 @@ module RuboCop
         PATTERN
 
         def on_metadata(symbols, hash)
+          # RSpec example groups accept two string arguments. In such a case,
+          # the rspec_metadata matcher will interpret the second string
+          # argument as a metadata symbol.
+          symbols.shift if symbols.first&.str_type?
+
           symbols.each do |symbol|
             on_metadata_symbol(symbol)
           end

data/lib/rubocop/cop/rspec/mixin/metadata.rb

@@ -30,12 +30,12 @@ module RuboCop
         def on_block(node)
           rspec_configure(node) do |block_var|
             metadata_in_block(node, block_var) do |metadata_arguments|
-              on_matadata_arguments(metadata_arguments)
+              on_metadata_arguments(metadata_arguments)
             end
           end
 
           rspec_metadata(node) do |metadata_arguments|
-            on_matadata_arguments(metadata_arguments)
+            on_metadata_arguments(metadata_arguments)
           end
         end
         alias on_numblock on_block
@@ -46,7 +46,7 @@ module RuboCop
 
         private
 
-        def on_matadata_arguments(metadata_arguments)
+        def on_metadata_arguments(metadata_arguments)
           *symbols, last = metadata_arguments
           hash = nil
           case last&.type

data/lib/rubocop/cop/rspec/mixin/skip_or_pending.rb

@@ -8,7 +8,7 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
 
         # @!method skipped_in_metadata?(node)
-        def_node_matcher :skipped_in_metadata?, <<-PATTERN
+        def_node_matcher :skipped_in_metadata?, <<~PATTERN
           {
             (send _ _ <(sym {:skip :pending}) ...>)
             (send _ _ ... (hash <(pair (sym {:skip :pending}) { true str dstr }) ...>))
@@ -30,7 +30,7 @@ module RuboCop
         #
         #   @param node [RuboCop::AST::Node]
         #   @return [Array<RuboCop::AST::Node>] matching nodes
-        def_node_matcher :skip_or_pending_inside_block?, <<-PATTERN
+        def_node_matcher :skip_or_pending_inside_block?, <<~PATTERN
           (block <(send nil? {:skip :pending} ...) ...>)
         PATTERN
       end

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

@@ -70,7 +70,7 @@ module RuboCop
         TRUE = ->(node) { node.true_type? }
 
         # @!method aggregate_failures?(node)
-        def_node_matcher :aggregate_failures?, <<-PATTERN
+        def_node_matcher :aggregate_failures?, <<~PATTERN
           (block {
               (send _ _ <(sym :aggregate_failures) ...>)
               (send _ _ ... (hash <(pair (sym :aggregate_failures) %1) ...>))
@@ -81,7 +81,7 @@ module RuboCop
         def_node_matcher :expect?, '(send nil? #Expectations.all ...)'
 
         # @!method aggregate_failures_block?(node)
-        def_node_matcher :aggregate_failures_block?, <<-PATTERN
+        def_node_matcher :aggregate_failures_block?, <<~PATTERN
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN
 

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

@@ -67,7 +67,7 @@ module RuboCop
         private
 
         def skipped?(node)
-          skippable?(node) && skipped_in_metadata?(node) ||
+          (skippable?(node) && skipped_in_metadata?(node)) ||
             skipped_regular_example_without_body?(node)
         end
 

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

@@ -103,7 +103,7 @@ module RuboCop
           on_pending_by_metadata(node)
           return unless (parent = parent_node(node))
 
-          if example_group?(parent) || block_node_example_group?(node)
+          if spec_group?(parent) || block_node_example_group?(node)
             on_skipped_by_example_method(node)
             on_skipped_by_example_group_method(node)
           elsif example?(parent)

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

@@ -26,7 +26,7 @@ module RuboCop
         end
 
         # @!method predicate_in_actual?(node)
-        def_node_matcher :predicate_in_actual?, <<-PATTERN
+        def_node_matcher :predicate_in_actual?, <<~PATTERN
           (send
             (send nil? :expect {
               (block $(send !nil? #predicate? ...) ...)
@@ -36,12 +36,12 @@ module RuboCop
         PATTERN
 
         # @!method be_bool?(node)
-        def_node_matcher :be_bool?, <<-PATTERN
+        def_node_matcher :be_bool?, <<~PATTERN
           (send nil? {:be :eq :eql :equal} {true false})
         PATTERN
 
         # @!method be_boolthy?(node)
-        def_node_matcher :be_boolthy?, <<-PATTERN
+        def_node_matcher :be_boolthy?, <<~PATTERN
           (send nil? {:be_truthy :be_falsey :be_falsy :a_truthy_value :a_falsey_value :a_falsy_value})
         PATTERN
 
@@ -179,7 +179,7 @@ module RuboCop
         end
 
         # @!method predicate_matcher?(node)
-        def_node_matcher :predicate_matcher?, <<-PATTERN
+        def_node_matcher :predicate_matcher?, <<~PATTERN
           (send
             (send nil? :expect $!nil?)
             #Runners.all
@@ -188,7 +188,7 @@ module RuboCop
         PATTERN
 
         # @!method predicate_matcher_block?(node)
-        def_node_matcher :predicate_matcher_block?, <<-PATTERN
+        def_node_matcher :predicate_matcher_block?, <<~PATTERN
           (block
             (send
               (send nil? :expect $!nil?)
@@ -202,7 +202,7 @@ module RuboCop
 
           return false if allowed_explicit_matchers.include?(name)
 
-          name.start_with?('be_', 'have_') && !name.end_with?('?') ||
+          (name.start_with?('be_', 'have_') && !name.end_with?('?')) ||
             %w[include respond_to].include?(name)
         end
 

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

@@ -23,7 +23,7 @@ module RuboCop
           MSG = 'Use `before` instead of `setup`.'
 
           # @!method setup_call(node)
-          def_node_matcher :setup_call, <<-PATTERN
+          def_node_matcher :setup_call, <<~PATTERN
             (block
               $(send nil? :setup)
               (args) _)

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

@@ -25,7 +25,7 @@ module RuboCop
           RESTRICT_ON_SEND = RUNNERS
 
           # @!method match_status(node)
-          def_node_matcher :match_status, <<-PATTERN
+          def_node_matcher :match_status, <<~PATTERN
             (send
               (send nil? :expect
                 $(send (send nil? :response) {:status :code})

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

@@ -60,12 +60,14 @@ module RuboCop
           RESTRICT_ON_SEND = %i[have_http_status].freeze
 
           # @!method http_status(node)
-          def_node_matcher :http_status, <<-PATTERN
+          def_node_matcher :http_status, <<~PATTERN
             (send nil? :have_http_status ${int sym str})
           PATTERN
 
           def on_send(node)
             http_status(node) do |arg|
+              return if arg.str_type? && arg.heredoc?
+
               checker = checker_class.new(arg)
               return unless checker.offensive?
 
@@ -105,6 +107,10 @@ module RuboCop
               format(MSG, prefer: prefer, current: current)
             end
 
+            def current
+              offense_range.source
+            end
+
             def offense_range
               node
             end
@@ -129,10 +135,6 @@ module RuboCop
               symbol.inspect
             end
 
-            def current
-              node.value.inspect
-            end
-
             private
 
             def symbol
@@ -140,7 +142,7 @@ module RuboCop
             end
 
             def number
-              node.source.delete('"').to_i
+              node.value.to_i
             end
           end
 
@@ -154,10 +156,6 @@ module RuboCop
               number.to_s
             end
 
-            def current
-              symbol.inspect
-            end
-
             private
 
             def symbol
@@ -190,10 +188,6 @@ module RuboCop
               end
             end
 
-            def current
-              offense_range.source
-            end
-
             private
 
             def symbol
@@ -201,15 +195,15 @@ module RuboCop
             end
 
             def number
-              node.source.to_i
+              node.value.to_i
             end
 
             def normalize_str
-              normalized = node.source.delete('"')
-              if normalized.match?(/\A\d+\z/)
-                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(normalized.to_i)
+              str = node.value.to_s
+              if str.match?(/\A\d+\z/)
+                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(str.to_i)
               else
-                normalized
+                str
               end
             end
           end

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

@@ -24,8 +24,8 @@ module RuboCop
           RESTRICT_ON_SEND = %i[assert_equal refute_equal].freeze
 
           # @!method minitest_assertion(node)
-          def_node_matcher :minitest_assertion, <<-PATTERN
-          (send nil? {:assert_equal :refute_equal} $_ $_ $_?)
+          def_node_matcher :minitest_assertion, <<~PATTERN
+            (send nil? {:assert_equal :refute_equal} $_ $_ $_?)
           PATTERN
 
           def on_send(node)

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

@@ -30,7 +30,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[times].freeze
 
         # @!method receive_counts(node)
-        def_node_matcher :receive_counts, <<-PATTERN
+        def_node_matcher :receive_counts, <<~PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN
 

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

@@ -148,7 +148,7 @@ module RuboCop
         end
 
         def heredoc_or_splat?(node)
-          (node.str_type? || node.dstr_type?) && node.heredoc? ||
+          ((node.str_type? || node.dstr_type?) && node.heredoc?) ||
             node.splat_type?
         end
 

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for redundant predicate matcher.
+      #
+      # @example
+      #   # bad
+      #   expect(foo).to be_exist(bar)
+      #   expect(foo).not_to be_include(bar)
+      #
+      #   # good
+      #   expect(foo).to exist(bar)
+      #   expect(foo).not_to include(bar)
+      #
+      class RedundantPredicateMatcher < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<good>s` instead of `%<bad>s`.'
+        RESTRICT_ON_SEND =
+          %i[be_all be_cover be_end_with be_eql be_equal
+             be_exist be_exists be_include be_match
+             be_respond_to be_start_with].freeze
+
+        def on_send(node)
+          return if node.parent.block_type? || node.arguments.empty?
+          return unless replacable_arguments?(node)
+
+          method_name = node.method_name.to_s
+          replaced = replaced_method_name(method_name)
+          add_offense(node, message: message(method_name,
+                                             replaced)) do |corrector|
+            unless node.method?(:be_all)
+              corrector.replace(node.loc.selector, replaced)
+            end
+          end
+        end
+
+        private
+
+        def message(bad_method, good_method)
+          format(MSG, bad: bad_method, good: good_method)
+        end
+
+        def replacable_arguments?(node)
+          if node.method?(:be_all)
+            node.first_argument.send_type?
+          else
+            true
+          end
+        end
+
+        def replaced_method_name(method_name)
+          name = method_name.to_s.delete_prefix('be_')
+          if name == 'exists'
+            'exist'
+          else
+            name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that `remove_const` is not used in specs.
+      #
+      # @example
+      #   # bad
+      #   it 'does something' do
+      #     Object.send(:remove_const, :SomeConstant)
+      #   end
+      #
+      #   before do
+      #     SomeClass.send(:remove_const, :SomeConstant)
+      #   end
+      #
+      class RemoveConst < Base
+        include RuboCop::RSpec::Language
+        extend RuboCop::RSpec::Language::NodePattern
+
+        MSG = 'Do not use remove_const in specs. ' \
+              'Consider using e.g. `stub_const`.'
+        RESTRICT_ON_SEND = %i[send __send__].freeze
+
+        # @!method remove_const(node)
+        def_node_matcher :remove_const, <<~PATTERN
+          (send _ {:send | :__send__} (sym :remove_const) _)
+        PATTERN
+
+        # Check for offenses
+        def on_send(node)
+          remove_const(node) do
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -48,7 +48,7 @@ module RuboCop
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
         # @!method several_example_groups?(node)
-        def_node_matcher :several_example_groups?, <<-PATTERN
+        def_node_matcher :several_example_groups?, <<~PATTERN
           (begin <#example_group_with_body? #example_group_with_body? ...>)
         PATTERN
 

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

@@ -48,12 +48,12 @@ module RuboCop
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
         # @!method several_example_groups?(node)
-        def_node_matcher :several_example_groups?, <<-PATTERN
+        def_node_matcher :several_example_groups?, <<~PATTERN
           (begin <#example_group? #example_group? ...>)
         PATTERN
 
         # @!method doc_string_and_metadata(node)
-        def_node_matcher :doc_string_and_metadata, <<-PATTERN
+        def_node_matcher :doc_string_and_metadata, <<~PATTERN
           (block (send _ _ $_ $...) ...)
         PATTERN
 

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

@@ -50,7 +50,7 @@ module RuboCop
               'on line(s) %<repeat>s'
 
         # @!method several_include_examples?(node)
-        def_node_matcher :several_include_examples?, <<-PATTERN
+        def_node_matcher :several_include_examples?, <<~PATTERN
           (begin <#include_examples? #include_examples? ...>)
         PATTERN
 

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

@@ -48,7 +48,7 @@ module RuboCop
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'
 
         # @!method and_return_value(node)
-        def_node_search :and_return_value, <<-PATTERN
+        def_node_search :and_return_value, <<~PATTERN
           $(send _ :and_return $(...))
         PATTERN
 

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

@@ -62,7 +62,7 @@ module RuboCop
         PATTERN
 
         # @!method context?(node)
-        def_node_search :context?, <<-PATTERN
+        def_node_search :context?, <<~PATTERN
           (send nil?
             {#Subjects.all #Helpers.all #Includes.context #Hooks.all} ...
           )

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,8 +24,24 @@ 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
@@ -34,19 +54,37 @@ module RuboCop
         def on_send(node)
           shared_examples(node) do
             ast_node = node.first_argument
-            next unless ast_node&.sym_type?
+            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 +93,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
 

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

@@ -41,7 +41,7 @@ module RuboCop
 
         # @!method example_group_arguments(node)
         def_node_matcher :example_group_arguments, <<~PATTERN
-          (block (send #rspec? #ExampleGroups.all $_ $...) ...)
+          (block $(send #rspec? #ExampleGroups.all $_ $...) ...)
         PATTERN
 
         # @!method metadata_key_value(node)
@@ -50,16 +50,16 @@ module RuboCop
         def on_top_level_example_group(node)
           return unless top_level_groups.one?
 
-          example_group_arguments(node) do |class_name, arguments|
+          example_group_arguments(node) do |send_node, class_name, arguments|
             next if !class_name.const_type? || ignore_metadata?(arguments)
 
-            ensure_correct_file_path(class_name, arguments)
+            ensure_correct_file_path(send_node, class_name, arguments)
           end
         end
 
         private
 
-        def ensure_correct_file_path(class_name, arguments)
+        def ensure_correct_file_path(send_node, class_name, arguments)
           pattern = correct_path_pattern(class_name, arguments)
           return if filename_ends_with?(pattern)
 
@@ -67,7 +67,7 @@ module RuboCop
           # expression pattern to resemble a glob pattern for clearer error
           # messages.
           suffix = pattern.sub('.*', '*').sub('[^/]*', '*').sub('\.', '.')
-          add_global_offense(format(MSG, suffix: suffix))
+          add_offense(send_node, message: format(MSG, suffix: suffix))
         end
 
         def ignore_metadata?(arguments)

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')