Added TokenReference meta data

qossmic#1190
ariddlestone · Jun 11, 2023 · 204a454 · 204a454
1 parent 20772c6
commit 204a454
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 3 deletions.
diff --git a/src/Contract/Ast/TokenReferenceInterface.php b/src/Contract/Ast/TokenReferenceInterface.php
@@ -12,4 +12,9 @@ interface TokenReferenceInterface
     public function getFilepath(): ?string;
 
     public function getToken(): TokenInterface;
+
+    /**
+     * @return TokenReferenceMetaInterface[]
+     */
+    public function getMetaData(): array;
 }
diff --git a/src/Contract/Ast/TokenReferenceMetaInterface.php b/src/Contract/Ast/TokenReferenceMetaInterface.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Qossmic\Deptrac\Contract\Ast;
+
+interface TokenReferenceMetaInterface
+{
+}
diff --git a/src/Core/Ast/AstMap/ClassLike/ClassLikeReference.php b/src/Core/Ast/AstMap/ClassLike/ClassLikeReference.php
@@ -5,6 +5,7 @@
 namespace Qossmic\Deptrac\Core\Ast\AstMap\ClassLike;
 
 use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+use Qossmic\Deptrac\Contract\Ast\TokenReferenceMetaInterface;
 use Qossmic\Deptrac\Core\Ast\AstMap\AstInherit;
 use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\File\FileReference;
@@ -18,12 +19,14 @@ class ClassLikeReference implements TokenReferenceInterface
 
     /**
      * @param AstInherit[] $inherits
+     * @param TokenReferenceMetaInterface[] $metaData
      * @param DependencyToken[] $dependencies
      */
     public function __construct(
         private readonly ClassLikeToken $classLikeName,
         ClassLikeType $classLikeType = null,
         public readonly array $inherits = [],
+        public readonly array $metaData = [],
         public readonly array $dependencies = [],
         public readonly bool $isInternal = false,
         private readonly ?FileReference $fileReference = null
@@ -37,6 +40,7 @@ public function withFileReference(FileReference $astFileReference): self
             $this->classLikeName,
             $this->type,
             $this->inherits,
+            $this->metaData,
             $this->dependencies,
             $this->isInternal,
             $astFileReference
@@ -52,4 +56,9 @@ public function getToken(): ClassLikeToken
     {
         return $this->classLikeName;
     }
+
+    public function getMetaData(): array
+    {
+        return $this->metaData;
+    }
 }
diff --git a/src/Core/Ast/AstMap/ClassLike/ClassLikeReferenceBuilder.php b/src/Core/Ast/AstMap/ClassLike/ClassLikeReferenceBuilder.php
@@ -66,6 +66,7 @@ public function build(): ClassLikeReference
             $this->classLikeToken,
             $this->classLikeType,
             $this->inherits,
+            $this->metaData,
             $this->dependencies,
             $this->isInternal
         );

diff --git a/src/Core/Ast/AstMap/File/FileReference.php b/src/Core/Ast/AstMap/File/FileReference.php
@@ -6,6 +6,7 @@
 
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+use Qossmic\Deptrac\Contract\Ast\TokenReferenceMetaInterface;
 use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeReference;
 use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\Function\FunctionReference;
@@ -24,12 +25,14 @@ class FileReference implements TokenReferenceInterface
     /**
      * @param ClassLikeReference[] $classLikeReferences
      * @param FunctionReference[] $functionReferences
+     * @param TokenReferenceMetaInterface[] $metaData
      * @param DependencyToken[] $dependencies
      */
     public function __construct(
         public readonly string $filepath,
         array $classLikeReferences,
         array $functionReferences,
+        public readonly array $metaData,
         public readonly array $dependencies
     ) {
         /** @psalm-suppress ImpureFunctionCall */
@@ -53,4 +56,9 @@ public function getToken(): TokenInterface
     {
         return new FileToken($this->filepath);
     }
+
+    public function getMetaData(): array
+    {
+        return $this->metaData;
+    }
 }
diff --git a/src/Core/Ast/AstMap/File/FileReferenceBuilder.php b/src/Core/Ast/AstMap/File/FileReferenceBuilder.php
@@ -103,6 +103,12 @@ public function build(): FileReference
             $functionReferences[] = $functionReference->build();
         }
 
-        return new FileReference($this->filepath, $classReferences, $functionReferences, $this->dependencies);
+        return new FileReference(
+            $this->filepath,
+            $classReferences,
+            $functionReferences,
+            $this->metaData,
+            $this->dependencies
+        );
     }
 }
diff --git a/src/Core/Ast/AstMap/Function/FunctionReference.php b/src/Core/Ast/AstMap/Function/FunctionReference.php
@@ -6,6 +6,7 @@
 
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+use Qossmic\Deptrac\Contract\Ast\TokenReferenceMetaInterface;
 use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\File\FileReference;
 
@@ -15,10 +16,12 @@
 class FunctionReference implements TokenReferenceInterface
 {
     /**
+     * @param TokenReferenceMetaInterface[] $metaData
      * @param DependencyToken[] $dependencies
      */
     public function __construct(
         private readonly FunctionToken $functionName,
+        public readonly array $metaData = [],
         public readonly array $dependencies = [],
         private readonly ?FileReference $fileReference = null
     ) {}
@@ -27,6 +30,7 @@ public function withFileReference(FileReference $astFileReference): self
     {
         return new self(
             $this->functionName,
+            $this->metaData,
             $this->dependencies,
             $astFileReference
         );
@@ -41,4 +45,9 @@ public function getToken(): TokenInterface
     {
         return $this->functionName;
     }
+
+    public function getMetaData(): array
+    {
+        return $this->metaData;
+    }
 }
diff --git a/src/Core/Ast/AstMap/Function/FunctionReferenceBuilder.php b/src/Core/Ast/AstMap/Function/FunctionReferenceBuilder.php
@@ -29,6 +29,7 @@ public function build(): FunctionReference
     {
         return new FunctionReference(
             FunctionToken::fromFQCN($this->functionName),
+            $this->metaData,
             $this->dependencies
         );
     }

diff --git a/src/Core/Ast/AstMap/ReferenceBuilder.php b/src/Core/Ast/AstMap/ReferenceBuilder.php
@@ -6,12 +6,18 @@
 
 use Qossmic\Deptrac\Contract\Ast\DependencyType;
 use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
+use Qossmic\Deptrac\Contract\Ast\TokenReferenceMetaInterface;
 use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\Function\FunctionToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\Variable\SuperGlobalToken;
 
 abstract class ReferenceBuilder
 {
+    /**
+     * @var TokenReferenceMetaInterface[]
+     */
+    protected array $metaData = [];
+
     /** @var DependencyToken[] */
     protected array $dependencies = [];
 
@@ -28,6 +34,11 @@ final public function getTokenTemplates(): array
         return $this->tokenTemplates;
     }
 
+    public function addMetaData(TokenReferenceMetaInterface $metaDataItem): void
+    {
+        $this->metaData[] = $metaDataItem;
+    }
+
     /**
      * Unqualified function and constant names inside a namespace cannot be
      * statically resolved. Inside a namespace Foo, a call to strlen() may

diff --git a/src/Core/Ast/AstMap/Variable/VariableReference.php b/src/Core/Ast/AstMap/Variable/VariableReference.php
@@ -6,13 +6,20 @@
 
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 use Qossmic\Deptrac\Contract\Ast\TokenReferenceInterface;
+use Qossmic\Deptrac\Contract\Ast\TokenReferenceMetaInterface;
 
 /**
  * @psalm-immutable
  */
 class VariableReference implements TokenReferenceInterface
 {
-    public function __construct(private readonly SuperGlobalToken $tokenName) {}
+    /**
+     * @param TokenReferenceMetaInterface[] $metaData
+     */
+    public function __construct(
+        private readonly SuperGlobalToken $tokenName,
+        private readonly array $metaData = []
+    ) {}
 
     public function getFilepath(): ?string
     {
@@ -23,4 +30,9 @@ public function getToken(): TokenInterface
     {
         return $this->tokenName;
     }
+
+    public function getMetaData(): array
+    {
+        return $this->metaData;
+    }
 }
diff --git a/src/Core/Dependency/TokenResolver.php b/src/Core/Dependency/TokenResolver.php
@@ -27,7 +27,7 @@ public function resolve(TokenInterface $token, AstMap $astMap): TokenReferenceIn
             $token instanceof ClassLikeToken => $astMap->getClassReferenceForToken($token) ?? new ClassLikeReference($token),
             $token instanceof FunctionToken => $astMap->getFunctionReferenceForToken($token) ?? new FunctionReference($token),
             $token instanceof SuperGlobalToken => new VariableReference($token),
-            $token instanceof FileToken => $astMap->getFileReferenceForToken($token) ?? new FileReference($token->path, [], [], []),
+            $token instanceof FileToken => $astMap->getFileReferenceForToken($token) ?? new FileReference($token->path, [], [], [], []),
             default => throw UnrecognizedTokenException::cannotCreateReference($token)
         };
     }

diff --git a/tests/Core/Dependency/TokenResolverTest.php b/tests/Core/Dependency/TokenResolverTest.php
@@ -48,6 +48,7 @@ public function testResolvesClassLikeFromAstMap(): void
                 $classReference,
             ],
             [],
+            [],
             []
         );
         $astMap = new AstMap([$fileReference]);
@@ -79,6 +80,7 @@ public function testResolvesFunctionFromAstMap(): void
             [
                 $functionReference,
             ],
+            [],
             []
         );
         $astMap = new AstMap([$fileReference]);
@@ -117,6 +119,7 @@ public function testResolvesFileFromAstMap(): void
             'path/to/file.php',
             [],
             [],
+            [],
             []
         );
         $astMap = new AstMap([$fileReference]);