rubocop-rspec 2.11.1 → 2.13.0

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

@@ -10,7 +10,7 @@ module RuboCop
       # styles: "implicit", "each", and "example." All styles have
       # the same behavior.
       #
-      # @example when configuration is `EnforcedStyle: implicit`
+      # @example `EnforcedStyle: implicit` (default)
       #   # bad
       #   before(:each) do
       #     # ...
@@ -26,7 +26,7 @@ module RuboCop
       #     # ...
       #   end
       #
-      # @example when configuration is `EnforcedStyle: each`
+      # @example `EnforcedStyle: each`
       #   # bad
       #   before(:example) do
       #     # ...
@@ -42,7 +42,7 @@ module RuboCop
       #     # ...
       #   end
       #
-      # @example when configuration is `EnforcedStyle: example`
+      # @example `EnforcedStyle: example`
       #   # bad
       #   before(:each) do
       #     # ...
@@ -57,6 +57,7 @@ module RuboCop
       #   before(:example) do
       #     # ...
       #   end
+      #
       class HookArgument < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
@@ -66,11 +67,13 @@ module RuboCop
 
         # @!method scoped_hook(node)
         def_node_matcher :scoped_hook, <<-PATTERN
-          (block $(send _ #Hooks.all (sym ${:each :example})) ...)
+          ({block numblock} $(send _ #Hooks.all (sym ${:each :example})) ...)
         PATTERN
 
         # @!method unscoped_hook(node)
-        def_node_matcher :unscoped_hook, '(block $(send _ #Hooks.all) ...)'
+        def_node_matcher :unscoped_hook, <<-PATTERN
+          ({block numblock} $(send _ #Hooks.all) ...)
+        PATTERN
 
         def on_block(node)
           hook(node) do |method_send, scope_name|
@@ -86,6 +89,8 @@ module RuboCop
           end
         end
 
+        alias on_numblock on_block
+
         private
 
         def check_implicit(method_send)

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

@@ -6,8 +6,7 @@ module RuboCop
       # Checks for before/around/after hooks that come after an example.
       #
       # @example
-      #   # Bad
-      #
+      #   # bad
       #   it 'checks what foo does' do
       #     expect(foo).to be
       #   end
@@ -15,7 +14,7 @@ module RuboCop
       #   before { prepare }
       #   after { clean_up }
       #
-      #   # Good
+      #   # good
       #   before { prepare }
       #   after { clean_up }
       #
@@ -32,6 +31,7 @@ module RuboCop
         def_node_matcher :example_or_group?, <<-PATTERN
           {
             #{block_pattern('{#ExampleGroups.all #Examples.all}')}
+            #{numblock_pattern('{#ExampleGroups.all #Examples.all}')}
             #{send_pattern('#Includes.examples')}
           }
         PATTERN
@@ -42,6 +42,8 @@ module RuboCop
           check_hooks(node.body) if multiline_block?(node.body)
         end
 
+        alias on_numblock on_block
+
         private
 
         def multiline_block?(block)
@@ -52,13 +54,12 @@ 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 hook?(child)
+          first_example.right_siblings.each do |sibling|
+            next unless hook?(sibling)
 
-            msg = format(MSG, hook: child.method_name)
-            add_offense(child, message: msg) do |corrector|
-              autocorrect(corrector, child, first_example)
+            msg = format(MSG, hook: sibling.method_name)
+            add_offense(sibling, message: msg) do |corrector|
+              autocorrect(corrector, sibling, first_example)
             end
           end
         end

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

@@ -6,7 +6,6 @@ module RuboCop
       # Checks for equality assertions with identical expressions on both sides.
       #
       # @example
-      #
       #   # bad
       #   expect(foo.bar).to eq(foo.bar)
       #   expect(foo.bar).to eql(foo.bar)

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

@@ -16,6 +16,7 @@ module RuboCop
       #   it 'changes something to a new value' do
       #     expect { do_something }.to change(something).to(new_value)
       #   end
+      #
       class ImplicitBlockExpectation < Base
         MSG = 'Avoid implicit block expectations.'
         RESTRICT_ON_SEND = %i[is_expected should should_not].freeze

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

@@ -8,8 +8,7 @@ module RuboCop
       # This cop can be configured using the `EnforcedStyle` option
       # and supports the `--auto-gen-config` flag.
       #
-      # @example `EnforcedStyle: is_expected`
-      #
+      # @example `EnforcedStyle: is_expected` (default)
       #   # bad
       #   it { should be_truthy }
       #
@@ -17,7 +16,6 @@ module RuboCop
       #   it { is_expected.to be_truthy }
       #
       # @example `EnforcedStyle: should`
-      #
       #   # bad
       #   it { is_expected.to be_truthy }
       #

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

@@ -42,7 +42,7 @@ module RuboCop
           ...)
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example?(node)
 
           null_double(node) do |var, receiver|

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

@@ -24,7 +24,6 @@ module RuboCop
       #   end
       #
       # @example with AssignmentOnly configuration
-      #
       #   # rubocop.yml
       #   # RSpec/InstanceVariable:
       #   #   AssignmentOnly: false

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

@@ -5,19 +5,20 @@ module RuboCop
     module RSpec
       # Checks that only one `it_behaves_like` style is used.
       #
-      # @example when configuration is `EnforcedStyle: it_behaves_like`
+      # @example `EnforcedStyle: it_behaves_like` (default)
       #   # bad
       #   it_should_behave_like 'a foo'
       #
       #   # good
       #   it_behaves_like 'a foo'
       #
-      # @example when configuration is `EnforcedStyle: it_should_behave_like`
+      # @example `EnforcedStyle: it_should_behave_like`
       #   # bad
       #   it_behaves_like 'a foo'
       #
       #   # good
       #   it_should_behave_like 'a foo'
+      #
       class ItBehavesLike < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle

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

@@ -15,6 +15,7 @@ module RuboCop
       #   it 'validates users' do
       #     expect([user1, user2, user3]).to all(be_valid)
       #   end
+      #
       class IteratedExpectation < Base
         MSG = 'Prefer using the `all` matcher instead ' \
               'of iterating over an array.'
@@ -28,6 +29,13 @@ module RuboCop
           )
         PATTERN
 
+        # @!method each_numblock?(node)
+        def_node_matcher :each_numblock?, <<-PATTERN
+          (numblock
+            (send ... :each) _ $(...)
+          )
+        PATTERN
+
         # @!method expectation?(node)
         def_node_matcher :expectation?, <<-PATTERN
           (send (send nil? :expect (lvar %)) :to ...)
@@ -41,6 +49,14 @@ module RuboCop
           end
         end
 
+        def on_numblock(node)
+          each_numblock?(node) do |body|
+            if single_expectation?(body, :_1) || only_expectations?(body, :_1)
+              add_offense(node.send_node)
+            end
+          end
+        end
+
         private
 
         def single_expectation?(body, arg)

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

@@ -7,29 +7,29 @@ module RuboCop
       #
       # @example
       #   # bad
-      #     let(:params) { blah }
-      #     subject { described_class.new(params) }
+      #   let(:params) { blah }
+      #   subject { described_class.new(params) }
       #
-      #     before { do_something }
-      #     subject { described_class.new(params) }
+      #   before { do_something }
+      #   subject { described_class.new(params) }
       #
-      #     it { expect_something }
-      #     subject { described_class.new(params) }
-      #     it { expect_something_else }
+      #   it { expect_something }
+      #   subject { described_class.new(params) }
+      #   it { expect_something_else }
       #
       #
       #   # good
-      #     subject { described_class.new(params) }
-      #     let(:params) { blah }
+      #   subject { described_class.new(params) }
+      #   let(:params) { blah }
       #
       #   # good
-      #     subject { described_class.new(params) }
-      #     before { do_something }
+      #   subject { described_class.new(params) }
+      #   before { do_something }
       #
       #   # good
-      #     subject { described_class.new(params) }
-      #     it { expect_something }
-      #     it { expect_something_else }
+      #   subject { described_class.new(params) }
+      #   it { expect_something }
+      #   it { expect_something_else }
       #
       class LeadingSubject < Base
         extend AutoCorrector
@@ -37,7 +37,7 @@ module RuboCop
 
         MSG = 'Declare `subject` above any other `%<offending>s` declarations.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless subject?(node)
           return unless inside_example_group?(node)
 

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

@@ -10,7 +10,7 @@ module RuboCop
       #
       # If several examples may define a `DummyClass`, instead of being a
       # blank slate class as it will be in the first example, subsequent
-      # examples will be reopening it and modifying its behaviour in
+      # examples will be reopening it and modifying its behavior in
       # unpredictable ways.
       # Even worse when a class that exists in the codebase is reopened.
       #

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/message_expectation.rb

@@ -8,7 +8,7 @@ module RuboCop
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.
       #
-      # @example `EnforcedStyle: allow`
+      # @example `EnforcedStyle: allow` (default)
       #
       #   # bad
       #   expect(foo).to receive(:bar)

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

@@ -8,21 +8,27 @@ module RuboCop
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.
       #
-      # @example `EnforcedStyle: have_received`
+      # @example `EnforcedStyle: have_received` (default)
       #
       #   # bad
       #   expect(foo).to receive(:bar)
+      #   do_something
       #
       #   # good
+      #   allow(foo).to receive(:bar) # or use instance_spy
+      #   do_something
       #   expect(foo).to have_received(:bar)
       #
       # @example `EnforcedStyle: receive`
       #
       #   # bad
+      #   allow(foo).to receive(:bar)
+      #   do_something
       #   expect(foo).to have_received(:bar)
       #
       #   # good
       #   expect(foo).to receive(:bar)
+      #   do_something
       #
       class MessageSpies < Base
         include ConfigurableEnforcedStyle

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/empty_line_separation.rb

@@ -4,7 +4,10 @@ module RuboCop
   module Cop
     module RSpec
       # Helps determine the offending location if there is not an empty line
-      # following the node. Allows comments to follow directly after.
+      # following the node. Allows comments to follow directly after
+      # in the following cases.
+      # - `rubocop:enable` directive
+      # - followed by empty line(s)
       module EmptyLineSeparation
         include FinalEndLocation
         include RangeHelp
@@ -21,13 +24,19 @@ module RuboCop
         end
 
         def missing_separating_line(node)
-          line = final_end_location(node).line
+          line = final_end_line = final_end_location(node).line
 
-          line += 1 while comment_line?(processed_source[line])
+          while comment_line?(processed_source[line])
+            line += 1
+            comment = processed_source.comment_at_line(line)
+            if DirectiveComment.new(comment).enabled?
+              enable_directive_line = line
+            end
+          end
 
           return if processed_source[line].blank?
 
-          yield offending_loc(line)
+          yield offending_loc(enable_directive_line || final_end_line)
         end
 
         def offending_loc(last_line)

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
@@ -31,8 +30,25 @@ module RuboCop
       #     end
       #   end
       #
-      # @example configuration
+      # @example `aggregate_failures: true` (default)
+      #  # good - the cop ignores when RSpec aggregates failures
+      #   describe UserCreator do
+      #     it 'builds a user', :aggregate_failures do
+      #       expect(user.name).to eq("John")
+      #       expect(user.age).to eq(22)
+      #     end
+      #   end
       #
+      # @example `aggregate_failures: false`
+      #  # Detected as an offense
+      #   describe UserCreator do
+      #     it 'builds a user', aggregate_failures: false do
+      #       expect(user.name).to eq("John")
+      #       expect(user.age).to eq(22)
+      #     end
+      #   end
+      #
+      # @example configuration
       #   # .rubocop.yml
       #   # RSpec/MultipleExpectations:
       #   #   Max: 2
@@ -68,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