rubocop-rspec 3.3.0 → 3.6.0

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

@@ -47,7 +47,7 @@ module RuboCop
 
         # @!method skippable_example?(node)
         def_node_matcher :skippable_example?, <<~PATTERN
-          (send nil? #Examples.regular ...)
+          (send nil? #Examples.regular _ ...)
         PATTERN
 
         # @!method pending_block?(node)

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

@@ -63,8 +63,7 @@ module RuboCop
         def_node_matcher :skipped_in_example?, <<~PATTERN
           {
             (send nil? ${#Examples.skipped #Examples.pending})
-            (block (send nil? ${#Examples.skipped}) ...)
-            (numblock (send nil? ${#Examples.skipped}) ...)
+            (any_block (send nil? ${#Examples.skipped}) ...)
           }
         PATTERN
 
@@ -75,7 +74,7 @@ module RuboCop
 
         # @!method skipped_by_example_method_with_block?(node)
         def_node_matcher :skipped_by_example_method_with_block?, <<~PATTERN
-          ({block numblock} (send nil? ${#Examples.skipped #Examples.pending} ...) ...)
+          (any_block (send nil? ${#Examples.skipped #Examples.pending} ...) ...)
         PATTERN
 
         # @!method metadata_without_reason?(node)
@@ -94,11 +93,6 @@ module RuboCop
           (send #rspec? ${#ExampleGroups.skipped} ...)
         PATTERN
 
-        # @!method pending_step_without_reason?(node)
-        def_node_matcher :pending_step_without_reason?, <<~PATTERN
-          (send nil? {:skip :pending})
-        PATTERN
-
         def on_send(node)
           on_pending_by_metadata(node)
           return unless (parent = parent_node(node))

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

@@ -15,6 +15,8 @@ module RuboCop
 
         def check_inflected(node)
           predicate_in_actual?(node) do |predicate, to, matcher|
+            next if cannot_replace_predicate?(predicate)
+
             msg = message_inflected(predicate)
             add_offense(node, message: msg) do |corrector|
               remove_predicate(corrector, predicate)
@@ -35,9 +37,13 @@ module RuboCop
             $#boolean_matcher? ...)
         PATTERN
 
+        def cannot_replace_predicate?(send_node)
+          send_node.method?(:respond_to?) && send_node.arguments.length > 1
+        end
+
         # @!method be_bool?(node)
         def_node_matcher :be_bool?, <<~PATTERN
-          (send nil? {:be :eq :eql :equal} {true false})
+          (send nil? {:be :eq :eql :equal} boolean)
         PATTERN
 
         # @!method be_boolthy?(node)
@@ -63,7 +69,6 @@ module RuboCop
                  matcher_name: to_predicate_matcher(predicate.method_name))
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_matcher(name)
           case name = name.to_s
           when 'is_a?'
@@ -80,7 +85,6 @@ module RuboCop
             "be_#{name[0..-2]}"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def remove_predicate(corrector, predicate)
           range = predicate.loc.dot.with(
@@ -106,12 +110,16 @@ module RuboCop
 
         def true?(to_symbol, matcher)
           result = case matcher.method_name
-                   when :be, :eq
+                   when :be, :eq, :eql, :equal
                      matcher.first_argument.true_type?
                    when :be_truthy, :a_truthy_value
                      true
                    when :be_falsey, :be_falsy, :a_falsey_value, :a_falsy_value
                      false
+                   else
+                     # :nocov:
+                     :noop
+                     # :nocov:
                    end
           to_symbol == :to ? result : !result
         end
@@ -174,7 +182,7 @@ module RuboCop
 
         def heredoc_argument?(matcher)
           matcher.arguments.select do |arg|
-            arg.str_type? || arg.dstr_type? || arg.xstr_type?
+            arg.type?(:str, :dstr, :xstr)
           end.any?(&:heredoc?)
         end
 
@@ -233,7 +241,6 @@ module RuboCop
           corrector.insert_after(actual, ".#{predicate}" + args + block)
         end
 
-        # rubocop:disable Metrics/MethodLength
         def to_predicate_method(matcher)
           case matcher = matcher.to_s
           when 'be_a', 'be_an', 'be_a_kind_of', 'a_kind_of', 'be_kind_of'
@@ -250,7 +257,6 @@ module RuboCop
             "#{matcher[/\Abe_(.+)/, 1]}?"
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         def replacement_matcher(node)
           case [cop_config['Strict'], node.method?(:to)]
@@ -260,7 +266,7 @@ module RuboCop
             'be(false)'
           when [false, true]
             'be_truthy'
-          when [false, false]
+          else
             'be_falsey'
           end
         end
@@ -329,6 +335,10 @@ module RuboCop
             check_inflected(node)
           when :explicit
             check_explicit(node)
+          else
+            # :nocov:
+            :noop
+            # :nocov:
           end
         end
 

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

@@ -148,8 +148,7 @@ module RuboCop
         end
 
         def heredoc_or_splat?(node)
-          ((node.str_type? || node.dstr_type?) && node.heredoc?) ||
-            node.splat_type?
+          (node.type?(:str, :dstr) && node.heredoc?) || node.splat_type?
         end
 
         def requires_quotes?(value)

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

@@ -41,7 +41,7 @@ module RuboCop
 
         # @!method match_redundant_around_hook_block?(node)
         def_node_matcher :match_redundant_around_hook_block?, <<~PATTERN
-          ({block numblock} (send _ :around ...) ... (send _ :run))
+          (any_block (send _ :around ...) ... (send _ :run))
         PATTERN
 
         # @!method match_redundant_around_hook_send?(node)

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

@@ -80,10 +80,10 @@ module RuboCop
 
         def check_block_body(block)
           body = block.body
-          unless dynamic?(body) # rubocop:disable Style/GuardClause
-            add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
-              BlockBodyCorrector.new(block).call(corrector)
-            end
+          return if dynamic?(body)
+
+          add_offense(block.loc.begin, message: MSG_AND_RETURN) do |corrector|
+            BlockBodyCorrector.new(block).call(corrector)
           end
         end
 
@@ -162,6 +162,7 @@ module RuboCop
           end
 
           NULL_BLOCK_BODY = Struct.new(:loc, :source).new(nil, 'nil')
+          private_constant :NULL_BLOCK_BODY
         end
       end
     end

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

@@ -5,7 +5,9 @@ module RuboCop
     module RSpec
       # Checks for setup scattered across multiple hooks in an example group.
       #
-      # Unify `before`, `after`, and `around` hooks when possible.
+      # Unify `before` and `after` hooks when possible.
+      # However, `around` hooks are allowed to be defined multiple times,
+      # as unifying them would typically make the code harder to read.
       #
       # @example
       #   # bad
@@ -22,6 +24,12 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
+      #   describe Foo do
+      #     around { |example| before1; example.call; after1 }
+      #     around { |example| before2; example.call; after2 }
+      #   end
+      #
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
@@ -48,7 +56,7 @@ module RuboCop
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks
-            .select(&:knowable_scope?)
+            .select { |hook| hook.knowable_scope? && hook.name != :around }
             .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
             .reject(&:one?)

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

@@ -5,6 +5,8 @@ module RuboCop
     module RSpec
       # Sort RSpec metadata alphabetically.
       #
+      # Only the trailing metadata is sorted.
+      #
       # @example
       #   # bad
       #   describe 'Something', :b, :a
@@ -16,6 +18,9 @@ module RuboCop
       #   context 'Something', baz: true, foo: 'bar'
       #   it 'works', :a, :b, baz: true, foo: 'bar'
       #
+      #   # good, trailing metadata is sorted
+      #   describe 'Something', 'description', :a, :b, :z
+      #   context 'Something', :z, variable, :a, :b
       class SortMetadata < Base
         extend AutoCorrector
         include Metadata
@@ -23,8 +28,14 @@ module RuboCop
 
         MSG = 'Sort metadata alphabetically.'
 
-        def on_metadata(symbols, hash)
+        # @!method match_ambiguous_trailing_metadata?(node)
+        def_node_matcher :match_ambiguous_trailing_metadata?, <<~PATTERN
+          (send _ _ _ ... !{hash sym str dstr xstr})
+        PATTERN
+
+        def on_metadata(args, hash)
           pairs = hash&.pairs || []
+          symbols = trailing_symbols(args)
           return if sorted?(symbols, pairs)
 
           crime_scene = crime_scene(symbols, pairs)
@@ -35,6 +46,15 @@ module RuboCop
 
         private
 
+        def trailing_symbols(args)
+          args = args[...-1] if last_arg_could_be_a_hash?(args)
+          args.reverse.take_while(&:sym_type?).reverse
+        end
+
+        def last_arg_could_be_a_hash?(args)
+          args.last && match_ambiguous_trailing_metadata?(args.last.parent)
+        end
+
         def crime_scene(symbols, pairs)
           metadata = symbols + pairs
 
@@ -57,13 +77,7 @@ module RuboCop
         end
 
         def sort_symbols(symbols)
-          symbols.sort_by do |symbol|
-            if symbol.str_type? || symbol.sym_type?
-              symbol.value.to_s.downcase
-            else
-              symbol.source.downcase
-            end
-          end
+          symbols.sort_by { |symbol| symbol.value.to_s.downcase }
         end
       end
     end

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

@@ -69,7 +69,7 @@ module RuboCop
         end
 
         def symbol?(node)
-          node.sym_type? || node.dsym_type?
+          node.type?(:sym, :dsym)
         end
       end
     end

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

@@ -50,7 +50,7 @@ module RuboCop
           return unless inside_example_group?(node)
 
           variable_definition?(node) do |variable|
-            return if variable.dstr_type? || variable.dsym_type?
+            return if variable.type?(:dstr, :dsym)
             return if matches_allowed_pattern?(variable.value)
 
             check_name(node, variable.value, variable.source_range)

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

@@ -5,14 +5,14 @@ module RuboCop
     module RSpec
       # Checks for consistent verified double reference style.
       #
-      # Only investigates references that are one of the supported styles.
-      #
       # @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`.
+      # @safety
+      #   This cop is unsafe because the correction requires loading the class.
+      #   Loading before stubbing causes RSpec to only allow instance methods
+      #   to be stubbed.
       #
-      # @example `EnforcedStyle: constant` (default)
+      # @example
       #   # bad
       #   let(:foo) do
       #     instance_double('ClassName', method_name: 'returned_value')
@@ -23,18 +23,7 @@ module RuboCop
       #     instance_double(ClassName, method_name: 'returned_value')
       #   end
       #
-      # @example `EnforcedStyle: string`
-      #   # bad
-      #   let(:foo) do
-      #     instance_double(ClassName, method_name: 'returned_value')
-      #   end
-      #
-      #   # good
-      #   let(:foo) do
-      #     instance_double('ClassName', method_name: 'returned_value')
-      #   end
-      #
-      # @example Reference is not in the supported style list. No enforcement
+      # @example Reference is any dynamic variable. No enforcement
       #
       #   # good
       #   let(:foo) do
@@ -42,9 +31,9 @@ module RuboCop
       #   end
       class VerifiedDoubleReference < Base
         extend AutoCorrector
-        include ConfigurableEnforcedStyle
 
-        MSG = 'Use a %<style>s class reference for verified doubles.'
+        MSG = 'Use a constant class reference for verified doubles. ' \
+              'String references are not verifying unless the class is loaded.'
 
         RESTRICT_ON_SEND = Set[
           :class_double,
@@ -57,53 +46,25 @@ module RuboCop
           :stub_model
         ].freeze
 
-        REFERENCE_TYPE_STYLES = {
-          str: :string,
-          const: :constant
-        }.freeze
-
         # @!method verified_double(node)
         def_node_matcher :verified_double, <<~PATTERN
           (send
             nil?
             RESTRICT_ON_SEND
-            $_class_reference
+            $str
             ...)
         PATTERN
 
         def on_send(node)
-          verified_double(node) do |class_reference|
-            break correct_style_detected unless opposing_style?(class_reference)
-
-            message = format(MSG, style: style)
-            expression = class_reference.source_range
-
-            add_offense(expression, message: message) do |corrector|
-              offense = class_reference.source
-              corrector.replace(expression, correct_style(offense))
-
-              opposite_style_detected
+          verified_double(node) do |string_argument_node|
+            add_offense(string_argument_node) do |corrector|
+              autocorrect(corrector, string_argument_node)
             end
           end
         end
 
-        private
-
-        def opposing_style?(class_reference)
-          class_reference_style = REFERENCE_TYPE_STYLES[class_reference.type]
-
-          # Only enforce supported styles
-          return false unless class_reference_style
-
-          class_reference_style != style
-        end
-
-        def correct_style(offense)
-          if style == :string
-            "'#{offense}'"
-          else
-            offense.gsub(/^['"]|['"]$/, '')
-          end
+        def autocorrect(corrector, node)
+          corrector.replace(node, node.value)
         end
       end
     end

data/lib/rubocop/cop/rspec_cops.rb

@@ -48,6 +48,7 @@ require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'
+require_relative 'rspec/include_examples'
 require_relative 'rspec/indexed_let'
 require_relative 'rspec/instance_spy'
 require_relative 'rspec/instance_variable'
@@ -99,7 +100,6 @@ 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/string_as_instance_double_constant'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'

data/lib/rubocop/rspec/config_formatter.rb

@@ -6,9 +6,7 @@ module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
-      SUBDEPARTMENTS = [].freeze
-      AMENDMENTS = %(Metrics/BlockLength)
+      EXTENSION_ROOT_DEPARTMENT = %r{^RSpec/}.freeze
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
@@ -18,18 +16,15 @@ module RuboCop
 
       def dump
         YAML.dump(unified_config)
-          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
-          .gsub(*AMENDMENTS, "\n\\0")
-          .gsub(/^(\s+)- /, '\1  - ')
-          .gsub('"~"', '~')
+          .gsub(%r{^\w+/}, "\n\\0")   # Add an extra newline before each cop.
+          .gsub(/^(\s+)- /, '\1  - ') # Add 2 spaces before each array element.
+          .gsub('"~"', '~')           # Don't quote tilde, YAML's null value.
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
-
           replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))
           unified[cop]['Reference'] = reference(cop)

data/lib/rubocop/rspec/description_extractor.rb

@@ -62,8 +62,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
-            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
+          [RSPEC_COP_CLASS_NAME,
+           RUBOCOP_COP_CLASS_NAME].include?(yardoc.superclass.path)
         end
 
         def abstract?

data/lib/rubocop/rspec/hook.rb

@@ -64,7 +64,9 @@ module RuboCop
       end
 
       def transform_true(node)
-        node.true_type? ? true : node
+        return true if node.true_type?
+
+        node
       end
 
       def scope_name

data/lib/rubocop/rspec/language.rb

@@ -26,7 +26,7 @@ module RuboCop
 
       # @!method example_group?(node)
       def_node_matcher :example_group?, <<~PATTERN
-        ({block numblock} (send #rspec? #ExampleGroups.all ...) ...)
+        (any_block (send #rspec? #ExampleGroups.all ...) ...)
       PATTERN
 
       # @!method shared_group?(node)
@@ -35,7 +35,7 @@ module RuboCop
 
       # @!method spec_group?(node)
       def_node_matcher :spec_group?, <<~PATTERN
-        ({block numblock} (send #rspec?
+        (any_block (send #rspec?
              {#SharedGroups.all #ExampleGroups.all}
           ...) ...)
       PATTERN
@@ -50,10 +50,7 @@ module RuboCop
 
       # @!method hook?(node)
       def_node_matcher :hook?, <<~PATTERN
-        {
-          (numblock (send nil? #Hooks.all ...) ...)
-          (block (send nil? #Hooks.all ...) ...)
-        }
+        (any_block (send nil? #Hooks.all ...) ...)
       PATTERN
 
       # @!method let?(node)

data/lib/rubocop/rspec/plugin.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RSpec
+    # A plugin that integrates RuboCop RSpec with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rspec',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rspec',
+          description: 'Code style checking for RSpec files.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+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 = '3.3.0'
+      STRING = '3.6.0'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -17,7 +17,6 @@ module RuboCop
         @replacements = replace
       end
 
-      # rubocop:disable Metrics/MethodLength
       def rewrite
         case text
         when SHOULDNT_BE_PREFIX
@@ -32,7 +31,6 @@ module RuboCop
           remove_should_and_pluralize
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/rubocop/rspec.rb

@@ -3,12 +3,5 @@
 module RuboCop
   # RuboCop RSpec project namespace
   module RSpec
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config',
-                                                           'obsoletion.yml')
   end
 end

data/lib/rubocop-rspec.rb

@@ -6,9 +6,9 @@ require 'yaml'
 require 'rubocop'
 
 require_relative 'rubocop/rspec'
-require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/plugin'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
 
@@ -34,8 +34,6 @@ require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
-RuboCop::RSpec::Inject.defaults!
-
 require_relative 'rubocop/cop/rspec_cops'
 
 # We have to register our autocorrect incompatibilities in RuboCop's cops