feat: allow provider configuration

apiato · Jan 31, 2025 · 1685f07 · 1685f07
1 parent 135373d
commit 1685f07
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 92 deletions.
diff --git a/src/Foundation/Apiato.php b/src/Foundation/Apiato.php
@@ -5,12 +5,12 @@
 use Apiato\Foundation\Configuration\ApplicationBuilder;
 use Apiato\Foundation\Configuration\Factory;
 use Apiato\Foundation\Configuration\Localization;
+use Apiato\Foundation\Configuration\Provider;
 use Apiato\Foundation\Configuration\Repository;
 use Apiato\Foundation\Configuration\Routing;
 use Apiato\Foundation\Configuration\Seeding;
 use Apiato\Foundation\Configuration\View;
 use Composer\Autoload\ClassLoader;
-use Composer\ClassMapGenerator\ClassMapGenerator;
 
 use function Illuminate\Filesystem\join_paths;
 
@@ -19,8 +19,6 @@ final class Apiato
     private static self $instance;
     private string $sharedPath;
     /** @var string[] */
-    private array $providerPaths = [];
-    /** @var string[] */
     private array $configPaths = [];
     /** @var string[] */
     private array $eventDiscoveryPaths = [];
@@ -36,6 +34,7 @@ final class Apiato
     private Seeding $seeding;
     private Factory $factory;
     private Repository $repository;
+    private Provider $provider;
 
     private function __construct(
         private readonly string $basePath,
@@ -166,6 +165,17 @@ public function withSeeders(callable|null $callback = null): self
         return $this;
     }
 
+    public function withProviders(callable|null $callback = null): self
+    {
+        $this->provider ??= new Provider();
+
+        if (!is_null($callback)) {
+            $callback($this->provider);
+        }
+
+        return $this;
+    }
+
     public function withMigrations(string ...$path): self
     {
         $this->migrationPaths = $path;
@@ -193,28 +203,6 @@ public function withConfigs(string ...$path): void
         $this->configPaths = $path;
     }
 
-    public function withProviders(string ...$path): self
-    {
-        $this->providerPaths = $path;
-
-        return $this;
-    }
-
-    /*
-     * Get the service providers to be loaded.
-     *
-     * @return string[]
-     */
-    public function providers(): array
-    {
-        $classMapper = new ClassMapGenerator();
-        foreach ($this->providerPaths as $path) {
-            $classMapper->scanPaths($path);
-        }
-
-        return array_keys($classMapper->getClassMap()->getMap());
-    }
-
     /*
      * Get the config files.
      *
@@ -279,6 +267,11 @@ public function webRoutes(): array
         return $this->routing->webRoutes();
     }
 
+    public function providers(): array
+    {
+        return $this->provider->toArray();
+    }
+
     /**
      * Get the seeding configuration.
      */
@@ -311,6 +304,14 @@ public function repository(): Repository
         return $this->repository;
     }
 
+    /**
+     * Get the provider configuration.
+     */
+    public function provider(): Provider
+    {
+        return $this->provider;
+    }
+
     /**
      * Get the localization configuration.
      */

diff --git a/src/Foundation/Configuration/ApplicationBuilder.php b/src/Foundation/Configuration/ApplicationBuilder.php
@@ -19,9 +19,6 @@ private function withDefaults(string $basePath): void
     {
         $this->useSharedPath(
             $this->joinPaths($basePath, 'app/Ship'),
-        )->withProviders(
-            shared_path('Providers'),
-            ...$this->getDirs($this->joinPaths($basePath, 'app/Containers/*/*/Providers')),
         )->withConfigs(
             shared_path('Configs'),
             ...$this->getDirs($this->joinPaths($basePath, 'app/Containers/*/*/Configs')),
@@ -37,7 +34,12 @@ private function withDefaults(string $basePath): void
         )->withMigrations(
             shared_path('Migrations'),
             ...$this->getDirs($this->joinPaths($basePath, 'app/Containers/*/*/Data/Migrations')),
-        )->withSeeders(function (Seeding $seeding) use ($basePath): void {
+        )->withProviders(function (Provider $provider) use ($basePath): void {
+            $provider->loadFrom(
+                shared_path('Providers'),
+                ...$this->getDirs($this->joinPaths($basePath, 'app/Containers/*/*/Providers')),
+            );
+        })->withSeeders(function (Seeding $seeding) use ($basePath): void {
             $seeding->loadFrom(
                 ...$this->getDirs($this->joinPaths($basePath, 'app/Containers/*/*/Data/Seeders')),
             );
@@ -105,6 +107,13 @@ public function withSeeders(callable|null $callback = null): self
         return $this;
     }
 
+    public function withProviders(callable|null $callback = null): self
+    {
+        $this->apiato->withProviders($callback);
+
+        return $this;
+    }
+
     public function withMigrations(string ...$path): self
     {
         $this->apiato->withMigrations(...$path);
@@ -140,13 +149,6 @@ public function withConfigs(string ...$path): self
         return $this;
     }
 
-    public function withProviders(string ...$path): self
-    {
-        $this->apiato->withProviders(...$path);
-
-        return $this;
-    }
-
     /**
      * Set the shared directory path.
      */

diff --git a/src/Foundation/Configuration/Provider.php b/src/Foundation/Configuration/Provider.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Apiato\Foundation\Configuration;
+
+use Apiato\Console\CommandServiceProvider;
+use Apiato\Generator\GeneratorsServiceProvider;
+use Apiato\Macro\MacroServiceProvider;
+use Composer\ClassMapGenerator\ClassMapGenerator;
+use Illuminate\Support\DefaultProviders;
+
+final class Provider extends DefaultProviders
+{
+    public function __construct(array|null $providers = null)
+    {
+        parent::__construct($providers ?: [
+            GeneratorsServiceProvider::class,
+            MacroServiceProvider::class,
+            CommandServiceProvider::class,
+        ]);
+    }
+
+    public function loadFrom(string ...$paths): self
+    {
+        $classMapper = new ClassMapGenerator();
+        foreach ($paths as $path) {
+            $classMapper->scanPaths($path);
+        }
+
+        $this->merge(array_keys($classMapper->getClassMap()->getMap()));
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        return array_unique(parent::toArray());
+    }
+}
diff --git a/src/Foundation/Providers/ApiatoServiceProvider.php b/src/Foundation/Providers/ApiatoServiceProvider.php
@@ -3,7 +3,6 @@
 namespace Apiato\Foundation\Providers;
 
 use Apiato\Abstract\Providers\ServiceProvider;
-use Apiato\Console\CommandServiceProvider;
 use Apiato\Foundation\Apiato;
 use Apiato\Foundation\Database\DatabaseSeeder;
 use Apiato\Foundation\Support\Providers\ConfigServiceProvider;
@@ -12,17 +11,13 @@
 use Apiato\Foundation\Support\Providers\MigrationServiceProvider;
 use Apiato\Foundation\Support\Providers\RateLimitingServiceProvider;
 use Apiato\Foundation\Support\Providers\ViewServiceProvider;
-use Apiato\Generator\GeneratorsServiceProvider;
 use Illuminate\Foundation\AliasLoader;
 use Illuminate\Foundation\Console\AboutCommand;
 
 final class ApiatoServiceProvider extends ServiceProvider
 {
     public function register(): void
     {
-        $this->app->register(GeneratorsServiceProvider::class);
-        $this->app->register(MacroServiceProvider::class);
-        $this->app->register(CommandServiceProvider::class);
         $this->app->register(ConfigServiceProvider::class);
         $this->app->register(HelperServiceProvider::class);
         $this->app->register(LocalizationServiceProvider::class);

diff --git a/tests/Unit/Foundation/ApiatoTest.php b/tests/Unit/Foundation/ApiatoTest.php
@@ -1,8 +1,11 @@
 <?php
 
+use Apiato\Console\CommandServiceProvider;
 use Apiato\Foundation\Apiato;
 use Apiato\Foundation\Configuration\Factory;
 use Apiato\Foundation\Configuration\Repository;
+use Apiato\Generator\GeneratorsServiceProvider;
+use Apiato\Macro\MacroServiceProvider;
 use Workbench\App\Containers\MySection\Author\Data\Seeders\Murdered_2;
 use Workbench\App\Containers\MySection\Author\Data\Seeders\Ordered_1;
 use Workbench\App\Containers\MySection\Author\Data\Seeders\Unordered;
@@ -16,60 +19,65 @@
 
 describe(class_basename(Apiato::class), function (): void {
     it('can be created with default configuration', function (): void {
-        $config = Apiato::configure(__DIR__)->create();
-        expect($config->providers())->toEqualCanonicalizing([
-            ShipServiceProvider::class,
-            BookServiceProvider::class,
-            EventServiceProvider::class,
-        ])->and($config->configs())->toEqualCanonicalizing([
-            shared_path('Configs/boat.php'),
-            app_path('Containers/MySection/Book/Configs/mySection-book.php'),
-        ])->and($config->events())->toEqualCanonicalizing([
-            shared_path('Listeners'),
-            app_path('Containers/MySection/Book/Listeners'),
-            app_path('Containers/MySection/Author/Listeners'),
-        ])->and($config->commands())->toEqualCanonicalizing([
-            shared_path('Commands'),
-            app_path('Containers/MySection/Book/UI/CLI'),
-        ])->and($config->helpers())->toEqualCanonicalizing([
-            shared_path('Helpers/ExplosiveClass.php'),
-            shared_path('Helpers/functions.php'),
-            shared_path('Helpers/helpers.php'),
-            app_path('Containers/MySection/Book/Helpers/functions.php'),
-            app_path('Containers/MySection/Author/Helpers/helpers.php'),
-        ])->and($config->migrations())->toEqualCanonicalizing([
-            shared_path('Migrations'),
-            app_path('Containers/MySection/Book/Data/Migrations'),
-            app_path('Containers/Identity/User/Data/Migrations'),
-            app_path('Containers/SocialInteraction/Comment/Data/Migrations'),
-            app_path('Containers/SocialInteraction/Like/Data/Migrations'),
-        ])->and($config->seeding()->seeders())->toEqualCanonicalizing([
-            Workbench\App\Containers\MySection\Book\Data\Seeders\Ordered_1::class,
-            Workbench\App\Containers\MySection\Book\Data\Seeders\Murdered_2::class,
-            Workbench\App\Containers\MySection\Book\Data\Seeders\Wondered_3::class,
-            Workbench\App\Containers\MySection\Book\Data\Seeders\Unordered::class,
-            Ordered_1::class,
-            Murdered_2::class,
-            Wondered_3::class,
-            Unordered::class,
-        ])->and($config->localization()->paths())->toEqualCanonicalizing([
-            shared_path('Languages'),
-            app_path('Containers/MySection/Book/Languages'),
-        ])->and($config->view()->paths())->toEqualCanonicalizing([
-            shared_path('Views'),
-            shared_path('Mails/Templates'),
-            app_path('Containers/MySection/Book/UI/WEB/Views'),
-            app_path('Containers/MySection/Author/Mails/Templates'),
-        ])->and($config->routing()->webRoutes())->toEqualCanonicalizing([
-            app_path('Containers/MySection/Book/UI/WEB/Routes/CreateBook.v1.public.php'),
-            app_path('Containers/MySection/Book/UI/WEB/Routes/ListBooks.php'),
-            app_path('Containers/MySection/Author/UI/WEB/Routes/ListAuthors.php'),
-        ])->and($config->factory()->resolveFactoryName(Book::class))->toBe(BookFactory::class)
+        $config = Apiato::configure()->create();
+
+        expect($config->providers())
+            ->toEqualCanonicalizing([
+                GeneratorsServiceProvider::class,
+                MacroServiceProvider::class,
+                CommandServiceProvider::class,
+                ShipServiceProvider::class,
+                BookServiceProvider::class,
+                EventServiceProvider::class,
+            ])->and($config->configs())->toEqualCanonicalizing([
+                shared_path('Configs/boat.php'),
+                app_path('Containers/MySection/Book/Configs/mySection-book.php'),
+            ])->and($config->events())->toEqualCanonicalizing([
+                shared_path('Listeners'),
+                app_path('Containers/MySection/Book/Listeners'),
+                app_path('Containers/MySection/Author/Listeners'),
+            ])->and($config->commands())->toEqualCanonicalizing([
+                shared_path('Commands'),
+                app_path('Containers/MySection/Book/UI/CLI'),
+            ])->and($config->helpers())->toEqualCanonicalizing([
+                shared_path('Helpers/ExplosiveClass.php'),
+                shared_path('Helpers/functions.php'),
+                shared_path('Helpers/helpers.php'),
+                app_path('Containers/MySection/Book/Helpers/functions.php'),
+                app_path('Containers/MySection/Author/Helpers/helpers.php'),
+            ])->and($config->migrations())->toEqualCanonicalizing([
+                shared_path('Migrations'),
+                app_path('Containers/MySection/Book/Data/Migrations'),
+                app_path('Containers/Identity/User/Data/Migrations'),
+                app_path('Containers/SocialInteraction/Comment/Data/Migrations'),
+                app_path('Containers/SocialInteraction/Like/Data/Migrations'),
+            ])->and($config->seeding()->seeders())->toEqualCanonicalizing([
+                Workbench\App\Containers\MySection\Book\Data\Seeders\Ordered_1::class,
+                Workbench\App\Containers\MySection\Book\Data\Seeders\Murdered_2::class,
+                Workbench\App\Containers\MySection\Book\Data\Seeders\Wondered_3::class,
+                Workbench\App\Containers\MySection\Book\Data\Seeders\Unordered::class,
+                Ordered_1::class,
+                Murdered_2::class,
+                Wondered_3::class,
+                Unordered::class,
+            ])->and($config->localization()->paths())->toEqualCanonicalizing([
+                shared_path('Languages'),
+                app_path('Containers/MySection/Book/Languages'),
+            ])->and($config->view()->paths())->toEqualCanonicalizing([
+                shared_path('Views'),
+                shared_path('Mails/Templates'),
+                app_path('Containers/MySection/Book/UI/WEB/Views'),
+                app_path('Containers/MySection/Author/Mails/Templates'),
+            ])->and($config->routing()->webRoutes())->toEqualCanonicalizing([
+                app_path('Containers/MySection/Book/UI/WEB/Routes/CreateBook.v1.public.php'),
+                app_path('Containers/MySection/Book/UI/WEB/Routes/ListBooks.php'),
+                app_path('Containers/MySection/Author/UI/WEB/Routes/ListAuthors.php'),
+            ])->and($config->factory()->resolveFactoryName(Book::class))->toBe(BookFactory::class)
             ->and($config->repository()->resolveModelName(BookRepository::class))->toBe(Book::class);
     });
 
     it('accepts factory config override', function (): void {
-        $apiato = Apiato::configure(__DIR__)
+        $apiato = Apiato::configure()
             ->withFactories(function (Factory $factory): void {
                 $factory->resolveFactoryNameUsing(static fn (string $modelName): string => 'test');
             })->create();
@@ -78,7 +86,7 @@
     });
 
     it('accepts repository config override', function (): void {
-        $apiato = Apiato::configure(__DIR__)
+        $apiato = Apiato::configure()
             ->withRepositories(function (Repository $repository): void {
                 $repository->resolveModelNameUsing(static fn (string $repositoryName): string => 'test');
             })->create();