class RuboCop::Cop::RSpec::RepeatedDescription

Check for repeated description strings in example groups.

@example

# bad
RSpec.describe User do
  it 'is valid' do
    # ...
  end

  it 'is valid' do
    # ...
  end
end

# good
RSpec.describe User do
  it 'is valid when first and last name are present' do
    # ...
  end

  it 'is valid when last name only is present' do
    # ...
  end
end

Constants

MSG

Public Instance Methods

on_block(node) click to toggle source
# File lib/rubocop/cop/rspec/repeated_description.rb, line 33
def on_block(node)
  return unless example_group?(node)

  repeated_descriptions(node).each do |repeated_description|
    add_offense(repeated_description, location: :expression)
  end
end

Private Instance Methods

repeated_descriptions(node) click to toggle source

Select examples in the current scope with repeated description strings

# File lib/rubocop/cop/rspec/repeated_description.rb, line 44
def repeated_descriptions(node)
  grouped_examples =
    RuboCop::RSpec::ExampleGroup.new(node)
      .examples
      .group_by(&:doc_string)

  grouped_examples
    .select { |description, group| description && group.size > 1 }
    .values
    .flatten
    .map(&:definition)
end