AnnotationParser::getReader() - Code Metrics - Inspection of "Minor bugfix for Scrutinizer configuration" - FlyingDR/struct - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4cc6c2...176af1 )

by Alexander

created 2017-11-08 15:44 UTC

AnnotationParser::getReader() A

↳ Parent: AnnotationParser

Complexity

Conditions	3
Paths	2

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	11
cts	11
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	2
nop	0
crap	3

<?php

namespace Flying\Struct\Metadata;

use Doctrine\Common\Annotations\AnnotationRegistry;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\Annotations\SimpleAnnotationReader;
use Flying\Struct\Annotation\Struct\Annotation;
use Flying\Struct\Annotation\Struct\Property;
use Flying\Struct\Annotation\Struct\Struct;
use Flying\Struct\ConfigurationManager;
use Flying\Struct\Exception;

/**
 * Structures metadata parser implementation for parsing structure annotations
 */
class AnnotationParser extends AbstractMetadataParser
{
    /**
     * Annotations reader
     *
     * @var Reader
     */
    private $reader;
    /**
     * Namespaces for annotations autoloading
     *
     * @var array
     */
    private $namespaces = [];

    /**
     * Load annotation class
     *
     * @param string $class
     *
     * @return boolean
     */
    public function loadClass($class)
    {
        if (class_exists($class)) {
            return true;
        }
        $class = ucfirst(trim($class, '\\'));
        foreach ($this->namespaces as $ns) {
            $fqcn = $ns . '\\' . $class;
            if (class_exists($fqcn)) {
                return true;
            }
        }
        return false;
    }

    /**
     * {@inheritdoc}
     * @throws \Flying\Struct\Exception
     * @throws \InvalidArgumentException
     */
    protected function parseMetadata(\ReflectionClass $reflection, StructMetadata $metadata)
    {
        $reader = $this->getReader();
        $annotations = $reader->getClassAnnotations($reflection);
        foreach ($annotations as $annotation) {
            $metadata->addProperty($this->convertToMetadata($annotation));
        }
    }

    /**
     * Get annotations reader
     *
     * @return Reader
     * @throws \InvalidArgumentException
     */
    public function getReader()
    {
        if (!$this->reader) {
            $this->reader = new SimpleAnnotationReader();
            $namespaces = ConfigurationManager::getConfiguration()->getAnnotationNamespacesMap()->getAll();
            foreach ($namespaces as $ns) {
                $this->reader->addNamespace($ns);
            }
            $this->namespaces = array_reverse($namespaces, true);
            AnnotationRegistry::registerLoader([$this, 'loadClass']);

        }
        return $this->reader;
    }

    /**
     * Set annotations reader to use for parsing structure annotations
     *
     * @param Reader $reader
     *
     * @return $this
     */
    public function setReader(Reader $reader)
    {
        $this->reader = $reader;
        return $this;
    }

    /**
     * Convert given structure annotation into structure metadata
     *
     * @param Annotation $annotation Structure annotation to convert
     *
     * @return PropertyMetadata
     * @throws \InvalidArgumentException
     * @throws Exception
     */
    protected function convertToMetadata(Annotation $annotation)
    {
        if ($annotation instanceof Property) {
            $class = $this->resolvePropertyClass($annotation->getType());
            if (!$class) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new Exception('Unable to resolve structure property class for type: ' . $annotation->getType());
            }
            $property = new PropertyMetadata($annotation->getName(), $class, $annotation->getConfig());
            return $property;
        }

        if (!($annotation instanceof Struct)) {
            throw new Exception('Unknown structure annotation type');
        }

        if ($annotation->getClass()) {
            $class = $this->resolveStructClass($annotation->getClass());
            if (!$class) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                throw new Exception('Unable to resolve structure class: ' . $annotation->getClass());
            }
            $struct = ConfigurationManager::getConfiguration()->getMetadataManager()->getMetadata($class);
            if (!$struct instanceof StructMetadata) {
                throw new Exception('Failed to get structure metadata for class: ' . $class);
            }
            $struct->setName($annotation->getName());
            $struct->setConfig($annotation->getConfig());
        } else {
            if (!count($annotation->getProperties())) {
                throw new Exception('Structure metadata should have either class name or explicitly defined list of structure properties');
            }
            $struct = new StructMetadata($annotation->getName(), null, $annotation->getConfig());
            foreach ($annotation->getProperties() as $p) {
                $struct->addProperty($this->convertToMetadata($p));
            }
        }
        return $struct;
    }
}


1		<?php
2
3		namespace Flying\Struct\Metadata;
4
5		use Doctrine\Common\Annotations\AnnotationRegistry;
6		use Doctrine\Common\Annotations\Reader;
7		use Doctrine\Common\Annotations\SimpleAnnotationReader;
8		use Flying\Struct\Annotation\Struct\Annotation;
9		use Flying\Struct\Annotation\Struct\Property;
10		use Flying\Struct\Annotation\Struct\Struct;
11		use Flying\Struct\ConfigurationManager;
12		use Flying\Struct\Exception;
13
14		/**
15		* Structures metadata parser implementation for parsing structure annotations
16		*/
17		class AnnotationParser extends AbstractMetadataParser
18		{
19		/**
20		* Annotations reader
21		*
22		* @var Reader
23		*/
24		private $reader;
25		/**
26		* Namespaces for annotations autoloading
27		*
28		* @var array
29		*/
30		private $namespaces = [];
31
32		/**
33		* Load annotation class
34		*
35		* @param string $class
36		*
37		* @return boolean
38		*/
39	145	public function loadClass($class)
40		{
41	145	if (class_exists($class)) {
42	1	return true;
43		}
44	145	$class = ucfirst(trim($class, '\\'));
45	145	foreach ($this->namespaces as $ns) {
46	145	$fqcn = $ns . '\\' . $class;
47	145	if (class_exists($fqcn)) {
48		return true;
49		}
50	145	}
51	145	return false;
52		}
53
54		/**
55		* {@inheritdoc}
56		* @throws \Flying\Struct\Exception
57		* @throws \InvalidArgumentException
58		*/
59	182	protected function parseMetadata(\ReflectionClass $reflection, StructMetadata $metadata)
60		{
61	182	$reader = $this->getReader();
62	182	$annotations = $reader->getClassAnnotations($reflection);
63	182	foreach ($annotations as $annotation) {
64	181	$metadata->addProperty($this->convertToMetadata($annotation));
65	182	}
66	181	}
67
68		/**
69		* Get annotations reader
70		*
71		* @return Reader
72		* @throws \InvalidArgumentException
73		*/
74	182	public function getReader()
75		{
76	182	if (!$this->reader) {
77	182	$this->reader = new SimpleAnnotationReader();
78	182	$namespaces = ConfigurationManager::getConfiguration()->getAnnotationNamespacesMap()->getAll();
79	182	foreach ($namespaces as $ns) {
80	182	$this->reader->addNamespace($ns);
81	182	}
82	182	$this->namespaces = array_reverse($namespaces, true);
83	182	AnnotationRegistry::registerLoader([$this, 'loadClass']);
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:48 UTC by Report Bug Copy Issue Report The method `Doctrine\Common\Annotati...istry::registerLoader()` has been deprecated with message: this method is deprecated and will be removed in doctrine/annotations 2.0 autoloading should be deferred to the globally registered autoloader by then. For now, use @example AnnotationRegistry::registerLoader('class_exists') This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
84	182	}
85	182	return $this->reader;
86		}
87
88		/**
89		* Set annotations reader to use for parsing structure annotations
90		*
91		* @param Reader $reader
92		*
93		* @return $this
94		*/
95	1	public function setReader(Reader $reader)
96		{
97	1	$this->reader = $reader;
98	1	return $this;
99		}
100
101		/**
102		* Convert given structure annotation into structure metadata
103		*
104		* @param Annotation $annotation Structure annotation to convert
105		*
106		* @return PropertyMetadata
107		* @throws \InvalidArgumentException
108		* @throws Exception
109		*/
110	181	protected function convertToMetadata(Annotation $annotation)
111		{
112	181	if ($annotation instanceof Property) {
113	179	$class = $this->resolvePropertyClass($annotation->getType());
114	179	if (!$class) {
		0 ignored issues – show Bug Best Practice introduced 2017-11-08 15:48 UTC by Report Bug Copy Issue Report The expression `$class` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
115	1	throw new Exception('Unable to resolve structure property class for type: ' . $annotation->getType());
116		}
117	178	$property = new PropertyMetadata($annotation->getName(), $class, $annotation->getConfig());
118	178	return $property;
119		}
120
121	67	if (!($annotation instanceof Struct)) {
122		throw new Exception('Unknown structure annotation type');
123		}
124
125	67	if ($annotation->getClass()) {
126	67	$class = $this->resolveStructClass($annotation->getClass());
127	67	if (!$class) {
		0 ignored issues – show Bug Best Practice introduced 2017-11-08 15:48 UTC by Report Bug Copy Issue Report The expression `$class` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
128	2	throw new Exception('Unable to resolve structure class: ' . $annotation->getClass());
129		}
130	65	$struct = ConfigurationManager::getConfiguration()->getMetadataManager()->getMetadata($class);
131	65	if (!$struct instanceof StructMetadata) {
132	1	throw new Exception('Failed to get structure metadata for class: ' . $class);
133		}
134	64	$struct->setName($annotation->getName());
135	64	$struct->setConfig($annotation->getConfig());
136	64	} else {
137	15	if (!count($annotation->getProperties())) {
138		throw new Exception('Structure metadata should have either class name or explicitly defined list of structure properties');
139		}
140	15	$struct = new StructMetadata($annotation->getName(), null, $annotation->getConfig());
141	15	foreach ($annotation->getProperties() as $p) {
142	15	$struct->addProperty($this->convertToMetadata($p));
143	15	}
144		}
145	64	return $struct;
146		}
147		}
148

FlyingDR / struct

Push — master ( 4cc6c2...176af1 )

AnnotationParser::getReader() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like