rubocop-rspec 2.11.1 → 2.13.0

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

@@ -6,45 +6,44 @@ module RuboCop
       # Check for repeated include of shared examples.
       #
       # @example
+      #   # bad
+      #   describe 'foo' do
+      #     include_examples 'cool stuff'
+      #     include_examples 'cool stuff'
+      #   end
       #
-      #    # bad
-      #    describe 'foo' do
-      #      include_examples 'cool stuff'
-      #      include_examples 'cool stuff'
-      #    end
+      #   # bad
+      #   describe 'foo' do
+      #     it_behaves_like 'a cool', 'thing'
+      #     it_behaves_like 'a cool', 'thing'
+      #   end
       #
-      #    # bad
-      #    describe 'foo' do
-      #      it_behaves_like 'a cool', 'thing'
-      #      it_behaves_like 'a cool', 'thing'
-      #    end
+      #   # bad
+      #   context 'foo' do
+      #     it_should_behave_like 'a duck'
+      #     it_should_behave_like 'a duck'
+      #   end
       #
-      #    # bad
-      #    context 'foo' do
-      #      it_should_behave_like 'a duck'
-      #      it_should_behave_like 'a duck'
-      #    end
+      #   # good
+      #   describe 'foo' do
+      #     include_examples 'cool stuff'
+      #   end
       #
-      #    # good
-      #    describe 'foo' do
-      #      include_examples 'cool stuff'
-      #    end
+      #   describe 'bar' do
+      #     include_examples 'cool stuff'
+      #   end
       #
-      #    describe 'bar' do
-      #      include_examples 'cool stuff'
-      #    end
+      #   # good
+      #   describe 'foo' do
+      #     it_behaves_like 'a cool', 'thing'
+      #     it_behaves_like 'a cool', 'person'
+      #   end
       #
-      #    # good
-      #    describe 'foo' do
-      #      it_behaves_like 'a cool', 'thing'
-      #      it_behaves_like 'a cool', 'person'
-      #    end
-      #
-      #    # good
-      #    context 'foo' do
-      #      it_should_behave_like 'a duck'
-      #      it_should_behave_like 'a goose'
-      #    end
+      #   # good
+      #   context 'foo' do
+      #     it_should_behave_like 'a duck'
+      #     it_should_behave_like 'a goose'
+      #   end
       #
       class RepeatedIncludeExample < Base
         MSG = 'Repeated include of shared_examples %<name>s ' \

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

@@ -11,6 +11,17 @@ module RuboCop
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
+      # @example `EnforcedStyle: and_return` (default)
+      #   # bad
+      #   allow(Foo).to receive(:bar) { "baz" }
+      #   expect(Foo).to receive(:bar) { "baz" }
+      #
+      #   # good
+      #   allow(Foo).to receive(:bar).and_return("baz")
+      #   expect(Foo).to receive(:bar).and_return("baz")
+      #   # also good as the returned value is dynamic
+      #   allow(Foo).to receive(:bar) { bar.baz }
+      #
       # @example `EnforcedStyle: block`
       #   # bad
       #   allow(Foo).to receive(:bar).and_return("baz")
@@ -22,17 +33,6 @@ module RuboCop
       #   # also good as the returned value is dynamic
       #   allow(Foo).to receive(:bar).and_return(bar.baz)
       #
-      # @example `EnforcedStyle: and_return`
-      #   # bad
-      #   allow(Foo).to receive(:bar) { "baz" }
-      #   expect(Foo).to receive(:bar) { "baz" }
-      #
-      #   # good
-      #   allow(Foo).to receive(:bar).and_return("baz")
-      #   expect(Foo).to receive(:bar).and_return("baz")
-      #   # also good as the returned value is dynamic
-      #   allow(Foo).to receive(:bar) { bar.baz }
-      #
       class ReturnFromStub < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
@@ -59,7 +59,7 @@ module RuboCop
           check_and_return_call(node)
         end
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless style == :and_return
           return unless stub_with_block?(node)
 

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

@@ -31,7 +31,7 @@ module RuboCop
 
         MSG = 'Group all let/let! blocks in the example group together.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 
           check_let_declarations(node.body)
@@ -53,10 +53,6 @@ module RuboCop
             end
           end
         end
-
-        def find_first_let(node)
-          node.children.find { |child| let?(child) }
-        end
       end
     end
   end

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

@@ -26,7 +26,7 @@ module RuboCop
         MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
               'example group (also defined on %<lines>s).'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
           repeated_hooks(node).each do |occurrences|
@@ -35,7 +35,7 @@ module RuboCop
             occurrences.each do |occurrence|
               lines_except_current = lines - [occurrence.first_line]
               message = format(MSG, hook_name: occurrences.first.method_name,
-                               lines: lines_msg(lines_except_current))
+                                    lines: lines_msg(lines_except_current))
               add_offense(occurrence, message: message)
             end
           end

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

@@ -79,7 +79,7 @@ module RuboCop
         def_node_matcher :shared_example,
                          block_pattern('#SharedGroups.examples')
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           context_with_only_examples(node) do
             add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
               corrector.replace(node.send_node.loc.selector, 'shared_examples')

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

@@ -6,7 +6,6 @@ module RuboCop
       # Checks that message expectations do not have a configured response.
       #
       # @example
-      #
       #   # bad
       #   expect(foo).to receive(:bar).with(42).and_return("hello world")
       #

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

@@ -6,7 +6,6 @@ module RuboCop
       # Ensure that subject is defined using subject helper.
       #
       # @example
-      #
       #   # bad
       #   let(:subject) { foo }
       #   let!(:subject) { foo }

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

@@ -11,7 +11,7 @@ module RuboCop
       # when subject is also defined in parent example groups.
       #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
-      # @see https://samphippen.com/introducing-rspec-smells-and-where-to-find-them#smell-1-stubject
+      # @see https://penelope.zone/2015/12/27/introducing-rspec-smells-and-where-to-find-them.html#smell-1-stubjec
       # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
       #
       # @example
@@ -72,7 +72,7 @@ module RuboCop
         def_node_matcher :subject?, <<-PATTERN
           (block
             (send nil?
-              {:subject (sym $_) | $:subject}
+              { #Subjects.all (sym $_) | $#Subjects.all }
             ) args ...)
         PATTERN
 

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

@@ -10,26 +10,26 @@ module RuboCop
       # to `raise_error`
       #
       # @example
+      #   # bad
+      #   expect {
+      #     raise StandardError.new('error')
+      #   }.to raise_error
       #
-      #     # bad
-      #     expect {
-      #       raise StandardError.new('error')
-      #     }.to raise_error
+      #   # good
+      #   expect {
+      #     raise StandardError.new('error')
+      #   }.to raise_error(StandardError)
       #
-      #     # good
-      #     expect {
-      #       raise StandardError.new('error')
-      #     }.to raise_error(StandardError)
+      #   expect {
+      #     raise StandardError.new('error')
+      #   }.to raise_error('error')
       #
-      #     expect {
-      #       raise StandardError.new('error')
-      #     }.to raise_error('error')
+      #   expect {
+      #     raise StandardError.new('error')
+      #   }.to raise_error(/err/)
       #
-      #     expect {
-      #       raise StandardError.new('error')
-      #     }.to raise_error(/err/)
+      #   expect { do_something }.not_to raise_error
       #
-      #     expect { do_something }.not_to raise_error
       class UnspecifiedException < Base
         MSG = 'Specify the exception being captured'
         RESTRICT_ON_SEND = %i[to].freeze

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

@@ -22,6 +22,7 @@ module RuboCop
       #   # good
       #   subject('user') { create_user }
       #   let('user_name') { 'Adam' }
+      #
       class VariableDefinition < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle

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

@@ -5,7 +5,7 @@ module RuboCop
     module RSpec
       # Checks that memoized helper names use the configured style.
       #
-      # Variables can be excluded from checking using the `IgnoredPatterns`
+      # Variables can be excluded from checking using the `AllowedPatterns`
       # option.
       #
       # @example EnforcedStyle: snake_case (default)
@@ -26,22 +26,21 @@ module RuboCop
       #   subject(:userName1) { 'Adam' }
       #   let(:userName2) { 'Adam' }
       #
-      # @example IgnoredPatterns configuration
-      #
+      # @example AllowedPatterns configuration
       #   # rubocop.yml
       #   # RSpec/VariableName:
       #   #   EnforcedStyle: snake_case
-      #   #   IgnoredPatterns:
+      #   #   AllowedPatterns:
       #   #     - ^userFood
       #
       # @example
-      #   # okay because it matches the `^userFood` regex in `IgnoredPatterns`
+      #   # okay because it matches the `^userFood` regex in `AllowedPatterns`
       #   subject(:userFood_1) { 'spaghetti' }
       #   let(:userFood_2) { 'fettuccine' }
       #
       class VariableName < Base
         include ConfigurableNaming
-        include IgnoredPattern
+        include AllowedPattern
         include Variable
 
         MSG = 'Use %<style>s for variable names.'
@@ -49,7 +48,7 @@ module RuboCop
         def on_send(node)
           variable_definition?(node) do |variable|
             return if variable.dstr_type? || variable.dsym_type?
-            return if matches_ignored_pattern?(variable.value)
+            return if matches_allowed_pattern?(variable.value)
 
             check_name(node, variable.value, variable.loc.expression)
           end

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

@@ -22,6 +22,7 @@ module RuboCop
       #   let(:foo) do
       #     instance_double("ClassName", method_name: 'returned value')
       #   end
+      #
       class VerifiedDoubles < Base
         MSG = 'Prefer using verifying doubles over normal doubles.'
         RESTRICT_ON_SEND = %i[double spy].freeze

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

@@ -11,6 +11,7 @@ module RuboCop
       #
       #   # good
       #   expect(something).to be(1)
+      #
       class VoidExpect < Base
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               'Chain the methods or remove it.'
@@ -32,7 +33,7 @@ module RuboCop
           check_expect(node)
         end
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless expect_block?(node)
 
           check_expect(node)

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

@@ -11,6 +11,7 @@ module RuboCop
       #
       #   # good
       #   expect(foo).to receive(:bar).and_yield(1)
+      #
       class Yield < Base
         extend AutoCorrector
         include RangeHelp
@@ -26,7 +27,7 @@ module RuboCop
         # @!method block_call?(node)
         def_node_matcher :block_call?, '(send (lvar %) :call ...)'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless method_on_stub?(node.send_node)
 
           block_arg(node.arguments) do |block|
@@ -44,7 +45,7 @@ module RuboCop
 
         def autocorrect(corrector, node, range)
           corrector.replace(
-            range_with_surrounding_space(range: range, side: :left),
+            range_with_surrounding_space(range, side: :left),
             generate_replacement(node.body)
           )
         end

data/lib/rubocop/cop/rspec_cops.rb

@@ -2,6 +2,8 @@
 
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
+require_relative 'rspec/capybara/specific_finders'
+require_relative 'rspec/capybara/specific_matcher'
 require_relative 'rspec/capybara/visibility_matcher'
 
 require_relative 'rspec/factory_bot/attribute_defined_statically'
@@ -10,6 +12,7 @@ require_relative 'rspec/factory_bot/factory_class_name'
 require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
+require_relative 'rspec/rails/have_http_status'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
@@ -26,6 +29,7 @@ require_relative 'rspec/be_eql'
 require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/change_by_zero'
+require_relative 'rspec/class_check'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'
 require_relative 'rspec/describe_class'
@@ -75,6 +79,7 @@ require_relative 'rspec/multiple_memoized_helpers'
 require_relative 'rspec/multiple_subjects'
 require_relative 'rspec/named_subject'
 require_relative 'rspec/nested_groups'
+require_relative 'rspec/no_expectation_example'
 require_relative 'rspec/not_to_not'
 require_relative 'rspec/overwriting_setup'
 require_relative 'rspec/pending'

data/lib/rubocop/rspec/config_formatter.rb

@@ -21,17 +21,18 @@ module RuboCop
           .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
           .gsub(*AMENDMENTS, "\n\\0")
           .gsub(/^(\s+)- /, '\1  - ')
+          .gsub('"~"', '~')
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          next if SUBDEPARTMENTS.include?(cop)
-          next if AMENDMENTS.include?(cop)
+          next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
 
+          replace_nil(unified[cop])
           unified[cop].merge!(descriptions.fetch(cop))
-          unified[cop]['Reference'] = COP_DOC_BASE_URL + cop.sub('RSpec/', '')
+          unified[cop]['Reference'] = reference(cop)
         end
       end
 
@@ -39,6 +40,16 @@ module RuboCop
         (descriptions.keys | config.keys).grep(EXTENSION_ROOT_DEPARTMENT)
       end
 
+      def replace_nil(config)
+        config.each do |key, value|
+          config[key] = '~' if value.nil?
+        end
+      end
+
+      def reference(cop)
+        COP_DOC_BASE_URL + cop.sub('RSpec/', '')
+      end
+
       attr_reader :config, :descriptions
     end
   end

data/lib/rubocop/rspec/inject.rb

@@ -6,9 +6,7 @@ module RuboCop
     # bit of our configuration.
     module Inject
       def self.defaults!
-        project_root = Pathname.new(__dir__).parent.parent.parent.expand_path
-        config_default = project_root.join('config', 'default.yml')
-        path = config_default.to_s
+        path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.send(:load_yaml_configuration, path)
         config = RuboCop::Config.new(hash, path)
         puts "configuration from #{path}" if ConfigLoader.debug?

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -12,6 +12,10 @@ module RuboCop
         def block_pattern(string)
           "(block #{send_pattern(string)} ...)"
         end
+
+        def numblock_pattern(string)
+          "(numblock #{send_pattern(string)} ...)"
+        end
       end
     end
   end

data/lib/rubocop/rspec/language.rb

@@ -41,7 +41,12 @@ module RuboCop
       def_node_matcher :example?, block_pattern('#Examples.all')
 
       # @!method hook?(node)
-      def_node_matcher :hook?, block_pattern('#Hooks.all')
+      def_node_matcher :hook?, <<-PATTERN
+        {
+          #{block_pattern('#Hooks.all')}
+          #{numblock_pattern('#Hooks.all')}
+        }
+      PATTERN
 
       # @!method let?(node)
       def_node_matcher :let?, <<-PATTERN

data/lib/rubocop/rspec/node.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # RuboCop RSpec specific extensions of RuboCop::AST::Node
     module Node
-      # In various cops we want to regard const as literal althought it's not
+      # In various cops we want to regard const as literal although it's not
       # strictly literal.
       def recursive_literal_or_const?
         case type

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.11.1'
+      STRING = '2.13.0'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -31,8 +31,8 @@ module RuboCop
       attr_reader :text, :ignores, :replacements
 
       def replace_prefix(pattern, replacement)
-        text.sub(pattern) do |shouldnt|
-          uppercase?(shouldnt) ? replacement.upcase : replacement
+        text.sub(pattern) do |matched|
+          uppercase?(matched) ? replacement.upcase : replacement
         end
       end
 

data/lib/rubocop/rspec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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

@@ -5,6 +5,7 @@ require 'yaml'
 
 require 'rubocop'
 
+require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/node'
@@ -20,6 +21,8 @@ require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/comments_help'
 require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
+require_relative 'rubocop/cop/rspec/mixin/namespace'
+require_relative 'rubocop/cop/rspec/mixin/css_selector'
 
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'