GeneralAspectLoaderExtension::getInterceptor() - Code Metrics - Inspection of "Merge pull request #398 from andy-shea/reflection-..." - goaop/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( efe256...811ea7 )

by Alexander

created 2019-01-04 10:54 UTC

GeneralAspectLoaderExtension::getInterceptor() A

↳ Parent: GeneralAspectLoaderExtension

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	6.8088

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	7
cts	12
cp	0.5833
rs	9.2728
c	0
b	0
f	0
cc	5
nc	5
nop	2
crap	6.8088

<?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 Closure;
use Go\Aop\Advisor;
use Go\Aop\Aspect;
use Go\Aop\Framework;
use Go\Aop\Intercept\Interceptor;
use Go\Aop\Pointcut;
use Go\Aop\Support\DefaultPointcutAdvisor;
use Go\Lang\Annotation;
use Go\Lang\Annotation\BaseInterceptor;
use ReflectionMethod;
use Reflector;

use function get_class;

/**
 * General aspect loader add common support for general advices, declared as annotations
 */
class GeneralAspectLoaderExtension extends AbstractAspectLoaderExtension
{

    /**
     * General aspect loader works with annotations from aspect
     */
    public function getKind(): string
    {
        return self::KIND_ANNOTATION;
    }

    /**
     * General aspect loader works only with methods of aspect
     */
    public function getTargets(): array
    {
        return [self::TARGET_METHOD];
    }

    /**
     * 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\Interceptor
                || $metaInformation instanceof Annotation\Pointcut;
    }

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

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $adviceCallback = $reflection->getClosure($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.
    }
}

        switch (true) {
            // Register a pointcut by its name
            case ($metaInformation instanceof Annotation\Pointcut):
                $loadedItems[$methodId] = $pointcut;
                break;

            case ($pointcut instanceof Pointcut):
                $advice = $this->getInterceptor($metaInformation, $adviceCallback);

                $loadedItems[$methodId] = new DefaultPointcutAdvisor($pointcut, $advice);
                break;

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

        return $loadedItems;
    }

    /**
     * Returns an interceptor instance by meta-type annotation and closure
     *
     * @throws \UnexpectedValueException For unsupported annotations
     */
    protected function getInterceptor(BaseInterceptor $metaInformation, Closure $adviceCallback): Interceptor
    {
        $adviceOrder        = $metaInformation->order;
        $pointcutExpression = $metaInformation->value;
        switch (true) {
            case ($metaInformation instanceof Annotation\Before):
                return new Framework\BeforeInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);

            case ($metaInformation instanceof Annotation\After):
                return new Framework\AfterInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);

            case ($metaInformation instanceof Annotation\Around):
                return new Framework\AroundInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);

            case ($metaInformation instanceof Annotation\AfterThrowing):
                return new Framework\AfterThrowingInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);

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


Push — master ( efe256...811ea7 )

GeneralAspectLoaderExtension::getInterceptor() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

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 Closure;
15		use Go\Aop\Advisor;
16		use Go\Aop\Aspect;
17		use Go\Aop\Framework;
18		use Go\Aop\Intercept\Interceptor;
19		use Go\Aop\Pointcut;
20		use Go\Aop\Support\DefaultPointcutAdvisor;
21		use Go\Lang\Annotation;
22		use Go\Lang\Annotation\BaseInterceptor;
23		use ReflectionMethod;
24		use Reflector;
25
26		use function get_class;
27
28		/**
29		* General aspect loader add common support for general advices, declared as annotations
30		*/
31		class GeneralAspectLoaderExtension extends AbstractAspectLoaderExtension
32		{
33
34		/**
35		* General aspect loader works with annotations from aspect
36		*/
37	1	public function getKind(): string
38		{
39	1	return self::KIND_ANNOTATION;
40		}
41
42		/**
43		* General aspect loader works only with methods of aspect
44		*/
45	2	public function getTargets(): array
46		{
47	2	return [self::TARGET_METHOD];
48		}
49
50		/**
51		* Checks if loader is able to handle specific point of aspect
52		*
53		* @param Aspect $aspect Instance of aspect
54		* @param mixed\|\ReflectionClass\|\ReflectionMethod\|\ReflectionProperty $reflection Reflection of point
55		* @param mixed\|null $metaInformation Additional meta-information, e.g. annotation for method
56		*
57		* @return boolean true if extension is able to create an advisor from reflection and metaInformation
58		*/
59	1	public function supports(Aspect $aspect, $reflection, $metaInformation = null): bool
60		{
61	1	return $metaInformation instanceof Annotation\Interceptor
62	1	\|\| $metaInformation instanceof Annotation\Pointcut;
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\|ReflectionMethod $reflection Reflection of point
70		* @param mixed\|null $metaInformation Additional meta-information, e.g. annotation for method
71		*
72		* @return array\|Pointcut[]\|Advisor[]
73		*
74		* @throws \UnexpectedValueException
75		*/
76	1	public function load(Aspect $aspect, Reflector $reflection, $metaInformation = null): array
77		{
78	1	$loadedItems = [];
79	1	$pointcut = $this->parsePointcut($aspect, $reflection, $metaInformation->value);
80	1	$methodId = get_class($aspect) . '->' . $reflection->name;
		0 ignored issues – show 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	1	$adviceCallback = $reflection->getClosure($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 `getClosure()` does only exist in the following implementations of said interface: `Doctrine\Common\Reflection\StaticReflectionMethod`, `Go\Aop\Support\AnnotatedReflectionMethod`, `Go\Aop\Support\NamespacedReflectionFunction`, `Go\ParserReflection\ReflectionFunction`, `Go\ParserReflection\ReflectionMethod`, `ReflectionFunction`, `ReflectionMethod`, `Zend\Code\Reflection\FunctionReflection`, `Zend\Code\Reflection\MethodReflection`. 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...
82
83		switch (true) {
84		// Register a pointcut by its name
85	1	case ($metaInformation instanceof Annotation\Pointcut):
86		$loadedItems[$methodId] = $pointcut;
87		break;
88
89	1	case ($pointcut instanceof Pointcut):
90	1	$advice = $this->getInterceptor($metaInformation, $adviceCallback);
91
92	1	$loadedItems[$methodId] = new DefaultPointcutAdvisor($pointcut, $advice);
93	1	break;
94
95		default:
96		throw new \UnexpectedValueException('Unsupported pointcut class: ' . get_class($pointcut));
97		}
98
99	1	return $loadedItems;
100		}
101
102		/**
103		* Returns an interceptor instance by meta-type annotation and closure
104		*
105		* @throws \UnexpectedValueException For unsupported annotations
106		*/
107	1	protected function getInterceptor(BaseInterceptor $metaInformation, Closure $adviceCallback): Interceptor
108		{
109	1	$adviceOrder = $metaInformation->order;
110	1	$pointcutExpression = $metaInformation->value;
111		switch (true) {
112	1	case ($metaInformation instanceof Annotation\Before):
113	1	return new Framework\BeforeInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);
114
115	1	case ($metaInformation instanceof Annotation\After):
116	1	return new Framework\AfterInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);
117
118		case ($metaInformation instanceof Annotation\Around):
119		return new Framework\AroundInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);
120
121		case ($metaInformation instanceof Annotation\AfterThrowing):
122		return new Framework\AfterThrowingInterceptor($adviceCallback, $adviceOrder, $pointcutExpression);
123
124		default:
125		throw new \UnexpectedValueException('Unsupported method meta class: ' . get_class($metaInformation));
126		}
127		}
128		}
129

goaop / framework

Push — master ( efe256...811ea7 )

GeneralAspectLoaderExtension::getInterceptor() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like