Class: RuboCop::Cop::RSpec::DescribeClass

Inherits:
RuboCop::Cop show all
Includes:
RSpec::TopLevelDescribe
Defined in:
lib/rubocop/cop/rspec/describe_class.rb

Overview

Check that the first argument to the top level describe is the tested class or module.

Examples:

# bad
describe 'Do something' do
end

# good
describe TestedClass do
end

describe "A feature example", type: :feature do
end

Constant Summary collapse

REQUEST_PAIR = 
s(:pair, s(:sym, :type), s(:sym, :request))
FEATURE_PAIR = 
s(:pair, s(:sym, :type), s(:sym, :feature))
MESSAGE = 
'The first argument to describe should be the class or ' \
'module being tested.'

Instance Method Summary collapse

Methods included from RSpec::TopLevelDescribe

#on_send

Instance Method Details

#on_top_level_describe(_node, args) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/cop/rspec/describe_class.rb', line 29

def on_top_level_describe(_node, args)
  return if args[0] && args[0].type == :const

  return if args[1..-1].any? do |arg|
    next unless arg.hash_type?
    arg.children.any? do |n|
      [REQUEST_PAIR, FEATURE_PAIR].include?(n)
    end
  end

  add_offense(args[0], :expression, MESSAGE)
end