rubocop-rspec 2.12.1 → 2.13.0

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

@@ -16,13 +16,14 @@ module RuboCop
       #   let(:something) { other }
       #
       #   it { does_something }
+      #
       class EmptyLineAfterFinalLet < Base
         extend AutoCorrector
         include EmptyLineSeparation
 
         MSG = 'Add an empty line after the last `%<let>s`.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 
           final_let = node.body.child_nodes.reverse.find { |child| let?(child) }

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

@@ -5,6 +5,9 @@ module RuboCop
     module RSpec
       # Checks if there is an empty line after hook blocks.
       #
+      # `AllowConsecutiveOneLiners` configures whether adjacent
+      # one-line definitions are considered an offense.
+      #
       # @example
       #   # bad
       #   before { do_something }
@@ -19,11 +22,23 @@ module RuboCop
       #   it { does_something }
       #
       #   # good
-      #   before { do_something }
+      #   after { do_something }
       #
       #   it { does_something }
       #
-      #   # good
+      #   # fair - it's ok to have non-separated one-liners hooks
+      #   around { |test| test.run }
+      #   after { do_something }
+      #
+      #   it { does_something }
+      #
+      # @example with AllowConsecutiveOneLiners configuration
+      #   # rubocop.yml
+      #   # RSpec/EmptyLineAfterHook:
+      #   #   AllowConsecutiveOneLiners: false
+      #
+      #   # bad
+      #   around { |test| test.run }
       #   after { do_something }
       #
       #   it { does_something }
@@ -31,21 +46,36 @@ module RuboCop
       #   # good
       #   around { |test| test.run }
       #
+      #   after { do_something }
+      #
       #   it { does_something }
       #
       class EmptyLineAfterHook < Base
         extend AutoCorrector
+        include ConfigurableEnforcedStyle
         include EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<hook>s`.'
 
         def on_block(node)
           return unless hook?(node)
+          return if cop_config['AllowConsecutiveOneLiners'] &&
+            chained_single_line_hooks?(node)
 
           missing_separating_line_offense(node) do |method|
             format(MSG, hook: method)
           end
         end
+
+        alias on_numblock on_block
+
+        private
+
+        def chained_single_line_hooks?(node)
+          next_node = node.right_sibling
+
+          hook?(next_node) && node.single_line? && next_node.single_line?
+        end
       end
     end
   end

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

@@ -14,6 +14,7 @@ module RuboCop
       #   subject(:obj) { described_class }
       #
       #   let(:foo) { bar }
+      #
       class EmptyLineAfterSubject < Base
         extend AutoCorrector
         include EmptyLineSeparation
@@ -21,7 +22,7 @@ module RuboCop
 
         MSG = 'Add an empty line after `%<subject>s`.'
 
-        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/example_length.rb

@@ -47,12 +47,13 @@ module RuboCop
       #       content.
       #     HEREDOC
       #   end                 # 5 points
+      #
       class ExampleLength < Base
         include CodeLength
 
         LABEL = 'Example'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example?(node)
 
           check_code_length(node)

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

@@ -47,6 +47,7 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
+      #
       class ExampleWithoutDescription < Base
         include ConfigurableEnforcedStyle
 
@@ -57,7 +58,7 @@ module RuboCop
         # @!method example_description(node)
         def_node_matcher :example_description, '(send nil? _ $(str $_))'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example?(node)
 
           check_example_without_description(node.send_node)

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

@@ -29,6 +29,7 @@ module RuboCop
       #   # good
       #   it 'does things' do
       #   end
+      #
       class ExampleWording < Base
         extend AutoCorrector
 
@@ -46,7 +47,7 @@ module RuboCop
           } ...) ...)
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           it_description(node) do |description_node, message|
             if message.match?(SHOULD_PREFIX)
               add_wording_offense(description_node, MSG_SHOULD)

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

@@ -22,6 +22,7 @@ module RuboCop
       #   # good
       #   context 'when a condition is met' do
       #   end
+      #
       class ExcessiveDocstringSpacing < Base
         extend AutoCorrector
 

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

@@ -18,6 +18,9 @@ module RuboCop
       #   expect(pattern).to eq(/foo/)
       #   expect(name).to eq("John")
       #
+      #   # bad (not supported autocorrection)
+      #   expect(false).to eq(true)
+      #
       class ExpectActual < Base
         extend AutoCorrector
 

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

@@ -69,7 +69,7 @@ module RuboCop
           end
         end
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless style == :method_call
 
           expect_change_with_block(node) do |receiver, message|

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

@@ -20,13 +20,14 @@ module RuboCop
       #   it do
       #     expect(something).to eq 'foo'
       #   end
+      #
       class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
         # @!method expectation(node)
         def_node_search :expectation, send_pattern('#Expectations.all')
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless hook?(node)
           return if node.body.nil?
 
@@ -36,6 +37,8 @@ module RuboCop
           end
         end
 
+        alias on_numblock on_block
+
         private
 
         def message(expect, hook)

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

@@ -14,6 +14,7 @@ module RuboCop
       #
       #   # good
       #   expect { my_app.print_report }.to output('Hello World').to_stdout
+      #
       class ExpectOutput < Base
         MSG = 'Use `expect { ... }.to output(...).to_%<name>s` ' \
               'instead of mutating $%<name>s.'

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -24,6 +24,7 @@ module RuboCop
         #
         #   # good
         #   count { 1 }
+        #
         class AttributeDefinedStatically < Base
           extend AutoCorrector
 
@@ -39,7 +40,7 @@ module RuboCop
             (block (send _ #attribute_defining_method? ...) _ { (begin $...) $(send ...) } )
           PATTERN
 
-          def on_block(node)
+          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
             attributes = factory_attributes(node) || []
             attributes = [attributes] unless attributes.is_a?(Array) # rubocop:disable Style/ArrayCoercion, Lint/RedundantCopDisableDirective
 

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -30,6 +30,7 @@ module RuboCop
         #
         #   # good
         #   3.times { create :user }
+        #
         class CreateList < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
@@ -39,20 +40,23 @@ module RuboCop
           MSG_N_TIMES = 'Prefer %<number>s.times.'
           RESTRICT_ON_SEND = %i[create_list].freeze
 
-          # @!method n_times_block?(node)
-          def_node_matcher :n_times_block?, <<-PATTERN
+          # @!method array_new_or_n_times_block?(node)
+          def_node_matcher :array_new_or_n_times_block?, <<-PATTERN
             (block
-              (send (int _) :times)
+              {
+                (send (const {nil? | cbase} :Array) :new (int _)) |
+                (send (int _) :times)
+              }
               ...
             )
           PATTERN
 
-          # @!method n_times_block_with_arg_and_used?(node)
-          def_node_matcher :n_times_block_with_arg_and_used?, <<-PATTERN
+          # @!method block_with_arg_and_used?(node)
+          def_node_matcher :block_with_arg_and_used?, <<-PATTERN
             (block
-              (send (int _) :times)
+              _
               (args (arg _value))
-                `_value
+              `_value
             )
           PATTERN
 
@@ -71,11 +75,11 @@ module RuboCop
             (send {nil? #factory_bot?} :create_list (sym _) (int $_) ...)
           PATTERN
 
-          def on_block(node)
+          def on_block(node) # rubocop:todo InternalAffairs/NumblockHandler
             return unless style == :create_list
 
-            return unless n_times_block?(node)
-            return if n_times_block_with_arg_and_used?(node)
+            return unless array_new_or_n_times_block?(node)
+            return if block_with_arg_and_used?(node)
             return unless node.body
             return if arguments_include_method_call?(node.body)
             return unless contains_only_factory?(node.body)
@@ -183,7 +187,7 @@ module RuboCop
 
             def call_with_block_replacement(node)
               block = node.body
-              arguments = build_arguments(block, node.receiver.source)
+              arguments = build_arguments(block, count_from(node))
               replacement = format_receiver(block.receiver)
               replacement += format_method_call(block, 'create_list', arguments)
               replacement += format_block(block)
@@ -203,7 +207,7 @@ module RuboCop
               block = node.body
               factory, *options = *block.arguments
 
-              arguments = "#{factory.source}, #{node.receiver.source}"
+              arguments = "#{factory.source}, #{count_from(node)}"
               options = build_options_string(options)
               arguments += ", #{options}" unless options.empty?
 
@@ -212,6 +216,16 @@ module RuboCop
               replacement
             end
 
+            def count_from(node)
+              count_node =
+                if node.receiver.int_type?
+                  node.receiver
+                else
+                  node.send_node.first_argument
+                end
+              count_node.source
+            end
+
             def format_block(node)
               if node.body.begin_type?
                 format_multiline_block(node)

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -19,6 +19,7 @@ module RuboCop
         #   # good
         #   factory :foo, class: 'Foo' do
         #   end
+        #
         class FactoryClassName < Base
           extend AutoCorrector
 

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

@@ -58,6 +58,7 @@ module RuboCop
       #
       class FilePath < Base
         include TopLevelGroup
+        include Namespace
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
@@ -101,7 +102,7 @@ module RuboCop
 
         def pattern_for(example_group, method_name)
           if spec_suffix_only? || !example_group.const_type?
-            return pattern_for_spec_suffix_only?
+            return pattern_for_spec_suffix_only
           end
 
           [
@@ -111,7 +112,7 @@ module RuboCop
           ].join
         end
 
-        def pattern_for_spec_suffix_only?
+        def pattern_for_spec_suffix_only
           '.*_spec\.rb'
         end
 
@@ -123,8 +124,10 @@ module RuboCop
         end
 
         def expected_path(constant)
+          constants = namespace(constant) + constant.const_name.split('::')
+
           File.join(
-            constant.const_name.split('::').map do |name|
+            constants.map do |name|
               custom_transform.fetch(name) { camel_to_snake_case(name) }
             end
           )

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

@@ -5,6 +5,8 @@ module RuboCop
     module RSpec
       # Checks if examples are focused.
       #
+      # This cop does not support autocorrection in some cases.
+      #
       # @example
       #   # bad
       #   describe MyClass, focus: true do
@@ -19,6 +21,22 @@ module RuboCop
       #   # good
       #   describe MyClass do
       #   end
+      #
+      #   # bad
+      #   fdescribe 'test' do; end
+      #
+      #   # good
+      #   describe 'test' do; end
+      #
+      #   # bad
+      #   fdescribe 'test' do; end
+      #
+      #   # good
+      #   describe 'test' do; end
+      #
+      #   # bad (does not support autocorrection)
+      #   focus 'test' do; end
+      #
       class Focus < Base
         extend AutoCorrector
         include RangeHelp

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

@@ -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

@@ -9,7 +9,6 @@ module RuboCop
       # and supports the `--auto-gen-config` flag.
       #
       # @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

@@ -18,6 +18,7 @@ module RuboCop
       #
       #   # 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)