rubocop-rspec 1.34.1 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cde39325f1b2c820f9105b689ab70ed80cd0e05bc0255cad156cfd3418e90d33
-  data.tar.gz: f538c3972f746964aca96015ea16e5553589601defe597d7069cbbc5e1a20e24
+  metadata.gz: 47216a8696392108804dfd285875acfdec9857df832fb6270120b29161bcd5d6
+  data.tar.gz: 742b3c4e6836a6e7c8aa4d2ca02abd73f09870165f2e10a4eb41ea9d1ef6c859
 SHA512:
-  metadata.gz: dd46062a2e229f7f9af5404399eb08762cb18eb30649af6d9b3e6ea12e5ee56bbc13a8971ca951626e5239502faa06992ea2c67be74687dbb909e41b1fcfcbe7
-  data.tar.gz: 56e6d26667a4c96060fa80cc94795a21db84299272ad0b6ba532bce2e04e3362bbf12c2df53a4ae5db948ef1a1f1441618a201e30eef843aa1463879c0c21809
+  metadata.gz: 488afcabe181b6658b73014730194c4a1bab399e096d2fdb230f2d16bee41afa3d71d285fd764a7a6b766117bd68d6702c54cab33503a18ed3f6501428569ff0
+  data.tar.gz: a8030e59e2f88880b09621a868f18e8af0b44bca6927822f7e07cfcae9668a3e11d91aab7e4450dffa05d7409043a4e2db9b87373ea9b1316d00e924e52668d1

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master (Unreleased)
 
+## 1.35.0 (2019-08-02)
+
+* Add `RSpec/ImplicitBlockExpectation` cop. ([@pirj][])
+
 ## 1.34.1 (2019-07-31)
 
 * Fix `RSpec/DescribedClass`'s error when a local variable is part of the namespace. ([@pirj][])

data/config/default.yml

@@ -197,6 +197,11 @@ RSpec/HooksBeforeExamples:
   Description: Checks for before/around/after hooks that come after an example.
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/HooksBeforeExamples
 
+RSpec/ImplicitBlockExpectation:
+  Description: Check that implicit block expectation syntax is not used.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitBlockExpectation
+
 RSpec/ImplicitExpect:
   Description: Check that a consistent implicit expectation style is used.
   Enabled: true

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that implicit block expectation syntax is not used.
+      #
+      # Prefer using explicit block expectations.
+      #
+      # @example
+      #   # bad
+      #   subject { -> { do_something } }
+      #   it { is_expected.to change(something).to(new_value) }
+      #
+      #   # good
+      #   it 'changes something to a new value' do
+      #     expect { do_something }.to change(something).to(new_value)
+      #   end
+      class ImplicitBlockExpectation < Cop
+        MSG = 'Avoid implicit block expectations.'
+
+        def_node_matcher :lambda?, <<-PATTERN
+          {
+            (send (const nil? :Proc) :new)
+            (send nil? :proc)
+            (send nil? :lambda)
+          }
+        PATTERN
+
+        def_node_matcher :lambda_subject?, '(block #lambda? ...)'
+
+        def_node_matcher :implicit_expect, <<-PATTERN
+          $(send nil? {:is_expected :should :should_not} ...)
+        PATTERN
+
+        def on_send(node)
+          implicit_expect(node) do |implicit_expect|
+            subject = nearest_subject(implicit_expect)
+            add_offense(implicit_expect) if lambda_subject?(subject&.body)
+          end
+        end
+
+        private
+
+        def nearest_subject(node)
+          node
+            .each_ancestor(:block)
+            .lazy
+            .select { |block_node| multi_statement_example_group?(block_node) }
+            .map { |block_node| find_subject(block_node) }
+            .find(&:itself)
+        end
+
+        def multi_statement_example_group?(node)
+          example_group_with_body?(node) && node.body.begin_type?
+        end
+
+        def find_subject(block_node)
+          block_node.body.child_nodes.find { |send_node| subject?(send_node) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -41,6 +41,7 @@ require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
+require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'
 require_relative 'rspec/instance_spy'

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.34.1'
+      STRING = '1.35.0'
     end
   end
 end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::ImplicitBlockExpectation do
+  subject(:cop) { described_class.new }
+
+  it 'flags lambda in subject' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject { -> { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'ignores non-lambda subject' do
+    expect_no_offenses(<<-RUBY)
+      describe do
+        subject { 'normal' }
+        it { is_expected.to eq(something) }
+      end
+    RUBY
+  end
+
+  it 'flags lambda in subject!' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject! { -> { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags literal lambda' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject! { lambda { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags proc' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject! { proc { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags Proc.new' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject! { Proc.new { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags named subject' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject(:name) { -> { boom } }
+        it { is_expected.to change { something }.to(new_value) }
+             ^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags when subject is defined in the outer example group' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject { -> { boom } }
+        context do
+          it { is_expected.to change { something }.to(new_value) }
+               ^^^^^^^^^^^ Avoid implicit block expectations.
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores normal local subject' do
+    expect_no_offenses(<<-RUBY)
+      describe do
+        subject { -> { boom } }
+        context do
+          subject { 'normal' }
+          it { is_expected.to eq(something) }
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores named subject with deeply nested lambda' do
+    expect_no_offenses(<<-RUBY)
+      describe do
+        subject { {hash: -> { boom }} }
+        it { is_expected.to be(something) }
+      end
+    RUBY
+  end
+
+  it 'flags with `should` as implicit subject' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject { -> { boom } }
+        it { should change { something }.to(new_value) }
+             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'flags with `should_not` as implicit subject' do
+    expect_offense(<<-RUBY)
+      describe do
+        subject { -> { boom } }
+        it { should_not change { something }.to(new_value) }
+             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid implicit block expectations.
+      end
+    RUBY
+  end
+
+  it 'ignores when there is no subject defined' do
+    expect_no_offenses(<<-RUBY)
+      shared_examples 'subject is defined somewhere else' do
+        it { is_expected.to change { something }.to(new_value) }
+      end
+    RUBY
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.34.1
+  version: 1.35.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -150,6 +150,7 @@ files:
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/hooks_before_examples.rb
+- lib/rubocop/cop/rspec/implicit_block_expectation.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
 - lib/rubocop/cop/rspec/implicit_subject.rb
 - lib/rubocop/cop/rspec/instance_spy.rb
@@ -248,6 +249,7 @@ files:
 - spec/rubocop/cop/rspec/focus_spec.rb
 - spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/hooks_before_examples_spec.rb
+- spec/rubocop/cop/rspec/implicit_block_expectation_spec.rb
 - spec/rubocop/cop/rspec/implicit_expect_spec.rb
 - spec/rubocop/cop/rspec/implicit_subject_spec.rb
 - spec/rubocop/cop/rspec/instance_spy_spec.rb
@@ -368,6 +370,7 @@ test_files:
 - spec/rubocop/cop/rspec/focus_spec.rb
 - spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/hooks_before_examples_spec.rb
+- spec/rubocop/cop/rspec/implicit_block_expectation_spec.rb
 - spec/rubocop/cop/rspec/implicit_expect_spec.rb
 - spec/rubocop/cop/rspec/implicit_subject_spec.rb
 - spec/rubocop/cop/rspec/instance_spy_spec.rb