Merge branch '2.1' into dependabot/composer/phpstan/phpstan-phpunit-1.4.0

Author: GSadee

composer.json

@@ -40,7 +40,7 @@
     "require-dev": {
         "matthiasnoback/symfony-dependency-injection-test": "^5.0",
         "phpspec/phpspec": "^7.0",
-        "phpstan/phpstan": "1.11.8",
+        "phpstan/phpstan": "1.12.4",
         "phpstan/phpstan-phpunit": "1.4.0",
         "phpstan/phpstan-webmozart-assert": "1.2.0",
         "phpunit/phpunit": "^10.5",

src/Bundle/Sender/Adapter/SymfonyMailerAdapter.php

@@ -13,6 +13,8 @@
 
 namespace Sylius\Bundle\MailerBundle\Sender\Adapter;
 
+use Egulias\EmailValidator\EmailValidator;
+use Egulias\EmailValidator\Validation\RFCValidation;
 use Sylius\Component\Mailer\Event\EmailSendEvent;
 use Sylius\Component\Mailer\Model\EmailInterface;
 use Sylius\Component\Mailer\Renderer\RenderedEmail;
@@ -99,13 +101,13 @@ private function sendMessage(
         $message = (new Email())
             ->subject($renderedEmail->getSubject())
             ->from(new Address($senderAddress, $senderName))
-            ->to(...$recipients)
+            ->to(...$this->formatRecipients($recipients))
             ->replyTo(...$replyTo)
             ->html($renderedEmail->getBody())
         ;
 
-        $message->addCc(...$ccRecipients);
-        $message->addBcc(...$bccRecipients);
+        $message->addCc(...$this->formatRecipients($ccRecipients));
+        $message->addBcc(...$this->formatRecipients($bccRecipients));
 
         foreach ($attachments as $attachment) {
             $message->attachFromPath($attachment);
@@ -119,4 +121,29 @@ private function sendMessage(
 
         $this->dispatcher?->dispatch($emailSendEvent, SyliusMailerEvents::EMAIL_POST_SEND);
     }
+
+    /**
+     * There are two kinds of recipient array syntax that can be passed to the send method:
+     * - Only email addresses: ['john.doe@mail.com', 'jane.smith@mail.com']
+     * - Email addresses with names: ['john.doe@mail.com' => 'John Doe', 'jane.smith@mail.com' => 'Jane Smith']
+     *
+     * Since Symfony\Mailer requires an instance of Symfony\Component\Mime\Address or a valid email string for each recipient,
+     * we need to transform the recipient array where keys are address and values are name to an array of Address object.
+     */
+    protected function formatRecipients(array $recipients): array
+    {
+        $transformedRecipients = [];
+        $validator = new EmailValidator();
+        foreach ($recipients as $addressOrKey => $nameOrAddress) {
+            if (\is_string($addressOrKey) && $validator->isValid($addressOrKey, new RFCValidation())) {
+                $transformedRecipients[] = new Address($addressOrKey, $nameOrAddress);
+
+                continue;
+            }
+
+            $transformedRecipients[] = $nameOrAddress;
+        }
+
+        return $transformedRecipients;
+    }
 }

src/Component/spec/Sender/SenderSpec.php

@@ -63,6 +63,35 @@ function it_sends_an_email_through_the_adapter(
         $this->send('bar', ['john@example.com'], $data, [], []);
     }
 
+    function it_sends_an_email_and_name_pair_through_the_adapter(
+        EmailInterface $email,
+        EmailProviderInterface $provider,
+        RenderedEmail $renderedEmail,
+        RendererAdapterInterface $rendererAdapter,
+        SenderAdapterInterface $senderAdapter,
+    ): void {
+        $provider->getEmail('bar')->willReturn($email);
+        $email->isEnabled()->willReturn(true);
+        $email->getSenderAddress()->willReturn('sender@example.com');
+        $email->getSenderName()->willReturn('Sender');
+
+        $data = ['foo' => 2];
+
+        $rendererAdapter->render($email, ['foo' => 2])->willReturn($renderedEmail);
+        $senderAdapter->send(
+            ['john@example.com' => 'John Doe'],
+            'sender@example.com',
+            'Sender',
+            $renderedEmail,
+            $email,
+            $data,
+            [],
+            [],
+        )->shouldBeCalled();
+
+        $this->send('bar', ['john@example.com' => 'John Doe'], $data, [], []);
+    }
+
     function it_sends_an_email_with_cc_and_bcc_through_the_adapter(
         EmailInterface $email,
         EmailProviderInterface $provider,
@@ -94,6 +123,37 @@ function it_sends_an_email_with_cc_and_bcc_through_the_adapter(
         $this->send('bar', ['john@example.com'], $data, [], [], ['cc@example.com'], ['bcc@example.com']);
     }
 
+    function it_sends_an_email_with_cc_and_name_pair_and_bcc_and_name_pair_through_the_adapter(
+        EmailInterface $email,
+        EmailProviderInterface $provider,
+        RenderedEmail $renderedEmail,
+        RendererAdapterInterface $rendererAdapter,
+        SenderAdapterInterface $senderAdapter,
+    ): void {
+        $provider->getEmail('bar')->willReturn($email);
+        $email->isEnabled()->willReturn(true);
+        $email->getSenderAddress()->willReturn('sender@example.com');
+        $email->getSenderName()->willReturn('Sender');
+
+        $data = ['foo' => 2];
+
+        $rendererAdapter->render($email, ['foo' => 2])->willReturn($renderedEmail);
+        $senderAdapter->sendWithCC(
+            ['john@example.com'],
+            'sender@example.com',
+            'Sender',
+            $renderedEmail,
+            $email,
+            $data,
+            [],
+            [],
+            ['cc@example.com' => 'CC'],
+            ['bcc@example.com' => 'BCC'],
+        )->shouldBeCalled();
+
+        $this->send('bar', ['john@example.com'], $data, [], [], ['cc@example.com' => 'CC'], ['bcc@example.com' => 'BCC']);
+    }
+
     function it_sends_a_modified_email_with_cc_and_bcc_through_the_adapter(
         EmailInterface $email,
         EmailProviderInterface $provider,