Merge branch 'develop' into feature/renameSeeEmailsSent

ssfinney · ssfinney · commit b19364f0a88d · 2016-02-06T13:46:49.000-05:00
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.0.2
+0.0.4
diff --git a/readme.md b/readme.md
@@ -36,7 +36,9 @@ You mixin the assertions with the ```Spinen\MailAssertions\MailTracking``` trait
 * seeEmailEquals
 * seeEmailFrom
 * seeEmailReplyTo
-* seeEmailSubject
+* seeEmailSubjectContains
+* seeEmailSubjectDoesNotContain
+* seeEmailSubjectEquals
 * seeEmailTo
 * seeEmailWasNotSent
 * seeEmailWasSent
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;
     }
@@ -145,7 +145,8 @@ protected function seeEmailContains($excerpt, Swift_Message $message = null)
     protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = null)
     {
         $this->assertNotContains($excerpt, $this->getEmail($message)
-                                                ->getBody(), "Email containing the provided text was found in the body.");
+                                                ->getBody(),
+                                 "The last email sent contained the provided text in its body.");
 
         return $this;
     }
@@ -161,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;
     }
@@ -178,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;
     }
@@ -194,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;
     }
@@ -222,12 +224,60 @@ protected function seeEmailCountEquals($count)
      * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
+     * @deprecated in favor of seeEmailSubjectEquals
      */
     protected function seeEmailSubject($subject, Swift_Message $message = null)
     {
-        // TODO: Consider a subject contains like the message contains
+        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 PHPUnit_Framework_TestCase $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 PHPUnit_Framework_TestCase $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 PHPUnit_Framework_TestCase $this
+     */
+    protected function seeEmailSubjectEquals($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 +293,7 @@ protected function seeEmailSubject($subject, Swift_Message $message = null)
     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;
     }
@@ -255,7 +305,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;
     }
@@ -267,7 +319,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;
     }
diff --git a/tests/MailTrackingTest.php b/tests/MailTrackingTest.php
@@ -238,6 +238,31 @@ public function it_knows_how_many_emails_have_been_sent()
         $this->assertEquals($this->mail_tracking, $this->callProtectedMethod('seeEmailCountEquals', [2]));
     }
 
+    /**
+     * @test
+     * @group unit
+     */
+    public function it_makes_sure_email_subject_contains_expected_string()
+    {
+        $message = $this->makeMessage('full message subject');
+        $this->mail_tracking->recordMail($message);
+
+        $this->assertEquals($this->mail_tracking,
+                            $this->callProtectedMethod('seeEmailSubjectContains', ['subject']));
+    }
+
+    /**
+     * @test
+     * @group unit
+     */
+    public function it_makes_sure_email_subject_does_not_contain_string()
+    {
+        $message = $this->makeMessage('');
+        $this->mail_tracking->recordMail($message);
+
+        $this->assertEquals($this->mail_tracking, $this->callProtectedMethod('seeEmailSubjectDoesNotContain', ['subject']));
+    }
+
     /**
      * @test
      * @group unit
@@ -248,7 +273,7 @@ public function it_makes_sure_email_subject_is_what_is_expected()
         $this->mail_tracking->recordMail($message);
 
         $this->assertEquals($this->mail_tracking,
-                            $this->callProtectedMethod('seeEmailSubject', ['full message subject']));
+                            $this->callProtectedMethod('seeEmailSubjectEquals', ['full message subject']));
     }
 
     /**

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`	`}`
`@@ -145,7 +145,8 @@ protected function seeEmailContains($excerpt, Swift_Message $message = null)`
`145`	`145`	`protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = null)`
`146`	`146`	`{`
`147`	`147`	`$this->assertNotContains($excerpt, $this->getEmail($message)`
`148`		`- ->getBody(), "Email containing the provided text was found in the body.");`
	`148`	`+ ->getBody(),`
	`149`	`+ "The last email sent contained the provided text in its body.");`
`149`	`150`
`150`	`151`	`return $this;`
`151`	`152`	`}`
`@@ -161,7 +162,7 @@ protected function seeEmailDoesNotContain($excerpt, Swift_Message $message = nul`
`161`	`162`	`protected function seeEmailEquals($body, Swift_Message $message = null)`
`162`	`163`	`{`
`163`	`164`	`$this->assertEquals($body, $this->getEmail($message)`
`164`		`- ->getBody(), "No email with the provided body was sent.");`
	`165`	`+ ->getBody(), "The last email sent did not match the given email.");`
`165`	`166`
`166`	`167`	`return $this;`
`167`	`168`	`}`
`@@ -178,7 +179,7 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)`
`178`	`179`	`{`
`179`	`180`	`// TODO: Allow from to be an array to check email & name`
`180`	`181`	`$this->assertArrayHasKey($sender, (array)$this->getEmail($message)`
`181`		`- ->getFrom(), "No email was sent from $sender.");`
	`182`	`+ ->getFrom(), "The last email sent was not sent from $sender.");`
`182`	`183`
`183`	`184`	`return $this;`
`184`	`185`	`}`
`@@ -194,7 +195,8 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)`
`194`	`195`	`protected function seeEmailReplyTo($reply_to, Swift_Message $message = null)`
`195`	`196`	`{`
`196`	`197`	`$this->assertArrayHasKey($reply_to, (array)$this->getEmail($message)`
`197`		`- ->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.");`
`198`	`200`
`199`	`201`	`return $this;`
`200`	`202`	`}`
`@@ -222,12 +224,60 @@ protected function seeEmailCountEquals($count)`
`222`	`224`	`* @param Swift_Message\|null $message`
`223`	`225`	`*`
`224`	`226`	`* @return PHPUnit_Framework_TestCase $this`
	`227`	`+ * @deprecated in favor of seeEmailSubjectEquals`
`225`	`228`	`*/`
`226`	`229`	`protected function seeEmailSubject($subject, Swift_Message $message = null)`
`227`	`230`	`{`
`228`		`- // TODO: Consider a subject contains like the message contains`
	`231`	`+ return $this->seeEmailSubjectEquals($subject, $message);`
	`232`	`+ }`
	`233`	`+`
	`234`	`+ /**`
	`235`	`+ * Assert that the last email's subject contains the given string.`
	`236`	`+ *`
	`237`	`+ * @param string $excerpt`
	`238`	`+ * @param Swift_Message\|null $message`
	`239`	`+ *`
	`240`	`+ * @return PHPUnit_Framework_TestCase $this`
	`241`	`+ */`
	`242`	`+ protected function seeEmailSubjectContains($excerpt, Swift_Message $message = null)`
	`243`	`+ {`
	`244`	`+ $this->assertContains($excerpt, $this->getEmail($message)`
	`245`	`+ ->getSubject(),`
	`246`	`+ "The last email sent did not contain the provided subject.");`
	`247`	`+`
	`248`	`+ return $this;`
	`249`	`+ }`
	`250`	`+`
	`251`	`+ /**`
	`252`	`+ * Assert that the last email's subject does not contain the given string.`
	`253`	`+ *`
	`254`	`+ * @param string $excerpt`
	`255`	`+ * @param Swift_Message\|null $message`
	`256`	`+ *`
	`257`	`+ * @return PHPUnit_Framework_TestCase $this`
	`258`	`+ */`
	`259`	`+ protected function seeEmailSubjectDoesNotContain($excerpt, Swift_Message $message = null)`
	`260`	`+ {`
	`261`	`+ $this->assertNotContains($excerpt, $this->getEmail($message)`
	`262`	`+ ->getSubject(),`
	`263`	`+ "The last email sent contained the provided text in its subject.");`
	`264`	`+`
	`265`	`+ return $this;`
	`266`	`+ }`
	`267`	`+`
	`268`	`+ /**`
	`269`	`+ * Assert that the last email's subject matches the given string.`
	`270`	`+ *`
	`271`	`+ * @param string $subject`
	`272`	`+ * @param Swift_Message\|null $message`
	`273`	`+ *`
	`274`	`+ * @return PHPUnit_Framework_TestCase $this`
	`275`	`+ */`
	`276`	`+ protected function seeEmailSubjectEquals($subject, Swift_Message $message = null)`
	`277`	`+ {`
`229`	`278`	`$this->assertEquals($subject, $this->getEmail($message)`
`230`		`- ->getSubject(), "No email with a subject of $subject was found.");`
	`279`	`+ ->getSubject(),`
	`280`	`+ "The last email sent did not contain a subject of $subject.");`
`231`	`281`
`232`	`282`	`return $this;`
`233`	`283`	`}`
`@@ -243,7 +293,7 @@ protected function seeEmailSubject($subject, Swift_Message $message = null)`
`243`	`293`	`protected function seeEmailTo($recipient, Swift_Message $message = null)`
`244`	`294`	`{`
`245`	`295`	`$this->assertArrayHasKey($recipient, (array)$this->getEmail($message)`
`246`		`- ->getTo(), "No email was sent to $recipient.");`
	`296`	`+ ->getTo(), "The last email sent was not sent to $recipient.");`
`247`	`297`
`248`	`298`	`return $this;`
`249`	`299`	`}`
`@@ -255,7 +305,9 @@ protected function seeEmailTo($recipient, Swift_Message $message = null)`
`255`	`305`	`*/`
`256`	`306`	`protected function seeEmailWasNotSent()`
`257`	`307`	`{`
`258`		`- $this->assertEmpty($this->emails, 'Did not expect any emails to have been sent.');`
	`308`	`+ $emailsSent = count($this->emails);`
	`309`	`+`
	`310`	`+ $this->assertEmpty($this->emails, "Did not expect any emails to have been sent, but found $emailsSent");`
`259`	`311`
`260`	`312`	`return $this;`
`261`	`313`	`}`
`@@ -267,7 +319,7 @@ protected function seeEmailWasNotSent()`
`267`	`319`	`*/`
`268`	`320`	`protected function seeEmailWasSent()`
`269`	`321`	`{`
`270`		`- $this->assertNotEmpty($this->emails, 'No emails have been sent.');`
	`322`	`+ $this->assertNotEmpty($this->emails, 'Expected at least one email to be sent, but found none.');`
`271`	`323`
`272`	`324`	`return $this;`
`273`	`325`	`}`