rubocop-rspec 2.12.1 → 2.13.0

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

@@ -6,7 +6,7 @@ module RuboCop
       # Checks for `let` definitions that come after an example.
       #
       # @example
-      #   # Bad
+      #   # bad
       #   let(:foo) { bar }
       #
       #   it 'checks what foo does' do
@@ -19,7 +19,7 @@ module RuboCop
       #     expect(some).to be
       #   end
       #
-      #   # Good
+      #   # good
       #   let(:foo) { bar }
       #   let(:some) { other }
       #
@@ -43,7 +43,7 @@ module RuboCop
           }
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 
           check_let_declarations(node.body) if multiline_block?(node.body)
@@ -59,12 +59,11 @@ module RuboCop
           first_example = find_first_example(node)
           return unless first_example
 
-          node.each_child_node do |child|
-            next if child.sibling_index < first_example.sibling_index
-            next unless let?(child)
+          first_example.right_siblings.each do |sibling|
+            next unless let?(sibling)
 
-            add_offense(child) do |corrector|
-              autocorrect(corrector, child, first_example)
+            add_offense(sibling) do |corrector|
+              autocorrect(corrector, sibling, first_example)
             end
           end
         end

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

@@ -6,20 +6,20 @@ module RuboCop
       # Checks unreferenced `let!` calls being used for test setup.
       #
       # @example
-      #   # Bad
+      #   # bad
       #   let!(:my_widget) { create(:widget) }
       #
       #   it 'counts widgets' do
       #     expect(Widget.count).to eq(1)
       #   end
       #
-      #   # Good
+      #   # good
       #   it 'counts widgets' do
       #     create(:widget)
       #     expect(Widget.count).to eq(1)
       #   end
       #
-      #   # Good
+      #   # good
       #   before { create(:widget) }
       #
       #   it 'counts widgets' do
@@ -49,7 +49,7 @@ module RuboCop
         # @!method method_called?(node)
         def_node_search :method_called?, '(send nil? %)'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_or_shared_group_or_including?(node)
 
           unused_let_bang(node) do |let|

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

@@ -9,7 +9,7 @@ module RuboCop
       #   # bad
       #   allow(foo).to receive_message_chain(:bar, :baz).and_return(42)
       #
-      #   # better
+      #   # good
       #   thing = Thing.new(baz: 42)
       #   allow(foo).to receive(:bar).and_return(thing)
       #

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

@@ -19,10 +19,11 @@ module RuboCop
       #
       #   describe "A feature example" do
       #   end
+      #
       class MissingExampleGroupArgument < Base
         MSG = 'The first argument to `%<method>s` should not be empty.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
           return if node.send_node.arguments?
 

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps parsing css selector.
+      module CssSelector
+        COMMON_OPTIONS = %w[
+          above below left_of right_of near count minimum maximum between text
+          id class style visible obscured exact exact_text normalize_ws match
+          wait filter_set focused
+        ].freeze
+
+        module_function
+
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   id?('#some-id') # => true
+        #   id?('.some-class') # => false
+        def id?(selector)
+          selector.start_with?('#')
+        end
+
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   attribute?('[attribute]') # => true
+        #   attribute?('attribute') # => false
+        def attribute?(selector)
+          selector.start_with?('[')
+        end
+
+        # @param selector [String]
+        # @return [Array<String>]
+        # @example
+        #   attributes('a[foo-bar_baz]') # => {"foo-bar_baz=>true}
+        #   attributes('button[foo][bar]') # => {"foo"=>true, "bar"=>true}
+        #   attributes('table[foo=bar]') # => {"foo"=>"'bar'"}
+        def attributes(selector)
+          selector.scan(/\[(.*?)\]/).flatten.to_h do |attr|
+            key, value = attr.split('=')
+            [key, normalize_value(value)]
+          end
+        end
+
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   common_attributes?('a[focused]') # => true
+        #   common_attributes?('button[focused][visible]') # => true
+        #   common_attributes?('table[id=some-id]') # => true
+        #   common_attributes?('h1[invalid]') # => false
+        def common_attributes?(selector)
+          attributes(selector).keys.difference(COMMON_OPTIONS).none?
+        end
+
+        # @param selector [String]
+        # @return [Array<String>]
+        # @example
+        #   pseudo_classes('button:not([disabled])') # => ['not()']
+        #   pseudo_classes('a:enabled:not([valid])') # => ['enabled', 'not()']
+        def pseudo_classes(selector)
+          # Attributes must be excluded or else the colon in the `href`s URL
+          # will also be picked up as pseudo classes.
+          # "a:not([href='http://example.com']):enabled" => "a:not():enabled"
+          ignored_attribute = selector.gsub(/\[.*?\]/, '')
+          # "a:not():enabled" => ["not()", "enabled"]
+          ignored_attribute.scan(/:([^:]*)/).flatten
+        end
+
+        # @param selector [String]
+        # @return [Boolean]
+        # @example
+        #   multiple_selectors?('a.cls b#id') # => true
+        #   multiple_selectors?('a.cls') # => false
+        def multiple_selectors?(selector)
+          selector.match?(/[ >,+]/)
+        end
+
+        # @param value [String]
+        # @return [Boolean, String]
+        # @example
+        #   normalize_value('true') # => true
+        #   normalize_value('false') # => false
+        #   normalize_value(nil) # => false
+        #   normalize_value("foo") # => "'foo'"
+        def normalize_value(value)
+          case value
+          when 'true' then true
+          when 'false' then false
+          when nil then true
+          else "'#{value}'"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps to find namespace of the node.
+      module Namespace
+        private
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Array<String>]
+        # @example
+        #   namespace(node) # => ['A', 'B', 'C']
+        def namespace(node)
+          node
+            .each_ancestor(:class, :module)
+            .reverse_each
+            .flat_map { |ancestor| ancestor.defined_module_name.split('::') }
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,7 @@ module RuboCop
       #     describe '.do_something_else' do
       #     end
       #   end
+      #
       class MultipleDescribes < Base
         include TopLevelGroup
 

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

@@ -11,7 +11,6 @@ module RuboCop
       # and works with `--auto-gen-config`.
       #
       # @example
-      #
       #   # bad
       #   describe UserCreator do
       #     it 'builds a user' do
@@ -32,7 +31,6 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: true` (default)
-      #
       #  # good - the cop ignores when RSpec aggregates failures
       #   describe UserCreator do
       #     it 'builds a user', :aggregate_failures do
@@ -42,7 +40,6 @@ module RuboCop
       #   end
       #
       # @example `aggregate_failures: false`
-      #
       #  # Detected as an offense
       #   describe UserCreator do
       #     it 'builds a user', aggregate_failures: false do
@@ -52,7 +49,6 @@ module RuboCop
       #   end
       #
       # @example configuration
-      #
       #   # .rubocop.yml
       #   # RSpec/MultipleExpectations:
       #   #   Max: 2
@@ -88,7 +84,7 @@ module RuboCop
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example?(node)
 
           return if example_with_aggregate_failures?(node)

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

@@ -56,7 +56,6 @@ module RuboCop
       #   end
       #
       # @example when disabling AllowSubject configuration
-      #
       #   # rubocop.yml
       #   # RSpec/MultipleMemoizedHelpers:
       #   #   AllowSubject: false
@@ -72,7 +71,6 @@ module RuboCop
       #   end
       #
       # @example with Max configuration
-      #
       #   # rubocop.yml
       #   # RSpec/MultipleMemoizedHelpers:
       #   #   Max: 1
@@ -89,7 +87,7 @@ module RuboCop
 
         MSG = 'Example group has too many memoized helpers [%<count>d/%<max>d]'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless spec_group?(node)
 
           count = all_helpers(node).uniq.count

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

@@ -6,7 +6,6 @@ module RuboCop
       # Checks for consistent method usage for negating expectations.
       #
       # @example `EnforcedStyle: not_to` (default)
-      #
       #   # bad
       #   it '...' do
       #     expect(false).to_not be_true
@@ -18,7 +17,6 @@ module RuboCop
       #   end
       #
       # @example `EnforcedStyle: to_not`
-      #
       #   # bad
       #   it '...' do
       #     expect(false).not_to be_true
@@ -28,6 +26,7 @@ module RuboCop
       #   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/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