feat: report preview is now rendered using the correct template (#46)

Closes #45

composer.json

@@ -25,7 +25,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.10",
-        "getkirby/cms": "3.6.0-rc.4"
+        "getkirby/cms": "3.6.0-rc.4",
+        "mockery/mockery": "^1.4"
     },
     "scripts": {
         "test": "phpunit --bootstrap tests/bootstrap.php tests"

index.php

@@ -5,6 +5,7 @@
 use Kirby\Cms\Response;
 use KirbyReporter\Model\FormData;
 use KirbyReporter\Report\ReportClient;
+use KirbyReporter\Report\ReportMailTemplateParser;
 use KirbyReporter\Report\ReportTemplateParser;
 use KirbyReporter\Vendor\IssueTracker;
 use KirbyReporter\Vendor\Mail;
@@ -96,10 +97,16 @@
                 'action' => function () {
                     $requestData = kirby()->request()->body()->data();
                     $formData = new FormData($requestData);
-                    if (isset($formData->getFormFields()['description'])) {
+                    if (is_array(option('gearsdigital.reporter-for-kirby.repository'))) {
                         $parsedTemplate = (new class {
                             use ReportTemplateParser;
-                        })->parseTemplate($formData->getFormFields());
+                        })->parseTemplate($formData);
+
+                        return new Response(json_encode(trim($parsedTemplate)), 'application/json');
+                    } elseif ($type = option('gearsdigital.reporter-for-kirby.mail.type')) {
+                        $parsedTemplate = (new class {
+                            use ReportMailTemplateParser;
+                        })->parseTemplate($formData, $type ?? 'text');
 
                         return new Response(json_encode(trim($parsedTemplate)), 'application/json');
                     }

lib/Report/ReportClient.php

@@ -53,6 +53,6 @@ public final function createReport(FormData $formData): ReportResponse
 
         // we need to parse the reporer template first because we need to send a plain 'string'
         // to external APIs
-        return $this->client->report($formData, $this->parseTemplate($formData->getFormFields()));
+        return $this->client->report($formData, $this->parseTemplate($formData));
     }
 }

lib/Report/ReportMailTemplateParser.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace KirbyReporter\Report;
+
+use Kirby\Toolkit\Tpl;
+use KirbyReporter\Model\FormData;
+
+trait ReportMailTemplateParser
+{
+    private string $pluginName = 'gearsdigital/reporter-for-kirby';
+
+    public function parseTemplate(FormData $formData, string $type): string
+    {
+        return Tpl::load($this->getReportTemplate($type), ['title' => $formData->getTitle(), 'fields' => $formData->getFormFields()]);
+    }
+
+    private function getReportTemplate(string $type): string
+    {
+        $template = "report.${type}.php";
+        $templateRoot = kirby()->root('templates').DS."emails";
+        $pluginRoot = kirby()->plugin($this->pluginName);
+        $templatePath = file_exists($templateRoot.DS.$template) ? $templateRoot : $pluginRoot->root().DS."templates/emails";
+
+        return $templatePath.DS."$template";
+    }
+}

lib/Report/ReportTemplateParser.php

@@ -3,14 +3,15 @@
 namespace KirbyReporter\Report;
 
 use Kirby\Toolkit\Tpl;
+use KirbyReporter\Model\FormData;
 
 trait ReportTemplateParser
 {
     private string $pluginName = 'gearsdigital/reporter-for-kirby';
 
-    public function parseTemplate(array $templateData): string
+    public function parseTemplate(FormData $formData): string
     {
-        return Tpl::load($this->getReportTemplate(), ['fields' => $templateData]);
+        return Tpl::load($this->getReportTemplate(), ['title' => $formData->getTitle(), 'fields' => $formData->getFormFields()]);
     }
 
     private function getReportTemplate(): string

templates/emails/report.html.php

@@ -1,7 +1,7 @@
 Issue Report from "<?= site()->title() ?? ''; ?>" by <?= kirby()->user()->nameOrEmail() ?? ''; ?>
 
 ---
-<?= $title ?? ''; ?>
+<b><?= $title ?? ''; ?></b>
 
 ---
 <?= $fields['description'] ?? ''; ?>

tests/Traits/ReportMailTemplateParserTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace KirbyReporter\Traits;
+
+use Kirby\Toolkit\Tpl;
+use KirbyReporter\Model\FormData;
+use KirbyReporter\Report\ReportMailTemplateParser;
+use Mockery;
+use Mockery\Adapter\Phpunit\MockeryTestCase;
+
+class ReportMailTemplateParserTest extends MockeryTestCase
+{
+
+    private array $formData = [
+        'title' => 'Lorem',
+        'formFields' => [
+            'description' => 'Test',
+        ],
+    ];
+
+    public function test_parse_report_mail_text_template(): void
+    {
+        $mock = Mockery::mock('alias:'.Tpl::class);
+        $mock->shouldReceive('load')->andReturn('my-loaded-text-template');
+
+        $formData = new FormData($this->formData);
+        $parser = $this->getObjectForTrait(ReportMailTemplateParser::class);
+        $parsedTemplate = $parser->parseTemplate($formData, 'text');
+
+        $this->assertTrue(is_string($parsedTemplate));
+        $this->assertEquals('my-loaded-text-template', $parsedTemplate);
+    }
+
+    public function test_parse_report_mail_html_template(): void
+    {
+        $mock = Mockery::mock('alias:'.Tpl::class);
+        $mock->shouldReceive('load')->andReturn('my-loaded-html-template');
+
+        $formData = new FormData($this->formData);
+        $parser = $this->getObjectForTrait(ReportMailTemplateParser::class);
+        $parsedTemplate = $parser->parseTemplate($formData, 'html');
+
+        $this->assertTrue(is_string($parsedTemplate));
+        $this->assertEquals('my-loaded-html-template', $parsedTemplate);
+    }
+
+}