rubocop-rspec 2.11.1 → 2.13.0

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

@@ -6,7 +6,6 @@ module RuboCop
       # Checks if an example group defines `subject` multiple times.
       #
       # @example
-      #
       #   # bad
       #   describe Foo do
       #     subject(:user) { User.new }
@@ -19,6 +18,21 @@ module RuboCop
       #     subject(:post) { Post.new }
       #   end
       #
+      #   # bad (does not support autocorrection)
+      #   describe Foo do
+      #     subject!(:user) { User.new }
+      #     subject!(:post) { Post.new }
+      #   end
+      #
+      #   # good
+      #   describe Foo do
+      #     before do
+      #       User.new
+      #       Post.new
+      #     end
+      #   end
+      #
+      # This cop does not support autocorrection in some cases.
       # The autocorrect behavior for this cop depends on the type of
       # duplication:
       #
@@ -33,13 +47,14 @@ module RuboCop
       #   - If subjects are defined with `subject!` then we don't autocorrect.
       #     This is enough of an edge case that people can just move this to
       #     a `before` hook on their own
+      #
       class MultipleSubjects < Base
         extend AutoCorrector
         include RangeHelp
 
         MSG = 'Do not set more than one subject per example group'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
           subjects = RuboCop::RSpec::ExampleGroup.new(node).subjects

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

@@ -41,6 +41,7 @@ module RuboCop
       #
       #     it { is_expected.to be_valid }
       #   end
+      #
       class NamedSubject < Base
         MSG = 'Name your test subject if you need to reference it explicitly.'
 
@@ -55,7 +56,7 @@ module RuboCop
         # @!method subject_usage(node)
         def_node_search :subject_usage, '$(send nil? :subject)'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           if !example_or_hook_block?(node) || ignored_shared_example?(node)
             return
           end

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

@@ -36,7 +36,7 @@ module RuboCop
       #     end
       #   end
       #
-      #   # better
+      #   # good
       #   context 'using some feature as an admin' do
       #     let(:some)    { :various }
       #     let(:feature) { :setup   }
@@ -53,34 +53,40 @@ module RuboCop
       #     it 'yada yada'
       #   end
       #
-      # @example configuration
-      #
-      #   # .rubocop.yml
-      #   # RSpec/NestedGroups:
-      #   #   Max: 2
-      #
-      #   context 'when using some feature' do
-      #     let(:some)    { :various }
-      #     let(:feature) { :setup   }
-      #
-      #     context 'when user is signed in' do
-      #       let(:user) do
-      #         UserCreate.call(user_attributes)
+      # @example `Max: 3` (default)
+      #   # bad
+      #   describe Foo do
+      #     context 'foo' do
+      #       context 'bar' do
+      #         context 'baz' do # flagged by rubocop
+      #         end
       #       end
+      #     end
+      #   end
       #
-      #       let(:user_attributes) do
-      #         {
-      #           name: 'John',
-      #           age:  22,
-      #           role: role
-      #         }
+      # @example `Max: 2`
+      #   # bad
+      #   describe Foo do
+      #     context 'foo' do
+      #       context 'bar' do # flagged by rubocop
+      #         context 'baz' do # flagged by rubocop
+      #         end
       #       end
+      #     end
+      #   end
       #
-      #       context 'when user is an admin' do # flagged by rubocop
-      #         let(:role) { 'admin' }
+      # @example `AllowedGroups: [] (default)`
+      #   describe Foo do # <-- nested groups 1
+      #     context 'foo' do # <-- nested groups 2
+      #       context 'bar' do # <-- nested groups 3
+      #       end
+      #     end
+      #   end
       #
-      #         it 'blah blah'
-      #         it 'yada yada'
+      # @example `AllowedGroups: [path]`
+      #   describe Foo do # <-- nested groups 1
+      #     path '/foo' do # <-- nested groups 1 (not counted)
+      #       context 'bar' do # <-- nested groups 2
       #       end
       #     end
       #   end
@@ -113,13 +119,23 @@ module RuboCop
           example_group = example_group?(node)
           yield node, nesting if example_group && nesting > max_nesting
 
-          next_nesting = example_group ? nesting + 1 : nesting
+          next_nesting = if count_up_nesting?(node, example_group)
+                           nesting + 1
+                         else
+                           nesting
+                         end
 
           node.each_child_node(:block, :begin) do |child|
             find_nested_example_groups(child, nesting: next_nesting, &block)
           end
         end
 
+        def count_up_nesting?(node, example_group)
+          example_group &&
+            (node.block_type? &&
+            !allowed_groups.include?(node.method_name))
+        end
+
         def message(nesting)
           format(MSG, total: nesting, max: max_nesting)
         end
@@ -136,6 +152,10 @@ module RuboCop
             cop_config.fetch('Max', 3)
           end
         end
+
+        def allowed_groups
+          @allowed_groups ||= cop_config.fetch('AllowedGroups', [])
+        end
       end
     end
   end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks if an example contains any expectation.
+      #
+      # All RSpec's example and expectation methods are covered by default.
+      # If you are using your own custom methods,
+      # add the following configuration:
+      #
+      #   RSpec:
+      #     Language:
+      #       Examples:
+      #         Regular:
+      #           - custom_it
+      #       Expectations:
+      #         - custom_expect
+      #
+      # @example
+      #   # bad
+      #   it do
+      #     a?
+      #   end
+      #
+      #   # good
+      #   it do
+      #     expect(a?).to be(true)
+      #   end
+      #
+      class NoExpectationExample < Base
+        MSG = 'No expectation found in this example.'
+
+        # @!method regular_or_focused_example?(node)
+        # @param [RuboCop::AST::Node] node
+        # @return [Boolean]
+        def_node_matcher :regular_or_focused_example?, <<~PATTERN
+          {
+            #{block_pattern('{#Examples.regular | #Examples.focused}')}
+            #{numblock_pattern('{#Examples.regular | #Examples.focused}')}
+          }
+        PATTERN
+
+        # @!method including_any_expectation?(node)
+        # @param [RuboCop::AST::Node] node
+        # @return [Boolean]
+        def_node_search(
+          :including_any_expectation?,
+          send_pattern('#Expectations.all')
+        )
+
+        # @param [RuboCop::AST::BlockNode] node
+        def on_block(node)
+          return unless regular_or_focused_example?(node)
+          return if including_any_expectation?(node)
+
+          add_offense(node)
+        end
+
+        alias on_numblock on_block
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module RuboCop
     module RSpec
       # Checks for consistent method usage for negating expectations.
       #
-      # @example
+      # @example `EnforcedStyle: not_to` (default)
       #   # bad
       #   it '...' do
       #     expect(false).to_not be_true
@@ -15,6 +15,18 @@ module RuboCop
       #   it '...' do
       #     expect(false).not_to be_true
       #   end
+      #
+      # @example `EnforcedStyle: to_not`
+      #   # bad
+      #   it '...' do
+      #     expect(false).not_to be_true
+      #   end
+      #
+      #   # good
+      #   it '...' do
+      #     expect(false).to_not be_true
+      #   end
+      #
       class NotToNot < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle

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

@@ -21,6 +21,7 @@ module RuboCop
       #   let(:foo) { bar }
       #   let(:baz) { baz }
       #   let!(:other) { other }
+      #
       class OverwritingSetup < Base
         MSG = '`%<name>s` is already defined.'
 
@@ -30,7 +31,7 @@ module RuboCop
         # @!method first_argument_name(node)
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 
           find_duplicates(node.body) do |duplicate, name|

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

@@ -31,6 +31,7 @@ module RuboCop
       #   # good
       #   describe MyClass do
       #   end
+      #
       class Pending < Base
         MSG = 'Pending spec found.'
 

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

@@ -276,6 +276,7 @@ module RuboCop
       #
       #   # good - the above code is rewritten to it by this cop
       #   expect(foo.something?).to be_truthy
+      #
       class PredicateMatcher < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
@@ -291,7 +292,7 @@ module RuboCop
           end
         end
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           check_explicit(node) if style == :explicit
         end
 

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

@@ -7,7 +7,6 @@ module RuboCop
         # Checks that tests use RSpec `before` hook over Rails `setup` method.
         #
         # @example
-        #
         #   # bad
         #   setup do
         #     allow(foo).to receive(:bar)
@@ -30,7 +29,7 @@ module RuboCop
               (args) _)
           PATTERN
 
-          def on_block(node)
+          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
             setup_call(node) do |setup|
               add_offense(node) do |corrector|
                 corrector.replace setup, 'before'

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Checks that tests use `have_http_status` instead of equality matchers.
+        #
+        # @example
+        #   # bad
+        #   expect(response.status).to be(200)
+        #
+        #   # good
+        #   expect(response).to have_http_status(200)
+        #
+        class HaveHttpStatus < Base
+          extend AutoCorrector
+
+          MSG =
+            'Prefer `expect(response).%<to>s have_http_status(%<status>i)` ' \
+            'over `expect(response.status).%<to>s %<match>s`.'
+
+          # @!method match_status(node)
+          def_node_matcher :match_status, <<-PATTERN
+            (send
+              (send nil? :expect
+                $(send (send nil? :response) :status)
+              )
+              $#Runners.all
+              $(send nil? {:be :eq :eql :equal} (int $_))
+            )
+          PATTERN
+
+          def on_send(node)
+            match_status(node) do |response_status, to, match, status|
+              message = format(MSG, to: to, match: match.source, status: status)
+              add_offense(node, message: message) do |corrector|
+                corrector.replace(response_status.source_range, 'response')
+                corrector.replace(match.loc.selector, 'have_http_status')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,22 +6,21 @@ module RuboCop
       # Check for `once` and `twice` receive counts matchers usage.
       #
       # @example
+      #   # bad
+      #   expect(foo).to receive(:bar).exactly(1).times
+      #   expect(foo).to receive(:bar).exactly(2).times
+      #   expect(foo).to receive(:bar).at_least(1).times
+      #   expect(foo).to receive(:bar).at_least(2).times
+      #   expect(foo).to receive(:bar).at_most(1).times
+      #   expect(foo).to receive(:bar).at_most(2).times
       #
-      #     # bad
-      #     expect(foo).to receive(:bar).exactly(1).times
-      #     expect(foo).to receive(:bar).exactly(2).times
-      #     expect(foo).to receive(:bar).at_least(1).times
-      #     expect(foo).to receive(:bar).at_least(2).times
-      #     expect(foo).to receive(:bar).at_most(1).times
-      #     expect(foo).to receive(:bar).at_most(2).times
-      #
-      #     # good
-      #     expect(foo).to receive(:bar).once
-      #     expect(foo).to receive(:bar).twice
-      #     expect(foo).to receive(:bar).at_least(:once)
-      #     expect(foo).to receive(:bar).at_least(:twice)
-      #     expect(foo).to receive(:bar).at_most(:once)
-      #     expect(foo).to receive(:bar).at_most(:twice).times
+      #   # good
+      #   expect(foo).to receive(:bar).once
+      #   expect(foo).to receive(:bar).twice
+      #   expect(foo).to receive(:bar).at_least(:once)
+      #   expect(foo).to receive(:bar).at_least(:twice)
+      #   expect(foo).to receive(:bar).at_most(:once)
+      #   expect(foo).to receive(:bar).at_most(:twice).times
       #
       class ReceiveCounts < Base
         extend AutoCorrector

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

@@ -6,12 +6,11 @@ module RuboCop
       # Prefer `not_to receive(...)` over `receive(...).never`.
       #
       # @example
+      #   # bad
+      #   expect(foo).to receive(:bar).never
       #
-      #     # bad
-      #     expect(foo).to receive(:bar).never
-      #
-      #     # good
-      #     expect(foo).not_to receive(:bar)
+      #   # good
+      #   expect(foo).not_to receive(:bar)
       #
       class ReceiveNever < Base
         extend AutoCorrector

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

@@ -6,44 +6,43 @@ module RuboCop
       # Check for repeated description strings in example groups.
       #
       # @example
+      #   # bad
+      #   RSpec.describe User do
+      #     it 'is valid' do
+      #       # ...
+      #     end
       #
-      #     # bad
-      #     RSpec.describe User do
-      #       it 'is valid' do
-      #         # ...
-      #       end
-      #
-      #       it 'is valid' do
-      #         # ...
-      #       end
+      #     it 'is valid' do
+      #       # ...
       #     end
+      #   end
       #
-      #     # good
-      #     RSpec.describe User do
-      #       it 'is valid when first and last name are present' do
-      #         # ...
-      #       end
+      #   # good
+      #   RSpec.describe User do
+      #     it 'is valid when first and last name are present' do
+      #       # ...
+      #     end
       #
-      #       it 'is valid when last name only is present' do
-      #         # ...
-      #       end
+      #     it 'is valid when last name only is present' do
+      #       # ...
       #     end
+      #   end
       #
-      #     # good
-      #     RSpec.describe User do
-      #       it 'is valid' do
-      #         # ...
-      #       end
+      #   # good
+      #   RSpec.describe User do
+      #     it 'is valid' do
+      #       # ...
+      #     end
       #
-      #       it 'is valid', :flag do
-      #         # ...
-      #       end
+      #     it 'is valid', :flag do
+      #       # ...
       #     end
+      #   end
       #
       class RepeatedDescription < Base
         MSG = "Don't repeat descriptions within an example group."
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
           repeated_descriptions(node).each do |repeated_description|

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

@@ -18,7 +18,7 @@ module RuboCop
       class RepeatedExample < Base
         MSG = "Don't repeat examples within an example group."
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
           repeated_examples(node).each do |repeated_example|

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

@@ -6,42 +6,41 @@ module RuboCop
       # Check for repeated describe and context block body.
       #
       # @example
+      #   # bad
+      #   describe 'cool feature x' do
+      #     it { cool_predicate }
+      #   end
       #
-      #    # bad
-      #    describe 'cool feature x' do
-      #      it { cool_predicate }
-      #    end
+      #   describe 'cool feature y' do
+      #     it { cool_predicate }
+      #   end
       #
-      #    describe 'cool feature y' do
-      #      it { cool_predicate }
-      #    end
+      #   # good
+      #   describe 'cool feature' do
+      #     it { cool_predicate }
+      #   end
       #
-      #    # good
-      #    describe 'cool feature' do
-      #      it { cool_predicate }
-      #    end
+      #   describe 'another cool feature' do
+      #     it { another_predicate }
+      #   end
       #
-      #    describe 'another cool feature' do
-      #      it { another_predicate }
-      #    end
+      #   # good
+      #   context 'when case x', :tag do
+      #     it { cool_predicate }
+      #   end
       #
-      #    # good
-      #    context 'when case x', :tag do
-      #      it { cool_predicate }
-      #    end
+      #   context 'when case y' do
+      #     it { cool_predicate }
+      #   end
       #
-      #    context 'when case y' do
-      #      it { cool_predicate }
-      #    end
+      #   # good
+      #   context Array do
+      #     it { is_expected.to respond_to :each }
+      #   end
       #
-      #    # good
-      #    context Array do
-      #      it { is_expected.to respond_to :each }
-      #    end
-      #
-      #    context Hash do
-      #      it { is_expected.to respond_to :each }
-      #    end
+      #   context Hash do
+      #     it { is_expected.to respond_to :each }
+      #   end
       #
       class RepeatedExampleGroupBody < Base
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'

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

@@ -6,42 +6,41 @@ module RuboCop
       # Check for repeated example group descriptions.
       #
       # @example
+      #   # bad
+      #   describe 'cool feature' do
+      #     # example group
+      #   end
       #
-      #    # bad
-      #    describe 'cool feature' do
-      #      # example group
-      #    end
+      #   describe 'cool feature' do
+      #     # example group
+      #   end
       #
-      #    describe 'cool feature' do
-      #      # example group
-      #    end
+      #   # bad
+      #   context 'when case x' do
+      #     # example group
+      #   end
       #
-      #    # bad
-      #    context 'when case x' do
-      #      # example group
-      #    end
+      #   describe 'when case x' do
+      #     # example group
+      #   end
       #
-      #    describe 'when case x' do
-      #      # example group
-      #    end
+      #   # good
+      #   describe 'cool feature' do
+      #     # example group
+      #   end
       #
-      #    # good
-      #    describe 'cool feature' do
-      #      # example group
-      #    end
+      #   describe 'another cool feature' do
+      #     # example group
+      #   end
       #
-      #    describe 'another cool feature' do
-      #      # example group
-      #    end
+      #   # good
+      #   context 'when case x' do
+      #     # example group
+      #   end
       #
-      #    # good
-      #    context 'when case x' do
-      #      # example group
-      #    end
-      #
-      #    context 'when another case' do
-      #      # example group
-      #    end
+      #   context 'when another case' do
+      #     # example group
+      #   end
       #
       class RepeatedExampleGroupDescription < Base
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'