Merge pull request #54 from yajra/yanbrasiliano-fix-gateregistrar-permissions

fix: Ensure getPermissions returns Collection

Author: yajra

composer.json

@@ -24,10 +24,10 @@
         "illuminate/database": "^11.0"
     },
     "require-dev": {
-        "larastan/larastan": "^2.9.1",
-        "laravel/pint": "^1.14",
-        "rector/rector": "^1.0",
-        "orchestra/testbench": "^9.0"
+        "larastan/larastan": "^2.9.8",
+        "laravel/pint": "^1.17.1",
+        "rector/rector": "^1.2.2",
+        "orchestra/testbench": "^9.2"
     },
     "autoload": {
         "psr-4": {

phpstan.neon.dist

@@ -11,5 +11,3 @@ parameters:
     ignoreErrors:
 
     excludePaths:
-
-    checkMissingIterableValueType: true

src/Directives/DirectiveAbstract.php

@@ -9,7 +9,5 @@ abstract class DirectiveAbstract
     /**
      * IsRoleDirective constructor.
      */
-    public function __construct(protected Guard $auth)
-    {
-    }
+    public function __construct(protected Guard $auth) {}
 }

src/GateRegistrar.php

@@ -5,27 +5,22 @@
 use Illuminate\Contracts\Auth\Access\Gate as GateContract;
 use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Foundation\Auth\User;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Yajra\Acl\Models\Permission;
 
 class GateRegistrar
 {
-    public function __construct(public GateContract $gate, public Repository $cache)
-    {
-    }
+    public function __construct(public GateContract $gate, public Repository $cache) {}
 
     public function register(): void
     {
-        collect($this->getPermissions())->each(function ($data) {
-            $permission = new Permission($data);
-
+        $this->getPermissions()->each(function (Permission $permission) {
             $ability = $permission->slug;
             $policy = function (User $user) use ($permission) {
                 if (method_exists($user, 'getPermissions')) {
                     // @phpstan-ignore-next-line
-                    $permissions = collect($user->getPermissions());
-
-                    return $permissions->contains($permission->slug);
+                    return collect($user->getPermissions())->contains($permission->slug);
                 }
 
                 return false;
@@ -43,36 +38,32 @@ public function register(): void
     /**
      * Get all permissions.
      *
-     * @return array<array<string, mixed>>
+     * @return \Illuminate\Support\Collection<array-key, Permission>
      */
-    protected function getPermissions(): array
+    protected function getPermissions(): Collection
     {
         /** @var string $key */
         $key = config('acl.cache.key', 'permissions.policies');
 
         try {
-            if (config('acl.cache.enabled', true)) {
-                return $this->cache->rememberForever($key, fn () => $this->getPermissionsFromQuery());
-            } else {
-                return $this->getPermissionsFromQuery();
-            }
+            return config('acl.cache.enabled', true)
+                ? $this->cache->rememberForever($key, fn () => $this->getPermissionsFromQuery())
+                : $this->getPermissionsFromQuery();
         } catch (\Throwable) {
             $this->cache->forget($key);
 
-            return [];
+            return collect();
         }
     }
 
     /**
-     * @return array<array<string, mixed>>
+     * @return \Illuminate\Support\Collection<array-key, Permission>
      */
-    public function getPermissionsFromQuery(): array
+    public function getPermissionsFromQuery(): Collection
     {
-        // @phpstan-ignore-next-line
         return $this->getPermissionClass()
             ->with('roles')
-            ->get()
-            ->toArray();
+            ->get();
     }
 
     protected function getPermissionClass(): Permission

src/Models/Permission.php

@@ -105,6 +105,7 @@ public function users(): BelongsToMany
         /** @var class-string<\Illuminate\Foundation\Auth\User> $model */
         $model = config('acl.user', config('auth.providers.users.model'));
 
+        // @phpstan-ignore-next-line
         return $this->belongsToMany($model)->withTimestamps();
     }
 }

src/Models/Role.php

@@ -48,6 +48,7 @@ public function users(): BelongsToMany
         /** @var class-string<\Illuminate\Foundation\Auth\User> $model */
         $model = config('acl.user', config('auth.providers.users.model'));
 
+        // @phpstan-ignore-next-line
         return $this->belongsToMany($model)->withTimestamps();
     }
 }

src/Traits/InteractsWithPermission.php

@@ -69,9 +69,10 @@ public function grantPermission(mixed $ids, array $attributes = [], bool $touch
      */
     public function permissions(): BelongsToMany
     {
-        /** @var class-string $model */
+        /** @var class-string<Permission> $model */
         $model = config('acl.permission', Permission::class);
 
+        // @phpstan-ignore-next-line
         return $this->belongsToMany($model)->withTimestamps();
     }
 

src/Traits/InteractsWithRole.php

@@ -79,9 +79,10 @@ public function attachRole(mixed $role, array $attributes = [], bool $touch = tr
      */
     public function roles(): BelongsToMany
     {
-        /** @var class-string $model */
+        /** @var class-string<Role> $model */
         $model = config('acl.role', Role::class);
 
+        // @phpstan-ignore-next-line
         return $this->belongsToMany($model)->withTimestamps();
     }
 

tests/Feature/CanAtLeastMiddlewareTest.php

@@ -20,7 +20,7 @@ public function it_can_access_permission_protected_routes()
 
         $middleware = new CanAtLeastMiddleware;
 
-        $response = $middleware->handle(new Request(), fn () => 'Pass', 'create-article,non-existing-permission');
+        $response = $middleware->handle(new Request, fn () => 'Pass', 'create-article,non-existing-permission');
 
         $this->assertEquals('Pass', $response);
     }

tests/Feature/HasRoleTest.php

@@ -181,10 +181,10 @@ public function it_can_query_with_having_roles_scopes()
 
         $supportUser->attachRole($support);
 
-        $roles = (new User())->havingRoles([$manager->getKey(), $support->getKey()])->get();
+        $roles = (new User)->havingRoles([$manager->getKey(), $support->getKey()])->get();
         $this->assertCount(2, $roles);
 
-        $roles = (new User())->havingRolesBySlugs([$manager->slug, $user->slug])->get();
+        $roles = (new User)->havingRolesBySlugs([$manager->slug, $user->slug])->get();
         $this->assertCount(1, $roles);
     }
 }