IntroductionAspectExtension::getKind() - Code Metrics - Inspection of "Reflection getFileName fix" - goaop/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#398)

by Andy

created 2018-07-12 21:30 UTC

IntroductionAspectExtension::getKind() A

↳ Parent: IntroductionAspectExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
declare(strict_types = 1);
/*
 * Go! AOP framework
 *
 * @copyright Copyright 2012, Lisachenko Alexander <[email protected]>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Go\Core;

use Go\Aop\Advisor;
use Go\Aop\Aspect;
use Go\Aop\Framework;
use Go\Aop\Pointcut;
use Go\Aop\Support;
use Go\Lang\Annotation;
use ReflectionProperty;
use Reflector;

/**
 * Introduction aspect extension
 */
class IntroductionAspectExtension extends AbstractAspectLoaderExtension
{

    /**
     * Introduction aspect loader works with annotations from aspect
     *
     * For extension that works with annotations additional metaInformation will be passed
     *
     * @return string
     */
    public function getKind(): string
    {
        return self::KIND_ANNOTATION;
    }

    /**
     * Introduction aspect loader works only with properties of aspect
     */
    public function getTargets(): array
    {
        return [self::TARGET_PROPERTY];
    }

    /**
     * Checks if loader is able to handle specific point of aspect
     *
     * @param Aspect $aspect Instance of aspect
     * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point
     * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method
     *
     * @return boolean true if extension is able to create an advisor from reflection and metaInformation
     */
    public function supports(Aspect $aspect, $reflection, $metaInformation = null): bool
    {
        return
            ($metaInformation instanceof Annotation\DeclareParents) ||
            ($metaInformation instanceof Annotation\DeclareError);
    }

    /**
     * Loads definition from specific point of aspect into the container
     *
     * @param Aspect $aspect Instance of aspect
     * @param Reflector|ReflectionProperty $reflection Reflection of point
     * @param mixed|null $metaInformation Additional meta-information
     *
     * @throws \UnexpectedValueException
     *
     * @return Pointcut[]|Advisor[]
     */
    public function load(Aspect $aspect, Reflector $reflection, $metaInformation = null): array
    {
        $loadedItems = [];
        $pointcut    = $this->parsePointcut($aspect, $reflection, $metaInformation->value);
        $propertyId  = $reflection->class . '->' . $reflection->name;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        switch (true) {
            case ($metaInformation instanceof Annotation\DeclareParents):
                $implement = $metaInformation->defaultImpl;
                $interface = $metaInformation->interface;
                $advice    = new Framework\TraitIntroductionInfo($implement, $interface);
                $advisor   = new Support\DeclareParentsAdvisor($pointcut->getClassFilter(), $advice);
                $loadedItems[$propertyId] = $advisor;
                break;

            case (($metaInformation instanceof Annotation\DeclareError) && ($pointcut instanceof Pointcut)):
                $reflection->setAccessible(true);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $message = $reflection->getValue($aspect);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $level   = $metaInformation->level;
                $advice  = new Framework\DeclareErrorInterceptor($message, $level, $metaInformation->value);
                $loadedItems[$propertyId] = new Support\DefaultPointcutAdvisor($pointcut, $advice);
                break;

            default:
                throw new \UnexpectedValueException('Unsupported pointcut class: ' . get_class($pointcut));
        }

        return $loadedItems;
    }
}


1		<?php
2		declare(strict_types = 1);
3		/*
4		* Go! AOP framework
5		*
6		* @copyright Copyright 2012, Lisachenko Alexander <[email protected]>
7		*
8		* This source file is subject to the license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Go\Core;
13
14		use Go\Aop\Advisor;
15		use Go\Aop\Aspect;
16		use Go\Aop\Framework;
17		use Go\Aop\Pointcut;
18		use Go\Aop\Support;
19		use Go\Lang\Annotation;
20		use ReflectionProperty;
21		use Reflector;
22
23		/**
24		* Introduction aspect extension
25		*/
26		class IntroductionAspectExtension extends AbstractAspectLoaderExtension
27		{
28
29		/**
30		* Introduction aspect loader works with annotations from aspect
31		*
32		* For extension that works with annotations additional metaInformation will be passed
33		*
34		* @return string
35		*/
36	1	public function getKind(): string
37		{
38	1	return self::KIND_ANNOTATION;
39		}
40
41		/**
42		* Introduction aspect loader works only with properties of aspect
43		*/
44	2	public function getTargets(): array
45		{
46	2	return [self::TARGET_PROPERTY];
47		}
48
49		/**
50		* Checks if loader is able to handle specific point of aspect
51		*
52		* @param Aspect $aspect Instance of aspect
53		* @param mixed\|\ReflectionClass\|\ReflectionMethod\|\ReflectionProperty $reflection Reflection of point
54		* @param mixed\|null $metaInformation Additional meta-information, e.g. annotation for method
55		*
56		* @return boolean true if extension is able to create an advisor from reflection and metaInformation
57		*/
58		public function supports(Aspect $aspect, $reflection, $metaInformation = null): bool
59		{
60		return
61		($metaInformation instanceof Annotation\DeclareParents) \|\|
62		($metaInformation instanceof Annotation\DeclareError);
63		}
64
65		/**
66		* Loads definition from specific point of aspect into the container
67		*
68		* @param Aspect $aspect Instance of aspect
69		* @param Reflector\|ReflectionProperty $reflection Reflection of point
70		* @param mixed\|null $metaInformation Additional meta-information
71		*
72		* @throws \UnexpectedValueException
73		*
74		* @return Pointcut[]\|Advisor[]
75		*/
76		public function load(Aspect $aspect, Reflector $reflection, $metaInformation = null): array
77		{
78		$loadedItems = [];
79		$pointcut = $this->parsePointcut($aspect, $reflection, $metaInformation->value);
80		$propertyId = $reflection->class . '->' . $reflection->name;
		0 ignored issues – show Bug introduced 2017-08-07 19:54 UTC by Report Bug Copy Issue Report Accessing `class` on the interface `Reflector` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history... Bug introduced 2017-08-07 19:54 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `Reflector` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
81
82		switch (true) {
83		case ($metaInformation instanceof Annotation\DeclareParents):
84		$implement = $metaInformation->defaultImpl;
85		$interface = $metaInformation->interface;
86		$advice = new Framework\TraitIntroductionInfo($implement, $interface);
87		$advisor = new Support\DeclareParentsAdvisor($pointcut->getClassFilter(), $advice);
88		$loadedItems[$propertyId] = $advisor;
89		break;
90
91		case (($metaInformation instanceof Annotation\DeclareError) && ($pointcut instanceof Pointcut)):
92		$reflection->setAccessible(true);
		0 ignored issues – show Bug introduced 2018-04-07 17:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Reflector` as the method `setAccessible()` does only exist in the following implementations of said interface: `Doctrine\Common\Reflecti...ublicReflectionProperty`, `Doctrine\Common\Reflection\StaticReflectionMethod`, `Doctrine\Common\Reflecti...taticReflectionProperty`, `Doctrine\ORM\Mapping\ReflectionEmbeddedProperty`, `Go\Aop\Support\AnnotatedReflectionMethod`, `Go\Aop\Support\AnnotatedReflectionProperty`, `Go\ParserReflection\ReflectionMethod`, `Go\ParserReflection\ReflectionProperty`, `ReflectionMethod`, `ReflectionProperty`, `Zend\Code\Reflection\MethodReflection`, `Zend\Code\Reflection\PropertyReflection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
93		$message = $reflection->getValue($aspect);
		0 ignored issues – show Bug introduced 2018-04-07 17:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Reflector` as the method `getValue()` does only exist in the following implementations of said interface: `Doctrine\Common\Reflecti...ublicReflectionProperty`, `Doctrine\Common\Reflecti...taticReflectionProperty`, `Doctrine\ORM\Mapping\ReflectionEmbeddedProperty`, `Go\Aop\Support\AnnotatedReflectionProperty`, `Go\ParserReflection\ReflectionProperty`, `ReflectionProperty`, `Zend\Code\Reflection\PropertyReflection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
94		$level = $metaInformation->level;
95		$advice = new Framework\DeclareErrorInterceptor($message, $level, $metaInformation->value);
96		$loadedItems[$propertyId] = new Support\DefaultPointcutAdvisor($pointcut, $advice);
97		break;
98
99		default:
100		throw new \UnexpectedValueException('Unsupported pointcut class: ' . get_class($pointcut));
101		}
102
103		return $loadedItems;
104		}
105		}
106

goaop / framework

Pull Request — master (#398)

IntroductionAspectExtension::getKind() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like