feat: auth guard with multiple dynamic auth models

[0xb4lint]

• Added or updated tests
• Documented user facing changes
• Updated CHANGELOG.md

Changes

This PR handles the Guard interface and extracts the actual guard specified with, after the guard is extracted it loads the matching auth model (through the guard provider) from config and sets the return type (e.g. User, Admin, Customer...).

auth('admin')->user();
auth()->guard('admin')->user();
Auth::guard('admin')->user();

There are 2 new files added for tests app/Admin.php and config/auth.php.

(I've also added LoadsAuthModel trait, since getDefaultAuthModel() is implemented multiple times.)

Some example errors before this PR:

// Method Tests\\Features\\ReturnTypes\\Helpers\\AuthExtension::testAuthGuardUser() should return App\\User|null but returns Illuminate\\Contracts\\Auth\\Authenticatable|null.
public function testAuthGuardUser(): ?User
{
    return auth()->guard('web')->user();
}

// Method Tests\\Features\\ReturnTypes\\Helpers\\AuthExtension::testAuthGuardParameterUser() should return App\\User|null but returns Illuminate\\Contracts\\Auth\\Authenticatable|null.
public function testAuthGuardParameterUser(): ?User
{
    return auth('web')->user();
}

// Method Tests\\Features\\ReturnTypes\\AuthExtension::testGuardAdminUser() should return App\\Admin|null but returns Illuminate\\Contracts\\Auth\\Authenticatable|null.
public function testGuardAdminUser(): ?Admin
{
    return Auth::guard('admin')->user();
}

// Method Tests\\Features\\ReturnTypes\\Helpers\\AuthExtension::testAuthGuardAdminUser() should return App\\Admin|null but returns Illuminate\\Contracts\\Auth\\Authenticatable|null.
public function testAuthGuardAdminUser(): ?Admin
{
    return auth()->guard('admin')->user();
}

[szepeviktor]

Thank you.
Seem like everything is 🍏

[0xb4lint]

@szepeviktor @canvural I've finished a feature that dynamically resolves the actual guard (from nodeKey) and loads model from config for the return type.

Like these (note the ?Admin typehint):

// config/auth.php
// 'guards' => [
//     ...
//     'admin' => [
//         'driver' => 'session',
//         'provider' => 'admins',
//     ],
// ],
// 'providers' => [
//     ...
//    'admins' => [
//         'driver' => 'eloquent',
//         'model' => App\Admin::class,
//     ],
// ],

public function testGuardAdminUser(): ?Admin
{
    return Auth::guard('admin')->user();
}

public function testAuthGuardAdminParameterUser(): ?Admin
{
    return auth('admin')->user();
}

Should I wait for this merge or add the commit for this PR?

[0xb4lint]

@szepeviktor @canvural I've finished editing this PR. Added all the stuff for the dynamic guard return type feature. :)

[0xb4lint]

@canvural Have you had a chance to look at this yet?

[canvural]

Sorry no. I'm on holiday. I'll take a look next week 👍

[0xb4lint]

All right, have fun! 😉

[canvural]

Thank you for the PR! I left some comments. Other than that, it looks good!

[0xb4lint]

@canvural thanks for your feedback! I've fixed your comments, please check it.

[canvural]

Thank you! Looks good 👍