Guard - Code Metrics - Inspection of "secutiry moved into components" - spiral/components - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — feature/pre-split (197e7e)

by Anton

created 2016-12-19 12:45 UTC

Guard A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	0
loc	111
c	0
b	0
f	0
rs	10
wmc	12
lcom	1
cbo	4

6 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
B	allows()	21	6
A	getRoles()	4	1
A	withRoles()	7	1
A	getActor()	8	2
A	withActor()	7	1

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Security;

use Spiral\Core\Component;
use Spiral\Security\Exceptions\GuardException;

/**
 * Checks permissions using given actor.
 */
class Guard extends Component implements GuardInterface
{
    /**
     * @var ActorInterface|null
     */
    private $actor = null;

    /**
     * Session specific roles.
     *
     * @var array
     */
    private $roles = [];

    /**
     * @var PermissionsInterface
     */
    private $permissions = null;

    /**
     * @param array                $roles Session specific roles.
     * @param ActorInterface       $actor
     * @param PermissionsInterface $permissions
     */
    public function __construct(
        array $roles = [],
        ActorInterface $actor = null,
        PermissionsInterface $permissions
    ) {
        $this->roles = $roles;
        $this->actor = $actor;
        $this->permissions = $permissions;
    }

    /**
     * {@inheritdoc}
     */
    public function allows(string $permission, array $context = []): bool
    {
        foreach ($this->getRoles() as $role) {
            if (!$this->permissions->hasRole($role)) {
                continue;
            }

            $rule = $this->permissions->getRule($role, $permission);
            if ($rule === self::ALLOW) {
                return true;
            }

            if ($rule instanceof RuleInterface) {
                if ($rule->allows($this->actor, $permission, $context)) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Currently active actor/session roles.
     *
     * @return array
     *
     * @throws GuardException
     */
    public function getRoles(): array
    {
        return array_merge($this->roles, $this->actor->getRoles());
    }

    /**
     * Create instance of guard with session specific roles (existed roles will be droppped).
     *
     * @param array $roles
     *
     * @return self
     */
    public function withRoles(array $roles): Guard
    {
        $guard = clone $this;
        $guard->roles = $roles;

        return $guard;
    }

    /**
     * {@inheritdoc}
     *
     * @throws GuardException
     */
    public function getActor(): ActorInterface
    {
        if (empty($this->actor)) {
            throw new GuardException("Unable to get Guard Actor, no value set");
        }

        return $this->actor;
    }

    /**
     * {@inheritdoc}
     */
    public function withActor(ActorInterface $actor): GuardInterface
    {
        $guard = clone $this;
        $guard->actor = $actor;

        return $guard;
    }
}

1			<?php
2			/**
3			* Spiral Framework.
4			*
5			* @license MIT
6			* @author Anton Titov (Wolfy-J)
7			*/
8			namespace Spiral\Security;
9
10			use Spiral\Core\Component;
11			use Spiral\Security\Exceptions\GuardException;
12
13			/**
14			* Checks permissions using given actor.
15			*/
16			class Guard extends Component implements GuardInterface
17			{
18			/**
19			* @var ActorInterface\|null
20			*/
21			private $actor = null;
22
23			/**
24			* Session specific roles.
25			*
26			* @var array
27			*/
28			private $roles = [];
29
30			/**
31			* @var PermissionsInterface
32			*/
33			private $permissions = null;
34
35			/**
36			* @param array $roles Session specific roles.
37			* @param ActorInterface $actor
38			* @param PermissionsInterface $permissions
39			*/
40			public function __construct(
41			array $roles = [],
42			ActorInterface $actor = null,
43			PermissionsInterface $permissions
44			) {
45			$this->roles = $roles;
46			$this->actor = $actor;
47			$this->permissions = $permissions;
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function allows(string $permission, array $context = []): bool
54			{
55			foreach ($this->getRoles() as $role) {
56			if (!$this->permissions->hasRole($role)) {
57			continue;
58			}
59
60			$rule = $this->permissions->getRule($role, $permission);
61			if ($rule === self::ALLOW) {
62			return true;
63			}
64
65			if ($rule instanceof RuleInterface) {
66			if ($rule->allows($this->actor, $permission, $context)) {
			0 ignored issues – show Bug introduced 2016-12-19 12:48 UTC by Report Bug Copy Issue Report It seems like `$this->actor` can be `null`; however, `allows()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
67			return true;
68			}
69			}
70			}
71
72			return false;
73			}
74
75			/**
76			* Currently active actor/session roles.
77			*
78			* @return array
79			*
80			* @throws GuardException
81			*/
82			public function getRoles(): array
83			{
84			return array_merge($this->roles, $this->actor->getRoles());
85			}
86
87			/**
88			* Create instance of guard with session specific roles (existed roles will be droppped).
89			*
90			* @param array $roles
91			*
92			* @return self
93			*/
94			public function withRoles(array $roles): Guard
95			{
96			$guard = clone $this;
97			$guard->roles = $roles;
98
99			return $guard;
100			}
101
102			/**
103			* {@inheritdoc}
104			*
105			* @throws GuardException
106			*/
107			public function getActor(): ActorInterface
108			{
109			if (empty($this->actor)) {
110			throw new GuardException("Unable to get Guard Actor, no value set");
111			}
112
113			return $this->actor;
114			}
115
116			/**
117			* {@inheritdoc}
118			*/
119			public function withActor(ActorInterface $actor): GuardInterface
120			{
121			$guard = clone $this;
122			$guard->actor = $actor;
123
124			return $guard;
125			}
126			}

spiral / components

Branch — feature/pre-split (197e7e)

Guard A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like