AnnotationDriver::assertUnique() - Code Metrics - Inspection of "api key cleanup refactorings" - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (4efcd8)

by Maximilian

created 2016-08-14 14:03 UTC

AnnotationDriver::assertUnique() A

↳ Parent: AnnotationDriver

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	3
cts	4
cp	0.75
rs	9.4285
cc	2
eloc	3
nc	2
nop	1
crap	2.0625

<?php

namespace Ma27\ApiKeyAuthenticationBundle\Annotation\Driver;

use Doctrine\Common\Annotations\Reader;
use Ma27\ApiKeyAuthenticationBundle\Model\User\ClassMetadata;
use Ma27\ApiKeyAuthenticationBundle\Model\User\ModelConfigurationDriverInterface;
use ReflectionClass;

/**
 * Annotation driver which parses the annotations of the user model instance.
 *
 * @internal This code is part of the internal API to gather the appropriate model information and shouldn't be used for else use-cases
 */
final class AnnotationDriver implements ModelConfigurationDriverInterface
{
    /**
     * @var Reader
     */
    private $reader;

    /**
     * @var string
     */
    private $userClass;

    /**
     * Constructor.
     *
     * @param Reader $annotationReader
     * @param string $userClass
     */
    public function __construct(Reader $annotationReader, $userClass)
    {
        $this->reader = $annotationReader;
        $this->userClass = (string) $userClass;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \LogicException If one of the annotations is missing
     * @throws \LogicException If one property has multiple "auth" annotations
     */
    public function getMetadataForUser()
    {
        $reflection = new ReflectionClass($this->userClass);
        $properties = $reflection->getProperties();
        $loginProperty = $passwordProperty = $apiKeyProperty = $lastActionProperty = null;

        foreach ($properties as $reflectionProperty) {
            foreach (array('login', 'password', 'apiKey', 'lastAction') as $annotation) {
                $class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
                $annotationObject = $this->reader->getPropertyAnnotation($reflectionProperty, $class);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                if ($annotationObject) {
                    switch ($annotation) {
                        case 'login':
                            $this->assertUnique($loginProperty);
                            $loginProperty = $reflectionProperty;
                            break;
                        case 'password':
                            $this->assertUnique($passwordProperty);
                            $passwordProperty = $reflectionProperty;
                            break;
                        case 'apiKey':
                            $this->assertUnique($apiKeyProperty);
                            $apiKeyProperty = $reflectionProperty;
                            break;
                        case 'lastAction':
                            $this->assertUnique($lastActionProperty);
                            $lastActionProperty = $reflectionProperty;
                    }

                    if ($loginProperty && $passwordProperty && $apiKeyProperty && $lastActionProperty) {
                        break;
                    }

                    continue;
                }
            }
        }

        if (!$loginProperty || !$passwordProperty || !$apiKeyProperty) {
            throw new \LogicException(sprintf(
                'A user class must have a "%s", "%s", "%s" annotation!',
                'Login',
                'Password',
                'ApiKey'
            ));
        }

        return new ClassMetadata(array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ClassMetadata::LOGIN_PROPERTY       => $loginProperty,
            ClassMetadata::PASSWORD_PROPERTY    => $passwordProperty,
            ClassMetadata::API_KEY_PROPERTY     => $apiKeyProperty,
            ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
        ));
    }

    /**
     * Checks whether a property is already set.
     *
     * @param \ReflectionProperty $property
     */
    private function assertUnique(\ReflectionProperty $property = null)
    {
        if (!empty($property)) {
            throw $this->createDuplicateAnnotationException();
        }
    }

    /**
     * Creates the exception when.
     *
     * @return \InvalidArgumentException
     */
    private function createDuplicateAnnotationException()
    {
        return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
    }
}


1		<?php
2
3		namespace Ma27\ApiKeyAuthenticationBundle\Annotation\Driver;
4
5		use Doctrine\Common\Annotations\Reader;
6		use Ma27\ApiKeyAuthenticationBundle\Model\User\ClassMetadata;
7		use Ma27\ApiKeyAuthenticationBundle\Model\User\ModelConfigurationDriverInterface;
8		use ReflectionClass;
9
10		/**
11		* Annotation driver which parses the annotations of the user model instance.
12		*
13		* @internal This code is part of the internal API to gather the appropriate model information and shouldn't be used for else use-cases
14		*/
15		final class AnnotationDriver implements ModelConfigurationDriverInterface
16		{
17		/**
18		* @var Reader
19		*/
20		private $reader;
21
22		/**
23		* @var string
24		*/
25		private $userClass;
26
27		/**
28		* Constructor.
29		*
30		* @param Reader $annotationReader
31		* @param string $userClass
32		*/
33	10	public function __construct(Reader $annotationReader, $userClass)
34		{
35	10	$this->reader = $annotationReader;
36	10	$this->userClass = (string) $userClass;
37	10	}
38
39		/**
40		* {@inheritdoc}
41		*
42		* @throws \LogicException If one of the annotations is missing
43		* @throws \LogicException If one property has multiple "auth" annotations
44		*/
45	10	public function getMetadataForUser()
46		{
47	10	$reflection = new ReflectionClass($this->userClass);
48	10	$properties = $reflection->getProperties();
49	10	$loginProperty = $passwordProperty = $apiKeyProperty = $lastActionProperty = null;
50
51	10	foreach ($properties as $reflectionProperty) {
52	10	foreach (array('login', 'password', 'apiKey', 'lastAction') as $annotation) {
53	10	$class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
54	10	$annotationObject = $this->reader->getPropertyAnnotation($reflectionProperty, $class);
		0 ignored issues – show Bug introduced 2015-12-30 17:36 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$annotationObject` is correct as `$this->reader->getProper...ectionProperty, $class)` (which targets `Doctrine\Common\Annotati...getPropertyAnnotation()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
55
56	10	if ($annotationObject) {
57		switch ($annotation) {
58	10	case 'login':
59	9	$this->assertUnique($loginProperty);
60	9	$loginProperty = $reflectionProperty;
61	9	break;
62	10	case 'password':
63	9	$this->assertUnique($passwordProperty);
64	9	$passwordProperty = $reflectionProperty;
65	9	break;
66	10	case 'apiKey':
67	10	$this->assertUnique($apiKeyProperty);
68	10	$apiKeyProperty = $reflectionProperty;
69	10	break;
70	9	case 'lastAction':
71	9	$this->assertUnique($lastActionProperty);
72	9	$lastActionProperty = $reflectionProperty;
73	9	}
74
75	10	if ($loginProperty && $passwordProperty && $apiKeyProperty && $lastActionProperty) {
76	9	break;
77		}
78
79	10	continue;
80		}
81	10	}
82	10	}
83
84	10	if (!$loginProperty \|\| !$passwordProperty \|\| !$apiKeyProperty) {
85	1	throw new \LogicException(sprintf(
86	1	'A user class must have a "%s", "%s", "%s" annotation!',
87	1	'Login',
88	1	'Password',
89		'ApiKey'
90	1	));
91		}
92
93	9	return new ClassMetadata(array(
		0 ignored issues – show Documentation introduced 2016-08-14 14:08 UTC by Report Bug Copy Issue Report `array(\Ma27\ApiKeyAuthen...=> $lastActionProperty)` is of type `array<string\|integer,obj...flectionProperty>\|null>`, but the function expects a `array<integer,object<ReflectionProperty>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
94	9	ClassMetadata::LOGIN_PROPERTY => $loginProperty,
95	9	ClassMetadata::PASSWORD_PROPERTY => $passwordProperty,
96	9	ClassMetadata::API_KEY_PROPERTY => $apiKeyProperty,
97	9	ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
98	9	));
99		}
100
101		/**
102		* Checks whether a property is already set.
103		*
104		* @param \ReflectionProperty $property
105		*/
106	10	private function assertUnique(\ReflectionProperty $property = null)
107		{
108	10	if (!empty($property)) {
109		throw $this->createDuplicateAnnotationException();
110		}
111	10	}
112
113		/**
114		* Creates the exception when.
115		*
116		* @return \InvalidArgumentException
117		*/
118		private function createDuplicateAnnotationException()
119		{
120		return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
121		}
122		}
123

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

Branch — develop (4efcd8)

AnnotationDriver::assertUnique() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like