Clean up GroupedEndpoints factory

knuckleswtf · Jul 5, 2021 · bfeaddb · bfeaddb
1 parent 30e4850
commit bfeaddb
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 30 deletions.
diff --git a/camel/Camel.php b/camel/Camel.php
@@ -20,6 +20,8 @@ class Camel
      * @var array<string, string>
      */
     public static array $groupFileNames = [];
+    public static string $cacheDir = ".scribe/endpoints.cache";
+    public static string $camelDir = ".scribe/endpoints";
 
     /**
      * Load endpoints from the Camel files into groups (arrays).

diff --git a/src/Commands/GenerateDocumentation.php b/src/Commands/GenerateDocumentation.php
@@ -5,21 +5,14 @@
 use Illuminate\Console\Command;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\URL;
-use Illuminate\Support\Str;
 use Knuckles\Camel\Camel;
-use Knuckles\Camel\Extraction\ExtractedEndpointData;
 use Knuckles\Camel\Output\OutputEndpointData;
-use Knuckles\Scribe\Extracting\ApiDetails;
-use Knuckles\Scribe\Extracting\Extractor;
 use Knuckles\Scribe\GroupedEndpoints\GroupedEndpointsFactory;
 use Knuckles\Scribe\Matching\RouteMatcherInterface;
 use Knuckles\Scribe\Tools\ConsoleOutputUtils as c;
 use Knuckles\Scribe\Tools\DocumentationConfig;
-use Knuckles\Scribe\Tools\ErrorHandlingUtils as e;
 use Knuckles\Scribe\Tools\Globals;
-use Knuckles\Scribe\Tools\Utils;
 use Knuckles\Scribe\Writing\Writer;
-use Symfony\Component\Yaml\Yaml;
 
 class GenerateDocumentation extends Command
 {
@@ -32,9 +25,6 @@ class GenerateDocumentation extends Command
 
     private DocumentationConfig $docConfig;
 
-    public static string $camelDir = ".scribe/endpoints";
-    public static string $cacheDir = ".scribe/endpoints.cache";
-
     private bool $shouldExtract;
 
     private bool $forcing;
@@ -47,7 +37,7 @@ public function handle(RouteMatcherInterface $routeMatcher, GroupedEndpointsFact
 
         $groupedEndpoints = $this->mergeUserDefinedEndpoints(
             $groupedEndpointsInstance->get(),
-            Camel::loadUserDefinedEndpoints(static::$camelDir)
+            Camel::loadUserDefinedEndpoints(Camel::$camelDir)
         );
 
         $writer = new Writer($this->docConfig);
@@ -69,7 +59,7 @@ public function shouldExtract(): bool
         return $this->shouldExtract;
     }
 
-    public function getDocConfig()
+    public function getDocConfig(): DocumentationConfig
     {
         return $this->docConfig;
     }
@@ -94,6 +84,7 @@ public function bootstrap(): void
             throw new \Exception("Can't use --force and --no-extraction together.");
         }
 
+        // Reset this map useful for tests)
         Camel::$groupFileNames = [];
     }
 

diff --git a/src/GroupedEndpoints/GroupedEndpointsFactory.php b/src/GroupedEndpoints/GroupedEndpointsFactory.php
@@ -8,7 +8,7 @@
 
 class GroupedEndpointsFactory
 {
-    public static function make(GenerateDocumentation $command, RouteMatcherInterface $routeMatcher): GroupedEndpointsContract
+    public function make(GenerateDocumentation $command, RouteMatcherInterface $routeMatcher): GroupedEndpointsContract
     {
         if ($command->isForcing()) {
             return new GroupedEndpointsFromApp($command, $routeMatcher, false);

diff --git a/src/GroupedEndpoints/GroupedEndpointsFromApp.php b/src/GroupedEndpoints/GroupedEndpointsFromApp.php
@@ -13,6 +13,7 @@
 use Knuckles\Scribe\Matching\MatchedRoute;
 use Knuckles\Scribe\Matching\RouteMatcherInterface;
 use Knuckles\Scribe\Tools\ConsoleOutputUtils as c;
+use Knuckles\Scribe\Tools\DocumentationConfig;
 use Knuckles\Scribe\Tools\ErrorHandlingUtils as e;
 use Knuckles\Scribe\Tools\Utils as u;
 use Knuckles\Scribe\Tools\Utils;
@@ -23,10 +24,10 @@
 
 class GroupedEndpointsFromApp implements GroupedEndpointsContract
 {
-    private $command;
-    private $routeMatcher;
-    private $docConfig;
-    private $preserveUserChanges;
+    private GenerateDocumentation $command;
+    private RouteMatcherInterface $routeMatcher;
+    private DocumentationConfig $docConfig;
+    private bool $preserveUserChanges = true;
     private bool $encounteredErrors = false;
 
     public static string $camelDir;
@@ -41,8 +42,8 @@ public function __construct(GenerateDocumentation $command, RouteMatcherInterfac
         $this->docConfig = $command->getDocConfig();
         $this->preserveUserChanges = $preserveUserChanges;
 
-        static::$camelDir = GenerateDocumentation::$camelDir;
-        static::$cacheDir = GenerateDocumentation::$cacheDir;
+        static::$camelDir = Camel::$camelDir;
+        static::$cacheDir = Camel::$cacheDir;
     }
 
     public function get(): array

diff --git a/src/GroupedEndpoints/GroupedEndpointsFromCamelDir.php b/src/GroupedEndpoints/GroupedEndpointsFromCamelDir.php
@@ -9,12 +9,13 @@ class GroupedEndpointsFromCamelDir implements GroupedEndpointsContract
 {
     public function get(): array
     {
-        if (!is_dir(GenerateDocumentation::$camelDir)) {
-            throw new \InvalidArgumentException("Can't use --no-extraction because there are no endpoints in the " .
-                GenerateDocumentation::$camelDir . " directory.");
+        if (!is_dir(Camel::$camelDir)) {
+            throw new \InvalidArgumentException(
+                "Can't use --no-extraction because there are no endpoints in the " . Camel::$camelDir . " directory."
+            );
         }
 
-        return Camel::loadEndpointsIntoGroups(GenerateDocumentation::$camelDir);
+        return Camel::loadEndpointsIntoGroups(Camel::$camelDir);
     }
 
     public function hasEncounteredErrors(): bool

diff --git a/src/Writing/Writer.php b/src/Writing/Writer.php
@@ -3,7 +3,7 @@
 namespace Knuckles\Scribe\Writing;
 
 use Illuminate\Support\Facades\Storage;
-use Knuckles\Scribe\Tools\ConsoleOutputUtils;
+use Knuckles\Scribe\Tools\ConsoleOutputUtils as c;
 use Knuckles\Scribe\Tools\DocumentationConfig;
 use Knuckles\Scribe\Tools\Utils;
 use Symfony\Component\Yaml\Yaml;
@@ -49,7 +49,7 @@ public function writeDocs(array $groupedEndpoints)
     protected function writePostmanCollection(array $groups): void
     {
         if ($this->config->get('postman.enabled', true)) {
-            ConsoleOutputUtils::info('Generating Postman collection');
+            c::info('Generating Postman collection');
 
             $collection = $this->generatePostmanCollection($groups);
             if ($this->isStatic) {
@@ -60,14 +60,14 @@ protected function writePostmanCollection(array $groups): void
                 $collectionPath = 'storage/app/scribe/collection.json';
             }
 
-            ConsoleOutputUtils::success("Wrote Postman collection to: {$collectionPath}");
+            c::success("Wrote Postman collection to: {$collectionPath}");
         }
     }
 
     protected function writeOpenAPISpec(array $parsedRoutes): void
     {
         if ($this->config->get('openapi.enabled', false)) {
-            ConsoleOutputUtils::info('Generating OpenAPI specification');
+            c::info('Generating OpenAPI specification');
 
             $spec = $this->generateOpenAPISpec($parsedRoutes);
             if ($this->isStatic) {
@@ -78,7 +78,7 @@ protected function writeOpenAPISpec(array $parsedRoutes): void
                 $specPath = 'storage/app/scribe/openapi.yaml';
             }
 
-            ConsoleOutputUtils::success("Wrote OpenAPI specification to: {$specPath}");
+            c::success("Wrote OpenAPI specification to: {$specPath}");
         }
     }
 
@@ -156,7 +156,7 @@ protected function performFinalTasksForLaravelType(): void
 
     public function writeHtmlDocs(array $groupedEndpoints): void
     {
-        ConsoleOutputUtils::info('Writing HTML docs...');
+        c::info('Writing HTML docs...');
 
         // Then we convert them to HTML, and throw in the endpoints as well.
         /** @var HtmlWriter $writer */
@@ -167,7 +167,7 @@ public function writeHtmlDocs(array $groupedEndpoints): void
             $this->performFinalTasksForLaravelType();
         }
 
-        ConsoleOutputUtils::success("Wrote HTML documentation to: " . ($this->isStatic ? $this->staticTypeOutputPath : $this->laravelTypeOutputPath));
+        c::success("Wrote HTML docs to: " . rtrim($this->isStatic ? $this->staticTypeOutputPath : $this->laravelTypeOutputPath, '/').'/');
     }
 
 }