[Step 6 Upgrade] Add PHP 8+ Attributes support (#130)

[Step 6 Upgrade] Add PHP 8+ Attributes support
goaop · Feb 4, 2024 · bf823ac · bf823ac
1 parent b8e46fa
commit bf823ac
Show file tree

Hide file tree

Showing 20 changed files with 553 additions and 1 deletion.
diff --git a/nitpick.json b/nitpick.json
@@ -1,5 +1,6 @@
 {
     "ignore": [
+        "src/*",
         "tests/*",
         "docs/*"
     ]

diff --git a/src/ReflectionAttribute.php b/src/ReflectionAttribute.php
@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * Parser Reflection API
+ *
+ * @copyright Copyright 2015, 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\ParserReflection;
+
+use Go\ParserReflection\ValueResolver\NodeExpressionResolver;
+use ReflectionAttribute as BaseReflectionAttribute;
+use PhpParser\Node;
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Function_;
+use PhpParser\Node\Stmt\Property;
+use PhpParser\Node\Stmt\PropertyProperty;
+
+/**
+ * ref original usage https://3v4l.org/duaQI
+ */
+class ReflectionAttribute extends BaseReflectionAttribute
+{
+    public function __construct(
+        private string $attributeName,
+        private ReflectionClass|ReflectionMethod|ReflectionProperty|ReflectionClassConstant|ReflectionFunction|ReflectionParameter $reflector,
+        private array $arguments,
+        private bool $isRepeated,
+    ) {
+    }
+
+    public function getNode(): Node\Attribute
+    {
+        /** @var Class_|ClassMethod|PropertyProperty|ClassConst|Function_|Param $node  */
+        $node = $this->reflector->getNode();
+
+        // attrGroups only exists in Property Stmt
+        if ($node instanceof PropertyProperty) {
+            $node = $this->reflector->getTypeNode();
+        }
+
+        $nodeExpressionResolver = new NodeExpressionResolver($this);
+        foreach ($node->attrGroups as $attrGroup) {
+            foreach ($attrGroup->attrs as $attr) {
+                if ($attr->name->toString() !== $this->attributeName) {
+                    continue;
+                }
+
+                $arguments = [];
+                foreach ($attr->args as $arg) {
+                    $nodeExpressionResolver->process($arg->value);
+                    $arguments[] = $nodeExpressionResolver->getValue();
+                }
+
+                if ($arguments !== $this->arguments) {
+                    continue;
+                }
+
+                return $attr;
+            }
+        }
+
+        throw new ReflectionException('ReflectionAttribute should be initiated from Go\ParserReflection Reflection classes');
+    }
+
+    public function isRepeated(): bool
+    {
+        return $this->isRepeated;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getArguments(): array
+    {
+        return $this->arguments;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getName(): string
+    {
+        return $this->attributeName;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getTarget(): int
+    {
+        throw new \RuntimeException(sprintf('cannot get target from %s', $this::class));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function newInstance(): object
+    {
+        throw new \RuntimeException(sprintf('cannot create new instance from %s', $this::class));
+    }
+}
diff --git a/src/ReflectionClass.php b/src/ReflectionClass.php
@@ -12,6 +12,7 @@
 
 namespace Go\ParserReflection;
 
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\Traits\ReflectionClassLikeTrait;
 use PhpParser\Node\Name\FullyQualified;
@@ -27,6 +28,7 @@ class ReflectionClass extends InternalReflectionClass
 {
     use InternalPropertiesEmulationTrait;
     use ReflectionClassLikeTrait;
+    use AttributeResolverTrait;
 
     /**
      * Initializes reflection instance

diff --git a/src/ReflectionClassConstant.php b/src/ReflectionClassConstant.php
@@ -11,8 +11,10 @@
 
 namespace Go\ParserReflection;
 
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\ValueResolver\NodeExpressionResolver;
+use PhpParser\Node;
 use PhpParser\Node\Const_;
 use PhpParser\Node\Stmt\ClassConst;
 use PhpParser\Node\Stmt\ClassLike;
@@ -22,6 +24,7 @@
 class ReflectionClassConstant extends BaseReflectionClassConstant
 {
     use InternalPropertiesEmulationTrait;
+    use AttributeResolverTrait;
 
     /**
      * Concrete class constant node
@@ -213,4 +216,9 @@ public function __toString(): string
             (string) $value
         );
     }
+
+    public function getNode(): Node\Stmt\ClassConst
+    {
+        return $this->classConstantNode;
+    }
 }
diff --git a/src/ReflectionFunction.php b/src/ReflectionFunction.php
@@ -12,6 +12,7 @@
 namespace Go\ParserReflection;
 
 use Closure;
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\Traits\ReflectionFunctionLikeTrait;
 use PhpParser\Node\Stmt\Function_;
@@ -24,6 +25,7 @@ class ReflectionFunction extends BaseReflectionFunction
 {
     use InternalPropertiesEmulationTrait;
     use ReflectionFunctionLikeTrait;
+    use AttributeResolverTrait;
 
     /**
      * Initializes reflection instance for given AST-node

diff --git a/src/ReflectionMethod.php b/src/ReflectionMethod.php
@@ -11,6 +11,7 @@
 
 namespace Go\ParserReflection;
 
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\Traits\ReflectionFunctionLikeTrait;
 use PhpParser\Node\Stmt\ClassLike;
@@ -25,6 +26,7 @@ class ReflectionMethod extends BaseReflectionMethod
 {
     use InternalPropertiesEmulationTrait;
     use ReflectionFunctionLikeTrait;
+    use AttributeResolverTrait;
 
     /**
      * Name of the class

diff --git a/src/ReflectionParameter.php b/src/ReflectionParameter.php
@@ -11,6 +11,7 @@
 
 namespace Go\ParserReflection;
 
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\ValueResolver\NodeExpressionResolver;
 use PhpParser\Node\Expr;
@@ -32,6 +33,7 @@
 class ReflectionParameter extends BaseReflectionParameter
 {
     use InternalPropertiesEmulationTrait;
+    use AttributeResolverTrait;
 
     /**
      * Reflection function or method
@@ -260,7 +262,7 @@ public function getDeclaringFunction(): ReflectionFunctionAbstract
     /**
      * {@inheritDoc}
      */
-    public function getDefaultValue()
+    public function getDefaultValue(): mixed
     {
         if (!$this->isDefaultValueAvailable()) {
             throw new ReflectionException('Internal error: Failed to retrieve the default value');

diff --git a/src/ReflectionProperty.php b/src/ReflectionProperty.php
@@ -11,6 +11,7 @@
 
 namespace Go\ParserReflection;
 
+use Go\ParserReflection\Traits\AttributeResolverTrait;
 use Go\ParserReflection\Traits\InitializationTrait;
 use Go\ParserReflection\Traits\InternalPropertiesEmulationTrait;
 use Go\ParserReflection\ValueResolver\NodeExpressionResolver;
@@ -27,6 +28,7 @@ class ReflectionProperty extends BaseReflectionProperty
 {
     use InitializationTrait;
     use InternalPropertiesEmulationTrait;
+    use AttributeResolverTrait;
 
     /**
      * Type of property node

diff --git a/src/Traits/AttributeResolverTrait.php b/src/Traits/AttributeResolverTrait.php
@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * Parser Reflection API
+ *
+ * @copyright Copyright 2015, 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\ParserReflection\Traits;
+
+use Go\ParserReflection\ReflectionAttribute;
+use Go\ParserReflection\ReflectionProperty;
+use Go\ParserReflection\ValueResolver\NodeExpressionResolver;
+
+trait AttributeResolverTrait
+{
+    /**
+     * @return ReflectionAttribute[]
+     */
+    public function getAttributes(?string $name = null, int $flags = 0): array
+    {
+        if ($this instanceof ReflectionProperty) {
+            $node = $this->getTypeNode();
+        } else {
+            $node = $this->getNode();
+        }
+
+        $node = $this->getNode();
+        $attributes = [];
+        $nodeExpressionResolver = new NodeExpressionResolver($this);
+
+        foreach ($node->attrGroups as $attrGroup) {
+            foreach ($attrGroup->attrs as $attr) {
+                $arguments = [];
+                foreach ($attr->args as $arg) {
+                    $nodeExpressionResolver->process($arg->value);
+                    $arguments[] = $nodeExpressionResolver->getValue();
+                }
+
+                if ($name === null) {
+                    $attributes[] = new ReflectionAttribute($attr->name->toString(), $this, $arguments, $this->isAttributeRepeated($attr->name->toString(), $node->attrGroups));
+
+                    continue;
+                }
+
+                if ($name !== $attr->name->toString()) {
+                    continue;
+                }
+
+                $attributes[] = new ReflectionAttribute($name, $this, $arguments, $this->isAttributeRepeated($name, $node->attrGroups));
+            }
+        }
+
+        return $attributes;
+    }
+
+    private function isAttributeRepeated(string $attributeName, array $attrGroups): bool
+    {
+        $count = 0;
+
+        foreach ($attrGroups as $attrGroup) {
+            foreach ($attrGroup->attrs as $attr) {
+                if ($attr->name->toString() === $attributeName) {
+                    ++$count;
+                }
+            }
+        }
+
+        return $count >= 2;
+    }
+}
diff --git a/src/Traits/ReflectionClassLikeTrait.php b/src/Traits/ReflectionClassLikeTrait.php
@@ -583,6 +583,13 @@ public function getShortName(): string
 
     public function getStartLine(): int
     {
+        if ($this->classLikeNode->attrGroups !== []) {
+            $attrGroups = $this->classLikeNode->attrGroups;
+            $lastAttrGroupsEndLine = end($attrGroups)->getAttribute('endLine');
+
+            return $lastAttrGroupsEndLine + 1;
+        }
+
         return $this->classLikeNode->getAttribute('startLine');
     }
 

diff --git a/src/Traits/ReflectionFunctionLikeTrait.php b/src/Traits/ReflectionFunctionLikeTrait.php
@@ -219,6 +219,13 @@ public function getShortName(): string
 
     public function getStartLine(): int
     {
+        if ($this->functionLikeNode->attrGroups !== []) {
+            $attrGroups = $this->functionLikeNode->attrGroups;
+            $lastAttrGroupsEndLine = end($attrGroups)->getAttribute('endLine');
+
+            return $lastAttrGroupsEndLine + 1;
+        }
+
         return $this->functionLikeNode->getAttribute('startLine');
     }
 

diff --git a/tests/Locator/ComposerLocatorTest.php b/tests/Locator/ComposerLocatorTest.php
@@ -5,6 +5,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Go\ParserReflection\ReflectionClass;
+use Go\ParserReflection\ReflectionEngine;
 
 class ComposerLocatorTest extends TestCase
 {
@@ -21,4 +22,12 @@ public function testLocateClass()
             $locator->locateClass('\\' . ReflectionClass::class)
         );
     }
+
+    public function testLocateClassWithAttributes()
+    {
+        ReflectionEngine::init(new ComposerLocator());
+
+        $parsedClass = new \Go\ParserReflection\ReflectionClass(\Go\ParserReflection\Stub\RandomClassWithAttribute::class);
+        $this->assertIsArray($parsedClass->getAttributes());
+    }
 }