rubocop-rspec 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6138f067fde5bf88b21e56895a967a55e8bc9357dfd16d0044fd2777c5cbadc7
-  data.tar.gz: 64d630cc6a9f3d1413a8155486f002a1d524f9750ebf2c18d5c5bc485c21e438
+  metadata.gz: 443658797afd25742895f47e865522055e00c498fb74ca74fda1d09468d86470
+  data.tar.gz: 71e9ab9356e4287df026b2d051bc2de4407517021c62c28cc66dfb5164dda753
 SHA512:
-  metadata.gz: 57246fef93f5061741c542a5710c16c905ff086da1d06974473e8b6ad54a6c84e26c4d79f7f538a92bca7d53ceb4c20e9eace2d65536922168e4ca227bb5a152
-  data.tar.gz: 6940142c7e889246bab48ccd06dc35784731181b774fc047ba9359f5e5b5975b5b10cee3a2ac970e11142ed1ae9dfc004e88e30cba5470945088a23cd7506b8d
+  metadata.gz: 714551b4c0b85485ed5a0b0bdfc67cbca73b16fbb2a1ca5b498f578f928a04fe2ab58d1d9916bd140c64a62e23d81e9ea66944c294a98486776df9f204a2ba8f
+  data.tar.gz: 5b373a20f346018dd9cdf242e615e997b64d5803e77fd4fa434f346cb423366f199ee9597a3bf1515d238a16bf0e1cfc8178980d681e652a3352d78f003f1bbd

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 1.29.0 (2018-08-25)
+
+* `RSpec/InstanceVariable` - Recommend local variables in addition to `let`. ([@jaredbeck][])
+* Add `RSpec/ImplicitSubject` cop. ([@Darhazer][])
+* Add `RSpec/HooksBeforeExamples` cop. ([@Darhazer][])
+
 ## 1.28.0 (2018-08-14)
 
 * Add `RSpec/ReceiveNever` cop enforcing usage of `not_to receive` instead of `never` matcher. ([@Darhazer][])
@@ -328,6 +334,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@bquorning]: https://github.com/bquorning
 [@deivid-rodriguez]: https://github.com/deivid-rodriguez
 [@geniou]: https://github.com/geniou
+[@jaredbeck]: https://github.com/jaredbeck
 [@jawshooah]: https://github.com/jawshooah
 [@nevir]: https://github.com/nevir
 [@nijikon]: https://github.com/nijikon

data/config/default.yml

@@ -190,6 +190,11 @@ RSpec/HookArgument:
   - example
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/HookArgument
 
+RSpec/HooksBeforeExamples:
+  Enabled: true
+  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/ImplicitExpect:
   Description: Check that a consistent implicit expectation style is used.
   Enabled: true
@@ -199,6 +204,15 @@ RSpec/ImplicitExpect:
   - should
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitExpect
 
+RSpec/ImplicitSubject:
+  Enabled: true
+  Description: Checks for usage of implicit subject (`is_expected` / `should`).
+  EnforcedStyle: single_line_only
+  SupportedStyles:
+  - single_line_only
+  - disallow
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitSubject
+
 RSpec/InstanceSpy:
   Description: Checks for `instance_double` used with `have_received`.
   Enabled: true

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

@@ -115,7 +115,7 @@ module RuboCop
           if style == :described_class
             node.eql?(@described_class)
           else
-            node.method_name == :described_class
+            node.send_type? && node.method_name == :described_class
           end
         end
       end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for before/around/after hooks that come after an example.
+      #
+      # @example
+      #   # Bad
+      #
+      #   it 'checks what foo does' do
+      #     expect(foo).to be
+      #   end
+      #
+      #   before { prepare }
+      #   after { clean_up }
+      #
+      #   # Good
+      #   before { prepare }
+      #   after { clean_up }
+      #
+      #   it 'checks what foo does' do
+      #     expect(foo).to be
+      #   end
+      #
+      class HooksBeforeExamples < Cop
+        include RangeHelp
+        include RuboCop::RSpec::FinalEndLocation
+
+        MSG = 'Move `%<hook>s` above the examples in the group.'.freeze
+
+        def_node_matcher :example_or_group?, <<-PATTERN
+          {
+            #{(Examples::ALL + ExampleGroups::ALL).block_pattern}
+            #{Includes::EXAMPLES.send_pattern}
+          }
+        PATTERN
+
+        def on_block(node)
+          return unless example_group_with_body?(node)
+
+          check_hooks(node.body) if multiline_block?(node.body)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            first_example = find_first_example(node.parent)
+            first_example_pos = first_example.loc.expression
+            indent = "\n" + ' ' * first_example.loc.column
+
+            corrector.insert_before(first_example_pos, source(node) + indent)
+            corrector.remove(node_range_with_surrounding_space(node))
+          end
+        end
+
+        private
+
+        def multiline_block?(block)
+          block.begin_type?
+        end
+
+        def check_hooks(node)
+          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)
+
+            add_offense(
+              child,
+              message: format(MSG, hook: child.method_name)
+            )
+          end
+        end
+
+        def find_first_example(node)
+          node.children.find { |sibling| example_or_group?(sibling) }
+        end
+
+        def node_range_with_surrounding_space(node)
+          range = node_range(node)
+          range_by_whole_lines(range, include_final_newline: true)
+        end
+
+        def source(node)
+          node_range(node).source
+        end
+
+        def node_range(node)
+          range_between(
+            node.loc.expression.begin_pos,
+            final_end_location(node).end_pos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for usage of implicit subject (`is_expected` / `should`).
+      #
+      # This cop can be configured using the `EnforcedStyle` option
+      #
+      # @example `EnforcedStyle: single_line_only`
+      #   # bad
+      #   it do
+      #     is_expected.to be_truthy
+      #   end
+      #
+      #   # good
+      #   it { is_expected.to be_truthy }
+      #   it do
+      #     expect(subject).to be_truthy
+      #   end
+      #
+      # @example `EnforcedStyle: disallow`
+      #   # bad
+      #   it { is_expected.to be_truthy }
+      #
+      #   # good
+      #   it { expect(subject).to be_truthy }
+      #
+      class ImplicitSubject < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG = "Don't use implicit subject.".freeze
+
+        def_node_matcher :implicit_subject?, <<-PATTERN
+          (send nil? {:should :should_not :is_expected} ...)
+        PATTERN
+
+        def on_send(node)
+          return unless implicit_subject?(node)
+          return if valid_usage?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          replacement = 'expect(subject)'
+          if node.method_name == :should
+            replacement += '.to'
+          elsif node.method_name == :should_not
+            replacement += '.not_to'
+          end
+
+          ->(corrector) { corrector.replace(node.loc.selector, replacement) }
+        end
+
+        private
+
+        def valid_usage?(node)
+          return false unless style == :single_line_only
+          example = node.ancestors.find { |parent| example?(parent) }
+          example && example.single_line?
+        end
+      end
+    end
+  end
+end

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

@@ -47,7 +47,7 @@ module RuboCop
       #   end
       #
       class InstanceVariable < Cop
-        MSG = 'Use `let` instead of an instance variable.'.freeze
+        MSG = 'Replace instance variable with local variable or `let`.'.freeze
 
         EXAMPLE_GROUP_METHODS = ExampleGroups::ALL + SharedGroups::ALL
 

data/lib/rubocop/cop/rspec_cops.rb

@@ -37,7 +37,9 @@ require_relative 'rspec/expect_output'
 require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
+require_relative 'rspec/hooks_before_examples'
 require_relative 'rspec/implicit_expect'
+require_relative 'rspec/implicit_subject'
 require_relative 'rspec/instance_spy'
 require_relative 'rspec/instance_variable'
 require_relative 'rspec/invalid_predicate_matcher'

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.28.0'.freeze
+      STRING = '1.29.0'.freeze
     end
   end
 end

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

@@ -0,0 +1,135 @@
+RSpec.describe RuboCop::Cop::RSpec::HooksBeforeExamples do
+  subject(:cop) { described_class.new }
+
+  it 'flags `before` after `it`' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        it { is_expected.to be_after_let }
+        before { setup }
+        ^^^^^^^^^^^^^^^^ Move `before` above the examples in the group.
+      end
+    RUBY
+  end
+
+  it 'flags `before` after `context`' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        context 'a context' do
+          it { is_expected.to be_after_let }
+        end
+
+        before { setup }
+        ^^^^^^^^^^^^^^^^ Move `before` above the examples in the group.
+      end
+    RUBY
+  end
+
+  it 'flags `before` after `include_examples`' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        include_examples('should be after let')
+
+        before { setup }
+        ^^^^^^^^^^^^^^^^ Move `before` above the examples in the group.
+      end
+    RUBY
+  end
+
+  it 'flags `after` after an example' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        it { is_expected.to be_after_let }
+        after { cleanup }
+        ^^^^^^^^^^^^^^^^^ Move `after` above the examples in the group.
+      end
+    RUBY
+  end
+
+  it 'flags scoped hook after an example' do
+    expect_offense(<<-RUBY)
+      RSpec.describe User do
+        it { is_expected.to be_after_let }
+        before(:each) { cleanup }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^ Move `before` above the examples in the group.
+      end
+    RUBY
+  end
+
+  it 'does not flag hooks before the examples' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe User do
+        before(:each) { setup }
+        after(:each) { cleanup }
+
+        it { is_expected.to be_after_let }
+
+        context 'a context' do
+          it { is_expected.to work }
+        end
+
+        include_examples('everything is fine')
+      end
+    RUBY
+  end
+
+  it 'does not flag `before` in a nested context' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe User do
+        before { setup }
+
+        context 'something else' do
+          before { additional_setup }
+          it { is_expected.to work }
+        end
+
+        include_examples('everything is fine')
+      end
+    RUBY
+  end
+
+  it 'allows inclusion of context before hooks' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe User do
+        include_context 'special user'
+
+        before { setup }
+      end
+    RUBY
+  end
+
+  it 'ignores single-line example blocks' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe User do
+        include_examples 'special user' do
+          before { setup }
+        end
+      end
+    RUBY
+  end
+
+  bad_code = <<-RUBY
+    RSpec.describe User do
+      include_examples('should be after hook')
+      context 'another one' do
+        before { another_setup }
+        include_examples('should be ok')
+      end
+
+      after { cleanup }
+    end
+  RUBY
+
+  good_code = <<-RUBY
+    RSpec.describe User do
+      after { cleanup }
+      include_examples('should be after hook')
+      context 'another one' do
+        before { another_setup }
+        include_examples('should be ok')
+      end
+
+    end
+  RUBY
+
+  include_examples 'autocorrect', bad_code, good_code
+end

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

@@ -0,0 +1,142 @@
+RSpec.describe RuboCop::Cop::RSpec::ImplicitSubject, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) do
+    { 'EnforcedStyle' => enforced_style }
+  end
+
+  context 'with EnforcedStyle `single_line_only`' do
+    let(:enforced_style) { 'single_line_only' }
+
+    it 'flags `is_expected` in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it 'expect subject to be used' do
+          is_expected.to be_good
+          ^^^^^^^^^^^ Don't use implicit subject.
+        end
+      RUBY
+    end
+
+    it 'flags `should` in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it 'expect subject to be used' do
+          should be_good
+          ^^^^^^^^^^^^^^ Don't use implicit subject.
+        end
+      RUBY
+    end
+
+    it 'allows `is_expected` in single-line examples' do
+      expect_no_offenses(<<-RUBY)
+        it { is_expected.to be_good }
+      RUBY
+    end
+
+    it 'allows `should` in single-line examples' do
+      expect_no_offenses(<<-RUBY)
+        it { should be_good }
+      RUBY
+    end
+
+    it 'does not flag methods called is_expected and should' do
+      expect_no_offenses(<<-RUBY)
+        it 'uses some similar sounding methods' do
+          expect(baz).to receive(:is_expected)
+          baz.is_expected
+          foo.should(deny_access)
+        end
+      RUBY
+    end
+
+    it 'detects usage of `is_expected` inside helper methods' do
+      expect_offense(<<-RUBY)
+        def permits(actions)
+          actions.each { |action| is_expected.to permit_action(action) }
+                                  ^^^^^^^^^^^ Don't use implicit subject.
+        end
+      RUBY
+    end
+
+    bad_code = <<-RUBY
+      it 'works' do
+        is_expected.to be_truthy
+      end
+    RUBY
+
+    good_code = <<-RUBY
+      it 'works' do
+        expect(subject).to be_truthy
+      end
+    RUBY
+
+    include_examples 'autocorrect',
+                     bad_code,
+                     good_code
+
+    bad_code = <<-RUBY
+      it 'works' do
+        should be_truthy
+        should_not be_falsy
+      end
+    RUBY
+
+    good_code = <<-RUBY
+      it 'works' do
+        expect(subject).to be_truthy
+        expect(subject).not_to be_falsy
+      end
+    RUBY
+
+    include_examples 'autocorrect',
+                     bad_code,
+                     good_code
+  end
+
+  context 'with EnforcedStyle `disallow`' do
+    let(:enforced_style) { 'disallow' }
+
+    it 'flags `is_expected` in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it 'expect subject to be used' do
+          is_expected.to be_good
+          ^^^^^^^^^^^ Don't use implicit subject.
+        end
+      RUBY
+    end
+
+    it 'flags `is_expected` in single-line examples' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to be_good }
+             ^^^^^^^^^^^ Don't use implicit subject.
+      RUBY
+    end
+
+    it 'flags `should` in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it 'expect subject to be used' do
+          should be_good
+          ^^^^^^^^^^^^^^ Don't use implicit subject.
+        end
+      RUBY
+    end
+
+    it 'flags `should` in single-line examples' do
+      expect_offense(<<-RUBY)
+        it { should be_good }
+             ^^^^^^^^^^^^^^ Don't use implicit subject.
+      RUBY
+    end
+
+    include_examples 'autocorrect',
+                     'it { is_expected.to be_truthy }',
+                     'it { expect(subject).to be_truthy }'
+
+    include_examples 'autocorrect',
+                     'it { should be_truthy }',
+                     'it { expect(subject).to be_truthy }'
+
+    include_examples 'autocorrect',
+                     'it { should_not be_truthy }',
+                     'it { expect(subject).not_to be_truthy }'
+  end
+end

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

@@ -6,7 +6,7 @@ RSpec.describe RuboCop::Cop::RSpec::InstanceVariable do
       describe MyClass do
         before { @foo = [] }
         it { expect(@foo).to be_empty }
-                    ^^^^ Use `let` instead of an instance variable.
+                    ^^^^ Replace instance variable with local variable or `let`.
       end
     RUBY
   end
@@ -24,7 +24,7 @@ RSpec.describe RuboCop::Cop::RSpec::InstanceVariable do
     expect_offense(<<-RUBY)
       shared_examples 'shared example' do
         it { expect(@foo).to be_empty }
-                    ^^^^ Use `let` instead of an instance variable.
+                    ^^^^ Replace instance variable with local variable or `let`.
       end
     RUBY
   end
@@ -77,7 +77,7 @@ RSpec.describe RuboCop::Cop::RSpec::InstanceVariable do
         describe MyClass do
           before { @foo = [] }
           it { expect(@foo).to be_empty }
-                      ^^^^ Use `let` instead of an instance variable.
+                      ^^^^ Replace instance variable with local variable or `let`.
         end
       RUBY
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -148,7 +148,9 @@ files:
 - lib/rubocop/cop/rspec/file_path.rb
 - 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_expect.rb
+- lib/rubocop/cop/rspec/implicit_subject.rb
 - lib/rubocop/cop/rspec/instance_spy.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
 - lib/rubocop/cop/rspec/invalid_predicate_matcher.rb
@@ -241,7 +243,9 @@ files:
 - spec/rubocop/cop/rspec/file_path_spec.rb
 - 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_expect_spec.rb
+- spec/rubocop/cop/rspec/implicit_subject_spec.rb
 - spec/rubocop/cop/rspec/instance_spy_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/invalid_predicate_matcher_spec.rb
@@ -356,7 +360,9 @@ test_files:
 - spec/rubocop/cop/rspec/file_path_spec.rb
 - 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_expect_spec.rb
+- spec/rubocop/cop/rspec/implicit_subject_spec.rb
 - spec/rubocop/cop/rspec/instance_spy_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/invalid_predicate_matcher_spec.rb