class RuboCop::Cop::RSpec::UndescriptiveLiteralsDescription

Description should be descriptive.

If example group or example contains only ‘execute string`, numbers and regular expressions, the description is not clear.

@example

# bad
describe `time` do
 # ...
end

# bad
context /when foo/ do
  # ...
end

# bad
it 10000 do
  # ...
end

# good
describe Foo do
  # ...
end

# good
describe '#foo' do
  # ...
end

# good
context "when #{foo} is bar" do
  # ...
end

# good
it 'does something' do
  # ...
end

Constants

MSG

Public Instance Methods

on_block(node) click to toggle source
# File lib/rubocop/cop/rspec/undescriptive_literals_description.rb, line 55
def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
  example_groups_or_example?(node) do |arg|
    add_offense(arg) if offense?(arg)
  end
end

Private Instance Methods

offense?(node) click to toggle source
# File lib/rubocop/cop/rspec/undescriptive_literals_description.rb, line 63
def offense?(node)
  %i[xstr int regexp].include?(node.type)
end