Class Index [+]

Quicksearch

RSpec::Core::Subject::ExampleGroupMethods

Attributes

explicit_subject_block[R]

Public Instance Methods

its(attribute, &block) click to toggle source

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
     # File lib/rspec/core/subject.rb, line 151
151:         def its(attribute, &block)
152:           describe(attribute) do
153:             example do
154:               self.class.class_eval do
155:                 define_method(:subject) do
156:                   if defined?(@_subject)
157:                     @_subject
158:                   else
159:                     @_subject = Array === attribute ? super()[*attribute] : _nested_attribute(super(), attribute)
160:                   end
161:                 end
162:               end
163:               instance_eval(&block)
164:             end
165:           end
166:         end
subject(&block) click to toggle source

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

@example

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

See +ExampleMethods#should+ for more information about this approach.

     # File lib/rspec/core/subject.rb, line 180
180:         def subject(&block)
181:           block ? @explicit_subject_block = block : explicit_subject || implicit_subject
182:         end

Private Instance Methods

explicit_subject() click to toggle source
     # File lib/rspec/core/subject.rb, line 188
188:         def explicit_subject
189:           group = self
190:           while group.respond_to?(:explicit_subject_block)
191:             return group.explicit_subject_block if group.explicit_subject_block
192:             group = group.superclass
193:           end
194:         end
implicit_subject() click to toggle source
     # File lib/rspec/core/subject.rb, line 196
196:         def implicit_subject
197:           described = described_class || description
198:           Class === described ? proc { described.new } : proc { described }
199:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.