rubocop-rspec 1.8.0 → 1.9.0

data/lib/rubocop/rspec/example_group.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec example groups
+    class ExampleGroup
+      include Language
+      extend NodePattern::Macros
+
+      def_node_matcher :example?, Examples::ALL.block_pattern
+
+      # @!method scope_change?(node)
+      #
+      #   Detect if the node is an example group or shared example
+      #
+      #   Selectors which indicate that we should stop searching
+      #
+      def_node_matcher :scope_change?,
+                       (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
+
+      def initialize(node)
+        @node = node
+      end
+
+      def examples
+        examples_in_scope(node).map(&Example.public_method(:new))
+      end
+
+      private
+
+      attr_reader :node
+
+      def examples_in_scope(node)
+        node.each_child_node.flat_map do |child|
+          find_examples(child)
+        end
+      end
+
+      # Recursively search for examples within the current scope
+      #
+      # Searches node for examples and halts when a scope change is detected
+      #
+      # @param node [RuboCop::Node] node to recursively search for examples
+      #
+      # @return [Array<RuboCop::Node>] discovered example nodes
+      def find_examples(node)
+        return [] if scope_change?(node)
+
+        if example?(node)
+          [node]
+        else
+          examples_in_scope(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/language.rb

@@ -22,7 +22,19 @@ module RuboCop
           selectors.include?(selector)
         end
 
-        def to_node_pattern
+        def block_pattern
+          "(block #{send_pattern} ...)"
+        end
+
+        def send_pattern
+          "(send _ #{node_pattern_union} ...)"
+        end
+
+        def node_pattern_union
+          "{#{node_pattern}}"
+        end
+
+        def node_pattern
           selectors.map(&:inspect).join(' ')
         end
 
@@ -31,6 +43,10 @@ module RuboCop
         attr_reader :selectors
       end
 
+      module Matchers
+        MESSAGE_CHAIN = SelectorSet.new(%i(receive_message_chain stub_chain))
+      end
+
       module ExampleGroups
         GROUPS  = SelectorSet.new(%i(describe context feature example_group))
         SKIPPED = SelectorSet.new(%i(xdescribe xcontext xfeature))
@@ -45,6 +61,17 @@ module RuboCop
         )
       end
 
+      module Includes
+        ALL = SelectorSet.new(
+          %i(
+            it_behaves_like
+            it_should_behave_like
+            include_context
+            include_examples
+          )
+        )
+      end
+
       module Examples
         EXAMPLES = SelectorSet.new(%i(it specify example scenario its))
         FOCUSED  = SelectorSet.new(%i(fit fspecify fexample fscenario focus))

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

@@ -7,9 +7,7 @@ module RuboCop
       module NodePattern
         extend RuboCop::NodePattern::Macros
 
-        def_node_matcher :example_group?, <<-PATTERN
-          (block (send _ {#{ExampleGroups::ALL.to_node_pattern}} ...) ...)
-        PATTERN
+        def_node_matcher :example_group?, ExampleGroups::ALL.block_pattern
       end
     end
   end

data/lib/rubocop/rspec/top_level_describe.rb

@@ -31,9 +31,9 @@ module RuboCop
         # If we have no top level describe statements, we need to check any
         # blocks on the top level (e.g. after a require).
         if nodes.empty?
-          nodes = node_children(root_node).map do |child|
-            describe_statement_children(child) if child.type == :block
-          end.flatten.compact
+          nodes = root_node.each_child_node(:block).flat_map do |child|
+            describe_statement_children(child)
+          end
         end
 
         nodes
@@ -44,18 +44,14 @@ module RuboCop
       end
 
       def single_top_level_describe?
-        top_level_nodes.count == 1
+        top_level_nodes.one?
       end
 
       def describe_statement_children(node)
-        node_children(node).select do |element|
-          element.type == :send && element.children[1] == :describe
+        node.each_child_node(:send).select do |element|
+          element.children[1] == :describe
         end
       end
-
-      def node_children(node)
-        node.children.select { |e| e.is_a? Parser::AST::Node }
-      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.8.0'.freeze
+      STRING = '1.9.0'.freeze
     end
   end
 end

data/spec/project/default_config_spec.rb

@@ -6,12 +6,15 @@ describe 'config/default.yml' do
   let(:cop_names) do
     glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
 
-    Pathname.glob(glob).map do |file|
-      file_name = file.basename('.rb').to_s
-      cop_name  = file_name.gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+    cop_names =
+      Pathname.glob(glob).map do |file|
+        file_name = file.basename('.rb').to_s
+        cop_name  = file_name.gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
 
-      "RSpec/#{cop_name}"
-    end
+        "RSpec/#{cop_name}"
+      end
+
+    cop_names - %w(RSpec/Cop)
   end
 
   let(:config_keys) do

data/spec/project/project_requires_spec.rb

@@ -1,7 +1,7 @@
 describe 'Project requires' do
   it 'alphabetizes cop requires' do
     source   = SpecHelper::ROOT.join('lib', 'rubocop-rspec.rb').read
-    requires = source.split("\n").grep(%r{rubocop/cop})
+    requires = source.split("\n").grep(%r{rubocop/cop/rspec/[^(?:cop)]})
 
     expect(requires.join("\n")).to eql(requires.sort.join("\n"))
   end

data/spec/rubocop/{rspec/spec_only_spec.rb → cop/rspec/cop_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe RuboCop::RSpec::SpecOnly do
+RSpec.describe RuboCop::Cop::RSpec::Cop do
   subject(:cop) { fake_cop.new(config) }
 
   let(:config) do
@@ -20,9 +20,7 @@ RSpec.describe RuboCop::RSpec::SpecOnly do
   end
 
   let(:fake_cop) do
-    Class.new(RuboCop::Cop::Cop) do
-      include RuboCop::RSpec::SpecOnly
-
+    Class.new(described_class) do
       def self.name
         'RuboCop::RSpec::FakeCop'
       end

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

@@ -110,4 +110,40 @@ describe RuboCop::Cop::RSpec::DescribeClass do
   it "doesn't blow up on single-line describes" do
     expect_no_violations('describe Some::Class')
   end
+
+  it "doesn't flag top level describe in a shared example" do
+    expect_no_violations(<<-RUBY)
+      shared_examples 'Common::Interface' do
+        describe '#public_interface' do
+          it 'conforms to interface' do
+            # ...
+          end
+        end
+      end
+    RUBY
+  end
+
+  it "doesn't flag top level describe in a shared context" do
+    expect_no_violations(<<-RUBY)
+      RSpec.shared_context 'Common::Interface' do
+        describe '#public_interface' do
+          it 'conforms to interface' do
+            # ...
+          end
+        end
+      end
+    RUBY
+  end
+
+  it "doesn't flag top level describe in an unnamed shared context" do
+    expect_no_violations(<<-RUBY)
+      shared_context do
+        describe '#public_interface' do
+          it 'conforms to interface' do
+            # ...
+          end
+        end
+      end
+    RUBY
+  end
 end

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

@@ -160,7 +160,7 @@ describe RuboCop::Cop::RSpec::DescribedClass, :config do
     RUBY
   end
 
-  it 'does not flag violations within a scope change' do
+  it 'does not flag violations within a class scope change' do
     expect_no_violations(<<-RUBY)
       describe MyNamespace::MyClass do
         before do
@@ -172,7 +172,7 @@ describe RuboCop::Cop::RSpec::DescribedClass, :config do
     RUBY
   end
 
-  it 'does not flag violations within a scope change' do
+  it 'does not flag violations within a hook scope change' do
     expect_no_violations(<<-RUBY)
       describe do
         before do

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

@@ -4,63 +4,42 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
   let(:cop_config) { { 'Max' => 3 } }
 
   it 'ignores non-spec blocks' do
-    inspect_source(
-      cop,
-      [
-        'foo do',
-        '  line 1',
-        '  line 2',
-        '  line 3',
-        '  line 4',
-        'end'
-      ],
-      'foo_spec.rb'
-    )
-
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      foo do
+        line 1
+        line 2
+        line 3
+        line 4
+      end
+    RUBY
   end
 
   it 'allows an empty example' do
-    inspect_source(
-      cop,
-      [
-        'it do',
-        'end'
-      ],
-      'foo_spec.rb'
-    )
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      it do
+      end
+    RUBY
   end
 
   it 'allows a short example' do
-    inspect_source(
-      cop,
-      [
-        'it do',
-        '  line 1',
-        '  line 2',
-        '  line 3',
-        'end'
-      ],
-      'spec/foo_spec.rb'
-    )
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      it do
+        line 1
+        line 2
+        line 3
+      end
+    RUBY
   end
 
   it 'ignores comments' do
-    inspect_source(
-      cop,
-      [
-        'it do',
-        '  line 1',
-        '  line 2',
-        '  # comment',
-        '  line 3',
-        'end'
-      ],
-      'spec/foo_spec.rb'
-    )
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      it do
+        line 1
+        line 2
+        # comment
+        line 3
+      end
+    RUBY
   end
 
   shared_examples 'large example violation' do
@@ -82,18 +61,17 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
   end
 
   context 'when inspecting large examples' do
-    let(:source) do
-      [
-        'it do',
-        '  line 1',
-        '  line 2',
-        '  line 3',
-        '  line 4',
-        'end'
-      ]
+    it 'flags the example' do
+      expect_violation(<<-RUBY)
+        it do
+        ^^^^^ Example has too many lines. [4/3]
+          line 1
+          line 2
+          line 3
+          line 4
+        end
+      RUBY
     end
-
-    include_examples 'large example violation'
   end
 
   context 'with CountComments enabled' do
@@ -112,6 +90,16 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
       ]
     end
 
-    include_examples 'large example violation'
+    it 'flags the example' do
+      expect_violation(<<-RUBY)
+        it do
+        ^^^^^ Example has too many lines. [4/3]
+          line 1
+          line 2
+          # comment
+          line 3
+        end
+      RUBY
+    end
   end
 end

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

@@ -30,7 +30,7 @@ describe RuboCop::Cop::RSpec::ImplicitExpect, :config do
       expect_no_violations('it { is_expected.to_not be_truthy }')
     end
 
-    it 'approves of is_expected.to_not' do
+    it 'approves of is_expected.not_to' do
       expect_no_violations('it { is_expected.not_to be_truthy }')
     end
 

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+describe RuboCop::Cop::RSpec::MessageSpies, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'when EnforcedStyle is have_received' do
+    let(:cop_config) do
+      { 'EnforcedStyle' => 'have_received' }
+    end
+
+    it 'flags expect(...).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(...).to receive with' do
+      expect_violation(<<-RUBY)
+        expect(foo).to receive(:bar).with(:baz)
+                       ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'flags expect(...).to receive at_most' do
+      expect_violation(<<-RUBY)
+        expect(foo).to receive(:bar).at_most(42).times
+                       ^^^^^^^ Prefer `have_received` for setting message expectations. Setup `foo` as a spy using `allow` or `instance_spy`.
+      RUBY
+    end
+
+    it 'approves of expect(...).to have_received' do
+      expect_no_violations('expect(foo).to have_received(:bar)')
+    end
+
+    it 'generates a todo based on the usage of the correct style' do
+      inspect_source(cop, 'expect(foo).to have_received(:bar)', 'foo_spec.rb')
+
+      expect(cop.config_to_allow_offenses)
+        .to eq('EnforcedStyle' => 'have_received')
+    end
+
+    it 'generates a todo based on the usage of the alternate style' do
+      inspect_source(cop, 'expect(foo).to receive(:bar)', 'foo_spec.rb')
+
+      expect(cop.config_to_allow_offenses).to eq('EnforcedStyle' => 'receive')
+    end
+  end
+
+  context 'when EnforcedStyle is receive' do
+    let(:cop_config) do
+      { 'EnforcedStyle' => 'receive' }
+    end
+
+    it 'flags expect(...).to have_received' do
+      expect_violation(<<-RUBY)
+        expect(foo).to 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)
+                       ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'flags expect(...).to have_received at_most' do
+      expect_violation(<<-RUBY)
+        expect(foo).to have_received(:bar).at_most(42).times
+                       ^^^^^^^^^^^^^ Prefer `receive` for setting message expectations.
+      RUBY
+    end
+
+    it 'approves of expect(...).to receive' do
+      expect_no_violations('expect(foo).to receive(:bar)')
+    end
+
+    it 'generates a todo based on the usage of the correct style' do
+      inspect_source(cop, 'expect(foo).to receive(:bar)', 'foo_spec.rb')
+
+      expect(cop.config_to_allow_offenses).to eq('EnforcedStyle' => 'receive')
+    end
+
+    it 'generates a todo based on the usage of the alternate style' do
+      inspect_source(cop, 'expect(foo).to have_received(:bar)', 'foo_spec.rb')
+
+      expect(cop.config_to_allow_offenses)
+        .to eq('EnforcedStyle' => 'have_received')
+    end
+  end
+end