refactor: remove tightly coupled template parser from report client (#36

)
gearsdigital · Oct 31, 2021 · 7939f94 · 7939f94
1 parent 9ce5787
commit 7939f94
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 22 deletions.
diff --git a/lib/Client/BitbucketReport.php b/lib/Client/BitbucketReport.php
@@ -5,7 +5,6 @@
 use KirbyReporter\Model\FormData;
 use KirbyReporter\Report\ReportInterface;
 use KirbyReporter\Report\ReportResponse;
-use KirbyReporter\Report\ReportTemplateParser;
 use KirbyReporter\Traits\Expander;
 use KirbyReporter\Traits\Request;
 use KirbyReporter\Vendor\Vendor;
@@ -14,7 +13,6 @@ class BitbucketReport implements ReportInterface
 {
     use Request;
     use Expander;
-    use ReportTemplateParser;
 
     private string $urlTemplate = "https://api.bitbucket.org/2.0/repositories/{user}/{repo}/issues";
 
@@ -25,7 +23,7 @@ public function __construct(Vendor $vendor)
         $this->vendor = $vendor;
     }
 
-    public final function report(FormData $reportData): ReportResponse
+    public final function report(FormData $reportData, string $parsedTemplate): ReportResponse
     {
         $url = $this->expandUrl($this->urlTemplate, [
             "user" => $this->vendor->getOwner(),
@@ -34,7 +32,7 @@ public final function report(FormData $reportData): ReportResponse
 
         $reportData = [
             "title" => $reportData->getTitle(),
-            "description" => $this->parseTemplate($reportData->getFormFields()),
+            "description" => $parsedTemplate,
         ];
 
         $header = ["Authorization" => "Basic ".$this->getBasicAuth()];

diff --git a/lib/Client/GithubReport.php b/lib/Client/GithubReport.php
@@ -5,7 +5,6 @@
 use KirbyReporter\Model\FormData;
 use KirbyReporter\Report\ReportInterface;
 use KirbyReporter\Report\ReportResponse;
-use KirbyReporter\Report\ReportTemplateParser;
 use KirbyReporter\Traits\Expander;
 use KirbyReporter\Traits\Request;
 use KirbyReporter\Vendor\Vendor;
@@ -14,7 +13,6 @@ class GithubReport implements ReportInterface
 {
     use Request;
     use Expander;
-    use ReportTemplateParser;
 
     private string $urlTemplate = "https://api.github.com/repos/{user}/{repo}/issues";
 
@@ -25,7 +23,7 @@ public function __construct(Vendor $vendor)
         $this->vendor = $vendor;
     }
 
-    public final function report(FormData $reportData): ReportResponse
+    public final function report(FormData $reportData, string $parsedTemplate): ReportResponse
     {
         $url = $this->expandUrl($this->urlTemplate, [
             "user" => $this->vendor->getOwner(),
@@ -34,7 +32,7 @@ public final function report(FormData $reportData): ReportResponse
 
         $reportData = [
             "title" => $reportData->getTitle(),
-            "body" =>  $this->parseTemplate($reportData->getFormFields()),
+            "body" => $parsedTemplate,
         ];
 
         $header = ["Authorization" => "token ".$this->vendor->getToken()];

diff --git a/lib/Client/GitlabReport.php b/lib/Client/GitlabReport.php
@@ -5,7 +5,6 @@
 use KirbyReporter\Model\FormData;
 use KirbyReporter\Report\ReportInterface;
 use KirbyReporter\Report\ReportResponse;
-use KirbyReporter\Report\ReportTemplateParser;
 use KirbyReporter\Traits\Expander;
 use KirbyReporter\Traits\Request;
 use KirbyReporter\Vendor\Vendor;
@@ -14,7 +13,6 @@ class GitlabReport implements ReportInterface
 {
     use Request;
     use Expander;
-    use ReportTemplateParser;
 
     private string $urlTemplate = "https://gitlab.com/api/v4/projects/{user}%2F{repo}/issues";
 
@@ -25,7 +23,7 @@ public function __construct(Vendor $vendor)
         $this->vendor = $vendor;
     }
 
-    public final function report(FormData $reportData): ReportResponse
+    public final function report(FormData $reportData, string $parsedTemplate): ReportResponse
     {
         $url = $this->expandUrl($this->urlTemplate, [
             "user" => $this->vendor->getOwner(),
@@ -34,7 +32,7 @@ public final function report(FormData $reportData): ReportResponse
 
         $reportData = [
             "title" => $reportData->getTitle(),
-            "description" => $this->parseTemplate($reportData->getFormFields()),
+            "description" => $parsedTemplate,
         ];
 
         $header = ["Private-Token" => $this->vendor->getToken()];

diff --git a/lib/Report/ReportClient.php b/lib/Report/ReportClient.php
@@ -16,6 +16,8 @@
  */
 class ReportClient
 {
+    use ReportTemplateParser;
+
     /**
      * @var BitbucketReport|GithubReport|GitlabReport
      */
@@ -38,6 +40,8 @@ public function __construct(Vendor $vendor)
 
     public final function createReport(FormData $formData): ReportResponse
     {
-        return $this->client->report($formData);
+        $parsedTemplate = $this->parseTemplate($formData->getFormFields());
+
+        return $this->client->report($formData, $parsedTemplate);
     }
 }
diff --git a/lib/Report/ReportInterface.php b/lib/Report/ReportInterface.php
@@ -10,5 +10,5 @@
  */
 interface ReportInterface
 {
-    public function report(FormData $reportData): ReportResponse;
+    public function report(FormData $reportData, string $parsedTemplate): ReportResponse;
 }
diff --git a/tests/Client/BitbucketReportTest.php b/tests/Client/BitbucketReportTest.php
@@ -50,7 +50,7 @@ public function test_should_send_form_data_to_bitbucket_api()
                 'description' => 'Test',
             ],
         ]);
-        $response = $reporter->report($formData);
+        $response = $reporter->report($formData, 'parsedTemplate');
 
         // request
         $this->assertEquals("/2.0/repositories/test/test-repo/issues", $mock->getLastRequest()->getUri()->getPath());

diff --git a/tests/Client/GithubReportTest.php b/tests/Client/GithubReportTest.php
@@ -43,7 +43,7 @@ public function test_should_send_form_data_to_gitlab_api()
                 'description' => 'Test',
             ],
         ]);
-        $response = $reporter->report($formData);
+        $response = $reporter->report($formData, 'parsedTemplate');
 
         // request
         $this->assertEquals("/repos/test/test-repo/issues", $mock->getLastRequest()->getUri()->getPath());

diff --git a/tests/Client/GitlabReportTest.php b/tests/Client/GitlabReportTest.php
@@ -43,7 +43,7 @@ public function test_should_send_form_data_to_gitlab_api()
                 'description' => 'Test',
             ],
         ]);
-        $response = $reporter->report($formData);
+        $response = $reporter->report($formData, 'parsedTemplate');
 
         // request
         $this->assertEquals("/api/v4/projects/test%2Ftest-repo/issues", $mock->getLastRequest()->getUri()->getPath());

diff --git a/tests/Report/ReportClientTest.php b/tests/Report/ReportClientTest.php
@@ -4,8 +4,6 @@
  * @noinspection MethodShouldBeFinalInspection
  */
 
-namespace KirbyReporter\Mixins;
-
 use GuzzleHttp\Client;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
@@ -98,7 +96,7 @@ private function test_exeption(int $code, string $message)
         $this->expectExceptionMessage($message);
         $this->expectExceptionCode($code);
 
-        $reporter->report($formData);
+        $reporter->report($formData, 'parsedTemplate');
     }
 }
 
diff --git a/tests/Vendor/VendorTest.php b/tests/Vendor/VendorTest.php
@@ -4,8 +4,6 @@
  * @noinspection MethodShouldBeFinalInspection
  */
 
-namespace KirbyReporter\Mixins;
-
 use KirbyReporter\Exception\OptionNotFoundException;
 use KirbyReporter\Exception\UnsupportedPlatformException;
 use KirbyReporter\Vendor\Vendor;