RSpec Subject Extensions

rspec-subject-extensions adds each short-hand to generate a nested example group with a single example that specifies the expected value of each attribute of the subject. If no attribute is given, each element of the subject will be used.

Documentation

The Cucumber features are the most comprehensive and up-to-date docs for end-users.

The RDoc provides additional information for contributors and/or extenders.

All of the documentation is open source and a work in progress. If you find it lacking or confusing, you can help improve it by submitting requests and patches to the rspec-subject-extensions issue tracker.

Install

gem install rspec-subject-extensions

Requirements

rspec ~> 3.0
i18n >= 0.5.0
activesupport >= 3.0

Usage

Each

Using the singular name of the attributes

Creates a nested example group named by each and the submitted attribute, and then generates an example for each attribute using the submitted block.

# This ...
describe User do
  each(:address) { is_expected.to be_an Address }
end

# ... generates the same runtime structure as this:
describe User do
  describe "each address"
    it "is an Address" do
      subject.addresses.each do |address|
        expect(address).to be_an Address
      end
    end
  end
end

The attribute can be a Symbol or a String.

Using no attribute (ideal for testing scopes)

Creates a nested example group and then generates an example for each instance using the submitted block.

# This ...
describe User do
  subject { User.active }
  each { is_expected.to be_active }
end

# ... generates the same runtime structure as this:
describe User do
  describe "each instance" do
    it "is active" do
      subject.each do |user|
        expect(user).to be_active
      end
    end
  end
end