Skip to content

Commit

Permalink
refactor: Rename ProviderManager to TenantProviderManager to keep con…
Browse files Browse the repository at this point in the history
…sistency (#82)

* refactor: Rename ProviderManager to TenantProviderManager to keep consistency

* chore: Add missing changes
  • Loading branch information
ollieread authored Jan 5, 2025
1 parent 5199d45 commit 23b4d58
Show file tree
Hide file tree
Showing 10 changed files with 35 additions and 35 deletions.
4 changes: 2 additions & 2 deletions src/Facades/Sprout.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/Managers/TenancyManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*
* @package Core
*/
final class ProviderManager extends BaseFactory
final class TenantProviderManager extends BaseFactory
{
/**
* Get the name used by this factory
Expand Down
2 changes: 1 addition & 1 deletion src/Providers/EloquentTenantProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
8 changes: 4 additions & 4 deletions src/Sprout.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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);
}

/**
Expand Down
10 changes: 5 additions & 5 deletions src/SproutServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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
Expand All @@ -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');
}
Expand Down
14 changes: 7 additions & 7 deletions tests/Unit/SproutServiceProviderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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());
}
Expand Down
4 changes: 2 additions & 2 deletions tests/_Original/Providers/DatabaseTenantProviderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions tests/_Original/Providers/EloquentTenantProviderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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);
Expand Down
14 changes: 7 additions & 7 deletions tests/_Original/ServiceProviderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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]
Expand Down

0 comments on commit 23b4d58

Please sign in to comment.