Merge branch 'develop' of github.com:spinen/laravel-mail-assertions into develop

jimmypuckett · jimmypuckett · commit beee6df24ffb · 2016-02-06T10:41:55.000-05:00
# Conflicts:
#	src/MailTracking.php
diff --git a/src/MailTracking.php b/src/MailTracking.php
@@ -11,12 +11,12 @@
  *
  * Trait to mixin to your test to allow for custom assertions when using PHPUnit with Laravel.
  *
- * This originally started out as a copy & paste from a video series that Jeffery 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 initial
+ * 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 JEFFERY WAY.  WE ARE NOT CLAIMING TO
+ * 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
@@ -41,8 +41,8 @@ trait MailTracking
     /**
      * Register a listener for new emails.
      *
-     * Called my PHPUnit before each test it run.  It registers the MailRecorder "plugin" with Swift, so that we can
-     * get a copy of each email that is sent during that test.
+     * This calls my 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
      */
@@ -53,7 +53,7 @@ public function setUpMailTracking()
     }
 
     /**
-     * Retrieve the appropriate swift message.
+     * Retrieve the appropriate Swift message.
      *
      * @param Swift_Message|null $message
      *
@@ -67,15 +67,15 @@ protected function getEmail(Swift_Message $message = null)
     }
 
     /**
-     * Retrieve the mostly recently sent swift message.
+     * Retrieve the mostly recently sent Swift message.
      */
     protected function lastEmail()
     {
         return end($this->emails);
     }
 
     /**
-     * Store a new swift message.
+     * Store a new Swift message.
      *
      * Collection of emails that were received by the MailRecorder plugin during a test.
      *
@@ -97,7 +97,7 @@ public function recordMail(Swift_Message $email)
     protected function seeEmailBcc($bcc, Swift_Message $message = null)
     {
         $this->assertArrayHasKey($bcc, (array)$this->getEmail($message)
-                                                   ->getBcc(), "No email was bcc'ed to $bcc.");
+                                                   ->getBcc(), "The last email sent was not bcc'ed to $bcc.");
 
         return $this;
     }
@@ -113,7 +113,7 @@ protected function seeEmailBcc($bcc, Swift_Message $message = null)
     protected function seeEmailCc($cc, Swift_Message $message = null)
     {
         $this->assertArrayHasKey($cc, (array)$this->getEmail($message)
-                                                  ->getCc(), "No email was cc'ed to $cc.");
+                                                  ->getCc(), "The last email sent was not cc'ed to $cc.");
 
         return $this;
     }
@@ -129,7 +129,7 @@ protected function seeEmailCc($cc, Swift_Message $message = null)
     protected function seeEmailContains($excerpt, Swift_Message $message = null)
     {
         $this->assertContains($excerpt, $this->getEmail($message)
-                                             ->getBody(), "No email containing the provided body was found.");
+                                             ->getBody(), "The last email sent did not contain the provided body.");
 
         return $this;
     }
@@ -146,7 +146,7 @@ protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = nul
     {
         $this->assertNotContains($excerpt, $this->getEmail($message)
                                                 ->getBody(),
-                                 "Email containing the provided text was found in the body.");
+                                 "The last email sent contained the provided text in its body.");
 
         return $this;
     }
@@ -162,7 +162,7 @@ protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = nul
     protected function seeEmailEquals($body, Swift_Message $message = null)
     {
         $this->assertEquals($body, $this->getEmail($message)
-                                        ->getBody(), "No email with the provided body was sent.");
+                                        ->getBody(), "The last email sent did not match the given email.");
 
         return $this;
     }
@@ -179,7 +179,7 @@ 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(), "No email was sent from $sender.");
+                                                      ->getFrom(), "The last email sent was not sent from $sender.");
 
         return $this;
     }
@@ -195,7 +195,8 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)
     protected function seeEmailReplyTo($reply_to, Swift_Message $message = null)
     {
         $this->assertArrayHasKey($reply_to, (array)$this->getEmail($message)
-                                                        ->getReplyTo(), "No email was set to reply to $reply_to.");
+                                                        ->getReplyTo(),
+                                 "The last email sent was not set to reply to $reply_to.");
 
         return $this;
     }
@@ -227,7 +228,8 @@ protected function seeEmailsSent($count)
     protected function seeEmailSubject($subject, Swift_Message $message = null)
     {
         $this->assertEquals($subject, $this->getEmail($message)
-                                           ->getSubject(), "No email with a subject of $subject was found.");
+                                           ->getSubject(),
+                            "The last email sent did not contain a subject of $subject.");
 
         return $this;
     }
@@ -243,7 +245,8 @@ protected function seeEmailSubject($subject, Swift_Message $message = null)
     protected function seeEmailSubjectContains($excerpt, Swift_Message $message = null)
     {
         $this->assertContains($excerpt, $this->getEmail($message)
-                                             ->getSubject(), "No email containing the provided subject was found.");
+                                             ->getSubject(),
+                              "The last email sent did not contain the provided subject.");
 
         return $this;
     }
@@ -260,7 +263,7 @@ protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $messag
     {
         $this->assertNotContains($excerpt, $this->getEmail($message)
                                                 ->getSubject(),
-                                 "Email containing the provided text was found in the subject.");
+                                 "The last email sent contained the provided text in its subject.");
 
         return $this;
     }
@@ -276,7 +279,7 @@ protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $messag
     protected function seeEmailTo($recipient, Swift_Message $message = null)
     {
         $this->assertArrayHasKey($recipient, (array)$this->getEmail($message)
-                                                         ->getTo(), "No email was sent to $recipient.");
+                                                         ->getTo(), "The last email sent was not sent to $recipient.");
 
         return $this;
     }
@@ -288,7 +291,9 @@ protected function seeEmailTo($recipient, Swift_Message $message = null)
      */
     protected function seeEmailWasNotSent()
     {
-        $this->assertEmpty($this->emails, 'Did not expect any emails to have been sent.');
+        $emailsSent = count($this->emails);
+
+        $this->assertEmpty($this->emails, "Did not expect any emails to have been sent, but found $emailsSent");
 
         return $this;
     }
@@ -300,7 +305,7 @@ protected function seeEmailWasNotSent()
      */
     protected function seeEmailWasSent()
     {
-        $this->assertNotEmpty($this->emails, 'No emails have been sent.');
+        $this->assertNotEmpty($this->emails, 'Expected at least one email to be sent, but found none.');
 
         return $this;
     }

Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,12 @@`
`11`	`11`	`*`
`12`	`12`	`* Trait to mixin to your test to allow for custom assertions when using PHPUnit with Laravel.`
`13`	`13`	`*`
`14`		`- * This originally started out as a copy & paste from a video series that Jeffery Way did on laracasts.com. If you do`
`15`		`- * not have an account on Laracasts, you should get one. It is an amazing resource to learn from. We used that`
`16`		`- * example & converted it to a package so that it would be easy to install. We have also expanded on initial`
	`14`	`+ * This originally started out as a copy & paste from a video series that Jeffrey Way did on laracasts.com. If you do`
	`15`	`+ * not have an account on Laracasts, you should get one. It is an amazing resource to learn from. We used that`
	`16`	`+ * example & converted it to a package so that it would be easy to install. We have also expanded on the initial`
`17`	`17`	`* assertions.`
`18`	`18`	`*`
`19`		`- * I WANT IT CLEAR THAT THIS WOULD NOT HAVE HAPPENED WITHOUT THE INITIAL WORK OF JEFFERY WAY. WE ARE NOT CLAIMING TO`
	`19`	`+ * I WANT IT CLEAR THAT THIS WOULD NOT HAVE HAPPENED WITHOUT THE INITIAL WORK OF JEFFREY WAY. WE ARE NOT CLAIMING TO`
`20`	`20`	`* BE THE CREATORS OF THE CONCEPT.`
`21`	`21`	`*`
`22`	`22`	`* @package Spinen\MailAssertions`
`@@ -41,8 +41,8 @@ trait MailTracking`
`41`	`41`	`/**`
`42`	`42`	`* Register a listener for new emails.`
`43`	`43`	`*`
`44`		`- * Called my PHPUnit before each test it run. It registers the MailRecorder "plugin" with Swift, so that we can`
`45`		`- * get a copy of each email that is sent during that test.`
	`44`	`+ * This calls my PHPUnit before each test it runs. It registers the MailRecorder "plugin" with Swift, so that we`
	`45`	`+ * can get a copy of each email that is sent during that test.`
`46`	`46`	`*`
`47`	`47`	`* @before`
`48`	`48`	`*/`
`@@ -53,7 +53,7 @@ public function setUpMailTracking()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * Retrieve the appropriate swift message.`
	`56`	`+ * Retrieve the appropriate Swift message.`
`57`	`57`	`*`
`58`	`58`	`* @param Swift_Message\|null $message`
`59`	`59`	`*`
`@@ -67,15 +67,15 @@ protected function getEmail(Swift_Message $message = null)`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * Retrieve the mostly recently sent swift message.`
	`70`	`+ * Retrieve the mostly recently sent Swift message.`
`71`	`71`	`*/`
`72`	`72`	`protected function lastEmail()`
`73`	`73`	`{`
`74`	`74`	`return end($this->emails);`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`/**`
`78`		`- * Store a new swift message.`
	`78`	`+ * Store a new Swift message.`
`79`	`79`	`*`
`80`	`80`	`* Collection of emails that were received by the MailRecorder plugin during a test.`
`81`	`81`	`*`
`@@ -97,7 +97,7 @@ public function recordMail(Swift_Message $email)`
`97`	`97`	`protected function seeEmailBcc($bcc, Swift_Message $message = null)`
`98`	`98`	`{`
`99`	`99`	`$this->assertArrayHasKey($bcc, (array)$this->getEmail($message)`
`100`		`- ->getBcc(), "No email was bcc'ed to $bcc.");`
	`100`	`+ ->getBcc(), "The last email sent was not bcc'ed to $bcc.");`
`101`	`101`
`102`	`102`	`return $this;`
`103`	`103`	`}`
`@@ -113,7 +113,7 @@ protected function seeEmailBcc($bcc, Swift_Message $message = null)`
`113`	`113`	`protected function seeEmailCc($cc, Swift_Message $message = null)`
`114`	`114`	`{`
`115`	`115`	`$this->assertArrayHasKey($cc, (array)$this->getEmail($message)`
`116`		`- ->getCc(), "No email was cc'ed to $cc.");`
	`116`	`+ ->getCc(), "The last email sent was not cc'ed to $cc.");`
`117`	`117`
`118`	`118`	`return $this;`
`119`	`119`	`}`
`@@ -129,7 +129,7 @@ protected function seeEmailCc($cc, Swift_Message $message = null)`
`129`	`129`	`protected function seeEmailContains($excerpt, Swift_Message $message = null)`
`130`	`130`	`{`
`131`	`131`	`$this->assertContains($excerpt, $this->getEmail($message)`
`132`		`- ->getBody(), "No email containing the provided body was found.");`
	`132`	`+ ->getBody(), "The last email sent did not contain the provided body.");`
`133`	`133`
`134`	`134`	`return $this;`
`135`	`135`	`}`
`@@ -146,7 +146,7 @@ protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = nul`
`146`	`146`	`{`
`147`	`147`	`$this->assertNotContains($excerpt, $this->getEmail($message)`
`148`	`148`	`->getBody(),`
`149`		`- "Email containing the provided text was found in the body.");`
	`149`	`+ "The last email sent contained the provided text in its body.");`
`150`	`150`
`151`	`151`	`return $this;`
`152`	`152`	`}`
`@@ -162,7 +162,7 @@ protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = nul`
`162`	`162`	`protected function seeEmailEquals($body, Swift_Message $message = null)`
`163`	`163`	`{`
`164`	`164`	`$this->assertEquals($body, $this->getEmail($message)`
`165`		`- ->getBody(), "No email with the provided body was sent.");`
	`165`	`+ ->getBody(), "The last email sent did not match the given email.");`
`166`	`166`
`167`	`167`	`return $this;`
`168`	`168`	`}`
`@@ -179,7 +179,7 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)`
`179`	`179`	`{`
`180`	`180`	`// TODO: Allow from to be an array to check email & name`
`181`	`181`	`$this->assertArrayHasKey($sender, (array)$this->getEmail($message)`
`182`		`- ->getFrom(), "No email was sent from $sender.");`
	`182`	`+ ->getFrom(), "The last email sent was not sent from $sender.");`
`183`	`183`
`184`	`184`	`return $this;`
`185`	`185`	`}`
`@@ -195,7 +195,8 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)`
`195`	`195`	`protected function seeEmailReplyTo($reply_to, Swift_Message $message = null)`
`196`	`196`	`{`
`197`	`197`	`$this->assertArrayHasKey($reply_to, (array)$this->getEmail($message)`
`198`		`- ->getReplyTo(), "No email was set to reply to $reply_to.");`
	`198`	`+ ->getReplyTo(),`
	`199`	`+ "The last email sent was not set to reply to $reply_to.");`
`199`	`200`
`200`	`201`	`return $this;`
`201`	`202`	`}`
`@@ -227,7 +228,8 @@ protected function seeEmailsSent($count)`
`227`	`228`	`protected function seeEmailSubject($subject, Swift_Message $message = null)`
`228`	`229`	`{`
`229`	`230`	`$this->assertEquals($subject, $this->getEmail($message)`
`230`		`- ->getSubject(), "No email with a subject of $subject was found.");`
	`231`	`+ ->getSubject(),`
	`232`	`+ "The last email sent did not contain a subject of $subject.");`
`231`	`233`
`232`	`234`	`return $this;`
`233`	`235`	`}`
`@@ -243,7 +245,8 @@ protected function seeEmailSubject($subject, Swift_Message $message = null)`
`243`	`245`	`protected function seeEmailSubjectContains($excerpt, Swift_Message $message = null)`
`244`	`246`	`{`
`245`	`247`	`$this->assertContains($excerpt, $this->getEmail($message)`
`246`		`- ->getSubject(), "No email containing the provided subject was found.");`
	`248`	`+ ->getSubject(),`
	`249`	`+ "The last email sent did not contain the provided subject.");`
`247`	`250`
`248`	`251`	`return $this;`
`249`	`252`	`}`
`@@ -260,7 +263,7 @@ protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $messag`
`260`	`263`	`{`
`261`	`264`	`$this->assertNotContains($excerpt, $this->getEmail($message)`
`262`	`265`	`->getSubject(),`
`263`		`- "Email containing the provided text was found in the subject.");`
	`266`	`+ "The last email sent contained the provided text in its subject.");`
`264`	`267`
`265`	`268`	`return $this;`
`266`	`269`	`}`
`@@ -276,7 +279,7 @@ protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $messag`
`276`	`279`	`protected function seeEmailTo($recipient, Swift_Message $message = null)`
`277`	`280`	`{`
`278`	`281`	`$this->assertArrayHasKey($recipient, (array)$this->getEmail($message)`
`279`		`- ->getTo(), "No email was sent to $recipient.");`
	`282`	`+ ->getTo(), "The last email sent was not sent to $recipient.");`
`280`	`283`
`281`	`284`	`return $this;`
`282`	`285`	`}`
`@@ -288,7 +291,9 @@ protected function seeEmailTo($recipient, Swift_Message $message = null)`
`288`	`291`	`*/`
`289`	`292`	`protected function seeEmailWasNotSent()`
`290`	`293`	`{`
`291`		`- $this->assertEmpty($this->emails, 'Did not expect any emails to have been sent.');`
	`294`	`+ $emailsSent = count($this->emails);`
	`295`	`+`
	`296`	`+ $this->assertEmpty($this->emails, "Did not expect any emails to have been sent, but found $emailsSent");`
`292`	`297`
`293`	`298`	`return $this;`
`294`	`299`	`}`
`@@ -300,7 +305,7 @@ protected function seeEmailWasNotSent()`
`300`	`305`	`*/`
`301`	`306`	`protected function seeEmailWasSent()`
`302`	`307`	`{`
`303`		`- $this->assertNotEmpty($this->emails, 'No emails have been sent.');`
	`308`	`+ $this->assertNotEmpty($this->emails, 'Expected at least one email to be sent, but found none.');`
`304`	`309`
`305`	`310`	`return $this;`
`306`	`311`	`}`