Merge pull request #11 from kirschbaum-development/assertable-message…

…-updates Assertable message updates
kirschbaum-development · May 20, 2022 · a1ead8c · a1ead8c
2 parents 3fac474 + 793ec4d
commit a1ead8c
Show file tree

Hide file tree

Showing 27 changed files with 937 additions and 128 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to `mail-intercept` will be documented in this file
 
+## 0.3.1 - 2022-05-20
+
+- Better type-hinting for `AssertableMessage` class in assertions. Thank you [@amsoel](https://github.com/amsoell).
+
 ## 0.3.0 - 2022-03-08
 
 - Upgraded for Laravel 9

diff --git a/src/AssertableMessage.php b/src/AssertableMessage.php
@@ -80,8 +80,8 @@ public function __construct(Email $email)
     /**
      * Dynamically pass missing methods to the Symfony instance.
      *
-     * @param  string  $method
-     * @param  array  $parameters
+     * @param string $method
+     * @param array $parameters
      *
      * @return mixed
      */

diff --git a/src/Assertions/BccAssertions.php b/src/Assertions/BccAssertions.php
@@ -4,16 +4,17 @@
 
 use Illuminate\Support\Arr;
 use Symfony\Component\Mime\Email;
+use KirschbaumDevelopment\MailIntercept\AssertableMessage;
 
 trait BccAssertions
 {
     /**
      * Assert mail was BCC'd to address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailBcc(array|string $expected, Email $mail)
+    public function assertMailBcc(array|string $expected, AssertableMessage | Email $mail): void
     {
         $expectedAddresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getBcc', $mail);
@@ -31,9 +32,9 @@ public function assertMailBcc(array|string $expected, Email $mail)
      * Assert mail was not BCC'd to address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailNotBcc(array|string $expected, Email $mail)
+    public function assertMailNotBcc(array|string $expected, AssertableMessage | Email $mail): void
     {
         $addresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getBcc', $mail);

diff --git a/src/Assertions/CcAssertions.php b/src/Assertions/CcAssertions.php
@@ -4,16 +4,17 @@
 
 use Illuminate\Support\Arr;
 use Symfony\Component\Mime\Email;
+use KirschbaumDevelopment\MailIntercept\AssertableMessage;
 
 trait CcAssertions
 {
     /**
      * Assert mail was CC'd to address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailCc(array|string $expected, Email $mail)
+    public function assertMailCc(array|string $expected, AssertableMessage | Email $mail): void
     {
         $expectedAddresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getCc', $mail);
@@ -31,9 +32,9 @@ public function assertMailCc(array|string $expected, Email $mail)
      * Assert mail was not CC'd to address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailNotCc(array|string $expected, Email $mail)
+    public function assertMailNotCc(array|string $expected, AssertableMessage | Email $mail): void
     {
         $expectedAddresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getCc', $mail);

diff --git a/src/Assertions/ContentAssertions.php b/src/Assertions/ContentAssertions.php
@@ -3,16 +3,17 @@
 namespace KirschbaumDevelopment\MailIntercept\Assertions;
 
 use Symfony\Component\Mime\Email;
+use KirschbaumDevelopment\MailIntercept\AssertableMessage;
 
 trait ContentAssertions
 {
     /**
      * Assert mail body contains string.
      *
      * @param string $needle
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailBodyContainsString(string $needle, Email $mail)
+    public function assertMailBodyContainsString(string $needle, AssertableMessage | Email $mail): void
     {
         $method = method_exists($this, 'assertStringContainsString')
             ? 'assertStringContainsString'
@@ -29,9 +30,9 @@ public function assertMailBodyContainsString(string $needle, Email $mail)
      * Assert mail body does not contain string.
      *
      * @param string $needle
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailBodyNotContainsString(string $needle, Email $mail)
+    public function assertMailBodyNotContainsString(string $needle, AssertableMessage | Email $mail): void
     {
         $method = method_exists($this, 'assertStringNotContainsString')
             ? 'assertStringNotContainsString'

diff --git a/src/Assertions/ContentTypeAssertions.php b/src/Assertions/ContentTypeAssertions.php
@@ -4,15 +4,16 @@
 
 use Symfony\Component\Mime\Email;
 use Symfony\Component\Mime\Part\AbstractMultipartPart;
+use KirschbaumDevelopment\MailIntercept\AssertableMessage;
 
 trait ContentTypeAssertions
 {
     /**
      * Assert mail content type is text/plain.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsPlain(Email $mail)
+    public function assertMailIsPlain(AssertableMessage | Email $mail): void
     {
         $this->assertEquals(
             'plain',
@@ -24,9 +25,9 @@ public function assertMailIsPlain(Email $mail)
     /**
      * Assert mail content type is not text/plain.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsNotPlain(Email $mail)
+    public function assertMailIsNotPlain(AssertableMessage | Email $mail): void
     {
         $this->assertNotEquals(
             'plain',
@@ -38,9 +39,9 @@ public function assertMailIsNotPlain(Email $mail)
     /**
      * Assert multipart email has text/plain content type.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailHasPlainContent(Email $mail)
+    public function assertMailHasPlainContent(AssertableMessage | Email $mail): void
     {
         if ($mail->getBody() instanceof AbstractMultipartPart) {
             $hasPlainContent = collect($mail->getBody()->getParts())
@@ -56,9 +57,9 @@ public function assertMailHasPlainContent(Email $mail)
     /**
      * Assert multipart email does not have text/plain content type.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailDoesNotHavePlainContent(Email $mail)
+    public function assertMailDoesNotHavePlainContent(AssertableMessage | Email $mail): void
     {
         if ($mail->getBody() instanceof AbstractMultipartPart) {
             $hasPlainContent = collect($mail->getBody()->getParts())
@@ -74,9 +75,9 @@ public function assertMailDoesNotHavePlainContent(Email $mail)
     /**
      * Assert mail content type is text/html.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsHtml(Email $mail)
+    public function assertMailIsHtml(AssertableMessage | Email $mail): void
     {
         $this->assertEquals(
             'html',
@@ -88,9 +89,9 @@ public function assertMailIsHtml(Email $mail)
     /**
      * Assert mail content type is not text/html.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsNotHtml(Email $mail)
+    public function assertMailIsNotHtml(AssertableMessage | Email $mail): void
     {
         $this->assertNotEquals(
             'html',
@@ -102,9 +103,9 @@ public function assertMailIsNotHtml(Email $mail)
     /**
      * Assert multipart email has text/html content type.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailHasHtmlContent(Email $mail)
+    public function assertMailHasHtmlContent(AssertableMessage | Email $mail): void
     {
         if ($mail->getBody() instanceof AbstractMultipartPart) {
             $hasHtmlContent = collect($mail->getBody()->getParts())
@@ -120,9 +121,9 @@ public function assertMailHasHtmlContent(Email $mail)
     /**
      * Assert multipart email does not have text/html content type.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailDoesNotHaveHtmlContent(Email $mail)
+    public function assertMailDoesNotHaveHtmlContent(AssertableMessage | Email $mail): void
     {
         if ($mail->getBody() instanceof AbstractMultipartPart) {
             $hasHtmlContent = collect($mail->getBody()->getParts())
@@ -138,9 +139,9 @@ public function assertMailDoesNotHaveHtmlContent(Email $mail)
     /**
      * Assert mail content type is multipart/alternative.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsAlternative(Email $mail)
+    public function assertMailIsAlternative(AssertableMessage | Email $mail): void
     {
         $this->assertEquals(
             'alternative',
@@ -152,9 +153,9 @@ public function assertMailIsAlternative(Email $mail)
     /**
      * Assert mail content type is not multipart/alternative.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsNotAlternative(Email $mail)
+    public function assertMailIsNotAlternative(AssertableMessage | Email $mail): void
     {
         $this->assertNotEquals(
             'alternative',
@@ -166,9 +167,9 @@ public function assertMailIsNotAlternative(Email $mail)
     /**
      * Assert mail content type is multipart/mixed.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsMixed(Email $mail)
+    public function assertMailIsMixed(AssertableMessage | Email $mail): void
     {
         $this->assertEquals(
             'mixed',
@@ -180,9 +181,9 @@ public function assertMailIsMixed(Email $mail)
     /**
      * Assert mail content type is not multipart/mixed.
      *
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailIsNotMixed(Email $mail)
+    public function assertMailIsNotMixed(AssertableMessage | Email $mail): void
     {
         $this->assertNotEquals(
             'mixed',

diff --git a/src/Assertions/FromAssertions.php b/src/Assertions/FromAssertions.php
@@ -4,16 +4,17 @@
 
 use Illuminate\Support\Arr;
 use Symfony\Component\Mime\Email;
+use KirschbaumDevelopment\MailIntercept\AssertableMessage;
 
 trait FromAssertions
 {
     /**
      * Assert mail was sent from address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailSentFrom(array|string $expected, Email $mail)
+    public function assertMailSentFrom(array | string $expected, AssertableMessage | Email $mail): void
     {
         $expectedAddresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getFrom', $mail);
@@ -31,9 +32,9 @@ public function assertMailSentFrom(array|string $expected, Email $mail)
      * Assert mail was not sent from address.
      *
      * @param array|string $expected
-     * @param Email $mail
+     * @param AssertableMessage|Email $mail
      */
-    public function assertMailNotSentFrom(array|string $expected, Email $mail)
+    public function assertMailNotSentFrom(array | string $expected, AssertableMessage | Email $mail): void
     {
         $expectedAddresses = Arr::wrap($expected);
         $actualAddresses = $this->gatherEmailData('getFrom', $mail);