Merge pull request #516 from hydephp/add-a-route-list-command

Add a route:list command hydephp/develop@2cd2f28

Author: github-actions

src/Commands/HydeRouteListCommand.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Hyde\Framework\Commands;
+
+use Hyde\Framework\Hyde;
+use Hyde\Framework\Services\DiscoveryService;
+use LaravelZero\Framework\Commands\Command;
+
+/**
+ * Hyde command to display the list of site routes.
+ *
+ * @see \Hyde\Framework\Testing\Feature\Commands\HydeRouteListCommandTest
+ */
+class HydeRouteListCommand extends Command
+{
+    protected $signature = 'route:list';
+    protected $description = 'Display all registered routes.';
+
+    public function handle(): int
+    {
+        $this->table([
+            'Page Type',
+            'Source File',
+            'Output File',
+            'Route Key',
+        ], $this->getRoutes());
+
+        return 0;
+    }
+
+    protected function getRoutes(): array
+    {
+        $routes = [];
+        /** @var \Hyde\Framework\Models\Route $route */
+        foreach (Hyde::routes() as $route) {
+            $routes[] = [
+                $this->formatPageType($route->getPageType()),
+                $this->formatSourcePath($route->getSourcePath()),
+                $this->formatOutputPath($route->getOutputPath()),
+                $route->getRouteKey(),
+            ];
+        }
+
+        return $routes;
+    }
+
+    protected function formatPageType(string $class): string
+    {
+        return str_replace('Hyde\\Framework\\Models\\Pages\\', '', $class);
+    }
+
+    protected function formatSourcePath(string $path): string
+    {
+        return $this->clickablePathLink(DiscoveryService::createClickableFilepath(Hyde::path($path)), $path);
+    }
+
+    protected function formatOutputPath(string $path): string
+    {
+        if (! file_exists(Hyde::sitePath($path))) {
+            return "_site/$path";
+        }
+
+        return $this->clickablePathLink(DiscoveryService::createClickableFilepath(Hyde::sitePath($path)), "_site/$path");
+    }
+
+    protected function clickablePathLink(string $link, string $path): string
+    {
+        return "<href=$link>$path</>";
+    }
+}

src/HydeServiceProvider.php

@@ -108,6 +108,7 @@ protected function registerHydeConsoleCommands(): void
             Commands\HydeBuildSitemapCommand::class,
             Commands\HydeBuildRssFeedCommand::class,
             Commands\HydeBuildSearchCommand::class,
+            Commands\HydeRouteListCommand::class,
             Commands\HydeMakePostCommand::class,
             Commands\HydeMakePageCommand::class,
             Commands\HydeValidateCommand::class,

tests/Feature/Commands/HydeRouteListCommandTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Hyde\Framework\Testing\Feature\Commands;
+
+use Hyde\Testing\TestCase;
+
+/**
+ * @covers \Hyde\Framework\Commands\HydeRouteListCommand
+ */
+class HydeRouteListCommandTest extends TestCase
+{
+    public function testRouteListCommand()
+    {
+        $this->artisan('route:list')
+            ->expectsTable(['Page Type', 'Source File', 'Output File', 'Route Key'], [
+                [
+                    'BladePage',
+                    '_pages/404.blade.php',
+                    '_site/404.html',
+                    '404',
+                ],
+                [
+                    'BladePage',
+                    '_pages/index.blade.php',
+                    '_site/index.html',
+                    'index',
+                ],
+            ])->assertExitCode(0);
+    }
+
+    public function testClickableLinks()
+    {
+        $this->file('_site/index.html');
+        $this->artisan('route:list')
+            ->assertExitCode(0);
+    }
+}