2010-12-15 22:34:19 +00:00
|
|
|
module Shoulda # :nodoc:
|
|
|
|
module Matchers
|
|
|
|
module ActionMailer # :nodoc:
|
|
|
|
|
|
|
|
# The right email is sent.
|
|
|
|
#
|
|
|
|
# it { should have_sent_email.with_subject(/is spam$/) }
|
|
|
|
# it { should have_sent_email.from('do-not-reply@example.com') }
|
|
|
|
# it { should have_sent_email.with_body(/is spam\./) }
|
|
|
|
# it { should have_sent_email.to('myself@me.com') }
|
|
|
|
# it { should have_sent_email.with_subject(/spam/).
|
|
|
|
# from('do-not-reply@example.com').
|
|
|
|
# with_body(/spam/).
|
|
|
|
# to('myself@me.com') }
|
|
|
|
def have_sent_email
|
|
|
|
HaveSentEmailMatcher.new
|
|
|
|
end
|
|
|
|
|
|
|
|
class HaveSentEmailMatcher # :nodoc:
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
end
|
|
|
|
|
|
|
|
def with_subject(email_subject)
|
|
|
|
@email_subject = email_subject
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
|
|
|
def from(sender)
|
|
|
|
@sender = sender
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
|
|
|
def with_body(body)
|
|
|
|
@body = body
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
2011-05-23 21:57:16 +00:00
|
|
|
def with_part(content_type, body)
|
|
|
|
@parts ||= []
|
|
|
|
@parts << [/#{Regexp.escape(content_type)}/, body, content_type]
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
2010-12-15 22:34:19 +00:00
|
|
|
def to(recipient)
|
|
|
|
@recipient = recipient
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
2011-05-23 21:57:16 +00:00
|
|
|
def multipart(flag = true)
|
|
|
|
@multipart = !!flag
|
|
|
|
self
|
|
|
|
end
|
|
|
|
|
2010-12-15 22:34:19 +00:00
|
|
|
def matches?(subject)
|
|
|
|
::ActionMailer::Base.deliveries.each do |mail|
|
|
|
|
@subject_failed = !regexp_or_string_match(mail.subject, @email_subject) if @email_subject
|
2011-05-23 21:57:16 +00:00
|
|
|
@parts_failed = !parts_match(mail, @parts) if @parts
|
2011-05-23 21:57:16 +00:00
|
|
|
@body_failed = !body_match(mail, @body) if @body
|
2010-12-15 22:34:19 +00:00
|
|
|
@sender_failed = !regexp_or_string_match_in_array(mail.from, @sender) if @sender
|
|
|
|
@recipient_failed = !regexp_or_string_match_in_array(mail.to, @recipient) if @recipient
|
2011-05-23 21:57:16 +00:00
|
|
|
@multipart_failed = mail.multipart? != @multipart if defined?(@multipart)
|
2010-12-15 22:34:19 +00:00
|
|
|
return true unless anything_failed?
|
|
|
|
end
|
|
|
|
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
|
|
|
def failure_message
|
|
|
|
"Expected #{expectation}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def negative_failure_message
|
|
|
|
"Did not expect #{expectation}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def description
|
2010-12-17 16:50:49 +00:00
|
|
|
description = "send an email"
|
|
|
|
description << " with a subject of #{@email_subject.inspect}" if @email_subject
|
|
|
|
description << " containing #{@body.inspect}" if @body
|
2011-05-23 21:57:16 +00:00
|
|
|
@parts.each do |_, body, content_type|
|
|
|
|
description << " having a #{content_type} part containing #{body.inspect}"
|
|
|
|
end if @parts
|
2010-12-17 16:50:49 +00:00
|
|
|
description << " from #{@sender.inspect}" if @sender
|
|
|
|
description << " to #{@recipient.inspect}" if @recipient
|
|
|
|
description
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def expectation
|
|
|
|
expectation = "sent email"
|
|
|
|
expectation << " with subject #{@email_subject.inspect}" if @subject_failed
|
|
|
|
expectation << " with body #{@body.inspect}" if @body_failed
|
2011-05-23 21:57:16 +00:00
|
|
|
@parts.each do |_, body, content_type|
|
|
|
|
expectation << " with a #{content_type} part containing #{body}"
|
|
|
|
end if @parts && @parts_failed
|
2010-12-15 22:34:19 +00:00
|
|
|
expectation << " from #{@sender.inspect}" if @sender_failed
|
|
|
|
expectation << " to #{@recipient.inspect}" if @recipient_failed
|
2011-05-23 21:57:16 +00:00
|
|
|
expectation << " #{!@multipart && 'not '}being multipart" if @multipart_failed
|
2010-12-15 22:34:19 +00:00
|
|
|
expectation << "\nDeliveries:\n#{inspect_deliveries}"
|
|
|
|
end
|
|
|
|
|
|
|
|
def inspect_deliveries
|
|
|
|
::ActionMailer::Base.deliveries.map do |delivery|
|
|
|
|
"#{delivery.subject.inspect} to #{delivery.to.inspect}"
|
|
|
|
end.join("\n")
|
|
|
|
end
|
|
|
|
|
|
|
|
def anything_failed?
|
2011-05-23 21:57:16 +00:00
|
|
|
@subject_failed || @body_failed || @parts_failed || @sender_failed ||
|
|
|
|
@recipient_failed || @multipart_failed
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def regexp_or_string_match(a_string, a_regexp_or_string)
|
|
|
|
case a_regexp_or_string
|
|
|
|
when Regexp
|
|
|
|
a_string =~ a_regexp_or_string
|
|
|
|
when String
|
|
|
|
a_string == a_regexp_or_string
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def regexp_or_string_match_in_array(an_array, a_regexp_or_string)
|
|
|
|
case a_regexp_or_string
|
|
|
|
when Regexp
|
|
|
|
an_array.any? { |string| string =~ a_regexp_or_string }
|
|
|
|
when String
|
|
|
|
an_array.include?(a_regexp_or_string)
|
|
|
|
end
|
|
|
|
end
|
2011-05-23 21:57:16 +00:00
|
|
|
|
|
|
|
def body_match(mail, a_regexp_or_string)
|
|
|
|
# Mail objects instantiated by ActionMailer3 return a blank
|
|
|
|
# body if the e-mail is multipart. TMail concatenates the
|
|
|
|
# String representation of each part instead.
|
|
|
|
if mail.body.blank? && mail.multipart?
|
2011-05-23 21:57:16 +00:00
|
|
|
part_match(mail, /^text\//, a_regexp_or_string)
|
2011-05-23 21:57:16 +00:00
|
|
|
else
|
|
|
|
regexp_or_string_match(mail.body, a_regexp_or_string)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-05-23 21:57:16 +00:00
|
|
|
def parts_match(mail, parts)
|
|
|
|
return false if mail.parts.empty?
|
|
|
|
|
|
|
|
parts.all? do |content_type, match, _|
|
|
|
|
part_match(mail, content_type, match)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def part_match(mail, content_type, a_regexp_or_string)
|
|
|
|
matching = mail.parts.select {|p| p.content_type =~ content_type}
|
|
|
|
return false if matching.empty?
|
|
|
|
|
|
|
|
matching.all? do |part|
|
|
|
|
regexp_or_string_match(part.body, a_regexp_or_string)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2010-12-15 22:34:19 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
end
|