rubocop-rspec 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc31ff59557e82627745015742087123734c2d1abda96cc277ac243c8bee1f2
-  data.tar.gz: 819b5fea22acb7db40512b8291ce8cddec7c9580fb62ccb38bad146bdeaa27e1
+  metadata.gz: c0fcdb4a1fb882713a667ae92edf352ee496300bd20cbd44c79ec0c79773691f
+  data.tar.gz: 22ed75baf52c414c530edef39ba1a2b361c4e2060711775c093585c7a10ffe53
 SHA512:
-  metadata.gz: 1998ae7af3934178c41e2c8c965d33af83d1eb30e1becf04ef69b9b6eda8b023d7f2f8e63e2d4a5b2edc74d254d3beb93b34d48d1edbfa318c32d8f389cded80
-  data.tar.gz: 59cdfdb2dd906222e08e4839f3c9b8ee8d0dcb81d28ad65de6e7fd6055849d7eac4393d21197b8de621934e71ae4405345f6be71f6fe9eb0d1b09562060a388a
+  metadata.gz: 597bacb5b6c60657a33532a1d625008030338e16f8fca2e42d1a9b0dc4bf76a6e9296d8fb2948ad0947bb522212bc53ef997fc4155168c89e76c66fda4e6ef87
+  data.tar.gz: 9ecac64a0f6cccba7a794125e0e4bd0bd47722f8e5d2a3efed8828709fdc8c682ca09794a74c33d92f6feec90d70b856d2bf1f544d13c51fc4f63d7c398568e1

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Master (Unreleased)
 
+## 1.32.0 (2019-01-27)
+
+* Add `RSpec/Yield` cop, suggesting using the `and_yield` method when stubbing a method, accepting a block. ([@Darhazer][])
+* Fix `FactoryBot/CreateList` autocorrect crashing when the factory is called with a block=. ([@Darhazer][])
+* Fixed `RSpec/Focus` not flagging some cases of `RSpec.describe` with `focus: true`. ([@Darhazer][])
+* Fixed `RSpec/Pending` not flagging some cases of `RSpec.describe` with `:skip`. ([@Darhazer][])
+* Fix false positive in `RSpec/ReceiveCounts` when method name `exactly`, `at_least` or `at_most` is used along with `times`, without being an RSpec API. ([@Darhazer][])
+
 ## 1.31.0 (2019-01-02)
 
 * Add `IgnoreSharedExamples` option for `RSpec/NamedSubject`. ([@RST-J][])

data/config/default.yml

@@ -417,6 +417,11 @@ RSpec/VoidExpect:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VoidExpect
 
+RSpec/Yield:
+  Description: This cop checks for calling a block within a stub.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Yield
+
 Capybara/CurrentPathExpectation:
   Description: Checks that no expectations are set on Capybara's `current_path`.
   Enabled: true

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

@@ -69,9 +69,9 @@ module RuboCop
 
           def autocorrect(node)
             if style == :create_list
-              autocorrect_n_times_to_create_list(node)
+              CreateListCorrector.new(node)
             else
-              autocorrect_create_list_to_n_times(node)
+              TimesCorrector.new(node)
             end
           end
 
@@ -85,63 +85,127 @@ module RuboCop
             end
           end
 
-          def autocorrect_n_times_to_create_list(node)
-            block = node.parent
-            count = block.receiver.source
-            replacement = factory_call_replacement(block.body, count)
+          # :nodoc
+          class Corrector
+            private
 
-            lambda do |corrector|
-              corrector.replace(block.loc.expression, replacement)
+            def build_options_string(options)
+              options.map(&:source).join(', ')
+            end
+
+            def format_method_call(node, method, arguments)
+              if node.block_type? || node.parenthesized?
+                "#{method}(#{arguments})"
+              else
+                "#{method} #{arguments}"
+              end
+            end
+
+            def format_receiver(receiver)
+              return '' unless receiver
+
+              "#{receiver.source}."
             end
           end
 
-          def autocorrect_create_list_to_n_times(node)
-            replacement = generate_n_times_block(node)
-            lambda do |corrector|
+          # :nodoc
+          class TimesCorrector < Corrector
+            def initialize(node)
+              @node = node
+            end
+
+            def call(corrector)
+              replacement = generate_n_times_block(node)
               corrector.replace(node.loc.expression, replacement)
             end
-          end
 
-          def generate_n_times_block(node)
-            receiver, factory, count, options = *factory_list_call(node)
+            private
 
-            arguments = ":#{factory}"
-            options = build_options_string(options)
-            arguments += ", #{options}" unless options.empty?
+            attr_reader :node
 
-            replacement = format_receiver(receiver)
-            replacement += format_method_call(node, 'create', arguments)
-            "#{count}.times { #{replacement} }"
+            def generate_n_times_block(node)
+              factory, count, *options = node.arguments
+
+              arguments = factory.source
+              options = build_options_string(options)
+              arguments += ", #{options}" unless options.empty?
+
+              replacement = format_receiver(node.receiver)
+              replacement += format_method_call(node, 'create', arguments)
+              "#{count.source}.times { #{replacement} }"
+            end
           end
 
-          def factory_call_replacement(body, count)
-            receiver, factory, options = *factory_call(body)
+          # :nodoc:
+          class CreateListCorrector < Corrector
+            def initialize(node)
+              @node = node.parent
+            end
 
-            arguments = ":#{factory}, #{count}"
-            options = build_options_string(options)
-            arguments += ", #{options}" unless options.empty?
+            def call(corrector)
+              replacement = if node.body.block_type?
+                              call_with_block_replacement(node)
+                            else
+                              call_replacement(node)
+                            end
 
-            replacement = format_receiver(receiver)
-            replacement += format_method_call(body, 'create_list', arguments)
-            replacement
-          end
+              corrector.replace(node.loc.expression, replacement)
+            end
 
-          def build_options_string(options)
-            options.map(&:source).join(', ')
-          end
+            private
 
-          def format_method_call(node, method, arguments)
-            if node.parenthesized?
-              "#{method}(#{arguments})"
-            else
-              "#{method} #{arguments}"
+            attr_reader :node
+
+            def call_with_block_replacement(node)
+              block = node.body
+              arguments = build_arguments(block, node.receiver.source)
+              replacement = format_receiver(block.send_node.receiver)
+              replacement += format_method_call(block, 'create_list', arguments)
+              replacement += format_block(block)
+              replacement
             end
-          end
 
-          def format_receiver(receiver)
-            return '' unless receiver
+            def build_arguments(node, count)
+              factory, *options = *node.send_node.arguments
+
+              arguments = ":#{factory.value}, #{count}"
+              options = build_options_string(options)
+              arguments += ", #{options}" unless options.empty?
+              arguments
+            end
+
+            def call_replacement(node)
+              block = node.body
+              factory, *options = *block.arguments
+
+              arguments = "#{factory.source}, #{node.receiver.source}"
+              options = build_options_string(options)
+              arguments += ", #{options}" unless options.empty?
 
-            "#{receiver.source}."
+              replacement = format_receiver(block.receiver)
+              replacement += format_method_call(block, 'create_list', arguments)
+              replacement
+            end
+
+            def format_block(node)
+              if node.body.begin_type?
+                format_multiline_block(node)
+              else
+                format_singeline_block(node)
+              end
+            end
+
+            def format_multiline_block(node)
+              indent = ' ' * node.body.loc.column
+              indent_end = ' ' * node.parent.loc.column
+              " do #{node.arguments.source}\n" \
+              "#{indent}#{node.body.source}\n" \
+              "#{indent_end}end"
+            end
+
+            def format_singeline_block(node)
+              " { #{node.arguments.source} #{node.body.source} }"
+            end
           end
         end
       end

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

@@ -36,8 +36,8 @@ module RuboCop
         FOCUS_TRUE   = s(:pair, FOCUS_SYMBOL, s(:true))
 
         def_node_matcher :metadata, <<-PATTERN
-          {(send nil? #{FOCUSABLE_SELECTORS} ... (hash $...))
-           (send nil? #{FOCUSABLE_SELECTORS} $...)}
+          {(send {(const nil? :RSpec) nil?} #{FOCUSABLE_SELECTORS} ... (hash $...))
+           (send {(const nil? :RSpec) nil?} #{FOCUSABLE_SELECTORS} $...)}
         PATTERN
 
         def_node_matcher :focused_block?, focused.send_pattern

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

@@ -37,8 +37,8 @@ module RuboCop
         PENDING_SYMBOL = s(:sym, :pending)
 
         def_node_matcher :metadata, <<-PATTERN
-          {(send nil? #{SKIPPABLE_SELECTORS} ... (hash $...))
-           (send nil? #{SKIPPABLE_SELECTORS} $...)}
+          {(send {(const nil? :RSpec) nil?} #{SKIPPABLE_SELECTORS} ... (hash $...))
+           (send {(const nil? :RSpec) nil?} #{SKIPPABLE_SELECTORS} $...)}
         PATTERN
 
         def_node_matcher :pending_block?, PENDING_EXAMPLES.send_pattern

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

@@ -30,8 +30,12 @@ module RuboCop
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN
 
+        def_node_search :stub?, '(send nil? :receive ...)'
+
         def on_send(node)
           receive_counts(node) do |offending_node|
+            return unless stub?(offending_node.receiver)
+
             offending_range = range(node, offending_node)
 
             add_offense(
@@ -48,10 +52,9 @@ module RuboCop
               node.method_name,
               node.first_argument.source.to_i
             )
-            corrector.replace(
-              range(node.parent, node),
-              replacement
-            )
+
+            original = range(node.parent, node)
+            corrector.replace(original, replacement)
           end
         end
 

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # This cop checks for calling a block within a stub.
+      #
+      # @example
+      #   # bad
+      #   allow(foo).to receive(:bar) { |&block| block.call(1) }
+      #
+      #   # good
+      #   expect(foo).to be(:bar).and_yield(1)
+      class Yield < Cop
+        include RangeHelp
+
+        MSG = 'Use `.and_yield`.'.freeze
+
+        def_node_search :method_on_stub?, '(send nil? :receive ...)'
+
+        def_node_matcher :block_arg, '(args (blockarg $_))'
+
+        def_node_matcher :block_call?, '(send (lvar %) :call ...)'
+
+        def on_block(node)
+          return unless method_on_stub?(node.send_node)
+
+          block_arg(node.arguments) do |block|
+            if calling_block?(node.body, block)
+              add_offense(node, location: block_range(node))
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            node_range = range_with_surrounding_space(
+              range: block_range(node), side: :left
+            )
+            corrector.replace(node_range, generate_replacement(node.body))
+          end
+        end
+
+        private
+
+        def calling_block?(node, block)
+          if node.begin_type?
+            node.each_child_node.all? { |child| block_call?(child, block) }
+          else
+            block_call?(node, block)
+          end
+        end
+
+        def block_range(node)
+          block_start = node.loc.begin.begin_pos
+          block_end = node.loc.end.end_pos
+          range_between(block_start, block_end)
+        end
+
+        def generate_replacement(node)
+          if node.begin_type?
+            node.children.map { |child| convert_block_to_yield(child) }.join
+          else
+            convert_block_to_yield(node)
+          end
+        end
+
+        def convert_block_to_yield(node)
+          args = node.arguments
+          replacement = '.and_yield'
+          replacement += "(#{args.map(&:source).join(', ')})" if args.any?
+          replacement
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -75,3 +75,4 @@ require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/verified_doubles'
 require_relative 'rspec/void_expect'
+require_relative 'rspec/yield'

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.31.0'.freeze
+      STRING = '1.32.0'.freeze
     end
   end
 end

data/spec/rubocop/cop/rspec/factory_bot/create_list_spec.rb

@@ -88,6 +88,36 @@ RSpec.describe RuboCop::Cop::RSpec::FactoryBot::CreateList, :config do
     include_examples 'autocorrect',
                      '5.times { FactoryGirl.create :user }',
                      'FactoryGirl.create_list :user, 5'
+
+    bad_code = <<-RUBY
+      3.times do
+        create(:user, :trait) { |user| create :account, user: user }
+      end
+    RUBY
+
+    good_code = <<-RUBY
+      create_list(:user, 3, :trait) { |user| create :account, user: user }
+    RUBY
+
+    include_examples 'autocorrect', bad_code, good_code
+
+    bad_code = <<-RUBY
+      3.times do
+        create(:user, :trait) do |user|
+          create :account, user: user
+          create :profile, user: user
+        end
+      end
+    RUBY
+
+    good_code = <<-RUBY
+      create_list(:user, 3, :trait) do |user|
+          create :account, user: user
+          create :profile, user: user
+      end
+    RUBY
+
+    include_examples 'autocorrect', bad_code, good_code
   end
 
   context 'when EnforcedStyle is :n_times' do

data/spec/rubocop/cop/rspec/focus_spec.rb

@@ -10,6 +10,8 @@ RSpec.describe RuboCop::Cop::RSpec::Focus do
                               ^^^^^^^^^^^ Focused spec found.
       describe 'test', meta: true, focus: true do; end
                                    ^^^^^^^^^^^ Focused spec found.
+      RSpec.describe 'test', meta: true, focus: true do; end
+                                         ^^^^^^^^^^^ Focused spec found.
       it 'test', meta: true, focus: true do; end
                              ^^^^^^^^^^^ Focused spec found.
       xspecify 'test', meta: true, focus: true do; end
@@ -61,6 +63,8 @@ RSpec.describe RuboCop::Cop::RSpec::Focus do
                        ^^^^^^ Focused spec found.
       describe 'test', :focus do; end
                        ^^^^^^ Focused spec found.
+      RSpec.describe 'test', :focus do; end
+                             ^^^^^^ Focused spec found.
       xit 'test', :focus do; end
                   ^^^^^^ Focused spec found.
       context 'test', :focus do; end
@@ -108,10 +112,13 @@ RSpec.describe RuboCop::Cop::RSpec::Focus do
     RUBY
   end
 
+  # rubocop:disable RSpec/ExampleLength
   it 'flags focused block types' do
     expect_offense(<<-RUBY)
       fdescribe 'test' do; end
       ^^^^^^^^^^^^^^^^ Focused spec found.
+      RSpec.fdescribe 'test' do; end
+      ^^^^^^^^^^^^^^^^^^^^^^ Focused spec found.
       ffeature 'test' do; end
       ^^^^^^^^^^^^^^^ Focused spec found.
       fcontext 'test' do; end
@@ -128,4 +135,5 @@ RSpec.describe RuboCop::Cop::RSpec::Focus do
       ^^^^^^^^^^^^ Focused spec found.
     RUBY
   end
+  # rubocop:enable RSpec/ExampleLength
 end

data/spec/rubocop/cop/rspec/pending_spec.rb

@@ -82,6 +82,14 @@ RSpec.describe RuboCop::Cop::RSpec::Pending do
     RUBY
   end
 
+  it 'flags describe with skip symbol metadata' do
+    expect_offense(<<-RUBY)
+      RSpec.describe 'test', :skip do
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Pending spec found.
+      end
+    RUBY
+  end
+
   it 'flags blocks with pending symbol metadata' do
     expect_offense(<<-RUBY)
       it 'test', :pending do

data/spec/rubocop/cop/rspec/receive_counts_spec.rb

@@ -78,6 +78,12 @@ RSpec.describe RuboCop::Cop::RSpec::ReceiveCounts do
     RUBY
   end
 
+  it 'allows exactly(1).times when not called on `receive`' do
+    expect_no_offenses(<<-RUBY)
+      expect(action).to have_published_event.exactly(1).times
+    RUBY
+  end
+
   include_examples 'autocorrect',
                    'expect(foo).to receive(:bar).exactly(1).times { true }',
                    'expect(foo).to receive(:bar).once { true }'
@@ -85,4 +91,9 @@ RSpec.describe RuboCop::Cop::RSpec::ReceiveCounts do
   include_examples 'autocorrect',
                    'expect(foo).to receive(:bar).at_least(2).times { true }',
                    'expect(foo).to receive(:bar).at_least(:twice) { true }'
+
+  # Does not auto-correct if not part of the RSpec API
+  include_examples 'autocorrect',
+                   'expect(foo).to have_published_event(:bar).exactly(2).times',
+                   'expect(foo).to have_published_event(:bar).exactly(2).times'
 end

data/spec/rubocop/cop/rspec/yield_spec.rb

@@ -0,0 +1,80 @@
+RSpec.describe RuboCop::Cop::RSpec::Yield do
+  subject(:cop) { described_class.new }
+
+  it 'flags `block.call`' do
+    expect_offense(<<-RUBY)
+      allow(foo).to receive(:bar) { |&block| block.call }
+                                  ^^^^^^^^^^^^^^^^^^^^^^^ Use `.and_yield`.
+    RUBY
+  end
+
+  it 'flags multiple `block.call`' do
+    expect_offense(<<-RUBY)
+      allow(foo).to receive(:bar) do |&block|
+                                  ^^^^^^^^^^^ Use `.and_yield`.
+        block.call
+        block.call
+      end
+    RUBY
+  end
+
+  it 'flags `block.call` with arguments' do
+    expect_offense(<<-RUBY)
+      allow(foo).to receive(:bar) { |&block| block.call(1, 2) }
+                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `.and_yield`.
+    RUBY
+  end
+
+  it 'flags multiple `block.call` with arguments' do
+    expect_offense(<<-RUBY)
+      allow(foo).to receive(:bar) do |&block|
+                                  ^^^^^^^^^^^ Use `.and_yield`.
+         block.call(1)
+         block.call(2)
+       end
+    RUBY
+  end
+
+  it 'flags `block.call` when `receive` is chained' do
+    expect_offense(<<-RUBY)
+      allow(foo).to receive(:bar).with(anything) { |&block| block.call }
+                                                 ^^^^^^^^^^^^^^^^^^^^^^^ Use `.and_yield`.
+    RUBY
+  end
+
+  it 'ignores `receive` with no block arguments' do
+    expect_no_offenses(<<-RUBY)
+      allow(foo).to receive(:bar) { |block| block.call }
+    RUBY
+  end
+
+  it 'ignores stub when `block.call` is not the only statement' do
+    expect_no_offenses(<<-RUBY)
+      allow(foo).to receive(:bar) do |&block|
+        result = block.call
+        transform(result)
+      end
+    RUBY
+  end
+
+  include_examples 'autocorrect',
+                   'allow(foo).to receive(:bar) { |&block| block.call }',
+                   'allow(foo).to receive(:bar).and_yield'
+
+  include_examples 'autocorrect',
+                   'allow(foo).to receive(:bar) { |&block| block.call(1, 2) }',
+                   'allow(foo).to receive(:bar).and_yield(1, 2)'
+
+  bad_code = <<-RUBY
+    allow(foo).to receive(:bar) do |&block|
+      block.call(1)
+      block.call(2)
+    end
+  RUBY
+
+  good_code = <<-RUBY
+    allow(foo).to receive(:bar).and_yield(1).and_yield(2)
+  RUBY
+
+  include_examples 'autocorrect', bad_code, good_code
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -187,6 +187,7 @@ files:
 - lib/rubocop/cop/rspec/unspecified_exception.rb
 - lib/rubocop/cop/rspec/verified_doubles.rb
 - lib/rubocop/cop/rspec/void_expect.rb
+- lib/rubocop/cop/rspec/yield.rb
 - lib/rubocop/cop/rspec_cops.rb
 - lib/rubocop/rspec.rb
 - lib/rubocop/rspec/align_let_brace.rb
@@ -281,6 +282,7 @@ files:
 - spec/rubocop/cop/rspec/unspecified_exception_spec.rb
 - spec/rubocop/cop/rspec/verified_doubles_spec.rb
 - spec/rubocop/cop/rspec/void_expect_spec.rb
+- spec/rubocop/cop/rspec/yield_spec.rb
 - spec/rubocop/rspec/config_formatter_spec.rb
 - spec/rubocop/rspec/description_extractor_spec.rb
 - spec/rubocop/rspec/example_group_spec.rb
@@ -398,6 +400,7 @@ test_files:
 - spec/rubocop/cop/rspec/unspecified_exception_spec.rb
 - spec/rubocop/cop/rspec/verified_doubles_spec.rb
 - spec/rubocop/cop/rspec/void_expect_spec.rb
+- spec/rubocop/cop/rspec/yield_spec.rb
 - spec/rubocop/rspec/config_formatter_spec.rb
 - spec/rubocop/rspec/description_extractor_spec.rb
 - spec/rubocop/rspec/example_group_spec.rb