From b881c1a64e6017dbdb354495d7c774969cccd5c0 Mon Sep 17 00:00:00 2001 From: mraheelkhan Date: Wed, 4 Sep 2024 09:24:29 +0000 Subject: [PATCH 1/2] Fix styling --- src/Models/Permission.php | 2 +- src/Models/Role.php | 2 +- src/Traits/HasPermissions.php | 2 +- tests/HasPermissionsTest.php | 6 +++--- tests/PermissionMiddlewareTest.php | 14 +++++++------- tests/RoleMiddlewareTest.php | 14 +++++++------- tests/RoleOrPermissionMiddlewareTest.php | 14 +++++++------- tests/TestCase.php | 4 ++-- tests/TestHelper.php | 4 ++-- tests/WildcardMiddlewareTest.php | 10 +++++----- 10 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/Models/Permission.php b/src/Models/Permission.php index d23d15ac2..fd54b8ca0 100644 --- a/src/Models/Permission.php +++ b/src/Models/Permission.php @@ -107,7 +107,7 @@ public static function findByName(string $name, ?string $guardName = null): Perm public static function findById(int|string $id, ?string $guardName = null): PermissionContract { $guardName = $guardName ?? Guard::getDefaultName(static::class); - $permission = static::getPermission([(new static())->getKeyName() => $id, 'guard_name' => $guardName]); + $permission = static::getPermission([(new static)->getKeyName() => $id, 'guard_name' => $guardName]); if (! $permission) { throw PermissionDoesNotExist::withId($id, $guardName); diff --git a/src/Models/Role.php b/src/Models/Role.php index 86d81d379..e29e2d449 100644 --- a/src/Models/Role.php +++ b/src/Models/Role.php @@ -117,7 +117,7 @@ public static function findById(int|string $id, ?string $guardName = null): Role { $guardName = $guardName ?? Guard::getDefaultName(static::class); - $role = static::findByParam([(new static())->getKeyName() => $id, 'guard_name' => $guardName]); + $role = static::findByParam([(new static)->getKeyName() => $id, 'guard_name' => $guardName]); if (! $role) { throw RoleDoesNotExist::withId($id, $guardName); diff --git a/src/Traits/HasPermissions.php b/src/Traits/HasPermissions.php index 2514458d8..25d506088 100644 --- a/src/Traits/HasPermissions.php +++ b/src/Traits/HasPermissions.php @@ -190,7 +190,7 @@ public function filterPermission($permission, $guardName = null) } if (! $permission instanceof Permission) { - throw new PermissionDoesNotExist(); + throw new PermissionDoesNotExist; } return $permission; diff --git a/tests/HasPermissionsTest.php b/tests/HasPermissionsTest.php index 4c9528d0e..ce197b16c 100644 --- a/tests/HasPermissionsTest.php +++ b/tests/HasPermissionsTest.php @@ -263,7 +263,7 @@ public function it_throws_an_exception_when_calling_hasPermissionTo_with_an_inva $this->expectException(PermissionDoesNotExist::class); - $user->hasPermissionTo(new \stdClass()); + $user->hasPermissionTo(new \stdClass); } /** @test */ @@ -283,7 +283,7 @@ public function it_throws_an_exception_when_calling_hasDirectPermission_with_an_ $this->expectException(PermissionDoesNotExist::class); - $user->hasDirectPermission(new \stdClass()); + $user->hasDirectPermission(new \stdClass); } /** @test */ @@ -405,7 +405,7 @@ public function it_throws_an_exception_when_the_permission_does_not_exist_for_th /** @test */ public function it_can_reject_a_user_that_does_not_have_any_permissions_at_all() { - $user = new User(); + $user = new User; $this->assertFalse($user->hasPermissionTo('edit-articles')); } diff --git a/tests/PermissionMiddlewareTest.php b/tests/PermissionMiddlewareTest.php index aefc7849e..354f1f8b1 100644 --- a/tests/PermissionMiddlewareTest.php +++ b/tests/PermissionMiddlewareTest.php @@ -24,7 +24,7 @@ protected function setUp(): void { parent::setUp(); - $this->permissionMiddleware = new PermissionMiddleware(); + $this->permissionMiddleware = new PermissionMiddleware; } /** @test */ @@ -305,8 +305,8 @@ public function the_required_permissions_can_be_fetched_from_the_exception() $requiredPermissions = []; try { - $this->permissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->permissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-permission'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); @@ -326,8 +326,8 @@ public function the_required_permissions_can_be_displayed_in_the_exception() $message = null; try { - $this->permissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->permissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-permission'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); @@ -342,8 +342,8 @@ public function use_not_existing_custom_guard_in_permission() $class = null; try { - $this->permissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->permissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'edit-articles', 'xxx'); } catch (InvalidArgumentException $e) { $class = get_class($e); diff --git a/tests/RoleMiddlewareTest.php b/tests/RoleMiddlewareTest.php index 7ffc3a5c6..780277068 100644 --- a/tests/RoleMiddlewareTest.php +++ b/tests/RoleMiddlewareTest.php @@ -22,7 +22,7 @@ protected function setUp(): void { parent::setUp(); - $this->roleMiddleware = new RoleMiddleware(); + $this->roleMiddleware = new RoleMiddleware; } /** @test */ @@ -238,8 +238,8 @@ public function the_required_roles_can_be_fetched_from_the_exception() $requiredRoles = []; try { - $this->roleMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-role'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); @@ -259,8 +259,8 @@ public function the_required_roles_can_be_displayed_in_the_exception() $message = null; try { - $this->roleMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-role'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); @@ -275,8 +275,8 @@ public function use_not_existing_custom_guard_in_role() $class = null; try { - $this->roleMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'testRole', 'xxx'); } catch (InvalidArgumentException $e) { $class = get_class($e); diff --git a/tests/RoleOrPermissionMiddlewareTest.php b/tests/RoleOrPermissionMiddlewareTest.php index 4d473aa4f..617c4c5af 100644 --- a/tests/RoleOrPermissionMiddlewareTest.php +++ b/tests/RoleOrPermissionMiddlewareTest.php @@ -23,7 +23,7 @@ protected function setUp(): void { parent::setUp(); - $this->roleOrPermissionMiddleware = new RoleOrPermissionMiddleware(); + $this->roleOrPermissionMiddleware = new RoleOrPermissionMiddleware; } /** @test */ @@ -177,8 +177,8 @@ public function use_not_existing_custom_guard_in_role_or_permission() $class = null; try { - $this->roleOrPermissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleOrPermissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'testRole', 'xxx'); } catch (InvalidArgumentException $e) { $class = get_class($e); @@ -242,8 +242,8 @@ public function the_required_permissions_or_roles_can_be_fetched_from_the_except $requiredRolesOrPermissions = []; try { - $this->roleOrPermissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleOrPermissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-permission|some-role'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); @@ -264,8 +264,8 @@ public function the_required_permissions_or_roles_can_be_displayed_in_the_except $message = null; try { - $this->roleOrPermissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->roleOrPermissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'some-permission|some-role'); } catch (UnauthorizedException $e) { $message = $e->getMessage(); diff --git a/tests/TestCase.php b/tests/TestCase.php index 3a5532c8b..9e5e36c34 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -292,7 +292,7 @@ public function runMiddleware($middleware, $permission, $guard = null, bool $cli try { return $middleware->handle($request, function () { - return (new Response())->setContent(''); + return (new Response)->setContent(''); }, $permission, $guard)->status(); } catch (UnauthorizedException $e) { return $e->getStatusCode(); @@ -312,7 +312,7 @@ public function getRouter() public function getRouteResponse() { return function () { - return (new Response())->setContent(''); + return (new Response)->setContent(''); }; } diff --git a/tests/TestHelper.php b/tests/TestHelper.php index 5b8efa5cd..5eddab214 100644 --- a/tests/TestHelper.php +++ b/tests/TestHelper.php @@ -16,8 +16,8 @@ class TestHelper public function testMiddleware($middleware, $parameter) { try { - return $middleware->handle(new Request(), function () { - return (new Response())->setContent(''); + return $middleware->handle(new Request, function () { + return (new Response)->setContent(''); }, $parameter)->status(); } catch (HttpException $e) { return $e->getStatusCode(); diff --git a/tests/WildcardMiddlewareTest.php b/tests/WildcardMiddlewareTest.php index dc359fe49..596913707 100644 --- a/tests/WildcardMiddlewareTest.php +++ b/tests/WildcardMiddlewareTest.php @@ -23,11 +23,11 @@ protected function setUp(): void { parent::setUp(); - $this->roleMiddleware = new RoleMiddleware(); + $this->roleMiddleware = new RoleMiddleware; - $this->permissionMiddleware = new PermissionMiddleware(); + $this->permissionMiddleware = new PermissionMiddleware; - $this->roleOrPermissionMiddleware = new RoleOrPermissionMiddleware(); + $this->roleOrPermissionMiddleware = new RoleOrPermissionMiddleware; app('config')->set('permission.enable_wildcard_permission', true); } @@ -146,8 +146,8 @@ public function the_required_permissions_can_be_fetched_from_the_exception() $requiredPermissions = []; try { - $this->permissionMiddleware->handle(new Request(), function () { - return (new Response())->setContent(''); + $this->permissionMiddleware->handle(new Request, function () { + return (new Response)->setContent(''); }, 'permission.some'); } catch (UnauthorizedException $e) { $requiredPermissions = $e->getRequiredPermissions(); From df0ebb997d77ae01df0bf4a52073b61b17859606 Mon Sep 17 00:00:00 2001 From: Raheel Khan <30007262+mraheelkhan@users.noreply.github.com> Date: Wed, 4 Sep 2024 14:27:19 +0500 Subject: [PATCH 2/2] Add PR links to upgrade guide --- docs/upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrading.md b/docs/upgrading.md index da3d4423d..2d56f9b18 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -39,7 +39,7 @@ eg: if you have a custom model you will need to make changes, including accessin Be sure to compare your custom models with originals to see what else may have changed. -3. Model and Contract/Interface updates. The Role and Permission Models and Contracts/Interfaces have been updated with syntax changes to method signatures. Update any models you have extended, or contracts implemented, accordingly. See PR #2380 and #2480 for some of the specifics. +3. Model and Contract/Interface updates. The Role and Permission Models and Contracts/Interfaces have been updated with syntax changes to method signatures. Update any models you have extended, or contracts implemented, accordingly. See PR [#2380](https://github.com/spatie/laravel-permission/pull/2380) and [#2480](https://github.com/spatie/laravel-permission/pull/2480) for some of the specifics. 4. Migrations WILL need to be upgraded. (They have been updated to anonymous-class syntax that was introduced in Laravel 8, AND some structural coding changes in the registrar class changed the way we extracted configuration settings in the migration files.) There are no changes to the package's structure since v5, so if you had not customized it from the original then replacing the contents of the file should be enough. (Usually the only customization is if you've switched to UUIDs or customized MySQL index name lengths.) **If you get the following error, it means your migration file needs upgrading: `Error: Access to undeclared static property Spatie\Permission\PermissionRegistrar::$pivotPermission`**