Ensure template keeps working when text or html body are null (#1)

* Ensure template keeps working when text or html body are null

* Add better assertions for message validation with empty bodies

* Updated test expected variable handling

* Fix code style violations

Co-authored-by: kjellknapen <[email protected]>

Author: kjellknapen

src/ValidatedTemplateMessage.php

@@ -14,6 +14,7 @@
 use function gettype;
 use function head;
 use function is_array;
+use function optional;
 
 final class ValidatedTemplateMessage
 {
@@ -52,8 +53,8 @@ private function __construct(
         DynamicResponseModel $suggestedModel
     ) {
         $this->subject = (string) $renderedTemplate['Subject']['RenderedContent'];
-        $this->htmlBody = (string) $renderedTemplate['HtmlBody']['RenderedContent'];
-        $this->textBody = (string) $renderedTemplate['TextBody']['RenderedContent'];
+        $this->htmlBody = (string) optional($renderedTemplate['HtmlBody'])['RenderedContent'];
+        $this->textBody = (string) optional($renderedTemplate['TextBody'])['RenderedContent'];
         $this->renderedTemplate = $renderedTemplate;
 
         $this->parseForValidationErrors($model, $suggestedModel);

src/ValidatedTemplateMessageTest.php

@@ -88,6 +88,77 @@ public function itCanBeConstructedValidTemplateModels(DynamicTemplateModel $temp
         $this->assertFalse($validatedMessage->isInvalid());
     }
 
+    public function emptyBodyModels(): Generator
+    {
+        yield 'Response model with empty text' => [
+            new DynamicResponseModel([
+                'AllContentIsValid' => true,
+                'Subject' => [
+                    'RenderedContent' => $subject = 'Some rendered subject',
+                ],
+                'HtmlBody' => [
+                    'RenderedContent' => $htmlBody = 'Some rendered HTML',
+                ],
+                'TextBody' => null,
+            ]),
+            compact('subject', 'htmlBody') + ['textBody' => ''],
+        ];
+
+        yield 'Response model with empty html' => [
+            new DynamicResponseModel([
+                'AllContentIsValid' => true,
+                'Subject' => [
+                    'RenderedContent' => $subject = 'Some rendered subject',
+                ],
+                'HtmlBody' => null,
+                'TextBody' => [
+                    'RenderedContent' => $textBody = 'Some rendered text',
+                ],
+            ]),
+            compact('subject', 'textBody') + ['htmlBody' => ''],
+        ];
+
+        yield 'Response model with empty html and text' => [
+            new DynamicResponseModel([
+                'AllContentIsValid' => true,
+                'Subject' => [
+                    'RenderedContent' => $subject = 'Some rendered subject',
+                ],
+                'HtmlBody' => null,
+                'TextBody' => null,
+            ]),
+            compact('subject') + ['htmlBody' => '', 'textBody' => ''],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider emptyBodyModels
+     */
+    public function itCanHandleEmptyBodyValues(DynamicResponseModel $renderedTemplate, array $expectations): void
+    {
+        $this->setupFaker();
+        $templateModel = DynamicTemplateModel::fromVariables([
+            'project' => $this->faker->name,
+            'user' => [
+                'email' => $this->faker->email,
+                'name' => $this->faker->firstName,
+                'preferences' => [],
+            ],
+            'list' => [],
+        ]);
+        $suggestedModel = new DynamicResponseModel(self::SUGGESTED_MODEL);
+
+        $validatedMessage = ValidatedTemplateMessage::validate($renderedTemplate, $templateModel, $suggestedModel);
+
+        $this->assertSame($expectations['subject'], $validatedMessage->subject);
+        $this->assertSame($expectations['htmlBody'], $validatedMessage->htmlBody);
+        $this->assertSame($expectations['textBody'], $validatedMessage->textBody);
+        $this->assertEmpty($validatedMessage->missingVariables);
+        $this->assertEmpty($validatedMessage->invalidVariables);
+        $this->assertFalse($validatedMessage->isInvalid());
+    }
+
     public function invalidTemplateModels(): Generator
     {
         $this->setupFaker();