Class: RuboCop::Cop::RSpec::ExampleWithoutDescription

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

Overview

Checks for examples without a description.

RSpec allows for auto-generated example descriptions when there is no description provided or the description is an empty one.

This cop removes empty descriptions. It also defines whether auto-generated description is allowed, based on the configured style.

This cop can be configured using the `EnforcedStyle` option

Examples:

`EnforcedStyle: always_allow`

# bad
it('') { is_expected.to be_good }
it '' do
  result = service.call
  expect(result).to be(true)
end

# good
it { is_expected.to be_good }
it do
  result = service.call
  expect(result).to be(true)
end

`EnforcedStyle: single_line_only`

# bad
it('') { is_expected.to be_good }
it do
  result = service.call
  expect(result).to be(true)
end

# good
it { is_expected.to be_good }

`EnforcedStyle: disallow`

# bad
it { is_expected.to be_good }
it do
  result = service.call
  expect(result).to be(true)
end

Constant Summary collapse

MSG_DEFAULT_ARGUMENT =
'Omit the argument when you want to ' \
'have auto-generated description.'
MSG_ADD_DESCRIPTION =
'Add a description.'

Instance Method Summary collapse

Methods inherited from Base

inherited, #on_new_investigation

Methods included from RSpec::Language::NodePattern

#block_pattern, #send_pattern

Methods included from RSpec::Language

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

Instance Method Details

#example_description(node) ⇒ Object


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

def_node_matcher :example_description, '(send nil? _ $(str $_))'

#on_block(node) ⇒ Object


60
61
62
63
64
65
66
67
68
69
70
# File 'lib/rubocop/cop/rspec/example_without_description.rb', line 60

def on_block(node)
  return unless example?(node)

  check_example_without_description(node.send_node)

  example_description(node.send_node) do |message_node, message|
    return unless message.to_s.empty?

    add_offense(message_node, message: MSG_DEFAULT_ARGUMENT)
  end
end