Builder::build() - Code Metrics - Inspection of "Version bump" - Maslosoft/Addendum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 19c544...b7a61b )

by Peter

created 2016-07-12 13:41 UTC

Builder::build() A

↳ Parent: Builder

Complexity

Conditions	4
Paths	4

Size

Total Lines	21
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	10
Bugs	0	Features	0

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

<?php

/**
 * This software package is licensed under AGPL, Commercial license.
 *
 * @package maslosoft/addendum
 * @licence AGPL, Commercial
 * @copyright Copyright (c) Piotr Masełkowski <[email protected]> (Meta container, further improvements, bugfixes)
 * @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
 * @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
 * @link http://maslosoft.com/addendum/ - maslosoft addendum
 * @link https://code.google.com/p/addendum/ - original addendum project
 */

namespace Maslosoft\Addendum\Builder;

use Exception;
use Maslosoft\Addendum\Addendum;
use Maslosoft\Addendum\Cache\BuildOneCache;
use Maslosoft\Addendum\Collections\AnnotationsCollection;
use Maslosoft\Addendum\Collections\MatcherConfig;
use Maslosoft\Addendum\Helpers\CoarseChecker;
use Maslosoft\Addendum\Interfaces\AnnotationInterface;
use Maslosoft\Addendum\Matcher\AnnotationsMatcher;
use Maslosoft\Addendum\Reflection\ReflectionAnnotatedClass;
use Maslosoft\Addendum\Reflection\ReflectionAnnotatedMethod;
use Maslosoft\Addendum\Reflection\ReflectionAnnotatedProperty;
use Maslosoft\Addendum\Utilities\Blacklister;
use Maslosoft\Addendum\Utilities\ClassChecker;
use Maslosoft\Addendum\Utilities\NameNormalizer;
use Maslosoft\Addendum\Utilities\ReflectionName;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;

/**
 * @Label("Annotations builder")
 */
class Builder
{

	/**
	 * Cached values of parsing
	 * @var string[][][]
	 */
	private static $cache = [];

	/**
	 * Addendum instance
	 * @var Addendum
	 */
	private $addendum = null;

	/**
	 * One entity build cache
	 * @var BuildOneCache
	 */
	private $buildCache = null;

	public function __construct(Addendum $addendum = null)
	{
		$this->addendum = $addendum ?: new Addendum();
		$this->buildCache = new BuildOneCache(static::class, null, $this->addendum);
	}

	/**
	 * Build annotations collection
	 * @param ReflectionAnnotatedClass|ReflectionAnnotatedMethod|ReflectionAnnotatedProperty $targetReflection
	 * @return AnnotationsCollection
	 */
	public function build($targetReflection)
	{
		$annotations = [];

		$data = $this->buildOne($targetReflection);

		// Get annotations from current entity
		foreach ($data as $class => $parameters)
		{
			foreach ($parameters as $params)
			{
				$annotation = $this->instantiateAnnotation($class, $params, $targetReflection);
				if ($annotation !== false)
				{
					$annotations[$class][] = $annotation;
				}
			}
		}

		return new AnnotationsCollection($annotations);
	}

	private function buildOne($targetReflection)
	{
		// Decide where from take traits and base classes.
		// Either from class if it's being processed reflection class
		// or from declaring class if it's being processed for properties and
		// methods
		if ($targetReflection instanceof ReflectionClass)
		{
			$targetClass = $targetReflection;
		}
		else
		{
			$targetClass = $targetReflection->getDeclaringClass();
		}

		// Check if currently reflected component is cached
		$this->buildCache->setComponent(ReflectionName::createName($targetReflection));
		$cached = $this->buildCache->get();

		// Check if currently reflected component *class* is cached
		$this->buildCache->setComponent(ReflectionName::createName($targetClass));
		$cachedClass = $this->buildCache->get();

		// Cache is valid only if class cache is valid,
		// this is required for Conflicts and Target checks
		if (false !== $cached && false !== $cachedClass)
		{
			return $cached;
		}
		$traits = $targetClass->getTraits();

		// Get annotations from interfaces
		$interfacesData = [];
		foreach ($targetClass->getInterfaces() as $targetInterface)
		{
			// Recurse as interface might extend from other interfaces
			$interfaceData = $this->buildOne($targetInterface);
			if (empty($interfaceData))
			{
				continue;
			}
			$interfacesData = array_merge($interfacesData, $interfaceData);
		}

		// Get annotations from parent classes
		$parentData = [];
		$targetParent = $targetClass->getParentClass();
		if (!empty($targetParent))
		{
			// Recurse if has parent class, as it might have traits 
			// or interfaces too
			$parentData = $this->buildOne($targetParent);
		}

		// Get annotations from traits
		$traitsData = [];
		foreach ($traits as $trait)
		{
			$traitData = $this->getDataFor($targetReflection, $trait->name);
			if (false === $traitData || empty($traitData))
			{
				continue;
			}
			$traitsData = array_merge($traitsData, $traitData);
		}

		// Merge data from traits etc.
		// Data from class
		$data = array_merge($interfacesData, $parentData, $traitsData, $this->parse($targetReflection));

		$this->buildCache->setComponent(ReflectionName::createName($targetReflection));
		$this->buildCache->set($data);
		return $data;
	}

	/**
	 *
	 * @param ReflectionAnnotatedClass|ReflectionAnnotatedMethod|ReflectionAnnotatedProperty $targetReflection
	 * @param string $name
	 * @return boolean|mixed
	 */
	private function getDataFor($targetReflection, $name)
	{
		$target = new ReflectionAnnotatedClass($name, $this->addendum);
		$annotations = null;

		// Try to get annotations from entity, be it method, property or trait itself
		switch (true)
		{
			case $targetReflection instanceof ReflectionProperty && $target->hasProperty($targetReflection->name):
				$annotations = new ReflectionAnnotatedProperty($target->name, $targetReflection->name, $this->addendum);
				break;
			case $targetReflection instanceof ReflectionMethod && $target->hasMethod($targetReflection->name):
				$annotations = new ReflectionAnnotatedMethod($target->name, $targetReflection->name, $this->addendum);
				break;
			case $targetReflection instanceof ReflectionClass:
				$annotations = $target;
				break;
		}

		// Does not have property or method
		if (null === $annotations)
		{
			return false;
		}

		// Data from target
		return $this->parse($annotations);
	}

	/**
	 * Create new instance of annotation
	 * @param string $class
	 * @param mixed[] $parameters
	 * @param ReflectionAnnotatedClass|ReflectionAnnotatedMethod|ReflectionAnnotatedProperty|bool $targetReflection
	 * @return boolean|object
	 */
	public function instantiateAnnotation($class, $parameters, $targetReflection = false)
	{
		$class = ucfirst($class) . "Annotation";

		// If namespaces are empty assume global namespace
		$fqn = $this->normalizeFqn('\\', $class);
		foreach ($this->addendum->namespaces as $ns)
		{
			$fqn = $this->normalizeFqn($ns, $class);
			if (Blacklister::ignores($fqn))
			{
				continue;
			}
			try
			{
				if (!ClassChecker::exists($fqn))
				{
					$this->addendum->getLogger()->debug('Annotation class `{fqn}` not found, ignoring', ['fqn' => $fqn]);
					Blacklister::ignore($fqn);
				}
				else
				{
					// Class exists, exit loop
					break;
				}
			}
			catch (Exception $e)
			{
				// Ignore class autoloading errors
			}
		}
		if (Blacklister::ignores($fqn))
		{
			return false;
		}
		try
		{
			// NOTE: was class_exists here, however should be safe to use ClassChecker::exists here
			if (!ClassChecker::exists($fqn))
			{
				$this->addendum->getLogger()->debug('Annotation class `{fqn}` not found, ignoring', ['fqn' => $fqn]);
				Blacklister::ignore($fqn);
				return false;
			}
		}
		catch (Exception $e)
		{
			// Ignore autoload errors and return false
			Blacklister::ignore($fqn);
			return false;
		}
		$resolvedClass = Addendum::resolveClassName($fqn);
		if ((new ReflectionClass($resolvedClass))->implementsInterface(AnnotationInterface::class) || $resolvedClass == AnnotationInterface::class)
		{
			return new $resolvedClass($parameters, $targetReflection);
		}
		return false;
	}

	/**
	 * Normalize class name and namespace to proper fully qualified name
	 * @param string $ns
	 * @param string $class
	 * @return string
	 */
	private function normalizeFqn($ns, $class)
	{
		$fqn = "\\$ns\\$class";
		NameNormalizer::normalize($fqn);
		return $fqn;
	}

	/**
	 * Get doc comment
	 * @param ReflectionAnnotatedClass|ReflectionAnnotatedMethod|ReflectionAnnotatedProperty $reflection
	 * @return mixed[]
	 */
	private function parse($reflection)
	{
		$key = sprintf('%s@%s', $this->addendum->getInstanceId(), ReflectionName::createName($reflection));
		if (!isset(self::$cache[$key]))
		{
			//
			if (!CoarseChecker::mightHaveAnnotations($reflection))
			{
				self::$cache[$key] = [];
				return self::$cache[$key];
			}
			$parser = new AnnotationsMatcher;
			$data = [];
			$parser->setPlugins(new MatcherConfig([
				'addendum' => $this->addendum,
				'reflection' => $reflection
			]));
			$parser->matches($this->getDocComment($reflection), $data);
			self::$cache[$key] = $data;
		}
		return self::$cache[$key];
	}

	/**
	 * Get doc comment
	 * @param ReflectionAnnotatedClass|ReflectionAnnotatedMethod|ReflectionAnnotatedProperty $reflection
	 * @return mixed[]
	 */
	protected function getDocComment($reflection)
	{
		return Addendum::getDocComment($reflection);
	}

	/**
	 * Clear local parsing cache
	 */
	public static function clearCache()
	{
		self::$cache = [];
	}

}


1		<?php
2
3		/**
4		* This software package is licensed under AGPL, Commercial license.
5		*
6		* @package maslosoft/addendum
7		* @licence AGPL, Commercial
8		* @copyright Copyright (c) Piotr Masełkowski <[email protected]> (Meta container, further improvements, bugfixes)
9		* @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
10		* @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
11		* @link http://maslosoft.com/addendum/ - maslosoft addendum
12		* @link https://code.google.com/p/addendum/ - original addendum project
13		*/
14
15		namespace Maslosoft\Addendum\Builder;
16
17		use Exception;
18		use Maslosoft\Addendum\Addendum;
19		use Maslosoft\Addendum\Cache\BuildOneCache;
20		use Maslosoft\Addendum\Collections\AnnotationsCollection;
21		use Maslosoft\Addendum\Collections\MatcherConfig;
22		use Maslosoft\Addendum\Helpers\CoarseChecker;
23		use Maslosoft\Addendum\Interfaces\AnnotationInterface;
24		use Maslosoft\Addendum\Matcher\AnnotationsMatcher;
25		use Maslosoft\Addendum\Reflection\ReflectionAnnotatedClass;
26		use Maslosoft\Addendum\Reflection\ReflectionAnnotatedMethod;
27		use Maslosoft\Addendum\Reflection\ReflectionAnnotatedProperty;
28		use Maslosoft\Addendum\Utilities\Blacklister;
29		use Maslosoft\Addendum\Utilities\ClassChecker;
30		use Maslosoft\Addendum\Utilities\NameNormalizer;
31		use Maslosoft\Addendum\Utilities\ReflectionName;
32		use ReflectionClass;
33		use ReflectionMethod;
34		use ReflectionProperty;
35
36		/**
37		* @Label("Annotations builder")
38		*/
39		class Builder
40		{
41
42		/**
43		* Cached values of parsing
44		* @var string[][][]
45		*/
46		private static $cache = [];
47
48		/**
49		* Addendum instance
50		* @var Addendum
51		*/
52		private $addendum = null;
53
54		/**
55		* One entity build cache
56		* @var BuildOneCache
57		*/
58		private $buildCache = null;
59
60	46	public function __construct(Addendum $addendum = null)
61		{
62	46	$this->addendum = $addendum ?: new Addendum();
63	46	$this->buildCache = new BuildOneCache(static::class, null, $this->addendum);
64	46	}
65
66		/**
67		* Build annotations collection
68		* @param ReflectionAnnotatedClass\|ReflectionAnnotatedMethod\|ReflectionAnnotatedProperty $targetReflection
69		* @return AnnotationsCollection
70		*/
71	46	public function build($targetReflection)
72		{
73	46	$annotations = [];
74
75	46	$data = $this->buildOne($targetReflection);
76
77		// Get annotations from current entity
78	46	foreach ($data as $class => $parameters)
79		{
80	44	foreach ($parameters as $params)
81		{
82	44	$annotation = $this->instantiateAnnotation($class, $params, $targetReflection);
83	44	if ($annotation !== false)
84		{
85	44	$annotations[$class][] = $annotation;
86		}
87		}
88		}
89
90		return new AnnotationsCollection($annotations);
91	46	}
92
93		private function buildOne($targetReflection)
94	46	{
95		// Decide where from take traits and base classes.
96		// Either from class if it's being processed reflection class
97		// or from declaring class if it's being processed for properties and
98		// methods
99		if ($targetReflection instanceof ReflectionClass)
100	46	{
101		$targetClass = $targetReflection;
102	46	}
103		else
104		{
105		$targetClass = $targetReflection->getDeclaringClass();
106	26	}
107
108		// Check if currently reflected component is cached
109		$this->buildCache->setComponent(ReflectionName::createName($targetReflection));
110	46	$cached = $this->buildCache->get();
111	46
112		// Check if currently reflected component class is cached
113		$this->buildCache->setComponent(ReflectionName::createName($targetClass));
114	46	$cachedClass = $this->buildCache->get();
115	46
116		// Cache is valid only if class cache is valid,
117		// this is required for Conflicts and Target checks
118		if (false !== $cached && false !== $cachedClass)
119	46	{
120		return $cached;
121	46	}
122		$traits = $targetClass->getTraits();
123	43
124		// Get annotations from interfaces
125		$interfacesData = [];
126	43	foreach ($targetClass->getInterfaces() as $targetInterface)
127	43	{
128		// Recurse as interface might extend from other interfaces
129		$interfaceData = $this->buildOne($targetInterface);
130	38	if (empty($interfaceData))
131	38	{
132		continue;
133	36	}
134		$interfacesData = array_merge($interfacesData, $interfaceData);
135	2	}
136
137		// Get annotations from parent classes
138		$parentData = [];
139	43	$targetParent = $targetClass->getParentClass();
140	43	if (!empty($targetParent))
141	43	{
142		// Recurse if has parent class, as it might have traits
143		// or interfaces too
144		$parentData = $this->buildOne($targetParent);
145	23	}
146
147		// Get annotations from traits
148		$traitsData = [];
149	43	foreach ($traits as $trait)
150	43	{
151		$traitData = $this->getDataFor($targetReflection, $trait->name);
152	7	if (false === $traitData \|\| empty($traitData))
153	7	{
154		continue;
155	4	}
156		$traitsData = array_merge($traitsData, $traitData);
157	5	}
158
159		// Merge data from traits etc.
160		// Data from class
161	43	$data = array_merge($interfacesData, $parentData, $traitsData, $this->parse($targetReflection));
162
163	43	$this->buildCache->setComponent(ReflectionName::createName($targetReflection));
164	43	$this->buildCache->set($data);
165		return $data;
166	43	}
167
168		/**
169		*
170		* @param ReflectionAnnotatedClass\|ReflectionAnnotatedMethod\|ReflectionAnnotatedProperty $targetReflection
171		* @param string $name
172		* @return boolean\|mixed
173		*/
174		private function getDataFor($targetReflection, $name)
175	7	{
176		$target = new ReflectionAnnotatedClass($name, $this->addendum);
177	7	$annotations = null;
178	7
179		// Try to get annotations from entity, be it method, property or trait itself
180		switch (true)
181		{
182		case $targetReflection instanceof ReflectionProperty && $target->hasProperty($targetReflection->name):
183	7	$annotations = new ReflectionAnnotatedProperty($target->name, $targetReflection->name, $this->addendum);
184	4	break;
185	3	case $targetReflection instanceof ReflectionMethod && $target->hasMethod($targetReflection->name):
186	6	$annotations = new ReflectionAnnotatedMethod($target->name, $targetReflection->name, $this->addendum);
187	1	break;
188	1	case $targetReflection instanceof ReflectionClass:
189	1	$annotations = $target;
190	5	break;
191	5	}
192
193		// Does not have property or method
194		if (null === $annotations)
195	7	{
196		return false;
197	1	}
198
199		// Data from target
200		return $this->parse($annotations);
201	7	}
202
203		/**
204		* Create new instance of annotation
205		* @param string $class
206		* @param mixed[] $parameters
207		* @param ReflectionAnnotatedClass\|ReflectionAnnotatedMethod\|ReflectionAnnotatedProperty\|bool $targetReflection
208		* @return boolean\|object
209		*/
210		public function instantiateAnnotation($class, $parameters, $targetReflection = false)
211	44	{
212		$class = ucfirst($class) . "Annotation";
213	44
214		// If namespaces are empty assume global namespace
215		$fqn = $this->normalizeFqn('\\', $class);
216	44	foreach ($this->addendum->namespaces as $ns)
217	44	{
218		$fqn = $this->normalizeFqn($ns, $class);
219	44	if (Blacklister::ignores($fqn))
220	44	{
221		continue;
222	38	}
223		try
224		{
225		if (!ClassChecker::exists($fqn))
226	44	{
227		$this->addendum->getLogger()->debug('Annotation class `{fqn}` not found, ignoring', ['fqn' => $fqn]);
228	11	Blacklister::ignore($fqn);
229	11	}
230		else
231		{
232		// Class exists, exit loop
233		break;
234	44	}
235		}
236		catch (Exception $e)
237		{
238	11	// Ignore class autoloading errors
239		}
240		}
241		if (Blacklister::ignores($fqn))
242	44	{
243		return false;
244	1	}
245		try
246		{
247		// NOTE: was class_exists here, however should be safe to use ClassChecker::exists here
248		if (!ClassChecker::exists($fqn))
249	44	{
250		$this->addendum->getLogger()->debug('Annotation class `{fqn}` not found, ignoring', ['fqn' => $fqn]);
251		Blacklister::ignore($fqn);
252		return false;
253	44	}
254		}
255		catch (Exception $e)
256		{
257		// Ignore autoload errors and return false
258		Blacklister::ignore($fqn);
259		return false;
260		}
261		$resolvedClass = Addendum::resolveClassName($fqn);
262	44	if ((new ReflectionClass($resolvedClass))->implementsInterface(AnnotationInterface::class) \|\| $resolvedClass == AnnotationInterface::class)
263	44	{
264		return new $resolvedClass($parameters, $targetReflection);
265	44	}
266		return false;
267		}
268
269		/**
270		* Normalize class name and namespace to proper fully qualified name
271		* @param string $ns
272		* @param string $class
273		* @return string
274		*/
275		private function normalizeFqn($ns, $class)
276	44	{
277		$fqn = "\\$ns\\$class";
278	44	NameNormalizer::normalize($fqn);
279	44	return $fqn;
280	44	}
281
282		/**
283		* Get doc comment
284		* @param ReflectionAnnotatedClass\|ReflectionAnnotatedMethod\|ReflectionAnnotatedProperty $reflection
285		* @return mixed[]
286		*/
287		private function parse($reflection)
288	43	{
289		$key = sprintf('%s@%s', $this->addendum->getInstanceId(), ReflectionName::createName($reflection));
290	43	if (!isset(self::$cache[$key]))
291	43	{
292		//
293		if (!CoarseChecker::mightHaveAnnotations($reflection))
294	42	{
295		self::$cache[$key] = [];
296	23	return self::$cache[$key];
297	23	}
298		$parser = new AnnotationsMatcher;
299	39	$data = [];
300	39	$parser->setPlugins(new MatcherConfig([
301	39	'addendum' => $this->addendum,
302	39	'reflection' => $reflection
303	39	]));
304		$parser->matches($this->getDocComment($reflection), $data);
305	39	self::$cache[$key] = $data;
306	39	}
307		return self::$cache[$key];
308	40	}
309
310		/**
311		* Get doc comment
312		* @param ReflectionAnnotatedClass\|ReflectionAnnotatedMethod\|ReflectionAnnotatedProperty $reflection
313		* @return mixed[]
314		*/
315		protected function getDocComment($reflection)
316	39	{
317		return Addendum::getDocComment($reflection);
318	39	}
319
320		/**
321		* Clear local parsing cache
322		*/
323		public static function clearCache()
324	3	{
325		self::$cache = [];
326	3	}
327	3
328		}
329

Maslosoft / Addendum

Push — master ( 19c544...b7a61b )

Builder::build() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like