rubocop-rspec 1.9.1 → 1.10.0

data/lib/rubocop/rspec/concept.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec DSL methods
+    class Concept
+      include Language, Language::NodePattern
+      extend NodePattern::Macros
+
+      def initialize(node)
+        @node = node
+      end
+
+      def eql?(other)
+        node.eql?(other.node)
+      end
+
+      alias == eql?
+
+      def hash
+        [self.class, node].hash
+      end
+
+      def to_node
+        node
+      end
+
+      protected
+
+      attr_reader :node
+    end
+  end
+end

data/lib/rubocop/rspec/example.rb

@@ -3,17 +3,11 @@
 module RuboCop
   module RSpec
     # Wrapper for RSpec examples
-    class Example
-      extend RuboCop::NodePattern::Macros
-
+    class Example < Concept
       def_node_matcher :extract_doc_string,     '(send _ _ $str ...)'
       def_node_matcher :extract_metadata,       '(send _ _ _ $...)'
       def_node_matcher :extract_implementation, '(block send args $_)'
 
-      def initialize(node)
-        @node = node
-      end
-
       def doc_string
         extract_doc_string(definition)
       end
@@ -26,20 +20,6 @@ module RuboCop
         extract_implementation(node)
       end
 
-      def eql?(other)
-        node.eql?(other.node)
-      end
-
-      alias == eql?
-
-      def hash
-        [self.class, node].hash
-      end
-
-      def to_node
-        node
-      end
-
       def definition
         if node.send_type?
           node
@@ -47,10 +27,6 @@ module RuboCop
           node.children.first
         end
       end
-
-      protected
-
-      attr_reader :node
     end
   end
 end

data/lib/rubocop/rspec/example_group.rb

@@ -3,12 +3,7 @@
 module RuboCop
   module RSpec
     # Wrapper for RSpec example groups
-    class ExampleGroup
-      include Language
-      extend NodePattern::Macros
-
-      def_node_matcher :example?, Examples::ALL.block_pattern
-
+    class ExampleGroup < Concept
       # @!method scope_change?(node)
       #
       #   Detect if the node is an example group or shared example
@@ -18,21 +13,42 @@ module RuboCop
       def_node_matcher :scope_change?,
                        (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
 
-      def initialize(node)
-        @node = node
-      end
+      # @!method hook(node)
+      #
+      #   Detect if node is `before`, `after`, `around`
+      def_node_matcher :hook, <<-PATTERN
+      (block {$(send nil #{Hooks::ALL.node_pattern_union} ...)} ...)
+      PATTERN
 
       def examples
         examples_in_scope(node).map(&Example.public_method(:new))
       end
 
+      def hooks
+        hooks_in_scope(node).map(&Hook.public_method(:new))
+      end
+
       private
 
-      attr_reader :node
+      def hooks_in_scope(node)
+        node.each_child_node.flat_map do |child|
+          find_hooks(child)
+        end
+      end
+
+      def find_hooks(node)
+        return [] if scope_change?(node) || example?(node)
+
+        if hook(node)
+          [node]
+        else
+          hooks_in_scope(node)
+        end
+      end
 
-      def examples_in_scope(node)
+      def examples_in_scope(node, &blk)
         node.each_child_node.flat_map do |child|
-          find_examples(child)
+          find_examples(child, &blk)
         end
       end
 

data/lib/rubocop/rspec/hook.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec hook
+    class Hook < Concept
+      STANDARDIZED_SCOPES = %i(each context suite).freeze
+      private_constant(:STANDARDIZED_SCOPES)
+
+      def name
+        node.method_name
+      end
+
+      def knowable_scope?
+        return true unless scope_argument
+
+        scope_argument.sym_type?
+      end
+
+      def valid_scope?
+        STANDARDIZED_SCOPES.include?(scope)
+      end
+
+      def example?
+        scope.equal?(:each)
+      end
+
+      def scope
+        case scope_name
+        when nil, :each, :example then :each
+        when :context, :all       then :context
+        when :suite               then :suite
+        else
+          scope_name
+        end
+      end
+
+      private
+
+      def scope_name
+        scope_argument.to_a.first
+      end
+
+      def scope_argument
+        node.method_args.first
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -8,6 +8,7 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
 
         def_node_matcher :example_group?, ExampleGroups::ALL.block_pattern
+        def_node_matcher :example?, Examples::ALL.block_pattern
       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.9.1'.freeze
+      STRING = '1.10.0'.freeze
     end
   end
 end

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

@@ -20,7 +20,9 @@ RSpec.describe RuboCop::Cop::RSpec::Cop do
   end
 
   let(:fake_cop) do
-    Class.new(described_class) do
+    stub_const('RuboCop::RSpec', Module.new)
+    # rubocop:disable ClassAndModuleChildren
+    class RuboCop::RSpec::FakeCop < described_class
       def self.name
         'RuboCop::RSpec::FakeCop'
       end
@@ -29,6 +31,7 @@ RSpec.describe RuboCop::Cop::RSpec::Cop do
         add_offense(node, :expression, 'I flag everything')
       end
     end
+    RuboCop::RSpec::FakeCop
   end
 
   let(:rspec_patterns) { ['_spec.rb$', '(?:^|/)spec/'] }

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::RSpec::ExpectOutput do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense for overwriting $stdout within an example' do
+    expect_violation(<<-RUBY)
+      specify do
+        $stdout = StringIO.new
+        ^^^^^^^ Use `expect { ... }.to output(...).to_stdout` instead of mutating $stdout
+      end
+    RUBY
+  end
+
+  it 'registers an offense for overwriting $stderr ' \
+     'within an example scoped hook' do
+    expect_violation(<<-RUBY)
+      before(:each) do
+        $stderr = StringIO.new
+        ^^^^^^^ Use `expect { ... }.to output(...).to_stderr` instead of mutating $stderr
+      end
+    RUBY
+  end
+
+  it 'does not register an offense for interacting with $stdout' do
+    expect_no_violations(<<-RUBY)
+      specify do
+        $stdout.puts("hi")
+      end
+    RUBY
+  end
+
+  it 'does not flag assignments to other global variables' do
+    expect_no_violations(<<-RUBY)
+      specify do
+        $blah = StringIO.new
+      end
+    RUBY
+  end
+
+  it 'does not flag assignments to $stdout outside of example scope' do
+    expect_no_violations(<<-RUBY)
+      before(:suite) do
+        $stderr = StringIO.new
+      end
+    RUBY
+  end
+
+  it 'does not flag assignments to $stdout in example_group scope' do
+    expect_no_violations(<<-RUBY)
+      describe Foo do
+        $stderr = StringIO.new
+      end
+    RUBY
+  end
+
+  it 'does not flag assigns to $stdout when in the root scope' do
+    expect_no_violations('$stderr = StringIO.new')
+  end
+end

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

@@ -8,13 +8,49 @@ describe RuboCop::Cop::RSpec::MessageSpies, :config do
       { 'EnforcedStyle' => 'have_received' }
     end
 
-    it 'flags expect(...).to receive' do
+    it 'flags expect(send).to receive' do
       expect_violation(<<-RUBY)
         expect(foo).to receive(:bar)
                        ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
       RUBY
     end
 
+    it 'flags expect(lvar).to receive' do
+      expect_violation(<<-RUBY)
+        foo = baz
+        expect(foo).to receive(:bar)
+                       ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'flags expect(ivar).to receive' do
+      expect_violation(<<-RUBY)
+        expect(@foo).to receive(:bar)
+                        ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `@foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'flags expect(const).to receive' do
+      expect_violation(<<-RUBY)
+        expect(Foo).to receive(:bar)
+                       ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `Foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'flags expect(...).not_to receive' do
+      expect_violation(<<-RUBY)
+        expect(foo).not_to receive(:bar)
+                           ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'flags expect(...).to_not receive' do
+      expect_violation(<<-RUBY)
+        expect(foo).to_not receive(:bar)
+                           ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
     it 'flags expect(...).to receive with' do
       expect_violation(<<-RUBY)
         expect(foo).to receive(:bar).with(:baz)
@@ -52,13 +88,49 @@ describe RuboCop::Cop::RSpec::MessageSpies, :config do
       { 'EnforcedStyle' => 'receive' }
     end
 
-    it 'flags expect(...).to have_received' do
+    it 'flags expect(send).to have_received' do
       expect_violation(<<-RUBY)
         expect(foo).to have_received(:bar)
                        ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
       RUBY
     end
 
+    it 'flags expect(lvar).to have_received' do
+      expect_violation(<<-RUBY)
+        foo = baz
+        expect(foo).to have_received(:bar)
+                       ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'flags expect(ivar).to have_received' do
+      expect_violation(<<-RUBY)
+        expect(@foo).to have_received(:bar)
+                        ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'flags expect(const).to have_received' do
+      expect_violation(<<-RUBY)
+        expect(Foo).to have_received(:bar)
+                       ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'flags expect(...).not_to have_received' do
+      expect_violation(<<-RUBY)
+        expect(foo).not_to have_received(:bar)
+                           ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'flags expect(...).to_not have_received' do
+      expect_violation(<<-RUBY)
+        expect(foo).to_not have_received(:bar)
+                           ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
     it 'flags expect(...).to have_received with' do
       expect_violation(<<-RUBY)
         expect(foo).to have_received(:bar).with(:baz)

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

@@ -10,7 +10,7 @@ describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       expect_violation(<<-RUBY)
         describe Foo do
           it 'uses expect twice' do
-          ^^^^^^^^^^^^^^^^^^^^^^ Too many expectations.
+          ^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1]
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -53,7 +53,7 @@ describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       expect_violation(<<-RUBY)
         describe Foo do
           it 'uses expect three times' do
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Too many expectations.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [3/2]
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
             expect(qux).to eq(bar)

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

@@ -33,8 +33,8 @@ describe RuboCop::Cop::RSpec::NestedGroups, :config do
     RUBY
   end
 
-  context 'when MaxNesting is configured as 2' do
-    let(:cop_config) { { 'MaxNesting' => '2' } }
+  context 'when Max is configured as 2' do
+    let(:cop_config) { { 'Max' => '2' } }
 
     it 'flags two levels of nesting' do
       expect_violation(<<-RUBY)
@@ -51,4 +51,16 @@ describe RuboCop::Cop::RSpec::NestedGroups, :config do
       RUBY
     end
   end
+
+  context 'when configured with MaxNesting' do
+    let(:cop_config) { { 'MaxNesting' => '1' } }
+
+    it 'emits a deprecation warning' do
+      expect { inspect_source(cop, 'describe(Foo) { }', 'foo_spec.rb') }
+        .to output(
+          'Configuration key `MaxNesting` for RSpec/NestedGroups is ' \
+          "deprecated in favor of `Max`. Please use that instead.\n"
+        ).to_stderr
+    end
+  end
 end