module RSpec module Core module Subject module ExampleMethods # Returns the subject defined by the example group. The subject block is # only executed once per example, the result of which is cached and # returned by any subsequent calls to +subject+. # # If a class is passed to +describe+ and no subject is explicitly # declared in the example group, then +subject+ will return a new # instance of that class. # # @example # # # explicit subject defined by the subject method # describe Person do # subject { Person.new(:birthdate => 19.years.ago) } # it "should be eligible to vote" do # subject.should be_eligible_to_vote # end # end # # # implicit subject => { Person.new } # describe Person do # it "should be eligible to vote" do # subject.should be_eligible_to_vote # end # end def subject if defined?(@original_subject) @original_subject else @original_subject = instance_eval(&self.class.subject) end end begin require 'rspec/expectations/extensions/kernel' alias_method :__should_for_example_group__, :should alias_method :__should_not_for_example_group__, :should_not # When +should+ is called with no explicit receiver, the call is # delegated to the object returned by +subject+. Combined with # an implicit subject (see +subject+), this supports very concise # expressions. # # @example # # describe Person do # it { should be_eligible_to_vote } # end def should(matcher=nil, message=nil) self == subject ? self.__should_for_example_group__(matcher) : subject.should(matcher,message) end # Just like +should+, +should_not+ delegates to the subject (implicit or # explicit) of the example group. # # @example # # describe Person do # it { should_not be_eligible_to_vote } # end def should_not(matcher=nil, message=nil) self == subject ? self.__should_not_for_example_group__(matcher) : subject.should_not(matcher,message) end rescue LoadError end def _attribute_chain(attribute) attribute.to_s.split('.') end def _nested_attribute(subject, attribute) _attribute_chain(attribute).inject(subject) do |subject, attr| subject.send(attr) end end end module ExampleGroupMethods # Creates a nested example group named by the submitted +attribute+, # and then generates an example using the submitted block. # # # 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. # # 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. # # 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 def its(attribute, &block) describe(attribute) do example do self.class.class_eval do define_method(:subject) do if defined?(@_subject) @_subject else @_subject = Array === attribute ? super()[*attribute] : _nested_attribute(super(), attribute) end end end instance_eval(&block) end end end # 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. def subject(&block) block ? @explicit_subject_block = block : explicit_subject || implicit_subject end attr_reader :explicit_subject_block private def explicit_subject group = self while group.respond_to?(:explicit_subject_block) return group.explicit_subject_block if group.explicit_subject_block group = group.superclass end end def implicit_subject described = described_class || description Class === described ? proc { described.new } : proc { described } end end end end end