Spinen\MailAssertions\MailTracking

Complexity

Total Complexity

23

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Test Coverage

Coverage

88.64%

Importance

Changes	25
Bugs	1	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	seeEmailDoesNotContain()	0	7	1
A	seeEmailPriorityEquals()	0	9	1
A	setUpMailTracking()	0	9	1
A	seeEmailSubjectEquals()	0	7	1
A	seeEmailWasSent()	0	5	1
A	seeEmailContains()	0	6	1
A	seeEmailContentTypeEquals()	0	7	1
A	lastEmail()	0	3	1
A	seeEmailEquals()	0	6	1
A	seeEmailSubjectDoesNotContain()	0	7	1
A	seeEmailSubject()	0	3	1
A	seeEmailCountEquals()	0	7	1
A	seeEmailWasNotSent()	0	7	1
A	seeEmailCc()	0	6	1
A	seeEmailsSent()	0	3	1
A	seeEmailTo()	0	6	1
A	seeEmailSubjectContains()	0	7	1
A	recordMail()	0	3	1
A	seeEmailBcc()	0	6	1
A	seeEmailReplyTo()	0	7	1
A	getEmail()	0	5	2
A	seeEmailFrom()	0	7	1

<?php

namespace Spinen\MailAssertions;

use Illuminate\Support\Facades\Mail;
use Swift_Message;

/**
 * Trait MailTracking
 *
 * Trait to mixin to your test to allow for custom assertions when using PHPUnit with Laravel. This trait assumes
 * you are using it from the PHPUnit TestCase class (or a child class of it).
 *
 * This originally started out as a copy & paste from a video series that Jeffrey Way did on laracasts.com. If you do
 * not have an account on Laracasts, you should get one. It is an amazing resource to learn from. We used that
 * example & converted it to a package so that it would be easy to install. We have also expanded on the initial
 * assertions.
 *
 * I WANT IT CLEAR THAT THIS WOULD NOT HAVE HAPPENED WITHOUT THE INITIAL WORK OF JEFFREY WAY. WE ARE NOT CLAIMING TO
 * BE THE CREATORS OF THE CONCEPT.
 *
 * @package Spinen\MailAssertions
 * @see     https://gist.github.com/JeffreyWay/b501c53d958b07b8a332
 * @tutorial https://laracasts.com/series/phpunit-testing-in-laravel/episodes/12
 */
trait MailTracking
{
    // TODO: Add check for attachments (number of & name)
    // TODO: Add check for header
    // TODO: Add check for message type
    // TODO: Allow checking specific message not just most recent one

    /**
     * Delivered emails.
     *
     * @var array
     */
    protected $emails = [];

    /**
     * Register a listener for new emails.
     *
     * This calls our PHPUnit before each test it runs. It registers the MailRecorder "plugin" with Swift, so that we
     * can get a copy of each email that is sent during that test.
     *
     * @before
     */
    public function setUpMailTracking()
    {
        $register_plugin = function () {
            Mail::getSwiftMailer()
                ->registerPlugin(new MailRecorder($this));
        };

        $this->afterApplicationCreated(function () use ($register_plugin) {

It seems like afterApplicationCreated() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $register_plugin();
        });
    }

    /**
     * Retrieve the appropriate Swift message.
     *
     * @param Swift_Message|null $message
     *
     * @return Swift_Message
     */
    protected function getEmail(Swift_Message $message = null)
    {
        $this->seeEmailWasSent();

        return $message ?: $this->lastEmail();
    }

    /**
     * Retrieve the mostly recently sent Swift message.
     */
    protected function lastEmail()
    {
        return end($this->emails);
    }

    /**
     * Store a new Swift message.
     *
     * Collection of emails that were received by the MailRecorder plugin during a test.
     *
     * @param Swift_Message $email
     */
    public function recordMail(Swift_Message $email)
    {
        $this->emails[] = $email;
    }

    /**
     * Assert that the last email was bcc'ed to the given address.
     *
     * @param string             $bcc
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailBcc($bcc, Swift_Message $message = null)
    {
        $this->assertArrayHasKey($bcc, (array)$this->getEmail($message)

It seems like assertArrayHasKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                                                   ->getBcc(), "The last email sent was not bcc'ed to $bcc.");

        return $this;
    }

    /**
     * Assert that the last email was cc'ed to the given address.
     *
     * @param string             $cc
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailCc($cc, Swift_Message $message = null)
    {
        $this->assertArrayHasKey($cc, (array)$this->getEmail($message)
                                                  ->getCc(), "The last email sent was not cc'ed to $cc.");

        return $this;
    }

    /**
     * Assert that the last email's body contains the given text.
     *
     * @param string             $excerpt
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailContains($excerpt, Swift_Message $message = null)
    {
        $this->assertContains($excerpt, $this->getEmail($message)

It seems like assertContains() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                                             ->getBody(), "The last email sent did not contain the provided body.");

        return $this;
    }

    /**
     * Assert that the last email's content type equals the given text.
     * For example, "text/plain" and "text/html" are valid content types for an email.
     *
     * @param string             $content_type
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailContentTypeEquals($content_type, Swift_Message $message = null)
    {
        $this->assertEquals($content_type, $this->getEmail($message)

It seems like assertEquals() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                                                ->getContentType(),
            "The last email sent did not contain the provided body.");

        return $this;
    }

    /**
     * Assert that the last email's body does not contain the given text.
     *
     * @param string             $excerpt
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = null)
    {
        $this->assertNotContains($excerpt, $this->getEmail($message)

It seems like assertNotContains() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                                                ->getBody(),
                                 "The last email sent contained the provided text in its body.");

        return $this;
    }

    /**
     * Assert that the last email's body equals the given text.
     *
     * @param string             $body
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailEquals($body, Swift_Message $message = null)
    {
        $this->assertEquals($body, $this->getEmail($message)
                                        ->getBody(), "The last email sent did not match the given email.");

        return $this;
    }

    /**
     * Assert that the last email was delivered by the given address.
     *
     * @param string             $sender
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailFrom($sender, Swift_Message $message = null)
    {
        // TODO: Allow from to be an array to check email & name
        $this->assertArrayHasKey($sender, (array)$this->getEmail($message)
                                                      ->getFrom(), "The last email sent was not sent from $sender.");

        return $this;
    }

    /**
     * Assert that the last email had the given priority level.
     * The value is an integer where 1 is the highest priority and 5 is the lowest.
     *
     * @param integer            $priority
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailPriorityEquals($priority, Swift_Message $message = null)
    {
        $actual_priority = $this->getEmail($message)
                                ->getPriority();

        $this->assertEquals($priority, $actual_priority,
            "The last email sent had a priority of $actual_priority but expected $priority.");

        return $this;
    }

    /**
     * Assert that the last email was set to reply to the given address.
     *
     * @param string             $reply_to
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailReplyTo($reply_to, Swift_Message $message = null)
    {
        $this->assertArrayHasKey($reply_to, (array)$this->getEmail($message)
                                                        ->getReplyTo(),
                                 "The last email sent was not set to reply to $reply_to.");

        return $this;
    }

    /**
     * Assert that the given number of emails were sent.
     *
     * @param integer $count
     *
     * @return MailTracking $this
     * @deprecated in favor of seeEmailCountEquals
     */
    protected function seeEmailsSent($count)
    {
        return $this->seeEmailCountEquals($count);
    }

    /**
     * Assert that the given number of emails were sent.
     *
     * @param integer $count
     *
     * @return $this
     */
    protected function seeEmailCountEquals($count)
    {
        $emailsSent = count($this->emails);

        $this->assertCount($count, $this->emails, "Expected $count emails to have been sent, but $emailsSent were.");

It seems like assertCount() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Assert that the last email's subject matches the given string.
     *
     * @param string             $subject
     * @param Swift_Message|null $message
     *
     * @return MailTracking $this
     * @deprecated in favor of seeEmailSubjectEquals
     */
    protected function seeEmailSubject($subject, Swift_Message $message = null)
    {
        return $this->seeEmailSubjectEquals($subject, $message);
    }

    /**
     * Assert that the last email's subject contains the given string.
     *
     * @param string             $excerpt
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailSubjectContains($excerpt, Swift_Message $message = null)
    {
        $this->assertContains($excerpt, $this->getEmail($message)
                                             ->getSubject(),
                              "The last email sent did not contain the provided subject.");

        return $this;
    }

    /**
     * Assert that the last email's subject does not contain the given string.
     *
     * @param string             $excerpt
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $message = null)
    {
        $this->assertNotContains($excerpt, $this->getEmail($message)
                                                ->getSubject(),
                                 "The last email sent contained the provided text in its subject.");

        return $this;
    }

    /**
     * Assert that the last email's subject matches the given string.
     *
     * @param string             $subject
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailSubjectEquals($subject, Swift_Message $message = null)
    {
        $this->assertEquals($subject, $this->getEmail($message)
                                           ->getSubject(),
                            "The last email sent did not contain a subject of $subject.");

        return $this;
    }

    /**
     * Assert that the last email was sent to the given recipient.
     *
     * @param string             $recipient
     * @param Swift_Message|null $message
     *
     * @return $this
     */
    protected function seeEmailTo($recipient, Swift_Message $message = null)
    {
        $this->assertArrayHasKey($recipient, (array)$this->getEmail($message)
                                                         ->getTo(), "The last email sent was not sent to $recipient.");

        return $this;
    }

    /**
     * Assert that no emails were sent.
     *
     * @return $this
     */
    protected function seeEmailWasNotSent()
    {
        $emailsSent = count($this->emails);

        $this->assertEmpty($this->emails, "Did not expect any emails to have been sent, but found $emailsSent");

It seems like assertEmpty() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Assert that at least one email was sent.
     *
     * @return $this
     */
    protected function seeEmailWasSent()
    {
        $this->assertNotEmpty($this->emails, 'Expected at least one email to be sent, but found none.');

It seems like assertNotEmpty() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }
}