Class: RuboCop::Cop::RSpec::RepeatedIncludeExample

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/rspec/repeated_include_example.rb

Overview

Check for repeated include of shared examples.

Examples:

# bad
describe 'foo' do
  include_examples 'cool stuff'
  include_examples 'cool stuff'
end

# bad
describe 'foo' do
  it_behaves_like 'a cool', 'thing'
  it_behaves_like 'a cool', 'thing'
end

# bad
context 'foo' do
  it_should_behave_like 'a duck'
  it_should_behave_like 'a duck'
end

# good
describe 'foo' do
  include_examples 'cool stuff'
end

describe 'bar' do
  include_examples 'cool stuff'
end

# good
describe 'foo' do
  it_behaves_like 'a cool', 'thing'
  it_behaves_like 'a cool', 'person'
end

# good
context 'foo' do
  it_should_behave_like 'a duck'
  it_should_behave_like 'a goose'
end

Constant Summary collapse

MSG = 
'Repeated include of shared_examples %<name>s ' \
'on line(s) %<repeat>s'

Instance Method Summary collapse

Methods inherited from Base

inherited, #on_new_investigation

Methods included from RSpec::Language::NodePattern

#block_or_numblock_pattern, #block_pattern, #numblock_pattern, #send_pattern

Methods included from RSpec::Language

#example?, #example_group?, #example_group_with_body?, #explicit_rspec?, #hook?, #include?, #let?, #rspec?, #shared_group?, #spec_group?, #subject?

Instance Method Details

#include_examples?(node) ⇒ Object 



58
59
 
# File 'lib/rubocop/cop/rspec/repeated_include_example.rb', line 58

def_node_matcher :include_examples?,
'(send nil? #Includes.examples ...)'

#on_begin(node) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/rubocop/cop/rspec/repeated_include_example.rb', line 65

def on_begin(node)
  return unless several_include_examples?(node)

  repeated_include_examples(node).each do |item, repeats|
    add_offense(item, message: message(item, repeats))
  end
end

#several_include_examples?(node) ⇒ Object 



53
54
55
 
# File 'lib/rubocop/cop/rspec/repeated_include_example.rb', line 53

def_node_matcher :several_include_examples?, <<~PATTERN
  (begin <#include_examples? #include_examples? ...>)
PATTERN

#shared_examples_name(node) ⇒ Object 



62
63
 
# File 'lib/rubocop/cop/rspec/repeated_include_example.rb', line 62

def_node_matcher :shared_examples_name,
'(send nil? #Includes.examples $_name ...)'