rubocop-rspec 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fda044631502561746af13188e9d7217ef83f8fb
-  data.tar.gz: d021f893b44704291ff69433019a9798b50fe82e
+  metadata.gz: 48bfb61579b01b4044eeca76aa125c026ac18630
+  data.tar.gz: 240d2ce3b483174eae7c4049fcc65f8301bf48a1
 SHA512:
-  metadata.gz: 8d804e069e562fa9af39669b2f39b6d8fa81e1ce4778bba2dfbf999dd1afc583475e1bd3d296e1ce79cf40bf04ad42d09468d9b4b0eb6dd10fced565e7e970b3
-  data.tar.gz: 8d14f57b6eb8437b68a7f92acea42a687a7515e1793da6d11485e3c97140571b6741697fad84e6763be1f31fad1d897b88e8dd5131d0286e92fe05cd4c77717a
+  metadata.gz: 09f351caba55c9c7ad8710e286fec4b9f087028a64a886c4edf25d69b3147ecedebd5e7eeacec52a81285e14c3cd46cf615fbfef3c15a542fe6cd6c6a9d28a0c
+  data.tar.gz: 120152a6271b3eb853a9e8c4b19716667b401f732a712c045ebada5df7371c3a843e49d5a8a83cb5197fd7a9bbf4a12e6ef245fdf9df9cd26155a849cdcdeffc

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change log
 
-## Master (unreleased)
+## Master (Unreleased)
+
+## 1.12.0 (2017-02-21)
+
+* Add `RSpec/InstanceSpy` cop. ([@Darhazer][])
+* Add `RSpec/BeforeAfterAll` for avoiding leaky global test setup. ([@cfabianski][])
 
 ## 1.11.0 (2017-02-16)
 
@@ -180,3 +185,4 @@
 [@onk]: https://github.com/onk
 [@Darhazer]: https://github.com/Darhazer
 [@redross]: https://github.com/redross
+[@cfabianski]: https://github.com/cfabianski

data/config/default.yml

@@ -17,6 +17,14 @@ RSpec/BeEql:
   Description: Check for expectations where `be(...)` can replace `eql(...)`.
   Enabled: true
 
+RSpec/BeforeAfterAll:
+  Description: Check that before/after(:all) isn't being used.
+  Enabled: true
+  Exclude:
+  - spec/spec_helper.rb
+  - spec/rails_helper.rb
+  - spec/support/**/*.rb
+
 RSpec/DescribeClass:
   Description: Check that the first argument to the top level describe is a constant.
   Enabled: true
@@ -90,6 +98,10 @@ RSpec/ImplicitExpect:
   - is_expected
   - should
 
+RSpec/InstanceSpy:
+  Description: Checks for `instance_double` used with `have_received`.
+  Enabled: true
+
 RSpec/InstanceVariable:
   Description: Checks for instance variable usage in specs.
   AssignmentOnly: false

data/lib/rubocop-rspec.rb

@@ -23,6 +23,7 @@ RuboCop::RSpec::Inject.defaults!
 require 'rubocop/cop/rspec/any_instance'
 require 'rubocop/cop/rspec/around_block'
 require 'rubocop/cop/rspec/be_eql'
+require 'rubocop/cop/rspec/before_after_all'
 require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'
 require 'rubocop/cop/rspec/described_class'
@@ -35,6 +36,7 @@ require 'rubocop/cop/rspec/file_path'
 require 'rubocop/cop/rspec/focus'
 require 'rubocop/cop/rspec/hook_argument'
 require 'rubocop/cop/rspec/implicit_expect'
+require 'rubocop/cop/rspec/instance_spy'
 require 'rubocop/cop/rspec/instance_variable'
 require 'rubocop/cop/rspec/leading_subject'
 require 'rubocop/cop/rspec/let_setup'

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that before/after(:all) isn't being used.
+      #
+      # @example
+      #   # bad
+      #   #
+      #   # Faster but risk of state leaking between examples
+      #   #
+      #   describe MyClass do
+      #     before(:all) { Widget.create }
+      #     after(:all) { Widget.delete_all }
+      #   end
+      #
+      #   # good
+      #   #
+      #   # Slower but examples are properly isolated
+      #   #
+      #   describe MyClass do
+      #     before(:each) { Widget.create }
+      #     after(:each) { Widget.delete_all }
+      #   end
+      class BeforeAfterAll < Cop
+        MESSAGE = 'Beware of using `before/after(:all)` as it may cause state '\
+          'to leak between tests. If you are using rspec-rails, and '\
+          '`use_transactional_fixtures` is enabled, then records created in '\
+          '`before(:all)` are not rolled back.'.freeze
+
+        BEFORE_AFTER_METHODS = [
+          :before,
+          :after
+        ].freeze
+
+        ALL_PAIR = s(:sym, :all)
+        CONTEXT_PAIR = s(:sym, :context)
+
+        def on_send(node)
+          _receiver, method_name, *args = *node
+          return unless BEFORE_AFTER_METHODS.include?(method_name)
+          return unless args.include?(ALL_PAIR) || args.include?(CONTEXT_PAIR)
+
+          add_offense(node, :expression, MESSAGE)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for `instance_double` used with `have_received`.
+      #
+      # @example
+      #   # bad
+      #   it do
+      #     foo = instance_double(Foo).as_null_object
+      #     expect(foo).to have_received(:bar)
+      #   end
+      #
+      #   # good
+      #   it do
+      #     foo = instance_spy(Foo)
+      #     expect(foo).to have_received(:bar)
+      #   end
+      #
+      class InstanceSpy < Cop
+        MSG = 'Use `instance_spy` when you check your double ' \
+              'with `have_received`'.freeze
+
+        EXAMPLES = Examples::ALL.node_pattern_union.freeze
+
+        def_node_matcher :example?, "(block $(send nil #{EXAMPLES}) ...)"
+
+        def_node_search :null_double, <<-PATTERN
+        (lvasgn $_
+          (send
+            $(send nil :instance_double
+              ...) :as_null_object))
+        PATTERN
+
+        def_node_search :have_received_usage, <<-PATTERN
+        (send
+          (send nil :expect
+          (lvar $_)) :to
+          (send nil :have_received
+          ...)
+        ...)
+        PATTERN
+
+        def on_block(node)
+          return unless example?(node)
+
+          null_double(node) do |var, receiver|
+            have_received_usage(node) do |expected|
+              add_offense(receiver, :expression, MSG) if expected == var
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            replacement = 'instance_spy'
+            corrector.replace(node.loc.selector, replacement)
+
+            double_source_map = node.parent.loc
+            as_null_object_range = double_source_map
+              .dot
+              .join(double_source_map.selector)
+            corrector.remove(as_null_object_range)
+          end
+        end
+      end
+    end
+  end
+end

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.11.0'.freeze
+      STRING = '1.12.0'.freeze
     end
   end
 end

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

@@ -0,0 +1,92 @@
+describe RuboCop::Cop::RSpec::BeforeAfterAll, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'when offenses detected' do
+    let(:code) do
+      [
+        'describe MyClass do',
+        '  before(:all) { do_something}',
+        '  after(:all) { do_something_else }',
+        'end'
+      ]
+    end
+
+    let(:expected_error) do
+      'Beware of using `before/after(:all)` as it may cause state to leak '\
+        'between tests. If you are using rspec-rails, and '\
+        '`use_transactional_fixtures` is enabled, then records created in '\
+        '`before(:all)` are not rolled back.'
+    end
+
+    it 'reports 2 offenses' do
+      inspect_source(cop, code, 'foo_spec.rb')
+      expect(cop.offenses.size).to eq(2)
+    end
+
+    it 'reports the lines for these offenses' do
+      inspect_source(cop, code, 'foo_spec.rb')
+      expect(cop.offenses.map(&:line).sort).to eq([2, 3])
+    end
+
+    it 'describes the offenses' do
+      inspect_source(cop, code, 'foo_spec.rb')
+      expect(cop.messages).to eq([expected_error, expected_error])
+    end
+  end
+
+  it 'complains for :context' do
+    inspect_source(
+      cop,
+      [
+        'describe MyClass do',
+        '  before(:context) { do_something }',
+        '  after(:context) { do_something_else }',
+        'end'
+      ],
+      'foo_spec.rb'
+    )
+    expect(cop.offenses.size).to eq(2)
+  end
+
+  it 'does not complain for before/after :each' do
+    inspect_source(
+      cop,
+      [
+        'describe MyClass do',
+        '  before(:each) { do_something }',
+        '  after(:each) { do_something_else }',
+        'end'
+      ],
+      'foo_spec.rb'
+    )
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'does not complain for before/after :example' do
+    inspect_source(
+      cop,
+      [
+        'describe MyClass do',
+        '  before(:example) { do_something }',
+        '  after(:example) { do_something_else }',
+        'end'
+      ],
+      'foo_spec.rb'
+    )
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'does not complain for before/after' do
+    inspect_source(
+      cop,
+      [
+        'describe MyClass do',
+        '  before { do_something }',
+        '  after { do_something_else }',
+        'end'
+      ],
+      'foo_spec.rb'
+    )
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,60 @@
+describe RuboCop::Cop::RSpec::InstanceSpy do
+  subject(:cop) { described_class.new }
+
+  context 'when used with `have_received`' do
+    it 'adds an offense for an instance_double with single argument' do
+      expect_violation(<<-RUBY)
+        it do
+          foo = instance_double(Foo).as_null_object
+                ^^^^^^^^^^^^^^^^^^^^ Use `instance_spy` when you check your double with `have_received`
+          expect(foo).to have_received(:bar)
+        end
+      RUBY
+    end
+
+    it 'adds an offense for an instance_double with multiple arguments' do
+      expect_violation(<<-RUBY)
+        it do
+          foo = instance_double(Foo, :name).as_null_object
+                ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `instance_spy` when you check your double with `have_received`
+          expect(foo).to have_received(:bar)
+        end
+      RUBY
+    end
+
+    it 'ignores instance_double when it is not used with as_null_object' do
+      expect_no_violations(<<-RUBY)
+        it do
+          foo = instance_double(Foo)
+          expect(bar).to have_received(:bar)
+       end
+      RUBY
+    end
+  end
+
+  context 'when not used with `have_received`' do
+    it 'does not add an offence' do
+      expect_no_violations(<<-RUBY)
+        it do
+          foo = instance_double(Foo).as_null_object
+          expect(bar).to have_received(:bar)
+        end
+      RUBY
+    end
+  end
+
+  original = <<-RUBY
+  it do
+    foo = instance_double(Foo, :name).as_null_object
+    expect(foo).to have_received(:bar)
+  end
+  RUBY
+  corrected = <<-RUBY
+  it do
+    foo = instance_spy(Foo, :name)
+    expect(foo).to have_received(:bar)
+  end
+  RUBY
+
+  include_examples 'autocorrect', original, corrected
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -147,6 +147,7 @@ files:
 - lib/rubocop/cop/rspec/any_instance.rb
 - lib/rubocop/cop/rspec/around_block.rb
 - lib/rubocop/cop/rspec/be_eql.rb
+- lib/rubocop/cop/rspec/before_after_all.rb
 - lib/rubocop/cop/rspec/cop.rb
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
@@ -160,6 +161,7 @@ files:
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
+- lib/rubocop/cop/rspec/instance_spy.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
 - lib/rubocop/cop/rspec/leading_subject.rb
 - lib/rubocop/cop/rspec/let_setup.rb
@@ -199,6 +201,7 @@ files:
 - spec/rubocop/cop/rspec/any_instance_spec.rb
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
+- spec/rubocop/cop/rspec/before_after_all_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
@@ -212,6 +215,7 @@ files:
 - spec/rubocop/cop/rspec/focus_spec.rb
 - spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/implicit_expect_spec.rb
+- spec/rubocop/cop/rspec/instance_spy_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/leading_subject_spec.rb
 - spec/rubocop/cop/rspec/let_setup_spec.rb
@@ -273,6 +277,7 @@ test_files:
 - spec/rubocop/cop/rspec/any_instance_spec.rb
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
+- spec/rubocop/cop/rspec/before_after_all_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
@@ -286,6 +291,7 @@ test_files:
 - spec/rubocop/cop/rspec/focus_spec.rb
 - spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/implicit_expect_spec.rb
+- spec/rubocop/cop/rspec/instance_spy_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/leading_subject_spec.rb
 - spec/rubocop/cop/rspec/let_setup_spec.rb