UserAndLevel - Code Metrics - Inspection of "stopping work for the day" - z1haze/laravel-acl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c436ad...d0a6e2 )

by Stephen

created 2017-02-07 19:58 UTC

UserAndLevel C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	475
Duplicated Lines	15.58 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

98.71%

Importance

Changes

Metric	Value
dl	74
loc	475
c	0
b	0
f	0
wmc	59
lcom	1
cbo	2
ccs	153
cts	155
cp	0.9871
rs	6.1904

25 Methods

Rating	Name	Duplication	Size	Complexity
A	isLevel()	0	6	2
A	hasLevel()	0	8	2
A	addPermission()	0	4	1
A	addPermissions()	0	4	1
A	removePermission()	0	4	1
A	removePermissions()	0	4	1
A	syncPermissions()	0	4	1
A	clearPermissions()	0	8	3
A	getAllPermissions()	12	12	2
A	getInheritedPermissions()	12	12	2
A	getAvailablePermissions()	12	12	2
A	hasPermissionTo()	0	12	2
A	isLowerThan()	0	6	2
A	isHigherThan()	0	6	2
A	isEqualTo()	0	6	2
A	cacheGetAllPermissions()	0	16	2
A	cacheGetInheritedPermissions()	0	18	3
A	cacheGetAvailablePermissions()	0	6	1
A	cacheHasPermissionTo()	0	15	4
B	modifyPermissions()	0	22	6
A	buildPermissionsArray()	0	19	4
A	addOrNegate()	0	8	3
A	remove()	11	11	3
A	sync()	14	14	3
A	getPermission()	13	13	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UserAndLevel often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UserAndLevel, and based on these observations, apply Extract Interface, too.

<?php

namespace z1haze\Acl\Traits;

use Illuminate\Support\Collection;
use z1haze\Acl\Exceptions\PermissionNotFoundException;
use z1haze\Acl\Models\Level;
use z1haze\Acl\Models\Permission;

trait UserAndLevel
{
    /**
     * USER & LEVEL
     * Check if a model has a given level
     *
     * @param $level
     * @return bool
     */
    public function isLevel($level)
    {
        $level = $this->getALevel($level);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return is_a($this, config('laravel-acl.level'), true) ? $this->name == $level->name : $this->level->name == $level->name;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * USER & LEVEL
     * Check if a user has or has inherited
     * a given level
     *
     * @param $level
     * @return bool
     */
    public function hasLevel($level)
    {
        $level = $this->getLevel($level);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return get_class($this) == config('laravel-acl.level') ?
            $this->rank <= $level->rank :
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->level->rank <= $level->rank;
    }

    /**
     * USER & LEVEL
     * Add a single permission to a model
     *
     * @param $permission
     */
    public function addPermission($permission)
    {
        $this->modifyPermissions([$permission], 'add');
    }

    /**
     * USER & LEVEL
     * Add an array of permissions to a model
     *
     * @param $permissions
     */
    public function addPermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'add');
    }

    /**
     * USER & LEVEL
     * Remove a permission from a model
     *
     * @param $permission
     */
    public function removePermission($permission)
    {
        $this->modifyPermissions([$permission], 'remove');
    }

    /**
     * USER & LEVEL
     * Remove an array of permissions objects or permission names (can be mixed)
     *
     * @param $permissions
     */
    public function removePermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'remove');
    }

    /**
     * USER & LEVEL
     * Sync permissions on a model
     *
     * @param $permissions
     */
    public function syncPermissions(array $permissions)
    {
        $this->modifyPermissions($permissions, 'sync');
    }

    /**
     * USER & LEVEL
     * Clear permissions from a model
     *
     * @return mixed
     */
    public function clearPermissions()
    {
        if (get_class($this) == config('laravel-acl.user'))
            $this->permissions()->detach();


        if (get_class($this) == config('laravel-acl.level'))
            config('laravel-acl.permission', Permission::class)::whereLevelId($this->id)->update(['level_id' => null]);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }


    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetAllPermissions()
     *
     * @return mixed
     */
    public function getAllPermissions()

    {
        $model = get_class($this) == config('laravel-acl.level') ? 'Level' : 'User';

        return \Cache::remember(
            'laravel-acl.getAllPermissionsFor' . $model . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function () {
                return $this->cacheGetAllPermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetInheritedPermissions()
     *
     * @return mixed
     */
    public function getInheritedPermissions()

    {
        $model = get_class($this) == config('laravel-acl.level') ? 'Level' : 'User';

        return \Cache::remember(
            'laravel-acl.getInheritedPermissionsFor' . $model . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function () {
                return $this->cacheGetInheritedPermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheGetAvailablePermissions()
     *
     * @return mixed
     */
    public function getAvailablePermissions()

    {
        $model = get_class($this) == config('laravel-acl.level') ? 'Level' : 'User';

        return \Cache::remember(
            'laravel-acl.getAvailablePermissionsFor' . $model . '_' . $this->id,
            config('laravel-acl.cacheMinutes'),
            function () {
                return $this->cacheGetAvailablePermissions();
            }
        );
    }

    /**
     * USER & LEVEL
     * First try the cache to return the collection,
     * then fetch it from the database.
     *
     * See @cacheHasPermissionTo()
     *
     * @param $permission
     * @return mixed
     */
    public function hasPermissionTo($permission)
    {
        $model = get_class($this) == config('laravel-acl.level') ? 'Level' : 'User';

        return \Cache::remember(
            'laravel-acl.hasPermissionTo_' . $model . '_' . $this->id . '_Permission_' . $permission,
            config('laravel-acl.cacheMinutes'),
            function () use ($permission) {
                return $this->cacheHasPermissionTo($permission);
            }
        );
    }

    /**
     * USER & LEVEL
     * Returns if a level is lower ranking than another level,
     * or if a user is lower ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isLowerThan($other)
    {
        return get_class($this) == config('laravel-acl.user') ?
            $this->level->rank > $other->level->rank :
            $this->rank > $other->rank;
    }

    /**
     * USER & LEVEL
     * Returns if a level is higher ranking than another level,
     * or if a user is higher ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isHigherThan($other)
    {
        return get_class($this) == config('laravel-acl.user') ?
            $this->level->rank < $other->level->rank :
            $this->rank < $other->rank;
    }

    /**
     * USER & LEVEL
     * Returns if a equal is lower ranking than another level,
     * or if a user is equal ranking than another user.
     *
     * @param $other
     * @return bool
     */
    public function isEqualTo($other)
    {
        return get_class($this) == config('laravel-acl.user') ?
            $this->level->rank == $other->level->rank :
            $this->rank == $other->rank;
    }


    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * USER & LEVEL
     * Return a collection of all permissions
     * associated to a user by direct or
     * inheritance
     *
     * @return mixed
     */
    protected function cacheGetAllPermissions()
    {
        $rank = get_class($this) == config('laravel-acl.level') ?
            $this->rank :
            $this->level->rank;

        $levels = config('laravel-acl.level', Level::class)::where('rank', '>=', $rank)->with('permissions')->get();

        $allPerms = new Collection();

        $levels->each(function ($level, $key) use (&$allPerms) {

            $allPerms = $allPerms->merge($level->permissions);
        });

        return $allPerms->merge($this->permissions)->unique('id');
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * USER & LEVEL
     * Return a collection of permissions that
     * are inherited from a higher level
     * @return mixed
     */
    protected function cacheGetInheritedPermissions()
    {
        $rank = get_class($this) == config('laravel-acl.level') ?
            $this->rank :
            $this->level->rank;

        $levels = get_class($this) == config('laravel-acl.user') ?
            config('laravel-acl.level', Level::class)::where('rank', '>=', $rank)->with('permissions')->get() :
            config('laravel-acl.level', Level::class)::where('rank', '>', $rank)->with('permissions')->get();

        $inheritedPerms = new Collection();

        $levels->each(function ($level, $key) use (&$inheritedPerms) {

            $inheritedPerms = $inheritedPerms->merge($level->permissions->load('level'));
        });

        return $inheritedPerms->unique('id');
    }

    /**
     * USER & LEVEL
     * Return a collection of permissions still able to be assigned
     * ie, not already inherited or explicitly assigned
     * @return \Illuminate\Database\Eloquent\Collection
     */
    protected function cacheGetAvailablePermissions()
    {
        $allPerms = config('laravel-acl.permission', Permission::class)::with('level')->get();

        return $allPerms->diff($this->permissions);
    }

    /**
     * USER & LEVEL
     * Check if a model has permission to do something
     *
     * @param $permission
     * @return bool
     */
    protected function cacheHasPermissionTo($permission)
    {
        $permission = $this->getPermission($permission);

        if (get_class($this) == config('laravel-acl.user')) {
            $negatedPermissions = $this->permissions()->wherePivot('negated', true)->get();


            if ($this->getAllPermissions()->contains('id', $permission->id)) {
                return !$negatedPermissions->contains('id', $permission->id);
            }
        }
        
        return $this->getAllPermissions()->contains('id', $permission->id) ||
        $this->getAllPermissions()->contains('name', '*');
    }

    /**
     * USER & LEVEL
     * Modify a given set of permissions, given the action to be taken
     *
     * @param $permissions
     * @param $action
     * @return mixed
     */
    protected function modifyPermissions($permissions, $action)
    {
        $model = get_class($this) == config('laravel-acl.level') ? 'Level' : 'User';

        \Cache::forget('laravel-acl.getAvailablePermissionsFor' . $model . '_' . $this->id);
        \Cache::forget('laravel-acl.getAllPermissionsFor' . $model . '_' . $this->id);
        \Cache::forget('laravel-acl.getNegatedPermissionsForUser_' . $this->id);

        $permissionObjects = $this->buildPermissionsArray($permissions, $action, $model);

        if ($action == 'add' || $action == 'negate') {
            $this->addOrNegate($model, $permissionObjects, $action);
        }

        if ($action == 'remove') {
            $this->remove($model, $permissionObjects);
        }

        if ($action == 'sync') {
            $this->sync($model, $permissionObjects);
        }
    }

    /**
     * USER & LEVEL
     * Helper function to build the array
     * for modifyPermissions
     *
     * @param $permissions
     * @param $action
     * @param $model
     * @return mixed
     * @throws PermissionNotFoundException
     */
    protected function buildPermissionsArray($permissions, $action, $model)
    {
        $permissionsObjects = [];

        foreach ($permissions as $permission) {
            $permission = $this->getPermission($permission);
            \Cache::forget('laravel-acl.hasPermissionTo_' . $model . '_' . $this->id . '_Permission_' . $permission->id);

            if ($action == 'negate') {
                $permissionsObjects[$permission->id] = ['negated' => true];
            } else {
                $model == 'User' ?
                    array_push($permissionsObjects, $permission->id) :
                    array_push($permissionsObjects, $permission);
            }
        }

        return $permissionsObjects;
    }

    /**
     * USER & LEVEL
     * Helper function to handle adding or negating permissions
     *
     * @param $model
     * @param $permissionObjects
     */
    protected function addOrNegate($model, $permissionObjects, $action)

    {
        if ($model == 'User')
            $this->permissions()->attach($permissionObjects);


        if ($model == 'Level')
            $this->permissions()->saveMany($permissionObjects);

    }

    /**
     * USER & LEVEL
     * Helper function to handle removing permissions
     *
     * @param $model
     * @param $permissionObjects
     */
    protected function remove($model, $permissionObjects)

    {
        if ($model == 'User')
            $this->permissions()->detach($permissionObjects);


        if ($model == 'Level') {
            config('laravel-acl.permission', Permission::class)::whereIn('id', array_map(function ($permission) {
                return $permission->id;
            }, $permissionObjects))->update(['level_id' => null]);
        }
    }

    /**
     * USER & LEVEL
     * Help function to handle syncing permissions
     *
     * @param $model
     * @param $permissionObjects
     */
    protected function sync($model, $permissionObjects)

    {
        if ($model == 'User')
            $this->permissions()->sync($permissionObjects);


        if ($model == 'Level') {
            $this->clearPermissions();

            config('laravel-acl.permission', Permission::class)::whereIn('id', array_map(function ($permission) {
                return $permission->id;
            }, $permissionObjects))
                ->update(['level_id' => $this->id]);
        }
    }

    /**
     * USER & LEVEL
     * Helper function to get the permission whether it is the permission ID
     * or the permission name, or the permission object itself.
     *
     * @param $permission
     * @return mixed
     * @throws PermissionNotFoundException
     */
    protected function getPermission($permission)

    {
        if (is_string($permission))
            $permission = config('laravel-acl.permission', Permission::class)::whereName($permission)->first();

        if (is_int($permission))
            $permission = config('laravel-acl.permission', Permission::class)::find($permission);

        if (!$permission)
            throw new PermissionNotFoundException;

        return $permission;
    }
}

1		<?php
2
3		namespace z1haze\Acl\Traits;
4
5		use Illuminate\Support\Collection;
6		use z1haze\Acl\Exceptions\PermissionNotFoundException;
7		use z1haze\Acl\Models\Level;
8		use z1haze\Acl\Models\Permission;
9
10		trait UserAndLevel
11		{
12		/**
13		* USER & LEVEL
14		* Check if a model has a given level
15		*
16		* @param $level
17		* @return bool
18		*/
19	1	public function isLevel($level)
20		{
21	1	$level = $this->getALevel($level);
		0 ignored issues – show Bug introduced 2017-02-07 20:00 UTC by Report Bug Copy Issue Report It seems like `getALevel()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22
23	1	return is_a($this, config('laravel-acl.level'), true) ? $this->name == $level->name : $this->level->name == $level->name;
		0 ignored issues – show Bug introduced 2017-02-06 22:10 UTC by Report Bug Copy Issue Report The property `name` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-02-06 22:10 UTC by Report Bug Copy Issue Report The property `level` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
24		}
25
26		/**
27		* USER & LEVEL
28		* Check if a user has or has inherited
29		* a given level
30		*
31		* @param $level
32		* @return bool
33		*/
34	1	public function hasLevel($level)
35		{
36	1	$level = $this->getLevel($level);
		0 ignored issues – show Bug introduced 2017-02-06 17:55 UTC by Report Bug Copy Issue Report It seems like `getLevel()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
37

z1haze / laravel-acl