Role::usersQuery() - Code Metrics - Inspection of "Another update to Laravel-mongodb" - mostafamaklad/laravel-permission-mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#153)

unknown

created 2024-05-14 15:22 UTC

Role::usersQuery() A

↳ Parent: Role

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	4
ccs	0
cts	0
cp	0
crap	2
rs	10

<?php

namespace Maklad\Permission\Models;

use Illuminate\Database\Eloquent\Builder;
use MongoDB\Laravel\Eloquent\Model;
use Maklad\Permission\Contracts\PermissionInterface;
use Maklad\Permission\Contracts\RoleInterface;
use Maklad\Permission\Exceptions\GuardDoesNotMatch;
use Maklad\Permission\Exceptions\RoleAlreadyExists;
use Maklad\Permission\Exceptions\RoleDoesNotExist;
use Maklad\Permission\Guard;
use Maklad\Permission\Helpers;
use Maklad\Permission\Traits\HasPermissions;
use Maklad\Permission\Traits\RefreshesPermissionCache;
use ReflectionException;
use function is_string;

/**
 * Class Role
 * @property string $_id
 * @package Maklad\Permission\Models
 */
class Role extends Model implements RoleInterface
{
    use HasPermissions;

    use RefreshesPermissionCache;

    public $guarded = ['id'];
    protected Helpers $helpers;

    /**
     * Role constructor.
     *
     * @param array $attributes
     *
     * @throws ReflectionException
     */
    public function __construct(array $attributes = [])
    {
        $attributes['guard_name'] = $attributes['guard_name'] ?? (new Guard())->getDefaultName(static::class);

        parent::__construct($attributes);

        $this->helpers = new Helpers();

        $this->setTable(config('permission.collection_names.roles'));
    }

    /**
     * @param array $attributes
     *
     * @return Builder|\Illuminate\Database\Eloquent\Model|RoleInterface
     *
     * @throws RoleAlreadyExists
     * @throws ReflectionException
     */
    public static function create(array $attributes = []): \Illuminate\Database\Eloquent\Model|RoleInterface|Builder
    {
        $attributes['guard_name'] = $attributes['guard_name'] ?? (new Guard())->getDefaultName(static::class);
        $helpers = new Helpers();

        if (static::query()->where('name', $attributes['name'])->where('guard_name', $attributes['guard_name'])->first()) {
            $name = (string)$attributes['name'];
            $guardName = (string)$attributes['guard_name'];
            throw new RoleAlreadyExists($helpers->getRoleAlreadyExistsMessage($name, $guardName));
        }

        return static::query()->create($attributes);
    }

    /**
     * Find or create role by its name (and optionally guardName).
     *
     * @param string $name
     * @param string|null $guardName
     *
     * @return RoleInterface
     * @throws RoleAlreadyExists
     * @throws ReflectionException
     */
    public static function findOrCreate(string $name, string $guardName = null): Role
    {
        $guardName = $guardName ?? (new Guard())->getDefaultName(static::class);

        $role = static::query()
            ->where('name', $name)
            ->where('guard_name', $guardName)
            ->first();

        if (!$role) {
            $role = static::create(['name' => $name, 'guard_name' => $guardName]);
        }

        return $role;
    }

    /**
     * Find a role by its name and guard name.
     *
     * @param string $name
     * @param string|null $guardName
     *
     * @return RoleInterface
     * @throws RoleDoesNotExist
     * @throws ReflectionException
     */
    public static function findByName(string $name, string $guardName = null): RoleInterface
    {
        $guardName = $guardName ?? (new Guard())->getDefaultName(static::class);

        $role = static::query()
            ->where('name', $name)
            ->where('guard_name', $guardName)
            ->first();

        if (!$role) {
            $helpers = new Helpers();
            throw new RoleDoesNotExist($helpers->getRoleDoesNotExistMessage($name, $guardName));
        }

        return $role;
    }

    /**
     * A permission belongs to some users of the model associated with its guard.
     * @return mixed
     */
    public function usersQuery(): mixed
    {
        $usersClass = app($this->helpers->getModelForGuard($this->attributes['guard_name']));
        return $usersClass->query()->where('role_ids', 'all', [$this->_id]);
    }

    /**
     * A permission belongs to some users of the model associated with its guard.
     * @return mixed
     */
    public function getUsersAttribute(): mixed
    {
        return $this->usersQuery()->get();
    }

    /**
     * Determine if the user may perform the given permission.
     *
     * @param string|Permission $permission
filter:
    dependency_paths: ["lib/*"]
     *
     * @return bool
     *
     * @throws GuardDoesNotMatch
     * @throws ReflectionException
     */
    public function hasPermissionTo(string|PermissionInterface $permission): bool
    {
        if (is_string($permission)) {
            $permission = $this->getPermissionClass()->findByName($permission, $this->getDefaultGuardName());
        }

        if (!$this->getGuardNames()->contains($permission->guard_name)) {
            $expected = $this->getGuardNames();
            $given = $permission->guard_name;

            throw new GuardDoesNotMatch($this->helpers->getGuardDoesNotMatchMessage($expected, $given));
        }

        return in_array($permission->_id, $this->permission_ids ?? [], true);
    }
}


1		<?php
2
3		namespace Maklad\Permission\Models;
4
5		use Illuminate\Database\Eloquent\Builder;
6		use MongoDB\Laravel\Eloquent\Model;
7		use Maklad\Permission\Contracts\PermissionInterface;
8		use Maklad\Permission\Contracts\RoleInterface;
9		use Maklad\Permission\Exceptions\GuardDoesNotMatch;
10		use Maklad\Permission\Exceptions\RoleAlreadyExists;
11		use Maklad\Permission\Exceptions\RoleDoesNotExist;
12		use Maklad\Permission\Guard;
13		use Maklad\Permission\Helpers;
14		use Maklad\Permission\Traits\HasPermissions;
15		use Maklad\Permission\Traits\RefreshesPermissionCache;
16		use ReflectionException;
17		use function is_string;
18
19		/**
20		* Class Role
21		* @property string $_id
22		* @package Maklad\Permission\Models
23		*/
24		class Role extends Model implements RoleInterface
25		{
26		use HasPermissions;
		0 ignored issues – show introduced 2024-05-14 14:49 UTC by Report Bug Copy Issue Report The trait `Maklad\Permission\Traits\HasPermissions` requires some properties which are not provided by `Maklad\Permission\Models\Role`: `$permissions`, `$roles`, `$guard_name` Loading history...
27		use RefreshesPermissionCache;
28
29		public $guarded = ['id'];
30		protected Helpers $helpers;
31
32		/**
33		* Role constructor.
34		*
35	123	* @param array $attributes
36		*
37	123	* @throws ReflectionException
38		*/
39	123	public function __construct(array $attributes = [])
40		{
41	123	$attributes['guard_name'] = $attributes['guard_name'] ?? (new Guard())->getDefaultName(static::class);
42
43	123	parent::__construct($attributes);
44	123
45		$this->helpers = new Helpers();
46
47		$this->setTable(config('permission.collection_names.roles'));
48		}
49
50		/**
51		* @param array $attributes
52		*
53		* @return Builder\|\Illuminate\Database\Eloquent\Model\|RoleInterface
54		*
55	123	* @throws RoleAlreadyExists
56		* @throws ReflectionException
57	123	*/
58	123	public static function create(array $attributes = []): \Illuminate\Database\Eloquent\Model\|RoleInterface\|Builder
59		{
60	123	$attributes['guard_name'] = $attributes['guard_name'] ?? (new Guard())->getDefaultName(static::class);
61	1	$helpers = new Helpers();
62	1
63	1	if (static::query()->where('name', $attributes['name'])->where('guard_name', $attributes['guard_name'])->first()) {
64		$name = (string)$attributes['name'];
65		$guardName = (string)$attributes['guard_name'];
66	123	throw new RoleAlreadyExists($helpers->getRoleAlreadyExistsMessage($name, $guardName));
67		}
68
69		return static::query()->create($attributes);
70	123	}
71
72		/**
73		* Find or create role by its name (and optionally guardName).
74		*
75		* @param string $name
76		* @param string\|null $guardName
77		*
78		* @return RoleInterface
79		* @throws RoleAlreadyExists
80		* @throws ReflectionException
81		*/
82		public static function findOrCreate(string $name, string $guardName = null): Role
83	1	{
84		$guardName = $guardName ?? (new Guard())->getDefaultName(static::class);
85	1
86		$role = static::query()
87	1	->where('name', $name)
88	1	->where('guard_name', $guardName)
89	1	->first();
90
91	1	if (!$role) {
92	1	$role = static::create(['name' => $name, 'guard_name' => $guardName]);
93		}
94
95	1	return $role;
96		}
97
98		/**
99		* Find a role by its name and guard name.
100		*
101		* @param string $name
102		* @param string\|null $guardName
103		*
104		* @return RoleInterface
105		* @throws RoleDoesNotExist
106		* @throws ReflectionException
107		*/
108	49	public static function findByName(string $name, string $guardName = null): RoleInterface
109		{
110	49	$guardName = $guardName ?? (new Guard())->getDefaultName(static::class);
111
112	49	$role = static::query()
113	49	->where('name', $name)
114	49	->where('guard_name', $guardName)
115		->first();
116	49
117	2	if (!$role) {
118	2	$helpers = new Helpers();
119		throw new RoleDoesNotExist($helpers->getRoleDoesNotExistMessage($name, $guardName));
120		}
121	47
122		return $role;
123		}
124
125		/**
126		* A permission belongs to some users of the model associated with its guard.
127		* @return mixed
128		*/
129		public function usersQuery(): mixed
130		{
131		$usersClass = app($this->helpers->getModelForGuard($this->attributes['guard_name']));
132		return $usersClass->query()->where('role_ids', 'all', [$this->_id]);
133		}
134	12
135		/**
136	12	* A permission belongs to some users of the model associated with its guard.
137	9	* @return mixed
138		*/
139		public function getUsersAttribute(): mixed
140	11	{
141	1	return $this->usersQuery()->get();
142	1	}
143
144	1	/**
145		* Determine if the user may perform the given permission.
146		*
147	10	* @param string\|Permission $permission
		0 ignored issues – show Bug introduced 2024-05-14 14:49 UTC by Report Bug Copy Issue Report The type `Maklad\Permission\Models\Permission` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
148		*
149		* @return bool
150		*
151		* @throws GuardDoesNotMatch
152		* @throws ReflectionException
153		*/
154		public function hasPermissionTo(string\|PermissionInterface $permission): bool
155		{
156		if (is_string($permission)) {
157		$permission = $this->getPermissionClass()->findByName($permission, $this->getDefaultGuardName());
158		}
159
160		if (!$this->getGuardNames()->contains($permission->guard_name)) {
161		$expected = $this->getGuardNames();
162		$given = $permission->guard_name;
163
164		throw new GuardDoesNotMatch($this->helpers->getGuardDoesNotMatchMessage($expected, $given));
165		}
166
167		return in_array($permission->_id, $this->permission_ids ?? [], true);
168		}
169		}
170

mostafamaklad / laravel-permission-mongodb

Pull Request — master (#153)

Role::usersQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like