Merge pull request #113 from RonasIT/93-add-exception-for-invalid-documentation-viewer

feat: add exception for invalid documentation_viewer configuration.

Author: DenTray

src/Exceptions/UnsupportedDocumentationViewerException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Exceptions;
+
+use Exception;
+
+class UnsupportedDocumentationViewerException extends Exception
+{
+    public function __construct(string $invalidViewer)
+    {
+        parent::__construct(
+            "The documentation viewer '{$invalidViewer}' does not exists."
+             . " Please check that the 'documentation_viewer' key of your auto-doc.php config has one of valid values."
+        );
+    }
+}

src/Services/SwaggerService.php

@@ -15,6 +15,7 @@
 use RonasIT\Support\AutoDoc\Exceptions\LegacyConfigException;
 use RonasIT\Support\AutoDoc\Exceptions\SpecValidation\InvalidSwaggerSpecException;
 use RonasIT\Support\AutoDoc\Exceptions\SwaggerDriverClassNotFoundException;
+use RonasIT\Support\AutoDoc\Exceptions\UnsupportedDocumentationViewerException;
 use RonasIT\Support\AutoDoc\Exceptions\WrongSecurityConfigException;
 use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
 use RonasIT\Support\AutoDoc\Traits\GetDependenciesTrait;
@@ -94,6 +95,12 @@ protected function initConfig()
         if (version_compare($packageConfigs['config_version'], $version, '>')) {
             throw new LegacyConfigException();
         }
+
+        $documentationViewer = (string) Arr::get($this->config, 'documentation_viewer');
+
+        if (!view()->exists("auto-doc::documentation-{$documentationViewer}")) {
+            throw new UnsupportedDocumentationViewerException($documentationViewer);
+        }
     }
 
     protected function setDriver()

tests/SwaggerServiceTest.php

@@ -21,6 +21,7 @@
 use RonasIT\Support\AutoDoc\Exceptions\SpecValidation\MissingPathPlaceholderException;
 use RonasIT\Support\AutoDoc\Exceptions\SpecValidation\MissingRefFileException;
 use RonasIT\Support\AutoDoc\Exceptions\SwaggerDriverClassNotFoundException;
+use RonasIT\Support\AutoDoc\Exceptions\UnsupportedDocumentationViewerException;
 use RonasIT\Support\AutoDoc\Exceptions\WrongSecurityConfigException;
 use RonasIT\Support\AutoDoc\Services\SwaggerService;
 use RonasIT\Support\Tests\Support\Mock\TestNotificationSetting;
@@ -649,4 +650,30 @@ public function testAddDataWithoutBoundContract()
 
         $service->addData($request, $response);
     }
+
+    public function testSetInvalidDocumentationViewer()
+    {
+        config(['auto-doc.documentation_viewer' => 'invalid']);
+
+        $this->expectException(UnsupportedDocumentationViewerException::class);
+        $this->expectExceptionMessage(
+            "The documentation viewer 'invalid' does not exists."
+            . " Please check that the 'documentation_viewer' key of your auto-doc.php config has one of valid values."
+        );
+
+        app(SwaggerService::class);
+    }
+
+    public function testSetNullableDocumentationViewer()
+    {
+        config(['auto-doc.documentation_viewer' => null]);
+
+        $this->expectException(UnsupportedDocumentationViewerException::class);
+        $this->expectExceptionMessage(
+            "The documentation viewer '' does not exists."
+            . " Please check that the 'documentation_viewer' key of your auto-doc.php config has one of valid values."
+        );
+
+        app(SwaggerService::class);
+    }
 }