WIP: Frontend components installation.

Author: chikondikamwendo

composer.json

@@ -26,7 +26,8 @@
     "require": {
         "php": "^8.3",
         "illuminate/support": "11.* || 12.*",
-        "inertiajs/inertia-laravel": "^2.0"
+        "inertiajs/inertia-laravel": "^2.0",
+        "laravel/prompts": "^0.3.6"
     },
     "require-dev": {
         "larastan/larastan": "^3.6",

pint.json

@@ -56,6 +56,7 @@
         "visibility_required": true
     },
     "notName": [
-        "TestCase.php"
+        "TestCase.php",
+        "SupportedStacks.php"
     ]
 }

src/Console/Commands/InstallCommand.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codelabmw\InfiniteScroll\Console\Commands;
+
+use Codelabmw\InfiniteScroll\Contracts\Stack;
+use Codelabmw\InfiniteScroll\SupportedStacks;
+use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\App;
+
+use function Laravel\Prompts\error;
+use function Laravel\Prompts\info;
+use function Laravel\Prompts\select;
+use function Laravel\Prompts\spin;
+use function Laravel\Prompts\text;
+
+final class InstallCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'install:infinite-scroll';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Install Infinite Scrolling components for Inertia.';
+
+    /**
+     * List of registered supported stacks.
+     *
+     * @var Collection<string, class-string<Stack>>
+     */
+    private readonly Collection $supportedStacks;
+
+    /**
+     * Creates a new InstallCommand instance.
+     */
+    public function __construct(SupportedStacks $supportedStacksService)
+    {
+        parent::__construct();
+        $this->supportedStacks = collect($supportedStacksService->get());
+    }
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): ?int
+    {
+        /** @var string */
+        $stack = select(
+            label: 'Which stack are you using?',
+            options: $this->supportedStacks->keys(), // @phpstan-ignore-line
+            required: true,
+        );
+
+        /** @var Stack */
+        $stack = App::make((string) $this->supportedStacks->get($stack));
+
+        $installationPath = text(
+            label: 'Where do you want to install components?',
+            placeholder: $stack->getDefaultInstallationPath(),
+            required: true,
+        );
+
+        $error = spin(fn (): ?string => $this->install($stack->getStubs()), 'Installing infinite scroll components for '.$stack->getLabel().' in '.$installationPath.'.');
+
+        if ($error) {
+            error('Error occurred while installing components. '.$error);
+
+            return 1;
+        }
+
+        // @codeCoverageIgnoreStart
+        info('Successfully installed components.');
+
+        return null;
+        // @codeCoverageIgnoreEnd
+    }
+
+    /**
+     * Installs infinite scrolling frontend components.
+     *
+     * @param  Collection<int, string>  $stubs
+     */
+    private function install(Collection $stubs): ?string
+    {
+        if ($stubs->isEmpty()) {
+            return 'Installation files were not found.';
+        }
+
+        $error = null;
+        $stubs->each(function (string $file) use (&$error): void {
+            if (! file_exists($file)) {
+                $error = 'The file: '.$file.' does not exists.';
+
+                return;
+            }
+        });
+
+        return $error;
+    }
+}

src/Contracts/Stack.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codelabmw\InfiniteScroll\Contracts;
+
+use Illuminate\Support\Collection;
+
+interface Stack
+{
+    /**
+     * The display name of the stack.
+     */
+    public function getLabel(): string;
+
+    /**
+     * The default installation path of components for this stack.
+     */
+    public function getDefaultInstallationPath(): string;
+
+    /**
+     * The paths of the stubs to copy.
+     *
+     * @return Collection<int, string>
+     */
+    public function getStubs(): Collection;
+}

src/InfiniteScrollServiceProvider.php

@@ -4,6 +4,7 @@
 
 namespace Codelabmw\InfiniteScroll;
 
+use Codelabmw\InfiniteScroll\Console\Commands\InstallCommand;
 use Illuminate\Support\ServiceProvider;
 
 final class InfiniteScrollServiceProvider extends ServiceProvider
@@ -14,13 +15,18 @@ final class InfiniteScrollServiceProvider extends ServiceProvider
     public function register(): void
     {
         $this->app->bind('infinite-scroll', fn (): InfiniteScroll => new InfiniteScroll());
+        $this->app->singleton(SupportedStacks::class, fn (): SupportedStacks => new SupportedStacks());
     }
 
     /**
      * Bootstrap any application services.
      */
     public function boot(): void
     {
-        //
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                InstallCommand::class,
+            ]);
+        }
     }
 }

src/Stacks/React.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codelabmw\InfiniteScroll\Stacks;
+
+use Codelabmw\InfiniteScroll\Contracts\Stack;
+use Illuminate\Support\Collection;
+
+final class React implements Stack
+{
+    /**
+     * The display name of the stack.
+     */
+    public function getLabel(): string
+    {
+        return 'React';
+    }
+
+    /**
+     * The default installation path of components for this stack.
+     */
+    public function getDefaultInstallationPath(): string
+    {
+        return resource_path('js/components');
+    }
+
+    /**
+     * The paths of the stubs to copy.
+     *
+     * @return Collection<int, string>
+     */
+    public function getStubs(): Collection
+    {
+        return Collection::make();
+    }
+}

src/SupportedStacks.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codelabmw\InfiniteScroll;
+
+use Codelabmw\InfiniteScroll\Contracts\Stack;
+use Codelabmw\InfiniteScroll\Stacks\React;
+
+class SupportedStacks
+{
+    /**
+     * @return array<string, class-string<Stack>>
+     */
+    public function get(): array
+    {
+        return [
+            'React' => React::class,
+        ];
+    }
+}

tests/Architecture/ArchTest.php

@@ -1,9 +1,14 @@
 <?php
 
 declare(strict_types=1);
+
 use Codelabmw\InfiniteScroll\Facades\InfiniteScroll;
+use Codelabmw\InfiniteScroll\SupportedStacks;
 
 arch()->preset()->php();
 arch()->preset()->security();
-arch()->preset()->strict()->ignoring([InfiniteScroll::class]);
+arch()->preset()->strict()->ignoring([
+    InfiniteScroll::class,
+    SupportedStacks::class,
+]);
 arch()->preset()->laravel();

tests/Feature/Console/Commands/InstallCommandTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+use Codelabmw\InfiniteScroll\Stacks\React;
+use Codelabmw\InfiniteScroll\SupportedStacks;
+
+beforeEach(function (): void {
+    // Arrange
+    $mock = Mockery::mock(new SupportedStacks());
+    $mock->shouldReceive('get')->andReturn([
+        'React' => React::class,
+    ]);
+
+    $this->app->bind(SupportedStacks::class, fn () => $mock);
+});
+
+it('requires input', function (): void {
+    // Act & Assert
+    $this->artisan('install:infinite-scroll')
+        ->expectsQuestion('Which stack are you using?', 'React')
+        ->expectsQuestion('Where do you want to install components?', 'resources/js/components');
+});
+
+it('aborts if stack has no stub files', function (): void {
+    // Arrange
+    $mock = Mockery::mock(new React());
+    $mock->shouldReceive('getStubs')->andReturn(collect([]));
+
+    $this->app->bind(React::class, fn () => $mock);
+
+    // Act & Assert
+    $this->artisan('install:infinite-scroll')
+        ->expectsQuestion('Which stack are you using?', 'React')
+        ->expectsQuestion('Where do you want to install components?', 'resources/js/components')
+        ->assertExitCode(1);
+});
+
+it('aborts if stack has stub files that does not exists', function (): void {
+    // Arrange
+    $mock = Mockery::mock(new React());
+    $mock->shouldReceive('getStubs')->andReturn(collect([
+        'none-existent.file',
+    ]));
+
+    $this->app->bind(React::class, fn () => $mock);
+
+    // Act & Assert
+    $this->artisan('install:infinite-scroll')
+        ->expectsQuestion('Which stack are you using?', 'React')
+        ->expectsQuestion('Where do you want to install components?', 'resources/js/components')
+        ->assertExitCode(1);
+});
+
+it('installs proper files', function (): void {})->todo();