From 18e784e9f4cf5efe9a166086b0baef1f800cfbea Mon Sep 17 00:00:00 2001
From: asciito <ayax.cordova@aydev.mx>
Date: Mon, 2 Oct 2023 19:21:07 -0600
Subject: [PATCH] chore: refactor migration and command component

Reorder folder structure
Improve publish and register migration file

Signed-off-by: asciito <ayax.cordova@aydev.mx>
---
 src/Package/Concerns/HasCommand.php           | 83 ++++++++++++++++++
 src/Package/Concerns/HasCommands.php          | 86 -------------------
 .../{HasMigrations.php => HasMigration.php}   |  2 +-
 src/Package/Contracts/WithCommand.php         | 54 ++++++++++++
 src/Package/Contracts/WithCommands.php        | 45 ----------
 .../{WithMigrations.php => WithMigration.php} |  2 +-
 src/Package/Package.php                       | 12 +--
 src/Package/PackageServiceProvider.php        |  4 +-
 .../Command/PackageregisterCommandTest.php    | 51 +++++++++++
 .../Command/PackageuUnregisterCommandTest.php | 58 +++++++++++++
 .../Console/Commands/PackageCommandOne.php    | 32 +++++++
 .../Console/Commands/PackageCommandTwo.php    | 32 +++++++
 .../Commands/extra/PackageCommandFour.php     | 32 +++++++
 .../Commands/extra/PackageCommandThree.php    | 32 +++++++
 14 files changed, 384 insertions(+), 141 deletions(-)
 create mode 100644 src/Package/Concerns/HasCommand.php
 delete mode 100644 src/Package/Concerns/HasCommands.php
 rename src/Package/Concerns/{HasMigrations.php => HasMigration.php} (99%)
 create mode 100644 src/Package/Contracts/WithCommand.php
 delete mode 100644 src/Package/Contracts/WithCommands.php
 rename src/Package/Contracts/{WithMigrations.php => WithMigration.php} (98%)
 create mode 100644 tests/Feature/Command/PackageregisterCommandTest.php
 create mode 100644 tests/Feature/Command/PackageuUnregisterCommandTest.php
 create mode 100644 workbench/app/Console/Commands/PackageCommandOne.php
 create mode 100644 workbench/app/Console/Commands/PackageCommandTwo.php
 create mode 100644 workbench/app/Console/Commands/extra/PackageCommandFour.php
 create mode 100644 workbench/app/Console/Commands/extra/PackageCommandThree.php

diff --git a/src/Package/Concerns/HasCommand.php b/src/Package/Concerns/HasCommand.php
new file mode 100644
index 0000000..b0c706f
--- /dev/null
+++ b/src/Package/Concerns/HasCommand.php
@@ -0,0 +1,83 @@
+<?php
+
+namespace Asciito\LaravelPackage\Package\Concerns;
+
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+
+trait HasCommand
+{
+    protected bool $preventLoadDefaultCommandFolder = false;
+
+    protected bool $shouldIncludeCommandFromFolder = false;
+
+    public function hasCommand(): bool
+    {
+        return $this->shouldLoadDefaultCommandFolder()
+            || $this->getRegister('command')->isNotEmpty();
+    }
+
+    public function withCommand(string|array $command = []): static
+    {
+        $this->ensureRegistersInitialize('command');
+
+        if (filled($command)) {
+            $this->register(
+                'command',
+                $command,
+            );
+        }
+
+        $this->shouldIncludeCommandFromFolder = true;
+
+        return $this;
+    }
+
+    public function excludeCommand(string|array $path): static
+    {
+        $this->exclude('command', $path);
+
+        return $this;
+    }
+
+    public function getRegisteredCommand(): Collection
+    {
+        $files = $this->getDefaultCommandFiles();
+
+        return $files
+            ->merge($this->getRegister('command'))
+            ->filter(fn (string $path) => ! in_array($path, $this->getExclude('command')->all()));
+    }
+
+    public function getDefaultCommandFiles(): Collection
+    {
+        if (! $this->shouldLoadDefaultCommandFolder()) {
+            return collect();
+        }
+
+        return $this->getFilesFrom($this->getBasePath('console/commands'))
+            ->map(fn (string $path): string => Str::of($path)
+                    ->basename('.php')
+                    ->prepend(
+                        '\\',
+                        $this->getNamespace(),
+                        '\\Console\\Commands\\',
+                    )
+                ,
+            );
+
+    }
+
+    public function preventDefaultCommand(): static
+    {
+        $this->preventLoadDefaultCommandFolder = true;
+
+        return $this;
+    }
+
+    private function shouldLoadDefaultCommandFolder(): bool
+    {
+        return ! $this->preventLoadDefaultCommandFolder
+            && $this->shouldIncludeCommandFromFolder;
+    }
+}
diff --git a/src/Package/Concerns/HasCommands.php b/src/Package/Concerns/HasCommands.php
deleted file mode 100644
index b01a4e6..0000000
--- a/src/Package/Concerns/HasCommands.php
+++ /dev/null
@@ -1,86 +0,0 @@
-<?php
-
-namespace Asciito\LaravelPackage\Package\Concerns;
-
-use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\File;
-use Symfony\Component\Finder\SplFileInfo;
-
-trait HasCommands
-{
-    protected array $commands = [];
-
-    protected bool $preventLoadDefaultCommandsFolder = false;
-
-    protected bool $shouldLoadCommandsFromDefaultFolder = false;
-
-    protected array $excludedCommands = [];
-
-    public function hasCommands(): bool
-    {
-        return $this->shouldLoadDefaultCommandsFolder() || filled($this->commands);
-    }
-
-    private function shouldLoadDefaultCommandsFolder(): bool
-    {
-        return ! $this->preventLoadDefaultCommandsFolder && $this->shouldLoadCommandsFromDefaultFolder;
-    }
-
-    public function preventDefaultCommands(): static
-    {
-        $this->preventLoadDefaultCommandsFolder = true;
-
-        return $this;
-    }
-
-    public function withCommands(string|array ...$command): static
-    {
-        if (filled($command)) {
-            $this->commands = collect($command)
-                ->flatten()
-                ->merge($this->commands)
-                ->all();
-        }
-
-        $this->shouldLoadCommandsFromDefaultFolder = true;
-
-        return $this;
-    }
-
-    public function getRegisteredCommands(): Collection
-    {
-        $commands = [];
-
-        if ($this->shouldLoadDefaultCommandsFolder()) {
-            $commands = $this->loadCommandsFromDefaultFolder();
-        }
-
-        return collect($this->commands)
-            ->merge($commands)
-            ->filter(fn (string $command) => ! in_array($command, $this->excludedCommands));
-    }
-
-    public function loadCommandsFromDefaultFolder()
-    {
-        return collect(File::files($this->getBasePath('Console/Commands')))
-            ->filter(fn (SplFileInfo $file) => $file->getExtension() === 'php')
-            ->map(fn (SplFileInfo $file) => str($file)
-                ->after('Console/')
-                ->replace('/', '\\')
-                ->remove('.php')
-                ->prepend($this->getNamespace().'\\Console\\')
-                ->toString()
-            )
-            ->all();
-    }
-
-    /**
-     * Un-register a previously registered command
-     */
-    public function unregisterCommand(string $fqcn): static
-    {
-        $this->excludedCommands[] = $fqcn;
-
-        return $this;
-    }
-}
diff --git a/src/Package/Concerns/HasMigrations.php b/src/Package/Concerns/HasMigration.php
similarity index 99%
rename from src/Package/Concerns/HasMigrations.php
rename to src/Package/Concerns/HasMigration.php
index e5b4eee..b04df4c 100644
--- a/src/Package/Concerns/HasMigrations.php
+++ b/src/Package/Concerns/HasMigration.php
@@ -5,7 +5,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
-trait HasMigrations
+trait HasMigration
 {
     protected string $migrationPath;
 
diff --git a/src/Package/Contracts/WithCommand.php b/src/Package/Contracts/WithCommand.php
new file mode 100644
index 0000000..316a8de
--- /dev/null
+++ b/src/Package/Contracts/WithCommand.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Asciito\LaravelPackage\Package\Contracts;
+
+use Illuminate\Support\Collection;
+
+interface WithCommand
+{
+    /**
+     * Check if the package has command file(s) available
+     *
+     * @return bool true if the package has command file(s), false otherwise
+     */
+    public function hasCommand(): bool;
+
+    /**
+     * Register the command file(s) for the package
+     *
+     * This will register the command file(s) and will set the command to be publishable,
+     * and to set some files as publishable, and others not, just register the command file one
+     * by one, or in chunks.
+     *
+     * By calling this method this will try to load your command
+     * file(s) from the default command folder of your package.
+     *
+     * @param  string|string[]  $command The file(s) you want to register
+     */
+    public function withCommand(string|array $command = []): static;
+
+    /**
+     * Exclude a command from being register
+     */
+    public function excludeCommand(string|array $path): static;
+
+    /**
+     * An array with the command file(s) registered
+     *
+     * @return Collection The command file(s) registered in the package
+     */
+    public function getRegisteredCommand(): Collection;
+
+    /**
+     * Get the files from the command path
+     */
+    public function getDefaultCommandFiles(): Collection;
+
+    /**
+     * Prevent publishing the default command folder
+     *
+     * Calling this method ensures that the command files in the default folder
+     * wouldn't be loaded automatically.
+     */
+    public function preventDefaultCommand(): static;
+}
diff --git a/src/Package/Contracts/WithCommands.php b/src/Package/Contracts/WithCommands.php
deleted file mode 100644
index 8c2fe2d..0000000
--- a/src/Package/Contracts/WithCommands.php
+++ /dev/null
@@ -1,45 +0,0 @@
-<?php
-
-namespace Asciito\LaravelPackage\Package\Contracts;
-
-use Illuminate\Support\Collection;
-
-interface WithCommands
-{
-    /**
-     * Check if the package has commands to register
-     *
-     * @return bool true if the package has commands, false otherwise
-     */
-    public function hasCommands(): bool;
-
-    /**
-     * Prevent registering the default command folder
-     *
-     * Calling this method ensures that the command files in the default folder
-     * wouldn't be loaded automatically.
-     */
-    public function preventDefaultCommands(): static;
-
-    /**
-     * Register the config file(s) for the package
-     *
-     * By calling this method this will try to load your
-     * file(s) from the default command folder of your package.
-     *
-     * @param  string|string[]  $command The command(s) you want to register (the FQCN)
-     */
-    public function withCommands(string|array ...$command): static;
-
-    /**
-     * An array with the commands registered
-     *
-     * @return Collection The commands registered in the package
-     */
-    public function getRegisteredCommands(): Collection;
-
-    /**
-     * Un-register a previously registered command
-     */
-    public function unregisterCommand(string $fqcn): static;
-}
diff --git a/src/Package/Contracts/WithMigrations.php b/src/Package/Contracts/WithMigration.php
similarity index 98%
rename from src/Package/Contracts/WithMigrations.php
rename to src/Package/Contracts/WithMigration.php
index 850cc32..b7baeb4 100644
--- a/src/Package/Contracts/WithMigrations.php
+++ b/src/Package/Contracts/WithMigration.php
@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Collection;
 
-interface WithMigrations
+interface WithMigration
 {
     /**
      * Check if the package has migration file(s) available
diff --git a/src/Package/Package.php b/src/Package/Package.php
index 2799415..6f76284 100644
--- a/src/Package/Package.php
+++ b/src/Package/Package.php
@@ -2,12 +2,12 @@
 
 namespace Asciito\LaravelPackage\Package;
 
-use Asciito\LaravelPackage\Package\Concerns\HasCommands;
+use Asciito\LaravelPackage\Package\Concerns\HasCommand;
 use Asciito\LaravelPackage\Package\Concerns\HasConfig;
-use Asciito\LaravelPackage\Package\Concerns\HasMigrations;
-use Asciito\LaravelPackage\Package\Contracts\WithCommands;
+use Asciito\LaravelPackage\Package\Concerns\HasMigration;
+use Asciito\LaravelPackage\Package\Contracts\WithCommand;
 use Asciito\LaravelPackage\Package\Contracts\WithConfig;
-use Asciito\LaravelPackage\Package\Contracts\WithMigrations;
+use Asciito\LaravelPackage\Package\Contracts\WithMigration;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon;
@@ -16,9 +16,9 @@
 use Illuminate\Support\Str;
 use Symfony\Component\Finder\SplFileInfo;
 
-class Package implements WithCommands, WithConfig, WithMigrations
+class Package implements WithCommand, WithConfig, WithMigration
 {
-    use HasCommands, HasConfig, HasMigrations;
+    use HasCommand, HasConfig, HasMigration;
 
     /**
      * @var string The package name
diff --git a/src/Package/PackageServiceProvider.php b/src/Package/PackageServiceProvider.php
index 5466984..cf7330c 100644
--- a/src/Package/PackageServiceProvider.php
+++ b/src/Package/PackageServiceProvider.php
@@ -158,8 +158,8 @@ protected function publishesMigrations(Package $package): void
      */
     protected function publishesCommands(Package $package): void
     {
-        if ($package->hasCommands()) {
-            $this->commands($package->getRegisteredCommands()->all());
+        if ($package->hasCommand()) {
+            $this->commands($package->getRegisteredCommand()->all());
         }
     }
 }
diff --git a/tests/Feature/Command/PackageregisterCommandTest.php b/tests/Feature/Command/PackageregisterCommandTest.php
new file mode 100644
index 0000000..712167c
--- /dev/null
+++ b/tests/Feature/Command/PackageregisterCommandTest.php
@@ -0,0 +1,51 @@
+<?php
+
+use Asciito\LaravelPackage\Package\Package;
+
+use function Pest\Laravel\artisan;
+
+trait PackageRegisterCommandTest
+{
+    protected function configurePackage(Package $package): void
+    {
+        $package
+            ->setName('package')
+            ->withCommand([
+                \Workbench\App\Console\Commands\Extra\PackageCommandThree::class,
+                \Workbench\App\Console\Commands\Extra\PackageCommandFour::class,
+            ]);
+    }
+}
+
+uses(PackageRegisterCommandTest::class);
+
+test('package has registered files from folder', function () {
+    expect($this->package)
+        ->getRegisteredCommand()
+        ->toHaveCount(4);
+
+    artisan('list')
+        ->expectsOutputToContain('package:test-one')
+        ->expectsOutputToContain('package:test-two')
+        ->expectsOutputToContain('package:test-three')
+        ->expectsOutputToContain('package:test-four')
+        ->assertSuccessful();
+});
+
+it('run registered commands', function () {
+    artisan('package:test-one')
+        ->expectsOutput('Package test one')
+        ->assertSuccessful();
+
+    artisan('package:test-two')
+        ->expectsOutput('Package test two')
+        ->assertSuccessful();
+
+    artisan('package:test-three')
+        ->expectsOutput('Package test three')
+        ->assertSuccessful();
+
+    artisan('package:test-four')
+        ->expectsOutput('Package test four')
+        ->assertSuccessful();
+});
diff --git a/tests/Feature/Command/PackageuUnregisterCommandTest.php b/tests/Feature/Command/PackageuUnregisterCommandTest.php
new file mode 100644
index 0000000..2e61e63
--- /dev/null
+++ b/tests/Feature/Command/PackageuUnregisterCommandTest.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace Asciito\LaravelPackage\Tests\Feature\Command;
+
+use Asciito\LaravelPackage\Package\Package;
+
+use Symfony\Component\Console\Exception\CommandNotFoundException;
+use function Pest\Laravel\artisan;
+
+trait PackageUnregisterCommandTest
+{
+    protected function configurePackage(Package $package): void
+    {
+        $package
+            ->setName('unregister-package')
+            ->withCommand(\Workbench\App\Console\Commands\PackageCommandOne::class)
+            ->withCommand([
+                \Workbench\App\Console\Commands\Extra\PackageCommandThree::class,
+                \Workbench\App\Console\Commands\Extra\PackageCommandFour::class,
+            ])
+            ->excludeCommand(\Workbench\App\Console\Commands\Extra\PackageCommandThree::class)
+            ->preventDefaultCommand();
+    }
+}
+
+uses(PackageUnregisterCommandTest::class);
+
+test('package has registered files from folder', function () {
+    expect($this->package)
+        ->getRegisteredCommand()
+        ->toHaveCount(2);
+
+    artisan('list')
+        ->expectsOutputToContain('package:test-one')
+        ->doesntExpectOutputToContain('package:test-two')
+        ->doesntExpectOutputToContain('package:test-three')
+        ->expectsOutputToContain('package:test-four')
+        ->assertSuccessful();
+});
+
+it('run registered commands', function () {
+    artisan('package:test-one')
+        ->expectsOutput('Package test one')
+        ->assertSuccessful();
+
+    expect(function () {
+        artisan('package:test-two')
+            ->assertFailed();
+    })->toThrow(CommandNotFoundException::class)
+    ->and(function () {
+        artisan('package:test-three')
+            ->assertFailed();
+    })->toThrow(CommandNotFoundException::class);
+
+    artisan('package:test-four')
+        ->expectsOutput('Package test four')
+        ->assertSuccessful();
+});
diff --git a/workbench/app/Console/Commands/PackageCommandOne.php b/workbench/app/Console/Commands/PackageCommandOne.php
new file mode 100644
index 0000000..e901e48
--- /dev/null
+++ b/workbench/app/Console/Commands/PackageCommandOne.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Workbench\App\Console\Commands;
+
+use Illuminate\Console\Command;
+
+class PackageCommandOne extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'package:test-one';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Package Test One';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->info('Package test one');
+
+        return self::SUCCESS;
+    }
+}
diff --git a/workbench/app/Console/Commands/PackageCommandTwo.php b/workbench/app/Console/Commands/PackageCommandTwo.php
new file mode 100644
index 0000000..4872aca
--- /dev/null
+++ b/workbench/app/Console/Commands/PackageCommandTwo.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Workbench\App\Console\Commands;
+
+use Illuminate\Console\Command;
+
+class PackageCommandTwo extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'package:test-two';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Package Test Two';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->info('Package test two');
+
+        return self::SUCCESS;
+    }
+}
diff --git a/workbench/app/Console/Commands/extra/PackageCommandFour.php b/workbench/app/Console/Commands/extra/PackageCommandFour.php
new file mode 100644
index 0000000..95c29d7
--- /dev/null
+++ b/workbench/app/Console/Commands/extra/PackageCommandFour.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Workbench\App\Console\Commands\extra;
+
+use Illuminate\Console\Command;
+
+class PackageCommandFour extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'package:test-four';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Package Test Four';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->info('Package test four');
+
+        return self::SUCCESS;
+    }
+}
diff --git a/workbench/app/Console/Commands/extra/PackageCommandThree.php b/workbench/app/Console/Commands/extra/PackageCommandThree.php
new file mode 100644
index 0000000..9d9f37d
--- /dev/null
+++ b/workbench/app/Console/Commands/extra/PackageCommandThree.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Workbench\App\Console\Commands\extra;
+
+use Illuminate\Console\Command;
+
+class PackageCommandThree extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'package:test-three';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Package Test Three';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        $this->info('Package test three');
+
+        return self::SUCCESS;
+    }
+}