rubocop-rspec 2.14.2 → 2.16.0

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helper methods to find RSpec metadata.
+      module Metadata
+        extend RuboCop::NodePattern::Macros
+
+        include RuboCop::RSpec::Language
+
+        # @!method rspec_metadata(node)
+        def_node_matcher :rspec_metadata, <<~PATTERN
+          (block
+            (send
+              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all} _ ${send str sym}* (hash $...)?)
+            ...)
+        PATTERN
+
+        # @!method rspec_configure(node)
+        def_node_matcher :rspec_configure, <<~PATTERN
+          (block (send #rspec? :configure) (args (arg $_)) ...)
+        PATTERN
+
+        # @!method metadata_in_block(node)
+        def_node_search :metadata_in_block, <<~PATTERN
+          (send (lvar %) #Hooks.all _ ${send str sym}* (hash $...)?)
+        PATTERN
+
+        def on_block(node)
+          rspec_configure(node) do |block_var|
+            metadata_in_block(node, block_var) do |symbols, pairs|
+              on_metadata(symbols, pairs.flatten)
+            end
+          end
+
+          rspec_metadata(node) do |symbols, pairs|
+            on_metadata(symbols, pairs.flatten)
+          end
+        end
+        alias on_numblock on_block
+
+        def on_metadata(_symbols, _pairs)
+          raise ::NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -12,11 +12,11 @@ module RuboCop
       # should be the most important object in your tests so they deserve
       # a descriptive name.
       #
-      # This cop can be configured in your configuration using the
-      # `IgnoreSharedExamples` which will not report offenses for implicit
+      # This cop can be configured in your configuration using `EnforcedStyle`,
+      # and `IgnoreSharedExamples` which will not report offenses for implicit
       # subjects in shared example groups.
       #
-      # @example
+      # @example `EnforcedStyle: always` (default)
       #   # bad
       #   RSpec.describe User do
       #     subject { described_class.new }
@@ -27,7 +27,7 @@ module RuboCop
       #   end
       #
       #   # good
-      #   RSpec.describe Foo do
+      #   RSpec.describe User do
       #     subject(:user) { described_class.new }
       #
       #     it 'is valid' do
@@ -36,13 +36,49 @@ module RuboCop
       #   end
       #
       #   # also good
-      #   RSpec.describe Foo do
+      #   RSpec.describe User do
+      #     subject(:user) { described_class.new }
+      #
+      #     it { is_expected.to be_valid }
+      #   end
+      #
+      # @example `EnforcedStyle: named_only`
+      #   # bad
+      #   RSpec.describe User do
+      #     subject(:user) { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(subject.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.describe User do
       #     subject(:user) { described_class.new }
       #
+      #     it 'is valid' do
+      #       expect(user.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # also good
+      #   RSpec.describe User do
+      #     subject { described_class.new }
+      #
       #     it { is_expected.to be_valid }
       #   end
       #
+      #   # acceptable
+      #   RSpec.describe User do
+      #     subject { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(subject.valid?).to be(true)
+      #     end
+      #   end
       class NamedSubject < Base
+        include ConfigurableEnforcedStyle
+
         MSG = 'Name your test subject if you need to reference it explicitly.'
 
         # @!method example_or_hook_block?(node)
@@ -62,14 +98,53 @@ module RuboCop
           end
 
           subject_usage(node) do |subject_node|
-            add_offense(subject_node.loc.selector)
+            check_explicit_subject(subject_node)
           end
         end
 
+        private
+
         def ignored_shared_example?(node)
           cop_config['IgnoreSharedExamples'] &&
             node.each_ancestor(:block).any?(&method(:shared_example?))
         end
+
+        def check_explicit_subject(node)
+          return if allow_explicit_subject?(node)
+
+          add_offense(node.loc.selector)
+        end
+
+        def allow_explicit_subject?(node)
+          !always? && !named_only?(node)
+        end
+
+        def always?
+          style == :always
+        end
+
+        def named_only?(node)
+          style == :named_only &&
+            subject_definition_is_named?(node)
+        end
+
+        def subject_definition_is_named?(node)
+          subject = nearest_subject(node)
+
+          subject&.send_node&.arguments?
+        end
+
+        def nearest_subject(node)
+          node
+            .each_ancestor(:block)
+            .lazy
+            .map { |block_node| find_subject(block_node) }
+            .find(&:itself)
+        end
+
+        def find_subject(block_node)
+          block_node.body.child_nodes.find { |send_node| subject?(send_node) }
+        end
       end
     end
   end

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

@@ -133,7 +133,7 @@ module RuboCop
         def count_up_nesting?(node, example_group)
           example_group &&
             (node.block_type? &&
-            !allowed_groups.include?(node.method_name))
+            !allowed_groups.include?(node.method_name.to_s))
         end
 
         def message(nesting)

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for pending or skipped examples without reason.
+      #
+      # @example
+      #   # bad
+      #   pending 'does something' do
+      #   end
+      #
+      #   # bad
+      #   it 'does something', :pending do
+      #   end
+      #
+      #   # bad
+      #   it 'does something' do
+      #     pending
+      #   end
+      #
+      #   # bad
+      #   xdescribe 'something' do
+      #   end
+      #
+      #   # bad
+      #   skip 'does something' do
+      #   end
+      #
+      #   # bad
+      #   it 'does something', :skip do
+      #   end
+      #
+      #   # bad
+      #   it 'does something' do
+      #     skip
+      #   end
+      #
+      #   # bad
+      #   it 'does something'
+      #
+      #   # good
+      #   it 'does something' do
+      #     pending 'reason'
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     skip 'reason'
+      #   end
+      #
+      #   # good
+      #   it 'does something', pending: 'reason' do
+      #   end
+      #
+      #   # good
+      #   it 'does something', skip: 'reason' do
+      #   end
+      class PendingWithoutReason < Base
+        MSG = 'Give the reason for pending or skip.'
+
+        # @!method pending_by_example_method?(node)
+        def_node_matcher :pending_by_example_method?, block_pattern(<<~PATTERN)
+          #Examples.pending
+        PATTERN
+
+        # @!method pending_by_metadata_without_reason?(node)
+        def_node_matcher :pending_by_metadata_without_reason?, <<~PATTERN
+          (send #rspec? {#ExampleGroups.all #Examples.all} ... {<(sym :pending) ...> (hash <(pair (sym :pending) true) ...>)})
+        PATTERN
+
+        # @!method skipped_by_example_method?(node)
+        def_node_matcher :skipped_by_example_method?, block_pattern(<<~PATTERN)
+          #Examples.skipped
+        PATTERN
+
+        # @!method skipped_by_example_group_method?(node)
+        def_node_matcher(
+          :skipped_by_example_group_method?,
+          block_pattern(<<~PATTERN)
+            #ExampleGroups.skipped
+          PATTERN
+        )
+
+        # @!method skipped_by_metadata_without_reason?(node)
+        def_node_matcher :skipped_by_metadata_without_reason?, <<~PATTERN
+          (send #rspec? {#ExampleGroups.all #Examples.all} ... {<(sym :skip) ...> (hash <(pair (sym :skip) true) ...>)})
+        PATTERN
+
+        def on_send(node)
+          if pending_without_reason?(node)
+            add_offense(node, message: 'Give the reason for pending.')
+          elsif skipped_without_reason?(node)
+            add_offense(node, message: 'Give the reason for skip.')
+          end
+        end
+
+        private
+
+        def pending_by_pending_step_without_reason?(node)
+          node.method?(:pending) && node.first_argument.nil?
+        end
+
+        def pending_without_reason?(node)
+          pending_by_example_method?(node.block_node) ||
+            pending_by_metadata_without_reason?(node) ||
+            pending_by_pending_step_without_reason?(node)
+        end
+
+        def skipped_by_skip_step_without_reason?(node)
+          node.method?(:skip) && node.first_argument.nil?
+        end
+
+        def skipped_without_reason?(node)
+          skipped_by_example_group_method?(node.block_node) ||
+            skipped_by_example_method?(node.block_node) ||
+            skipped_by_metadata_without_reason?(node) ||
+            skipped_by_skip_step_without_reason?(node)
+        end
+      end
+    end
+  end
+end

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

@@ -283,6 +283,8 @@ module RuboCop
         include InflectedHelper
         include ExplicitHelper
 
+        RESTRICT_ON_SEND = Runners.all
+
         def on_send(node)
           case style
           when :inflected

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

@@ -13,20 +13,23 @@ module RuboCop
         #   # good
         #   expect(response).to have_http_status(200)
         #
-        class HaveHttpStatus < Base
+        class HaveHttpStatus < ::RuboCop::Cop::Base
           extend AutoCorrector
 
           MSG =
             'Prefer `expect(response).%<to>s have_http_status(%<status>i)` ' \
             'over `expect(response.status).%<to>s %<match>s`.'
 
+          RUNNERS = %i[to to_not not_to].to_set
+          RESTRICT_ON_SEND = RUNNERS
+
           # @!method match_status(node)
           def_node_matcher :match_status, <<-PATTERN
             (send
               (send nil? :expect
                 $(send (send nil? :response) :status)
               )
-              $#Runners.all
+              $RUNNERS
               $(send nil? {:be :eq :eql :equal} (int $_))
             )
           PATTERN

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

@@ -33,7 +33,7 @@ module RuboCop
         #
         # @example `Inferences` configuration
         #   # .rubocop.yml
-        #   # RSpec/InferredSpecType:
+        #   # RSpec/Rails/InferredSpecType:
         #   #   Inferences:
         #   #     services: service
         #

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

@@ -45,8 +45,12 @@ module RuboCop
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
-          repeated_descriptions(node).each do |repeated_description|
-            add_offense(repeated_description)
+          repeated_descriptions(node).each do |description|
+            add_offense(description)
+          end
+
+          repeated_its(node).each do |its|
+            add_offense(its)
           end
         end
 
@@ -57,6 +61,7 @@ module RuboCop
           grouped_examples =
             RuboCop::RSpec::ExampleGroup.new(node)
               .examples
+              .reject { |n| n.definition.method?(:its) }
               .group_by { |example| example_signature(example) }
 
           grouped_examples
@@ -66,9 +71,27 @@ module RuboCop
             .map(&:definition)
         end
 
+        def repeated_its(node)
+          grouped_its =
+            RuboCop::RSpec::ExampleGroup.new(node)
+              .examples
+              .select { |n| n.definition.method?(:its) }
+              .group_by { |example| its_signature(example) }
+
+          grouped_its
+            .select { |signatures, group| signatures.any? && group.size > 1 }
+            .values
+            .flatten
+            .map(&:to_node)
+        end
+
         def example_signature(example)
           [example.metadata, example.doc_string]
         end
+
+        def its_signature(example)
+          [example.doc_string, example]
+        end
       end
     end
   end

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

@@ -41,6 +41,8 @@ module RuboCop
           end
         end
 
+        private
+
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks

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

@@ -18,45 +18,12 @@ module RuboCop
       #
       class SortMetadata < Base
         extend AutoCorrector
+        include Metadata
         include RangeHelp
 
         MSG = 'Sort metadata alphabetically.'
 
-        # @!method rspec_metadata(node)
-        def_node_matcher :rspec_metadata, <<~PATTERN
-          (block
-            (send
-              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all} _ ${send str sym}* (hash $...)?)
-            ...)
-        PATTERN
-
-        # @!method rspec_configure(node)
-        def_node_matcher :rspec_configure, <<~PATTERN
-          (block (send #rspec? :configure) (args (arg $_)) ...)
-        PATTERN
-
-        # @!method metadata_in_block(node)
-        def_node_search :metadata_in_block, <<~PATTERN
-          (send (lvar %) #Hooks.all _ ${send str sym}* (hash $...)?)
-        PATTERN
-
-        def on_block(node)
-          rspec_configure(node) do |block_var|
-            metadata_in_block(node, block_var) do |symbols, pairs|
-              investigate(symbols, pairs.flatten)
-            end
-          end
-
-          rspec_metadata(node) do |symbols, pairs|
-            investigate(symbols, pairs.flatten)
-          end
-        end
-
-        alias on_numblock on_block
-
-        private
-
-        def investigate(symbols, pairs)
+        def on_metadata(symbols, pairs)
           return if sorted?(symbols, pairs)
 
           crime_scene = crime_scene(symbols, pairs)
@@ -65,6 +32,8 @@ module RuboCop
           end
         end
 
+        private
+
         def crime_scene(symbols, pairs)
           metadata = symbols + pairs
 

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

@@ -133,6 +133,8 @@ module RuboCop
           }
         PATTERN
 
+        RESTRICT_ON_SEND = %i[to].freeze
+
         def on_send(node)
           expectation(node, &method(:on_expectation))
         end

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

@@ -50,6 +50,8 @@ module RuboCop
           add_offense(node.children.last)
         end
 
+        private
+
         def empty_exception_matcher?(node)
           empty_raise_error_or_exception(node) && !block_with_args?(node.parent)
         end

data/lib/rubocop/cop/rspec_cops.rb

@@ -12,6 +12,7 @@ require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/consistent_parentheses_style'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
+require_relative 'rspec/factory_bot/factory_name_style'
 require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
@@ -42,6 +43,7 @@ require_relative 'rspec/describe_symbol'
 require_relative 'rspec/described_class'
 require_relative 'rspec/described_class_module_wrapping'
 require_relative 'rspec/dialect'
+require_relative 'rspec/duplicated_metadata'
 require_relative 'rspec/empty_example_group'
 require_relative 'rspec/empty_hook'
 require_relative 'rspec/empty_line_after_example'
@@ -87,6 +89,7 @@ require_relative 'rspec/no_expectation_example'
 require_relative 'rspec/not_to_not'
 require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'
+require_relative 'rspec/pending_without_reason'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/receive_counts'
 require_relative 'rspec/receive_never'

data/lib/rubocop/rspec/config_formatter.rb

@@ -9,7 +9,7 @@ module RuboCop
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
       AMENDMENTS = %(Metrics/BlockLength)
-      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
+      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
         @config       = config
@@ -47,7 +47,7 @@ module RuboCop
       end
 
       def reference(cop)
-        COP_DOC_BASE_URL + cop.sub('RSpec/', '')
+        COP_DOC_BASE_URL + cop
       end
 
       attr_reader :config, :descriptions

data/lib/rubocop/rspec/description_extractor.rb

@@ -21,7 +21,8 @@ module RuboCop
 
       # Decorator of a YARD code object for working with documented rspec cops
       class CodeObject
-        COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
+        RSPEC_COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
+        RUBOCOP_COP_CLASS_NAME = 'RuboCop::Cop::Base'
         RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'
 
         def initialize(yardoc)
@@ -32,10 +33,7 @@ module RuboCop
         #
         # @return [Boolean]
         def rspec_cop?
-          class_documentation? &&
-            rspec_cop_namespace? &&
-            cop_subclass? &&
-            !abstract?
+          cop_subclass? && !abstract? && rspec_cop_namespace?
         end
 
         # Configuration for the documented cop that would live in default.yml
@@ -55,10 +53,6 @@ module RuboCop
           yardoc.docstring.split("\n\n").first.to_s
         end
 
-        def class_documentation?
-          yardoc.type.equal?(:class)
-        end
-
         def rspec_cop_namespace?
           documented_constant.start_with?(RSPEC_NAMESPACE)
         end
@@ -68,7 +62,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == COP_CLASS_NAME
+          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
+            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
         end
 
         def abstract?

data/lib/rubocop/rspec/language.rb

@@ -135,8 +135,9 @@ module RuboCop
       end
 
       module HookScopes # :nodoc:
+        ALL = %i[each example context all suite].freeze
         def self.all(element)
-          Language.config['HookScopes'].include?(element.to_s)
+          ALL.include?(element)
         end
       end
 
@@ -158,8 +159,13 @@ module RuboCop
       end
 
       module Runners # :nodoc:
-        def self.all(element)
-          Language.config['Runners'].include?(element.to_s)
+        ALL = %i[to to_not not_to].freeze
+        class << self
+          def all(element = nil)
+            return ALL if element.nil?
+
+            ALL.include?(element)
+          end
         end
       end
 

data/lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'with default RSpec/Language config' do
+  include_context 'config'
+
+  # Deep duplication is needed to prevent config leakage between examples
+  let(:other_cops) do
+    default_language = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Language']
+    default_include = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Include']
+    { 'RSpec' =>
+      {
+        'Include' => default_include,
+        'Language' => deep_dup(default_language)
+      } }
+  end
+
+  def deep_dup(object)
+    case object
+    when Array
+      object.map { |item| deep_dup(item) }
+    when Hash
+      object.transform_values(&method(:deep_dup))
+    else
+      object # only collections undergo modifications and need duping
+    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 = '2.14.2'
+      STRING = '2.16.0'
     end
   end
 end