[Feature] Pointcut namespace refactoring #500

lisachenko · 2024-04-13T12:58:17Z

Previous Pointcut system wasn't type-safe, consisted of mix of different PointFilters and Poincuts, which resulted in extra code duplication, tricky checks and absence of strict typing of arguments.

For version 4 of framework, following major Pointcut interface will be used with it's main matches method:

    /**
     * Performs matching of point of code, returns true if point matches
     *
     * @param ReflectionClass<T>|ReflectionFileNamespace $context 
     * @param ReflectionMethod|ReflectionProperty|ReflectionFunction|null $reflector
     * @param null|(string&class-string<T>)|(object&T) $instanceOrScope
     * @param null|array<mixed>  $arguments
     *
     * @template T of object
     */
    public function matches(
        ReflectionClass|ReflectionFileNamespace                $context,
        ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
        object|string                                          $instanceOrScope = null,
        array                                                  $arguments = null
    ): bool;

Pointcut matching is now always performed via single interface by checking first context, then context + reflector and finally, for dynamic pointcuts it checks context + reflector + instance + arguments of invocation.

Pay an attention, that in current version of framework, position of $context and $reflector has been switched to have more natural matching.

This major refactoring removed the duplication around PointFilter and Pointcut. PHP8 features and types have been applied to the namespace for strong typing. Now only one Pointcut interface is responsible for matching of joinpoint. New tests were added, PhpStan level 9 check achieved for the Pointcut namespace now. Signature of Pointcut has been changed to highlight logic of 3-stage matching. Now first element of Pointcut->matches() is always context to streamline optimizations. IntroductionAdvisor has been removed too to unify logic inside GenericPointcutAdvisor. All filters from the Support namespace have been removed or refactored/renamed into pointcuts.

scrutinizer-notifier · 2024-04-13T12:58:27Z

A new inspection was created.

Nitpick-CI · 2024-04-13T12:58:57Z

src/Aop/Framework/DynamicInvocationMatcherInterceptor.php

 */
 public function __construct(
- private PointFilter $pointFilter,
+ private Pointcut $pointcut,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:58:58Z

src/Aop/Pointcut.php

+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool;
+}


Expected 1 newline at end of file; 0 found

Nitpick-CI · 2024-04-13T12:58:58Z

src/Aop/Pointcut/AndPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:58:59Z

src/Aop/Pointcut/AttributePointcut.php

- if (!isset(self::$mappings[$filterKind])) {
- throw new InvalidArgumentException("Unsupported filter kind {$filterKind}");
+ public function __construct(
+ private int $pointcutKind,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:00Z

src/Aop/Pointcut/AttributePointcut.php

- throw new InvalidArgumentException("Unsupported filter kind {$filterKind}");
+ public function __construct(
+ private int $pointcutKind,
+ private string $attributeClassName,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:00Z

src/Aop/Pointcut/AttributePointcut.php

+ public function __construct(
+ private int $pointcutKind,
+ private string $attributeClassName,
+ private bool $useContextForMatching = false,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:01Z

src/Aop/Pointcut/AttributePointcut.php

+ private int $pointcutKind,
+ private string $attributeClassName,
+ private bool $useContextForMatching = false,
+ ) {}


Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:02Z

src/Aop/Pointcut/AttributePointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:03Z

src/Aop/Pointcut/ClassInheritancePointcut.php

+ * Inheritance class matcher constructor
+ * @param (string&class-string) $parentClassOrInterfaceName Parent class or interface name to match in hierarchy
+ */
+ public function __construct(private string $parentClassOrInterfaceName) {}


Opening brace should be on a new line

Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:03Z

src/Aop/Pointcut/ClassInheritancePointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:04Z

src/Aop/Pointcut/ClassMemberReference.php

- {
- return $this->memberNamePattern;
- }
+ public Pointcut $classFilter,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:05Z

src/Aop/Pointcut/ClassMemberReference.php

- return $this->memberNamePattern;
- }
+ public Pointcut $classFilter,
+ public ModifierPointcut $visibilityFilter,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:06Z

src/Aop/Pointcut/ClassMemberReference.php

- }
+ public Pointcut $classFilter,
+ public ModifierPointcut $visibilityFilter,
+ public ModifierPointcut $accessTypeFilter,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:06Z

src/Aop/Pointcut/ClassMemberReference.php

+ public Pointcut $classFilter,
+ public ModifierPointcut $visibilityFilter,
+ public ModifierPointcut $accessTypeFilter,
+ public string $memberNamePattern


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:07Z

src/Aop/Pointcut/ClassMemberReference.php

+ public ModifierPointcut $visibilityFilter,
+ public ModifierPointcut $accessTypeFilter,
+ public string $memberNamePattern
+ ) {}


Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:08Z

src/Aop/Pointcut/MagicMethodDynamicPointcut.php

+ *
+ * @param string $methodName Method name to match, can contain wildcards "*","?" or "|"
+ */
+ public function __construct(private string $methodName) {


Opening brace should be on a new line

Nitpick-CI · 2024-04-13T12:59:08Z

src/Aop/Pointcut/MagicMethodDynamicPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:09Z

src/Aop/Pointcut/MatchInheritedPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:10Z

src/Aop/Pointcut/ModifierPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:10Z

src/Aop/Pointcut/NamePointcut.php

+ * @param bool $useContextForMatching Switch to matching context name instead of reflector
+ */
+ public function __construct(
+ private int $pointcutKind,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:11Z

src/Aop/Pointcut/NamePointcut.php

+ */
+ public function __construct(
+ private int $pointcutKind,
+ private string $name,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:12Z

src/Aop/Pointcut/NamePointcut.php

+ public function __construct(
+ private int $pointcutKind,
+ private string $name,
+ private bool $useContextForMatching = false,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:12Z

src/Aop/Pointcut/NamePointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:13Z

src/Aop/Pointcut/NotPointcut.php

- $this->pointcut = $pointcut;
- $this->kind = $pointcut->getKind();
- }
+ public function __construct(private Pointcut $pointcut) {}


Opening brace should be on a new line

Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:14Z

src/Aop/Pointcut/NotPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:14Z

src/Aop/Pointcut/OrPointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:15Z

src/Aop/Pointcut/PointcutReference.php

- {
- return $this->getPointcut()->matches($point, $context, $instance, $arguments);
+ public function __construct(
+ private AspectContainer $container,


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:16Z

src/Aop/Pointcut/PointcutReference.php

- return $this->getPointcut()->matches($point, $context, $instance, $arguments);
+ public function __construct(
+ private AspectContainer $container,
+ private readonly string $pointcutId


Line indented incorrectly; expected 4 spaces, found 8

Nitpick-CI · 2024-04-13T12:59:16Z

src/Aop/Pointcut/PointcutReference.php

+ public function __construct(
+ private AspectContainer $container,
+ private readonly string $pointcutId
+ ) {}


Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:17Z

src/Aop/Pointcut/PointcutReference.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:18Z

src/Aop/Pointcut/ReturnTypePointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): bool {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

Nitpick-CI · 2024-04-13T12:59:18Z

src/Aop/Pointcut/TruePointcut.php

 */
- protected int $filterKind;
+ public function __construct(private int $pointcutKind = self::KIND_ALL) {}


Opening brace should be on a new line

Closing brace must be on a line by itself

Nitpick-CI · 2024-04-13T12:59:19Z

src/Aop/Pointcut/TruePointcut.php

+ ReflectionMethod|ReflectionProperty|ReflectionFunction $reflector = null,
+ object|string $instanceOrScope = null,
+ array $arguments = null
+ ): true {


There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found 0 spaces

lisachenko added 2 commits April 2, 2024 21:36

[BC Break] Refactor ClassMemberReference to the readonly PHP8.2 DTO

f04e776

lisachenko added BC Break PHP-8.2 labels Apr 13, 2024

Nitpick-CI reviewed Apr 13, 2024

View reviewed changes

lisachenko added this to the 4.0.0 milestone Apr 13, 2024

lisachenko merged commit e2d30bf into master Apr 13, 2024
6 of 7 checks passed

lisachenko deleted the feature/pointcut-namespace-refactoring branch April 13, 2024 13:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Pointcut namespace refactoring #500

[Feature] Pointcut namespace refactoring #500

lisachenko commented Apr 13, 2024

scrutinizer-notifier commented Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

Nitpick-CI Apr 13, 2024

[Feature] Pointcut namespace refactoring #500

[Feature] Pointcut namespace refactoring #500

Conversation

lisachenko commented Apr 13, 2024

scrutinizer-notifier commented Apr 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment