Class: RuboCop::Cop::RSpec::NamedSubject

Inherits:
RuboCop::Cop show all
Defined in:
lib/rubocop/cop/rspec/named_subject.rb

Overview

Give ‘subject` a descriptive name if you reference it directly

Examples:

# bad
RSpec.describe User do
  subject { described_class.new }

  it 'is valid' do
    expect(subject.valid?).to be(true)
  end
end

# good
RSpec.describe Foo do
  subject(:user) { described_class.new }

  it 'is valid' do
    expect(user.valid?).to be(true)
  end
end

# also good
RSpec.describe Foo do
  subject(:user) { described_class.new }

  it { should be_valid }
end

Constant Summary collapse

MSG = 
'Name your test subject if '\
'you need to reference it explicitly.'.freeze

Instance Method Summary collapse

Instance Method Details

#on_block(node) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/rspec/named_subject.rb', line 45

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

  subject_usage(node) do |subject_node|
    add_offense(subject_node, :selector)
  end
end