fix: replaced SwaggerDriverInterface with abstract BaseDriver class, added MissedRemoteDocumentationUrlException

Abstract BaseDriver has been added to unify saveTmpData, getTmpData methods semantic.

Author: vitgrams

composer.json

@@ -18,7 +18,7 @@
   "require": {
     "php": ">=7.3.0",
     "laravel/framework": ">=5.3.0",
-    "phpunit/phpunit": ">=7.0|<10.0"
+    "phpunit/phpunit": ">=7.0"
   },
   "require-dev": {
     "orchestra/testbench": "^6.25",

config/auto-doc.php

@@ -100,7 +100,7 @@
     |
     | The name of driver, which will collect and save documentation
     | Feel free to use your own driver class which should be inherited from
-    | `RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface` interface,
+    | `RonasIT\Support\AutoDoc\Drivers\BaseDriver` class,
     | or one of our drivers from the `drivers` config:
     */
     'driver' => env('SWAGGER_DRIVER', 'local'),

src/Drivers/BaseDriver.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Drivers;
+
+abstract class BaseDriver
+{
+    protected $tempFilePath;
+
+    public function saveTmpData($data)
+    {
+        file_put_contents($this->tempFilePath, json_encode($data));
+    }
+
+    public function getTmpData()
+    {
+        if (file_exists($this->tempFilePath)) {
+            $content = file_get_contents($this->tempFilePath);
+
+            return json_decode($content, true);
+        }
+
+        return null;
+    }
+
+    abstract public function saveData(): void;
+
+    abstract public function getDocumentation(): array;
+}

src/Drivers/LocalDriver.php

@@ -3,41 +3,23 @@
 namespace RonasIT\Support\AutoDoc\Drivers;
 
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
-use RonasIT\Support\AutoDoc\Exceptions\MissedProductionFilePathException;
-use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
+use RonasIT\Support\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
 
-class LocalDriver implements SwaggerDriverInterface
+class LocalDriver extends BaseDriver
 {
     protected $prodFilePath;
-    protected $tempFilePath;
 
     public function __construct()
     {
         $this->prodFilePath = config('auto-doc.drivers.local.production_path');
         $this->tempFilePath = storage_path('temp_documentation.json');
 
         if (empty($this->prodFilePath)) {
-            throw new MissedProductionFilePathException();
+            throw new MissedRemoteDocumentationUrlException();
         }
     }
 
-    public function saveTmpData($data)
-    {
-        file_put_contents($this->tempFilePath, json_encode($data));
-    }
-
-    public function getTmpData()
-    {
-        if (file_exists($this->tempFilePath)) {
-            $content = file_get_contents($this->tempFilePath);
-
-            return json_decode($content, true);
-        }
-
-        return null;
-    }
-
-    public function saveData()
+    public function saveData(): void
     {
         file_put_contents($this->prodFilePath, json_encode($this->getTmpData()));
 

src/Drivers/RemoteDriver.php

@@ -3,38 +3,25 @@
 namespace RonasIT\Support\AutoDoc\Drivers;
 
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
-use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
+use RonasIT\Support\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
 
-class RemoteDriver implements SwaggerDriverInterface
+class RemoteDriver extends BaseDriver
 {
     protected $key;
     protected $remoteUrl;
-    protected $tempFilePath;
 
     public function __construct()
     {
         $this->key = config('auto-doc.drivers.remote.key');
         $this->remoteUrl = config('auto-doc.drivers.remote.url');
         $this->tempFilePath = storage_path('temp_documentation.json');
-    }
-
-    public function saveTmpData($data)
-    {
-        file_put_contents($this->tempFilePath, json_encode($data));
-    }
 
-    public function getTmpData()
-    {
-        if (file_exists($this->tempFilePath)) {
-            $content = file_get_contents($this->tempFilePath);
-
-            return json_decode($content, true);
+        if (empty($this->remoteUrl)) {
+            throw new MissedRemoteDocumentationUrlException();
         }
-
-        return null;
     }
 
-    public function saveData()
+    public function saveData(): void
     {
         $this->makeHttpRequest('post', $this->getUrl(), $this->getTmpData(), [
             'Content-Type: application/json'
@@ -64,7 +51,7 @@ protected function getUrl(): string
     /**
      * @codeCoverageIgnore
      */
-    protected function makeHttpRequest($type, $url, $data = [], $headers = [])
+    protected function makeHttpRequest($type, $url, $data = [], $headers = []): array
     {
         $curl = curl_init();
 

src/Drivers/StorageDriver.php

@@ -4,14 +4,12 @@
 
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Illuminate\Support\Facades\Storage;
-use RonasIT\Support\AutoDoc\Exceptions\MissedProductionFilePathException;
-use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
+use RonasIT\Support\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
 
-class StorageDriver implements SwaggerDriverInterface
+class StorageDriver extends BaseDriver
 {
     protected $disk;
     protected $prodFilePath;
-    protected $tempFilePath;
 
     public function __construct()
     {
@@ -20,27 +18,11 @@ public function __construct()
         $this->tempFilePath = storage_path('temp_documentation.json');
 
         if (empty($this->prodFilePath)) {
-            throw new MissedProductionFilePathException();
+            throw new MissedRemoteDocumentationUrlException();
         }
     }
 
-    public function saveTmpData($data)
-    {
-        file_put_contents($this->tempFilePath, json_encode($data));
-    }
-
-    public function getTmpData()
-    {
-        if (file_exists($this->tempFilePath)) {
-            $content = file_get_contents($this->tempFilePath);
-
-            return json_decode($content, true);
-        }
-
-        return null;
-    }
-
-    public function saveData()
+    public function saveData(): void
     {
         $this->disk->put($this->prodFilePath, json_encode($this->getTmpData()));
 

src/Exceptions/InvalidDriverClassException.php

@@ -8,6 +8,6 @@ class InvalidDriverClassException extends Exception
 {
     public function __construct(string $driver)
     {
-        parent::__construct("The driver '{$driver}' is not implements the SwaggerDriverInterface.");
+        parent::__construct("The driver '{$driver}' does not extend the BaseDriver class.");
     }
 }

src/Exceptions/MissedRemoteDocumentationUrlException.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Exceptions;
+
+use Exception;
+
+class MissedRemoteDocumentationUrlException extends Exception
+{
+    public function __construct($message = null, $code = 0, Exception $previous = null)
+    {
+        $message = $message ?? 'Remote documentation url missed in config';
+
+        parent::__construct($message, $code, $previous);
+    }
+}

src/Interfaces/SwaggerDriverInterface.php

@@ -8,16 +8,16 @@
 use Illuminate\Support\Str;
 use ReflectionClass;
 use Illuminate\Http\Request;
+use RonasIT\Support\AutoDoc\Drivers\BaseDriver;
 use RonasIT\Support\AutoDoc\Exceptions\LegacyConfigException;
 use RonasIT\Support\AutoDoc\Exceptions\WrongSecurityConfigException;
 use RonasIT\Support\AutoDoc\Traits\GetDependenciesTrait;
 use Symfony\Component\HttpFoundation\Response;
-use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
 use RonasIT\Support\AutoDoc\Exceptions\InvalidDriverClassException;
 use RonasIT\Support\AutoDoc\Exceptions\SwaggerDriverClassNotFoundException;
 
 /**
- * @property SwaggerDriverInterface $driver
+ * @property BaseDriver $driver
  */
 class SwaggerService
 {
@@ -97,7 +97,7 @@ protected function setDriver()
             $this->driver = app($className);
         }
 
-        if (!$this->driver instanceof SwaggerDriverInterface) {
+        if (!$this->driver instanceof BaseDriver) {
             throw new InvalidDriverClassException($driver);
         }
     }