make the Mailable class tappable. (#53788)

Author: kevinb1989

src/Illuminate/Mail/Mailable.php

@@ -19,6 +19,7 @@
 use Illuminate\Support\Traits\ForwardsCalls;
 use Illuminate\Support\Traits\Localizable;
 use Illuminate\Support\Traits\Macroable;
+use Illuminate\Support\Traits\Tappable;
 use Illuminate\Testing\Constraints\SeeInOrder;
 use PHPUnit\Framework\Assert as PHPUnit;
 use ReflectionClass;
@@ -29,7 +30,7 @@
 
 class Mailable implements MailableContract, Renderable
 {
-    use Conditionable, ForwardsCalls, Localizable, Macroable {
+    use Conditionable, ForwardsCalls, Localizable, Tappable, Macroable {
         __call as macroCall;
     }
 

tests/Mail/MailMailableTest.php

@@ -24,13 +24,7 @@ protected function tearDown(): void
 
     public function testMailableSetsRecipientsCorrectly()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new WelcomeMailableStub;
         $mailable->to('[email protected]');
@@ -114,13 +108,7 @@ public function render()
 
     public function testMailableSetsCcRecipientsCorrectly()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new WelcomeMailableStub;
         $mailable->cc('[email protected]');
@@ -211,13 +199,7 @@ public function render()
 
     public function testMailableSetsBccRecipientsCorrectly()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new WelcomeMailableStub;
         $mailable->bcc('[email protected]');
@@ -308,13 +290,7 @@ public function render()
 
     public function testMailableSetsReplyToCorrectly()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new WelcomeMailableStub;
         $mailable->replyTo('[email protected]');
@@ -394,13 +370,7 @@ public function render()
 
     public function testMailableSetsFromCorrectly()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new WelcomeMailableStub;
         $mailable->from('[email protected]');
@@ -630,13 +600,7 @@ public function testMailablePriorityGetsSent()
 
     public function testMailableMetadataGetsSent()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $view = m::mock(Factory::class);
 
@@ -671,13 +635,7 @@ public function render()
 
     public function testMailableTagGetsSent()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $view = m::mock(Factory::class);
 
@@ -829,13 +787,7 @@ public function toMailAttachment()
 
     public function testHasAttachmentWithEnvelopeAttachments()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
         $mailable = new class extends Mailable
         {
             public function envelope()
@@ -1034,13 +986,7 @@ public function testItCanCheckForStorageBasedAttachments()
 
     public function testAssertHasAttachment()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new class() extends Mailable
         {
@@ -1070,13 +1016,7 @@ public function build()
 
     public function testAssertHasAttachedData()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new class() extends Mailable
         {
@@ -1134,13 +1074,7 @@ public function build()
 
     public function testAssertHasSubject()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new class() extends Mailable
         {
@@ -1194,13 +1128,7 @@ public function testMailableHeadersGetSent()
 
     public function testMailableAttributesInBuild()
     {
-        Container::getInstance()->instance('mailer', new class
-        {
-            public function render()
-            {
-                //
-            }
-        });
+        $this->stubMailer();
 
         $mailable = new class() extends Mailable
         {
@@ -1227,6 +1155,32 @@ public function build()
         $mailable->assertHasMetadata('user_id', 1);
         $mailable->assertHasSubject('test subject');
     }
+
+    public function testMailablesCanBeTapped()
+    {
+        $this->stubMailer();
+
+        $mail = new WelcomeMailableStub;
+
+        $mail->tap(fn ($mailable) => $mailable->to('[email protected]', 'Taylor Otwell'));
+        $mail->tap(fn ($mailable) => $mailable->subject('Test Subject!'));
+
+        $mail->tap(function ($mailable) {
+            $mailable->assertTo('[email protected]')
+                ->assertHasSubject('Test Subject!');
+        });
+    }
+
+    protected function stubMailer()
+    {
+        Container::getInstance()->instance('mailer', new class
+        {
+            public function render()
+            {
+                //
+            }
+        });
+    }
 }
 
 class MailableHeadersStub extends Mailable