Cleanup

terminal42 · Sep 17, 2024 · 2aab579 · 2aab579
1 parent 1af134f
commit 2aab579
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 4 deletions.
diff --git a/src/Parcel/Stamp/Mailer/EmailStamp.php b/src/Parcel/Stamp/Mailer/EmailStamp.php
@@ -34,6 +34,9 @@ class EmailStamp implements StampInterface
      */
     private array $attachmentVouchers = [];
 
+    /**
+     * @var array<string>
+     */
     private array $embeddedImageVouchers = [];
 
     public function withFromName(string $fromName): self
@@ -108,6 +111,9 @@ public function withHtml(string $html): self
         return $clone;
     }
 
+    /**
+     * @return array<string>
+     */
     public function getEmbeddedImageVouchers(): array
     {
         return $this->embeddedImageVouchers;

diff --git a/tests/BulkyItem/InMemoryDbafs.php b/tests/BulkyItem/InMemoryDbafs.php
@@ -11,8 +11,14 @@
 
 class InMemoryDbafs implements DbafsInterface
 {
+    /**
+     * @var array<string, FilesystemItem>
+     */
     private array $records = [];
 
+    /**
+     * @var array<string, array<mixed>>
+     */
     private array $meta = [];
 
     public function getPathFromUuid(Uuid $uuid): string|null

diff --git a/tests/BulkyItem/VirtualFilesystemCollection.php b/tests/BulkyItem/VirtualFilesystemCollection.php
@@ -8,6 +8,9 @@
 
 class VirtualFilesystemCollection
 {
+    /**
+     * @param array<string, VirtualFilesystem> $vfs
+     */
     public function __construct(private array $vfs = [])
     {
     }

diff --git a/tests/EventListener/AdminEmailTokenListenerTest.php b/tests/EventListener/AdminEmailTokenListenerTest.php
@@ -8,7 +8,6 @@
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\PageModel;
 use Contao\TestCase\ContaoTestCase;
-use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Terminal42\NotificationCenterBundle\Config\MessageConfig;
@@ -48,7 +47,10 @@ public function testAddsAdminTokens(string $configFriendlyEmail, string $pageFri
         $this->assertSame($expectedEmail, $tokenCollection->getByName('admin_email')->getValue());
     }
 
-    public static function adminEmailProvider(): \Generator
+    /**
+     * @return iterable<array{0: string, 1: string, 2: string, 3: string}>
+     */
+    public static function adminEmailProvider(): iterable
     {
         yield 'Basic admin email in config' => [
             'foobar-config@terminal42.ch',

diff --git a/tests/Gateway/MailerGatewayTest.php b/tests/Gateway/MailerGatewayTest.php
@@ -34,6 +34,9 @@ class MailerGatewayTest extends ContaoTestCase
 {
     /**
      * @dataProvider embeddingHtmlImagesProvider
+     *
+     * @param array<string, string> $mockFiles
+     * @param array<string, string> $expectedAttachmentsContentsAndPath
      */
     public function testEmbeddingHtmlImages(string $parsedTemplateHtml, array $mockFiles, array $expectedAttachmentsContentsAndPath): void
     {
@@ -80,7 +83,7 @@ static function (Email $email) use ($parsedTemplateHtml, $expectedAttachmentsCon
         $parcel = $parcel->withStamp(new TokenCollectionStamp($tokenCollection));
 
         $gateway = new MailerGateway(
-            $this->createFrameWorkWithTemplate('mail_default', $parsedTemplateHtml),
+            $this->createFrameWorkWithTemplate($parsedTemplateHtml),
             $vfsCollection->get('files'),
             $mailer,
         );
@@ -93,6 +96,9 @@ static function (Email $email) use ($parsedTemplateHtml, $expectedAttachmentsCon
         $gateway->sendParcel($parcel);
     }
 
+    /**
+     * @return iterable<array{0: string, 1: array<string, string>, 2: array<string, string>}>
+     */
     public static function embeddingHtmlImagesProvider(): iterable
     {
         yield 'Test embeds a relative upload path' => [
@@ -135,7 +141,7 @@ private function createVfsCollection(): VirtualFilesystemCollection
         return $vfsCollection;
     }
 
-    private function createFrameWorkWithTemplate(string $templateName, string $parsedTemplateHtml): ContaoFramework
+    private function createFrameWorkWithTemplate(string $parsedTemplateHtml): ContaoFramework
     {
         $controllerAdapter = $this->mockAdapter(['convertRelativeUrls']);
         $controllerAdapter

diff --git a/tests/Token/TokenTest.php b/tests/Token/TokenTest.php
@@ -31,6 +31,9 @@ public function testArrayParserFormat(array $value, string $expectedParserValue)
         $this->assertSame($expectedParserValue, $token->getParserValue());
     }
 
+    /**
+     * @return iterable<array{0: array<mixed>, 1: string}>
+     */
     public static function arrayProvider(): iterable
     {
         yield 'Simple list array token' => [
@@ -65,6 +68,9 @@ public static function arrayProvider(): iterable
         ];
     }
 
+    /**
+     * @return iterable<array{0: mixed, 1: string}>
+     */
     public static function anythingProvider(): iterable
     {
         yield [