From fb19e61084f4abab2af2c3a87f69a443d816fc5f Mon Sep 17 00:00:00 2001 From: Ollie Read Date: Sun, 5 Jan 2025 17:32:53 +0000 Subject: [PATCH 1/2] refactor: Rename ProviderManager to TenantProviderManager to keep consistency --- src/Facades/Sprout.php | 4 ++-- src/Managers/TenancyManager.php | 8 ++++---- ...oviderManager.php => TenantProviderManager.php} | 0 src/SproutServiceProvider.php | 10 +++++----- tests/Unit/SproutServiceProviderTest.php | 14 +++++++------- .../Providers/EloquentTenantProviderTest.php | 4 ++-- tests/_Original/ServiceProviderTest.php | 14 +++++++------- 7 files changed, 27 insertions(+), 27 deletions(-) rename src/Managers/{ProviderManager.php => TenantProviderManager.php} (100%) diff --git a/src/Facades/Sprout.php b/src/Facades/Sprout.php index 10a7091..f89fcf6 100644 --- a/src/Facades/Sprout.php +++ b/src/Facades/Sprout.php @@ -8,7 +8,7 @@ use Sprout\Contracts\Tenancy; use Sprout\Contracts\Tenant; use Sprout\Managers\IdentityResolverManager; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Support\ResolutionHook; /** @@ -31,7 +31,7 @@ * @method static bool isBootableOverride(string $class) * @method static \Sprout\Sprout markAsInContext() * @method static \Sprout\Sprout markAsOutsideContext() - * @method static ProviderManager providers() + * @method static TenantProviderManager providers() * @method static \Sprout\Sprout registerOverride(string $class) * @method static IdentityResolverManager resolvers() * @method static string route(string $name, Tenant $tenant, string|null $resolver = null, string|null $tenancy = null, array $parameters = [], bool $absolute = true) diff --git a/src/Managers/TenancyManager.php b/src/Managers/TenancyManager.php index a8462e3..bf862a1 100644 --- a/src/Managers/TenancyManager.php +++ b/src/Managers/TenancyManager.php @@ -18,17 +18,17 @@ final class TenancyManager extends BaseFactory { /** - * @var \Sprout\Managers\ProviderManager + * @var \Sprout\Managers\TenantProviderManager */ - private ProviderManager $providerManager; + private TenantProviderManager $providerManager; /** * Create a new instance * * @param \Illuminate\Contracts\Foundation\Application $app - * @param \Sprout\Managers\ProviderManager $providerManager + * @param \Sprout\Managers\TenantProviderManager $providerManager */ - public function __construct(Application $app, ProviderManager $providerManager) + public function __construct(Application $app, TenantProviderManager $providerManager) { parent::__construct($app); diff --git a/src/Managers/ProviderManager.php b/src/Managers/TenantProviderManager.php similarity index 100% rename from src/Managers/ProviderManager.php rename to src/Managers/TenantProviderManager.php diff --git a/src/SproutServiceProvider.php b/src/SproutServiceProvider.php index e9d61a6..c2fb0e1 100644 --- a/src/SproutServiceProvider.php +++ b/src/SproutServiceProvider.php @@ -12,7 +12,7 @@ use Sprout\Http\RouterMethods; use Sprout\Listeners\IdentifyTenantOnRouting; use Sprout\Managers\IdentityResolverManager; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Managers\TenancyManager; use Sprout\Support\ResolutionHook; use Sprout\Support\SettingsRepository; @@ -49,8 +49,8 @@ private function registerSprout(): void private function registerManagers(): void { // Register the tenant provider manager - $this->app->singleton(ProviderManager::class, function ($app) { - return new ProviderManager($app); + $this->app->singleton(TenantProviderManager::class, function ($app) { + return new TenantProviderManager($app); }); // Register the identity resolver manager @@ -60,11 +60,11 @@ private function registerManagers(): void // Register the tenancy manager $this->app->singleton(TenancyManager::class, function ($app) { - return new TenancyManager($app, $app->make(ProviderManager::class)); + return new TenancyManager($app, $app->make(TenantProviderManager::class)); }); // Alias the managers with simple names - $this->app->alias(ProviderManager::class, 'sprout.providers'); + $this->app->alias(TenantProviderManager::class, 'sprout.providers'); $this->app->alias(IdentityResolverManager::class, 'sprout.resolvers'); $this->app->alias(TenancyManager::class, 'sprout.tenancies'); } diff --git a/tests/Unit/SproutServiceProviderTest.php b/tests/Unit/SproutServiceProviderTest.php index 7bf8914..853fda3 100644 --- a/tests/Unit/SproutServiceProviderTest.php +++ b/tests/Unit/SproutServiceProviderTest.php @@ -13,7 +13,7 @@ use Sprout\Http\Middleware\TenantRoutes; use Sprout\Listeners\IdentifyTenantOnRouting; use Sprout\Managers\IdentityResolverManager; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Managers\TenancyManager; use Sprout\Sprout; use Sprout\SproutServiceProvider; @@ -54,17 +54,17 @@ public function sproutIsRegistered(): void #[Test] public function providerManagerIsRegistered(): void { - $this->assertTrue(app()->has(ProviderManager::class)); + $this->assertTrue(app()->has(TenantProviderManager::class)); $this->assertTrue(app()->has('sprout.providers')); - $this->assertTrue(app()->isShared(ProviderManager::class)); + $this->assertTrue(app()->isShared(TenantProviderManager::class)); $this->assertFalse(app()->isShared('sprout.providers')); - $this->assertSame(app()->make(ProviderManager::class), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(TenantProviderManager::class), app()->make(TenantProviderManager::class)); $this->assertSame(app()->make('sprout.providers'), app()->make('sprout.providers')); - $this->assertSame(app()->make(ProviderManager::class), app()->make('sprout.providers')); - $this->assertSame(app()->make('sprout.providers'), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(TenantProviderManager::class), app()->make('sprout.providers')); + $this->assertSame(app()->make('sprout.providers'), app()->make(TenantProviderManager::class)); $this->assertSame(app()->make(Sprout::class)->providers(), app()->make('sprout.providers')); - $this->assertSame(app()->make(Sprout::class)->providers(), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(Sprout::class)->providers(), app()->make(TenantProviderManager::class)); $this->assertSame(sprout()->providers(), sprout()->providers()); $this->assertSame(app()->make(Sprout::class)->providers(), sprout()->providers()); } diff --git a/tests/_Original/Providers/EloquentTenantProviderTest.php b/tests/_Original/Providers/EloquentTenantProviderTest.php index 2025359..4b4c146 100644 --- a/tests/_Original/Providers/EloquentTenantProviderTest.php +++ b/tests/_Original/Providers/EloquentTenantProviderTest.php @@ -8,7 +8,7 @@ use Orchestra\Testbench\Concerns\WithWorkbench; use Orchestra\Testbench\TestCase; use PHPUnit\Framework\Attributes\Test; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Providers\EloquentTenantProvider; use Sprout\Sprout; use Workbench\App\Models\TenantModel; @@ -29,7 +29,7 @@ protected function defineEnvironment($app): void #[Test] public function isRegisteredCorrectly(): void { - $manager = app(ProviderManager::class); + $manager = app(TenantProviderManager::class); $provider = $manager->get('tenants'); $this->assertNotNull($provider); diff --git a/tests/_Original/ServiceProviderTest.php b/tests/_Original/ServiceProviderTest.php index 80d3f50..1982463 100644 --- a/tests/_Original/ServiceProviderTest.php +++ b/tests/_Original/ServiceProviderTest.php @@ -17,7 +17,7 @@ use Sprout\Listeners\SetCurrentTenantContext; use Sprout\Listeners\SetCurrentTenantForJob; use Sprout\Managers\IdentityResolverManager; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Managers\TenancyManager; use Sprout\Sprout; use Sprout\SproutServiceProvider; @@ -60,17 +60,17 @@ public function coreSproutConfigExists(): void #[Test] public function providerManagerIsRegistered(): void { - $this->assertTrue(app()->has(ProviderManager::class)); + $this->assertTrue(app()->has(TenantProviderManager::class)); $this->assertTrue(app()->has('sprout.providers')); - $this->assertTrue(app()->isShared(ProviderManager::class)); + $this->assertTrue(app()->isShared(TenantProviderManager::class)); $this->assertFalse(app()->isShared('sprout.providers')); - $this->assertSame(app()->make(ProviderManager::class), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(TenantProviderManager::class), app()->make(TenantProviderManager::class)); $this->assertSame(app()->make('sprout.providers'), app()->make('sprout.providers')); - $this->assertSame(app()->make(ProviderManager::class), app()->make('sprout.providers')); - $this->assertSame(app()->make('sprout.providers'), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(TenantProviderManager::class), app()->make('sprout.providers')); + $this->assertSame(app()->make('sprout.providers'), app()->make(TenantProviderManager::class)); $this->assertSame(app()->make(Sprout::class)->providers(), app()->make('sprout.providers')); - $this->assertSame(app()->make(Sprout::class)->providers(), app()->make(ProviderManager::class)); + $this->assertSame(app()->make(Sprout::class)->providers(), app()->make(TenantProviderManager::class)); } #[Test] From 51f6c5ca79d65c6e35bac584eeb3d5f0aa42b8dc Mon Sep 17 00:00:00 2001 From: Ollie Read Date: Sun, 5 Jan 2025 17:33:22 +0000 Subject: [PATCH 2/2] chore: Add missing changes --- src/Managers/TenantProviderManager.php | 2 +- src/Providers/EloquentTenantProvider.php | 2 +- src/Sprout.php | 8 ++++---- tests/_Original/Providers/DatabaseTenantProviderTest.php | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Managers/TenantProviderManager.php b/src/Managers/TenantProviderManager.php index 804a51f..e64cea8 100644 --- a/src/Managers/TenantProviderManager.php +++ b/src/Managers/TenantProviderManager.php @@ -21,7 +21,7 @@ * * @package Core */ -final class ProviderManager extends BaseFactory +final class TenantProviderManager extends BaseFactory { /** * Get the name used by this factory diff --git a/src/Providers/EloquentTenantProvider.php b/src/Providers/EloquentTenantProvider.php index 597f312..b0c1731 100644 --- a/src/Providers/EloquentTenantProvider.php +++ b/src/Providers/EloquentTenantProvider.php @@ -22,7 +22,7 @@ * * @package Providers * - * @internal New instances are created with {@see \Sprout\Managers\ProviderManager::createEloquentProvider()}, and shouldn't be created manually + * @internal New instances are created with {@see \Sprout\Managers\TenantProviderManager::createEloquentProvider()}, and shouldn't be created manually */ final class EloquentTenantProvider extends BaseTenantProvider { diff --git a/src/Sprout.php b/src/Sprout.php index deeec2d..371a615 100644 --- a/src/Sprout.php +++ b/src/Sprout.php @@ -8,7 +8,7 @@ use Sprout\Contracts\Tenancy; use Sprout\Contracts\Tenant; use Sprout\Managers\IdentityResolverManager; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Managers\TenancyManager; use Sprout\Support\ResolutionHook; use Sprout\Support\SettingsRepository; @@ -161,13 +161,13 @@ public function resolvers(): IdentityResolverManager /** * Get the tenant providers manager * - * @return \Sprout\Managers\ProviderManager + * @return \Sprout\Managers\TenantProviderManager * * @throws \Illuminate\Contracts\Container\BindingResolutionException */ - public function providers(): ProviderManager + public function providers(): TenantProviderManager { - return $this->app->make(ProviderManager::class); + return $this->app->make(TenantProviderManager::class); } /** diff --git a/tests/_Original/Providers/DatabaseTenantProviderTest.php b/tests/_Original/Providers/DatabaseTenantProviderTest.php index 148954d..90c24b9 100644 --- a/tests/_Original/Providers/DatabaseTenantProviderTest.php +++ b/tests/_Original/Providers/DatabaseTenantProviderTest.php @@ -10,7 +10,7 @@ use Orchestra\Testbench\Concerns\WithWorkbench; use Orchestra\Testbench\TestCase; use PHPUnit\Framework\Attributes\Test; -use Sprout\Managers\ProviderManager; +use Sprout\Managers\TenantProviderManager; use Sprout\Providers\DatabaseTenantProvider; use Sprout\Sprout; use Sprout\Support\GenericTenant; @@ -34,7 +34,7 @@ protected function defineEnvironment($app): void #[Test] public function isRegisteredCorrectly(): void { - $manager = app(ProviderManager::class); + $manager = app(TenantProviderManager::class); $provider = $manager->get('backup'); $this->assertNotNull($provider);