fix: resolved review conversations;

Return removed SwaggerDriverInterface.

Author: vitgrams

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\Drivers\BaseDriver` class,
+    | `RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface` interface,
     | or one of our drivers from the `drivers` config:
     */
     'driver' => env('SWAGGER_DRIVER', 'local'),

src/Drivers/BaseDriver.php

@@ -2,10 +2,17 @@
 
 namespace RonasIT\Support\AutoDoc\Drivers;
 
-abstract class BaseDriver
+use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
+
+abstract class BaseDriver implements SwaggerDriverInterface
 {
     protected $tempFilePath;
 
+    public function __construct()
+    {
+        $this->tempFilePath = storage_path('temp_documentation.json');
+    }
+
     public function saveTmpData($data): void
     {
         file_put_contents($this->tempFilePath, json_encode($data));
@@ -22,7 +29,10 @@ public function getTmpData(): ?array
         return null;
     }
 
-    abstract public function saveData(): void;
-
-    abstract public function getDocumentation(): array;
+    protected function clearTmpData(): void
+    {
+        if (file_exists($this->tempFilePath)) {
+            unlink($this->tempFilePath);
+        }
+    }
 }

src/Drivers/LocalDriver.php

@@ -11,8 +11,9 @@ class LocalDriver extends BaseDriver
 
     public function __construct()
     {
+        parent::__construct();
+
         $this->prodFilePath = config('auto-doc.drivers.local.production_path');
-        $this->tempFilePath = storage_path('temp_documentation.json');
 
         if (empty($this->prodFilePath)) {
             throw new MissedProductionFilePathException();
@@ -23,9 +24,7 @@ public function saveData(): void
     {
         file_put_contents($this->prodFilePath, json_encode($this->getTmpData()));
 
-        if (file_exists($this->tempFilePath)) {
-            unlink($this->tempFilePath);
-        }
+        $this->clearTmpData();
     }
 
     public function getDocumentation(): array

src/Drivers/RemoteDriver.php

@@ -12,9 +12,10 @@ class RemoteDriver extends BaseDriver
 
     public function __construct()
     {
+        parent::__construct();
+
         $this->key = config('auto-doc.drivers.remote.key');
         $this->remoteUrl = config('auto-doc.drivers.remote.url');
-        $this->tempFilePath = storage_path('temp_documentation.json');
 
         if (empty($this->remoteUrl)) {
             throw new MissedRemoteDocumentationUrlException();
@@ -27,9 +28,7 @@ public function saveData(): void
             'Content-Type: application/json'
         ]);
 
-        if (file_exists($this->tempFilePath)) {
-            unlink($this->tempFilePath);
-        }
+        $this->clearTmpData();
     }
 
     public function getDocumentation(): array

src/Drivers/StorageDriver.php

@@ -13,9 +13,10 @@ class StorageDriver extends BaseDriver
 
     public function __construct()
     {
+        parent::__construct();
+
         $this->disk = Storage::disk(config('auto-doc.drivers.storage.disk'));
         $this->prodFilePath = config('auto-doc.drivers.storage.production_path');
-        $this->tempFilePath = storage_path('temp_documentation.json');
 
         if (empty($this->prodFilePath)) {
             throw new MissedProductionFilePathException();
@@ -26,9 +27,7 @@ public function saveData(): void
     {
         $this->disk->put($this->prodFilePath, json_encode($this->getTmpData()));
 
-        if (file_exists($this->tempFilePath)) {
-            unlink($this->tempFilePath);
-        }
+        $this->clearTmpData();
     }
 
     public function getDocumentation(): array

src/Interfaces/SwaggerDriverInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Interfaces;
+
+interface SwaggerDriverInterface
+{
+    /**
+     * Save temporary data
+     *
+     * @param array $data
+     */
+    public function saveTmpData($data);
+
+    /**
+     * Get temporary data
+     */
+    public function getTmpData();
+
+    /**
+     * Save production data
+     */
+    public function saveData();
+
+    /**
+     * Get production documentation
+     */
+    public function getDocumentation(): array;
+}

src/Services/SwaggerService.php

@@ -3,21 +3,21 @@
 namespace RonasIT\Support\AutoDoc\Services;
 
 use Illuminate\Container\Container;
+use Illuminate\Http\Request;
 use Illuminate\Http\Testing\File;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use ReflectionClass;
-use Illuminate\Http\Request;
-use RonasIT\Support\AutoDoc\Drivers\BaseDriver;
+use RonasIT\Support\AutoDoc\Exceptions\InvalidDriverClassException;
 use RonasIT\Support\AutoDoc\Exceptions\LegacyConfigException;
+use RonasIT\Support\AutoDoc\Exceptions\SwaggerDriverClassNotFoundException;
 use RonasIT\Support\AutoDoc\Exceptions\WrongSecurityConfigException;
+use RonasIT\Support\AutoDoc\Interfaces\SwaggerDriverInterface;
 use RonasIT\Support\AutoDoc\Traits\GetDependenciesTrait;
 use Symfony\Component\HttpFoundation\Response;
-use RonasIT\Support\AutoDoc\Exceptions\InvalidDriverClassException;
-use RonasIT\Support\AutoDoc\Exceptions\SwaggerDriverClassNotFoundException;
 
 /**
- * @property BaseDriver $driver
+ * @property SwaggerDriverInterface $driver
  */
 class SwaggerService
 {
@@ -97,7 +97,7 @@ protected function setDriver()
             $this->driver = app($className);
         }
 
-        if (!$this->driver instanceof BaseDriver) {
+        if (!$this->driver instanceof SwaggerDriverInterface) {
             throw new InvalidDriverClassException($driver);
         }
     }
@@ -653,7 +653,7 @@ public function getDocFileContent()
             $paths = array_keys($fileContent['paths']);
 
             foreach ($paths as $path) {
-                $additionalDocPath =  $fileContent['paths'][$path];
+                $additionalDocPath = $fileContent['paths'][$path];
 
                 if (empty($documentation['paths'][$path])) {
                     $documentation['paths'][$path] = $additionalDocPath;