Merge pull request #928 from hydephp/refactor-RebuildStaticSiteCommand-class

emmadesilva · web-flow · commit e2caf5b2917c · 2023-02-08T11:31:52.000+01:00
Refactor the RebuildStaticSiteCommand class
diff --git a/packages/framework/src/Console/Commands/RebuildStaticPageCommand.php b/packages/framework/src/Console/Commands/RebuildStaticPageCommand.php
@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Console\Commands;
+
+use Exception;
+use Hyde\Console\Concerns\Command;
+use Hyde\Foundation\Facades\PageCollection;
+use Hyde\Framework\Features\BuildTasks\BuildTask;
+use Hyde\Framework\Services\BuildService;
+use Hyde\Framework\Services\RebuildService;
+use Hyde\Hyde;
+use Illuminate\Console\OutputStyle;
+use function dirname;
+use function file_exists;
+use function in_array;
+use function str_replace;
+use function unslash;
+
+/**
+ * Hyde Command to build a single static site file.
+ *
+ * @see \Hyde\Framework\Testing\Feature\Commands\RebuildStaticSiteCommandTest
+ */
+class RebuildStaticPageCommand extends Command
+{
+    /** @var string */
+    protected $signature = 'rebuild {path : The relative file path (example: _posts/hello-world.md)}';
+
+    /** @var string */
+    protected $description = 'Run the static site builder for a single file';
+
+    public function handle(): int
+    {
+        if ($this->argument('path') === Hyde::getMediaDirectory()) {
+            (new BuildService($this->getOutput()))->transferMediaAssets();
+
+            $this->info('All done!');
+
+            return Command::SUCCESS;
+        }
+
+        return $this->makeBuildTask($this->output, $this->getNormalizedPathString())->handle() ?? Command::SUCCESS;
+    }
+
+    protected function getNormalizedPathString(): string
+    {
+        return str_replace('\\', '/', unslash($this->argument('path')));
+    }
+
+    protected function makeBuildTask(OutputStyle $output, string $path): BuildTask
+    {
+        return new class($output, $path) extends BuildTask
+        {
+            public static string $description = 'Rebuilding page';
+
+            protected string $path;
+
+            public function __construct(OutputStyle $output, string $path)
+            {
+                parent::__construct($output);
+                $this->path = $path;
+            }
+
+            public function run(): void
+            {
+                $this->validate();
+
+                (new RebuildService($this->path))->execute();
+            }
+
+            public function then(): void
+            {
+                $this->createdSiteFile(Command::createClickableFilepath(
+                    PageCollection::getPage($this->path)->getOutputPath()
+                ))->withExecutionTime();
+            }
+
+            protected function validate(): void
+            {
+                $directory = Hyde::pathToRelative(dirname($this->path));
+
+                $directories = [
+                    Hyde::pathToRelative(Hyde::getBladePagePath()),
+                    Hyde::pathToRelative(Hyde::getBladePagePath()),
+                    Hyde::pathToRelative(Hyde::getMarkdownPagePath()),
+                    Hyde::pathToRelative(Hyde::getMarkdownPostPath()),
+                    Hyde::pathToRelative(Hyde::getDocumentationPagePath()),
+                ];
+
+                if (! in_array($directory, $directories)) {
+                    throw new Exception("Path [$this->path] is not in a valid source directory.", 400);
+                }
+
+                if (! file_exists(Hyde::path($this->path))) {
+                    throw new Exception("File [$this->path] not found.", 404);
+                }
+            }
+        };
+    }
+}
diff --git a/packages/framework/src/Console/Commands/RebuildStaticSiteCommand.php b/packages/framework/src/Console/Commands/RebuildStaticSiteCommand.php
diff --git a/packages/framework/src/Console/HydeConsoleServiceProvider.php b/packages/framework/src/Console/HydeConsoleServiceProvider.php
@@ -21,7 +21,7 @@ public function register(): void
             Commands\BuildSearchCommand::class,
             Commands\BuildSiteCommand::class,
             Commands\BuildSitemapCommand::class,
-            Commands\RebuildStaticSiteCommand::class,
+            Commands\RebuildStaticPageCommand::class,
 
             Commands\MakePageCommand::class,
             Commands\MakePostCommand::class,
diff --git a/packages/framework/tests/Feature/Commands/RebuildStaticPageCommandTest.php b/packages/framework/tests/Feature/Commands/RebuildStaticPageCommandTest.php
@@ -8,15 +8,15 @@
 use Hyde\Testing\TestCase;
 
 /**
- * @covers \Hyde\Console\Commands\RebuildStaticSiteCommand
+ * @covers \Hyde\Console\Commands\RebuildStaticPageCommand
  */
-class RebuildStaticSiteCommandTest extends TestCase
+class RebuildStaticPageCommandTest extends TestCase
 {
     public function test_handle_is_successful_with_valid_path()
     {
         $this->file('_pages/test-page.md', 'foo');
 
-        $this->artisan('rebuild '.'_pages/test-page.md')->assertExitCode(0);
+        $this->artisan('rebuild _pages/test-page.md')->assertExitCode(0);
 
         $this->assertFileExists(Hyde::path('_site/test-page.html'));
 
