[2.x] Interactive component publisher command

packages/framework/src/Console/Commands/PublishViewsCommand.php

@@ -5,6 +5,8 @@
 namespace Hyde\Console\Commands;
 
 use Hyde\Console\Concerns\Command;
+use Hyde\Console\Helpers\ConsoleHelper;
+use Hyde\Console\Helpers\InteractivePublishCommandHelper;
 use Illuminate\Support\Facades\Artisan;
 
 use function str_replace;
@@ -17,7 +19,7 @@
 class PublishViewsCommand extends Command
 {
     /** @var string */
-    protected $signature = 'publish:views {category? : The category to publish}';
+    protected $signature = 'publish:views {category? : The category to publish} {--i|interactive : Interactively select the views to publish}';
 
     /** @var string */
     protected $description = 'Publish the hyde components for customization. Note that existing files will be overwritten';
@@ -43,6 +45,12 @@ class PublishViewsCommand extends Command
 
     public function handle(): int
     {
+        if ($this->isInteractive() && ConsoleHelper::usesWindowsOs()) {
+            $this->error('Due to limitations in the Windows version of PHP, it is not currently possible to use interactive mode on Windows outside of WSL.');
+
+            return Command::FAILURE;
+        }
+
         $selected = (string) ($this->argument('category') ?? $this->promptForCategory());
 
         if ($selected === 'all' || $selected === '') {
@@ -56,8 +64,20 @@ public function handle(): int
         return Command::SUCCESS;
     }
 
+    protected function isInteractive(): bool
+    {
+        return $this->option('interactive');
+    }
+
     protected function publishOption(string $selected): void
     {
+        // Todo: Don't trigger interactive if "all" is selected
+        if ($this->isInteractive()) {
+            $this->handleInteractivePublish($selected);
+
+            return;
+        }
+
         Artisan::call('vendor:publish', [
             '--tag' => $this->options[$selected]['group'] ?? $selected,
             '--force' => true,
@@ -94,4 +114,16 @@ protected function parseChoiceIntoKey(string $choice): string
     {
         return strstr(str_replace(['<comment>', '</comment>'], '', $choice), ':', true) ?: '';
     }
+
+    protected function handleInteractivePublish(string $selected): void
+    {
+        $publisher = new InteractivePublishCommandHelper($this->options[$selected]['group']);
+
+        $choices = $publisher->getFileChoices();
+
+        $selectedFiles = ConsoleHelper::multiselect('Select the files you want to publish (CTRL+A to toggle all)', $choices, [], 10, 'required', hint: 'Navigate with arrow keys, space to select, enter to confirm.');
+        $publisher->handle($selectedFiles);
+
+        $this->infoComment($publisher->formatOutput($selectedFiles));
+    }
 }

packages/framework/src/Console/Helpers/ConsoleHelper.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Console\Helpers;
+
+use Closure;
+use Illuminate\Support\Collection;
+
+use function Laravel\Prompts\multiselect;
+
+/**
+ * @internal This class contains internal helpers for interacting with the console, and for easier testing.
+ *
+ * @codeCoverageIgnore This class provides internal testing helpers and does not need to be tested.
+ */
+class ConsoleHelper
+{
+    protected static array $mocks = [];
+
+    public static function clearMocks(): void
+    {
+        static::$mocks = [];
+    }
+
+    public static function usesWindowsOs()
+    {
+        if (isset(static::$mocks['usesWindowsOs'])) {
+            return static::$mocks['usesWindowsOs'];
+        }
+
+        return windows_os();
+    }
+
+    public static function mockWindowsOs(bool $isWindows = true): void
+    {
+        static::$mocks['usesWindowsOs'] = $isWindows;
+    }
+
+    // Todo: Add test to ensure the signature is the same if Laravel updates it
+    public static function multiselect(string $label, array|Collection $options, array|Collection $default = [], int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = 'Use the space bar to select options.', ?Closure $transform = null): array
+    {
+        if (isset(static::$mocks['multiselect'])) {
+            $returns = static::$mocks['multiselect'];
+            $assertionCallback = static::$mocks['multiselectAssertion'] ?? null;
+
+            if ($assertionCallback !== null) {
+                $assertionCallback($label, $options, $default, $scroll, $required, $validate, $hint, $transform);
+            }
+
+            return $returns;
+        }
+
+        return multiselect($label, $options, $default, $scroll, $required, $validate, $hint, $transform);
+    }
+
+    public static function mockMultiselect(array $returns, ?Closure $assertionCallback = null): void
+    {
+        assert(! isset(static::$mocks['multiselect']), 'Cannot mock multiselect twice.');
+
+        static::$mocks['multiselect'] = $returns;
+        static::$mocks['multiselectAssertion'] = $assertionCallback;
+    }
+}

packages/framework/src/Console/Helpers/InteractivePublishCommandHelper.php

@@ -0,0 +1,143 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Console\Helpers;
+
+use Hyde\Facades\Filesystem;
+use Hyde\Foundation\Providers\ViewServiceProvider;
+use Hyde\Hyde;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Str;
+use Illuminate\Support\Stringable;
+use Symfony\Component\Finder\SplFileInfo;
+
+use function Hyde\path_join;
+
+/**
+ * @internal This class offloads logic from the PublishViewsCommand class and should not be used elsewhere.
+ */
+class InteractivePublishCommandHelper
+{
+    protected readonly string $group;
+    protected readonly string $sourceDirectory;
+    protected readonly string $targetDirectory;
+
+    /** @var array<string, string> Map of source files to target files */
+    protected readonly array $publishableFilesMap;
+
+    /** @param "hyde-layouts"|"hyde-components"|"hyde-page-404" $group */
+    public function __construct(string $group)
+    {
+        $this->group = $group;
+
+        [$this->sourceDirectory, $this->targetDirectory] = $this->getPublishPaths();
+
+        $this->publishableFilesMap = $this->mapPublishableFiles($this->findAllFilesForTag());
+    }
+
+    /** @return array<string, string> */
+    public function getFileChoices(): array
+    {
+        return Arr::mapWithKeys($this->publishableFilesMap, /** @return array<string, string> */ function (string $source): array {
+            return [$source => $this->pathRelativeToDirectory($source, $this->targetDirectory)];
+        });
+    }
+
+    /** @param array<string> $selectedFiles */
+    public function handle(array $selectedFiles): void
+    {
+        $filesToPublish = $this->filterPublishableFiles($selectedFiles);
+
+        $this->publishFiles($filesToPublish);
+    }
+
+    /** @return array{string, string} */
+    protected function getPublishPaths(): array
+    {
+        $viewPaths = ServiceProvider::pathsToPublish(ViewServiceProvider::class, $this->group);
+
+        $source = array_key_first($viewPaths);
+        $target = $viewPaths[$source];
+
+        return [$source, $target];
+    }
+
+    /** @return \Symfony\Component\Finder\SplFileInfo[] */
+    protected function findAllFilesForTag(): array
+    {
+        return File::allFiles($this->sourceDirectory);
+    }
+
+    /**
+     * @param  \Symfony\Component\Finder\SplFileInfo[]  $search
+     * @return array<string, string>
+     */
+    protected function mapPublishableFiles(array $search): array
+    {
+        return Arr::mapWithKeys($search, /** @return array<string, string> */ function (SplFileInfo $file): array {
+            $targetPath = path_join($this->targetDirectory, $file->getRelativePathname());
+
+            return [Hyde::pathToRelative(realpath($file->getPathname())) => Hyde::pathToRelative($targetPath)];
+        });
+    }
+
+    /** @param array<string, string> $selectedFiles */
+    protected function publishFiles(array $selectedFiles): void
+    {
+        foreach ($selectedFiles as $source => $target) {
+            Filesystem::ensureDirectoryExists(dirname($target));
+            Filesystem::copy($source, $target); // Todo: See how we should handle existing files
+        }
+    }
+
+    /**
+     * @experimental This method may be toned down in the future.
+     *
+     * @param  array<string>  $selectedFiles
+     */
+    public function formatOutput(array $selectedFiles): string
+    {
+        $fileCount = count($selectedFiles);
+        $displayLimit = 3;
+
+        $fileNames = collect($selectedFiles)
+            ->map(fn (string $file): string => $this->pathRelativeToDirectory($file, $this->sourceDirectory));
+
+        $displayFiles = $fileNames->take($displayLimit)->implode(', ');
+
+        return Str::of('Published')
+            ->when(
+                $fileCount === $this->publishableFilesMapCount(),
+                fn (Stringable $str): Stringable => $str->append(' all files, including'),
+                fn (Stringable $str): Stringable => $str->append(' ', Str::plural('file', $fileCount))
+            )
+            ->append(' [', $displayFiles, ']')
+            ->when(
+                $fileCount > $displayLimit,
+                fn (Stringable $str): Stringable => $str->append(' and ', $fileCount - $displayLimit, ' more')
+            )
+            ->toString();
+    }
+
+    protected function pathRelativeToDirectory(string $source, string $directory): string
+    {
+        return Str::after($source, basename($directory).'/');
+    }
+
+    /**
+     * @param  array<string>  $selectedFiles
+     * @return array<string, string>
+     */
+    protected function filterPublishableFiles(array $selectedFiles): array
+    {
+        return array_filter($this->publishableFilesMap, fn (string $file): bool => in_array($file, $selectedFiles));
+    }
+
+    protected function publishableFilesMapCount(): int
+    {
+        return count($this->publishableFilesMap);
+    }
+}

packages/framework/tests/Feature/Commands/PublishViewsCommandTest.php

@@ -4,12 +4,15 @@
 
 namespace Hyde\Framework\Testing\Feature\Commands;
 
+use Hyde\Console\Helpers\ConsoleHelper;
 use Hyde\Hyde;
 use Hyde\Testing\TestCase;
 use Illuminate\Support\Facades\File;
 
 /**
  * @covers \Hyde\Console\Commands\PublishViewsCommand
+ *
+ * @see \Hyde\Framework\Testing\Unit\InteractivePublishCommandHelperTest
  */
 class PublishViewsCommandTest extends TestCase
 {
@@ -48,4 +51,43 @@ public function testWithInvalidSuppliedTag()
             ->expectsOutputToContain('No publishable resources for tag [invalid].')
             ->assertExitCode(0);
     }
+
+    public function testInteractiveSelectionOnUnixSystems()
+    {
+        ConsoleHelper::mockWindowsOs(false);
+
+        ConsoleHelper::mockMultiselect(['resources/views/vendor/hyde/components/article-excerpt.blade.php'], function (string $label, array $options) {
+            $this->assertSame('Select the files you want to publish (CTRL+A to toggle all)', $label);
+            $this->assertContainsOnly('string', array_keys($options));
+            $this->assertContainsOnly('string', array_values($options));
+            $this->assertContains('resources/views/vendor/hyde/components/article-excerpt.blade.php', array_keys($options));
+            $this->assertContains('article-excerpt.blade.php', array_values($options));
+        });
+
+        $this->artisan('publish:views components --interactive')
+            ->expectsOutput('Published file [article-excerpt.blade.php]')
+            ->assertExitCode(0);
+
+        $this->assertFileExists(Hyde::path('resources/views/vendor/hyde/components/article-excerpt.blade.php'));
+
+        File::deleteDirectory(Hyde::path('resources/views/vendor/hyde'));
+    }
+
+    public function testInteractiveSelectionOnWindowsSystems()
+    {
+        ConsoleHelper::mockWindowsOs();
+
+        $this->artisan('publish:views components --interactive')
+            ->expectsOutput('Due to limitations in the Windows version of PHP, it is not currently possible to use interactive mode on Windows outside of WSL.')
+            ->assertExitCode(1);
+
+        File::deleteDirectory(Hyde::path('resources/views/vendor/hyde'));
+    }
+
+    protected function tearDown(): void
+    {
+        ConsoleHelper::clearMocks();
+
+        parent::tearDown();
+    }
 }