Module RSpec::Core::Subject::ExampleGroupMethods
In: lib/rspec/core/subject.rb

Methods

its   subject  

Attributes

explicit_subject_block  [R] 

Public Instance methods

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

@example

  # This ...
  describe Array do
    its(:size) { should eq(0) }
  end

  # ... generates the same runtime structure as this:
  describe Array do
    describe "size" do
      it "should eq(0)" do
        subject.size.should eq(0)
      end
    end
  end

The attribute can be a `Symbol` or a `String`. Given a `String` with dots, the result is as though you concatenated that `String` onto the subject in an expression.

@example

  describe Person do
    subject do
      Person.new.tap do |person|
        person.phone_numbers << "555-1212"
      end
    end

    its("phone_numbers.first") { should eq("555-1212") }
  end

When the subject is a `Hash`, you can refer to the Hash keys by specifying a `Symbol` or `String` in an array.

@example

  describe "a configuration Hash" do
    subject do
      { :max_users => 3,
        'admin' => :all_permissions }
    end

    its([:max_users]) { should eq(3) }
    its(['admin']) { should eq(:all_permissions) }

    # You can still access to its regular methods this way:
    its(:keys) { should include(:max_users) }
    its(:count) { should eq(2) }
  end

Declares a `subject` for an example group which can then be the implicit receiver (through delegation) of calls to `should`.

Given a `name`, defines a method with that name which returns the `subject`. This lets you declare the subject once and access it implicitly in one-liners and explicitly using an intention revealing name.

@param [String,Symbol] name used to define an accessor with an

  intention revealing name

@param block defines the value to be returned by `subject` in examples

@example

  describe CheckingAccount, "with $50" do
    subject { CheckingAccount.new(Money.new(50, :USD)) }
    it { should have_a_balance_of(Money.new(50, :USD)) }
    it { should_not be_overdrawn }
  end

  describe CheckingAccount, "with a non-zero starting balance" do
    subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }
    it { should_not be_overdrawn }
    it "has a balance equal to the starting balance" do
      account.balance.should eq(Money.new(50, :USD))
    end
  end

@see ExampleMethods#subject @see ExampleMethods#should

[Validate]