general refactor, move more classes under Database namespace

src/Bootstrappers/DatabaseTenancyBootstrapper.php

@@ -6,7 +6,7 @@ namespace Stancl\Tenancy\Bootstrappers;
 
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Database\DatabaseManager;
 use Stancl\Tenancy\Exceptions\TenantDatabaseDoesNotExistException;
 

src/CacheManager.php

@@ -6,6 +6,8 @@ namespace Stancl\Tenancy;
 
 use Illuminate\Cache\CacheManager as BaseCacheManager;
 
+// todo move to Cache namespace?
+
 class CacheManager extends BaseCacheManager
 {
     /**

src/Contracts/TenantWithDatabase.php

@@ -1,15 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\Contracts;
-
-use Stancl\Tenancy\DatabaseConfig;
-
-interface TenantWithDatabase extends Tenant
-{
-    public function database(): DatabaseConfig;
-
-    /** Get an internal key. */
-    public function getInternal(string $key): mixed;
-}

src/Controllers/TenantAssetsController.php

@@ -4,12 +4,13 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Controllers;
 
+use Closure;
 use Illuminate\Routing\Controller;
 use Throwable;
 
 class TenantAssetsController extends Controller
 {
-    public static $tenancyMiddleware = 'Stancl\Tenancy\Middleware\InitializeTenancyByDomain';
+    public static string|array|Closure $tenancyMiddleware = Stancl\Tenancy\Middleware\InitializeTenancyByDomain::class;
 
     public function __construct()
     {
@@ -22,7 +23,7 @@ class TenantAssetsController extends Controller
 
         try {
             return response()->file(storage_path("app/public/$path"));
-        } catch (Throwable $th) {
+        } catch (Throwable) {
             abort(404);
         }
     }

src/Database/Concerns/CreatesDatabaseUsers.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Concerns;
+namespace Stancl\Tenancy\Database\Concerns;
 
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 trait CreatesDatabaseUsers
 {

src/Database/Concerns/HasDatabase.php

@@ -4,8 +4,8 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 trait HasDatabase
 {

src/Database/Concerns/HasDomains.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+// todo not sure if this should be in Database\
 namespace Stancl\Tenancy\Database\Concerns;
 
 use Stancl\Tenancy\Contracts\Domain;

src/Database/Contracts/ManagesDatabaseUsers.php

@@ -2,11 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Contracts;
+namespace Stancl\Tenancy\Database\Contracts;
 
-use Stancl\Tenancy\DatabaseConfig;
-
-// todo possibly move to Database namespace, along with other classes
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 interface ManagesDatabaseUsers extends TenantDatabaseManager
 {

src/Database/Contracts/TenantDatabaseManager.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Contracts;
+namespace Stancl\Tenancy\Database\Contracts;
 
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 interface TenantDatabaseManager
 {

src/Database/Contracts/TenantWithDatabase.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Contracts;
+
+use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Database\DatabaseConfig;
+
+interface TenantWithDatabase extends Tenant
+{
+    public function database(): DatabaseConfig;
+}

src/Database/DatabaseConfig.php

@@ -2,30 +2,24 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy;
+namespace Stancl\Tenancy\Database;
 
 use Closure;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Str;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase as Tenant;
-use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase as Tenant;
 
 class DatabaseConfig
 {
-    /** @var Tenant|Model */
-    public $tenant;
+    // todo docblocks
+    public Tenant&Model $tenant;
 
-    /** @var callable */
-    public static $usernameGenerator;
+    public static Closure $usernameGenerator;
 
-    /** @var callable */
-    public static $passwordGenerator;
+    public static Closure $passwordGenerator;
 
-    /** @var callable */
-    public static $databaseNameGenerator;
+    public static Closure $databaseNameGenerator;
 
     public static function __constructStatic(): void
     {
@@ -86,7 +80,7 @@ class DatabaseConfig
     {
         $this->tenant->setInternal('db_name', $this->getName() ?? (static::$databaseNameGenerator)($this->tenant));
 
-        if ($this->manager() instanceof ManagesDatabaseUsers) {
+        if ($this->manager() instanceof Contracts\ManagesDatabaseUsers) {
             $this->tenant->setInternal('db_username', $this->getUsername() ?? (static::$usernameGenerator)($this->tenant));
             $this->tenant->setInternal('db_password', $this->getPassword() ?? (static::$passwordGenerator)($this->tenant));
         }
@@ -143,20 +137,18 @@ class DatabaseConfig
         }, []);
     }
 
-    /**
-     * Get the TenantDatabaseManager for this tenant's connection.
-     */
-    public function manager(): TenantDatabaseManager
+    /** Get the TenantDatabaseManager for this tenant's connection. */
+    public function manager(): Contracts\TenantDatabaseManager
     {
         $driver = config("database.connections.{$this->getTemplateConnectionName()}.driver");
 
         $databaseManagers = config('tenancy.database.managers');
 
         if (! array_key_exists($driver, $databaseManagers)) {
-            throw new DatabaseManagerNotRegisteredException($driver);
+            throw new Exceptions\DatabaseManagerNotRegisteredException($driver);
         }
 
-        /** @var TenantDatabaseManager $databaseManager */
+        /** @var Contracts\TenantDatabaseManager $databaseManager */
         $databaseManager = app($databaseManagers[$driver]);
 
         $databaseManager->setConnection($this->getTemplateConnectionName());

src/Database/DatabaseManager.php

@@ -7,14 +7,8 @@ namespace Stancl\Tenancy\Database;
 use Illuminate\Config\Repository;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
-
-// todo move to Database namespace
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 /**
  * @internal Class is subject to breaking changes in minor and patch versions.
@@ -97,11 +91,11 @@ class DatabaseManager
         $manager = $tenant->database()->manager();
 
         if ($manager->databaseExists($database = $tenant->database()->getName())) {
-            throw new TenantDatabaseAlreadyExistsException($database);
+            throw new Exceptions\TenantDatabaseAlreadyExistsException($database);
         }
 
-        if ($manager instanceof ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
-            throw new TenantDatabaseUserAlreadyExistsException($username);
+        if ($manager instanceof Contracts\ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
+            throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username);
         }
     }
 }

src/Database/Exceptions/DatabaseManagerNotRegisteredException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Exception;
+
+class DatabaseManagerNotRegisteredException extends Exception
+{
+    public function __construct(string $driver)
+    {
+        parent::__construct("Database manager for driver $driver is not registered.");
+    }
+}

src/Database/Exceptions/NoConnectionSetException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Exception;
 

src/Database/Exceptions/TenantDatabaseAlreadyExistsException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
 

src/Database/Exceptions/TenantDatabaseDoesNotExistException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Exception;
 

src/Database/Exceptions/TenantDatabaseUserAlreadyExistsException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
 

src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php

@@ -4,13 +4,13 @@ declare(strict_types=1);
 
 // todo likely move all of these classes to Database\
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
 use Illuminate\Database\Connection;
 use Illuminate\Support\Facades\DB;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 class MicrosoftSQLDatabaseManager implements TenantDatabaseManager
 {

src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
 use Illuminate\Database\Connection;
 use Illuminate\Support\Facades\DB;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 class MySQLDatabaseManager implements TenantDatabaseManager
 {

src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
-use Stancl\Tenancy\Concerns\CreatesDatabaseUsers;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\Concerns\CreatesDatabaseUsers;
+use Stancl\Tenancy\Database\Contracts\ManagesDatabaseUsers;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
 {

src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
 use Illuminate\Database\Connection;
 use Illuminate\Support\Facades\DB;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 class PostgreSQLDatabaseManager implements TenantDatabaseManager
 {

src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
 use Illuminate\Database\Connection;
 use Illuminate\Support\Facades\DB;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 class PostgreSQLSchemaManager implements TenantDatabaseManager
 {

src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SQLiteDatabaseManager implements TenantDatabaseManager
 {
@@ -13,7 +13,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     {
         try {
             return file_put_contents(database_path($tenant->database()->getName()), '');
-        } catch (\Throwable $th) {
+        } catch (\Throwable) {
             return false;
         }
     }
@@ -22,7 +22,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     {
         try {
             return unlink(database_path($tenant->database()->getName()));
-        } catch (\Throwable $th) {
+        } catch (\Throwable) {
             return false;
         }
     }

src/Events/SyncedResourceChangedInForeignDatabase.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Events;
 
 use Stancl\Tenancy\Contracts\Syncable;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SyncedResourceChangedInForeignDatabase
 {

src/Events/SyncedResourceSaved.php

@@ -6,7 +6,7 @@ namespace Stancl\Tenancy\Events;
 
 use Illuminate\Database\Eloquent\Model;
 use Stancl\Tenancy\Contracts\Syncable;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SyncedResourceSaved
 {

src/Exceptions/DatabaseManagerNotRegisteredException.php

@@ -1,13 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\Exceptions;
-
-class DatabaseManagerNotRegisteredException extends \Exception
-{
-    public function __construct($driver)
-    {
-        parent::__construct("Database manager for driver $driver is not registered.");
-    }
-}

src/Exceptions/TenantCouldNotBeIdentifiedByIdException.php

@@ -2,6 +2,8 @@
 
 declare(strict_types=1);
 
+// todo perhaps create Identification namespace
+
 namespace Stancl\Tenancy\Exceptions;
 
 use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;

src/Jobs/CreateDatabase.php

@@ -10,7 +10,7 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Database\DatabaseManager;
 use Stancl\Tenancy\Events\CreatingDatabase;
 use Stancl\Tenancy\Events\DatabaseCreated;

src/Jobs/DeleteDatabase.php

@@ -9,7 +9,7 @@ use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Events\DatabaseDeleted;
 use Stancl\Tenancy\Events\DeletingDatabase;
 

src/Jobs/DeleteDomains.php

@@ -8,7 +8,7 @@ use Illuminate\Bus\Queueable;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class DeleteDomains
 {

src/Jobs/MigrateDatabase.php

@@ -10,7 +10,7 @@ use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Artisan;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class MigrateDatabase implements ShouldQueue
 {

src/Jobs/SeedDatabase.php

@@ -10,7 +10,7 @@ use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Artisan;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SeedDatabase implements ShouldQueue
 {

src/UUIDGenerator.php

@@ -7,6 +7,8 @@ namespace Stancl\Tenancy;
 use Ramsey\Uuid\Uuid;
 use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator;
 
+// todo move to separate namespace
+
 class UUIDGenerator implements UniqueIdentifierGenerator
 {
     public static function generate($resource): string