feat!: Refactor DependencyInterface to use DependencyContext instead …

…of FileOccurence and DependencyType, so that we do not add a new method to the interface and constructor parameters every time we want to add a piece of information about the dependency. (#11)
qossmic · Mar 26, 2024 · 288f04f · 288f04f
1 parent cd5bb85
commit 288f04f
Show file tree

Hide file tree

Showing 43 changed files with 219 additions and 215 deletions.
diff --git a/src/Contract/Ast/DependencyContext.php b/src/Contract/Ast/DependencyContext.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qossmic\Deptrac\Contract\Ast;
+
+/**
+ * @psalm-immutable
+ *
+ * Context of the dependency.
+ *
+ * Any additional info about where the dependency occurred.
+ */
+final class DependencyContext
+{
+    public function __construct(
+        public readonly FileOccurrence $fileOccurrence,
+        public readonly DependencyType $dependencyType
+    ) {}
+}
diff --git a/src/Contract/Dependency/DependencyInterface.php b/src/Contract/Dependency/DependencyInterface.php
@@ -4,8 +4,7 @@
 
 namespace Qossmic\Deptrac\Contract\Dependency;
 
-use Qossmic\Deptrac\Contract\Ast\DependencyType;
-use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 
 /**
@@ -17,12 +16,10 @@ public function getDepender(): TokenInterface;
 
     public function getDependent(): TokenInterface;
 
-    public function getFileOccurrence(): FileOccurrence;
+    public function getContext(): DependencyContext;
 
     /**
      * @return array<array{name:string, line:int}>
      */
     public function serialize(): array;
-
-    public function getType(): DependencyType;
 }
diff --git a/src/Core/Ast/AstMap/DependencyToken.php b/src/Core/Ast/AstMap/DependencyToken.php
@@ -4,8 +4,7 @@
 
 namespace Qossmic\Deptrac\Core\Ast\AstMap;
 
-use Qossmic\Deptrac\Contract\Ast\DependencyType;
-use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 
 /**
@@ -15,7 +14,6 @@ class DependencyToken
 {
     public function __construct(
         public readonly TokenInterface $token,
-        public readonly FileOccurrence $fileOccurrence,
-        public readonly DependencyType $type
+        public readonly DependencyContext $context,
     ) {}
 }
diff --git a/src/Core/Ast/AstMap/File/FileReferenceBuilder.php b/src/Core/Ast/AstMap/File/FileReferenceBuilder.php
@@ -5,7 +5,6 @@
 namespace Qossmic\Deptrac\Core\Ast\AstMap\File;
 
 use Qossmic\Deptrac\Contract\Ast\DependencyType;
-use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
 use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeReferenceBuilder;
 use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeToken;
 use Qossmic\Deptrac\Core\Ast\AstMap\DependencyToken;
@@ -29,8 +28,7 @@ public function useStatement(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::USE
+            $this->createContext($occursAtLine, DependencyType::USE),
         );
 
         return $this;

diff --git a/src/Core/Ast/AstMap/ReferenceBuilder.php b/src/Core/Ast/AstMap/ReferenceBuilder.php
@@ -4,6 +4,7 @@
 
 namespace Qossmic\Deptrac\Core\Ast\AstMap;
 
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\DependencyType;
 use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
 use Qossmic\Deptrac\Core\Ast\AstMap\ClassLike\ClassLikeToken;
@@ -28,6 +29,11 @@ final public function getTokenTemplates(): array
         return $this->tokenTemplates;
     }
 
+    protected function createContext(int $occursAtLine, DependencyType $type): DependencyContext
+    {
+        return new DependencyContext(new FileOccurrence($this->filepath, $occursAtLine), $type);
+    }
+
     /**
      * Unqualified function and constant names inside a namespace cannot be
      * statically resolved. Inside a namespace Foo, a call to strlen() may
@@ -39,8 +45,7 @@ public function unresolvedFunctionCall(string $functionName, int $occursAtLine):
     {
         $this->dependencies[] = new DependencyToken(
             FunctionToken::fromFQCN($functionName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::UNRESOLVED_FUNCTION_CALL
+            $this->createContext($occursAtLine, DependencyType::UNRESOLVED_FUNCTION_CALL),
         );
 
         return $this;
@@ -50,8 +55,7 @@ public function variable(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::VARIABLE
+            $this->createContext($occursAtLine, DependencyType::VARIABLE),
         );
 
         return $this;
@@ -61,17 +65,15 @@ public function superglobal(string $superglobalName, int $occursAtLine): void
     {
         $this->dependencies[] = new DependencyToken(
             SuperGlobalToken::from($superglobalName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::SUPERGLOBAL_VARIABLE
+            $this->createContext($occursAtLine, DependencyType::SUPERGLOBAL_VARIABLE),
         );
     }
 
     public function returnType(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::RETURN_TYPE
+            $this->createContext($occursAtLine, DependencyType::RETURN_TYPE),
         );
 
         return $this;
@@ -81,8 +83,7 @@ public function throwStatement(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::THROW
+            $this->createContext($occursAtLine, DependencyType::THROW),
         );
 
         return $this;
@@ -92,44 +93,39 @@ public function anonymousClassExtends(string $classLikeName, int $occursAtLine):
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::ANONYMOUS_CLASS_EXTENDS
+            $this->createContext($occursAtLine, DependencyType::ANONYMOUS_CLASS_EXTENDS),
         );
     }
 
     public function anonymousClassTrait(string $classLikeName, int $occursAtLine): void
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::ANONYMOUS_CLASS_TRAIT
+            $this->createContext($occursAtLine, DependencyType::ANONYMOUS_CLASS_TRAIT),
         );
     }
 
     public function constFetch(string $classLikeName, int $occursAtLine): void
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::CONST
+            $this->createContext($occursAtLine, DependencyType::CONST),
         );
     }
 
     public function anonymousClassImplements(string $classLikeName, int $occursAtLine): void
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::ANONYMOUS_CLASS_IMPLEMENTS
+            $this->createContext($occursAtLine, DependencyType::ANONYMOUS_CLASS_IMPLEMENTS),
         );
     }
 
     public function parameter(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::PARAMETER
+            $this->createContext($occursAtLine, DependencyType::PARAMETER),
         );
 
         return $this;
@@ -139,8 +135,7 @@ public function attribute(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::ATTRIBUTE
+            $this->createContext($occursAtLine, DependencyType::ATTRIBUTE),
         );
 
         return $this;
@@ -150,8 +145,7 @@ public function instanceof(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::INSTANCEOF
+            $this->createContext($occursAtLine, DependencyType::INSTANCEOF),
         );
 
         return $this;
@@ -161,8 +155,7 @@ public function newStatement(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::NEW
+            $this->createContext($occursAtLine, DependencyType::NEW),
         );
 
         return $this;
@@ -172,8 +165,7 @@ public function staticProperty(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::STATIC_PROPERTY
+            $this->createContext($occursAtLine, DependencyType::STATIC_PROPERTY),
         );
 
         return $this;
@@ -183,8 +175,7 @@ public function staticMethod(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::STATIC_METHOD
+            $this->createContext($occursAtLine, DependencyType::STATIC_METHOD),
         );
 
         return $this;
@@ -194,8 +185,7 @@ public function catchStmt(string $classLikeName, int $occursAtLine): self
     {
         $this->dependencies[] = new DependencyToken(
             ClassLikeToken::fromFQCN($classLikeName),
-            new FileOccurrence($this->filepath, $occursAtLine),
-            DependencyType::CATCH
+            $this->createContext($occursAtLine, DependencyType::CATCH),
         );
 
         return $this;

diff --git a/src/Core/Ast/Parser/Cache/AstFileReferenceFileCache.php b/src/Core/Ast/Parser/Cache/AstFileReferenceFileCache.php
@@ -4,6 +4,7 @@
 
 namespace Qossmic\Deptrac\Core\Ast\Parser\Cache;
 
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\DependencyType;
 use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
 use Qossmic\Deptrac\Core\Ast\AstMap\AstInherit;
@@ -121,6 +122,7 @@ static function (array $data): array {
                             FunctionToken::class,
                             SuperGlobalToken::class,
                             FileOccurrence::class,
+                            DependencyContext::class,
                         ],
                     ]
                 );

diff --git a/src/Core/Dependency/Dependency.php b/src/Core/Dependency/Dependency.php
@@ -4,8 +4,7 @@
 
 namespace Qossmic\Deptrac\Core\Dependency;
 
-use Qossmic\Deptrac\Contract\Ast\DependencyType;
-use Qossmic\Deptrac\Contract\Ast\FileOccurrence;
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\TokenInterface;
 use Qossmic\Deptrac\Contract\Dependency\DependencyInterface;
 
@@ -14,15 +13,14 @@ class Dependency implements DependencyInterface
     public function __construct(
         private readonly TokenInterface $depender,
         private readonly TokenInterface $dependent,
-        private readonly FileOccurrence $fileOccurrence,
-        private readonly DependencyType $dependencyType
+        private readonly DependencyContext $context,
     ) {}
 
     public function serialize(): array
     {
         return [[
             'name' => $this->dependent->toString(),
-            'line' => $this->fileOccurrence->line,
+            'line' => $this->context->fileOccurrence->line,
         ]];
     }
 
@@ -36,13 +34,8 @@ public function getDependent(): TokenInterface
         return $this->dependent;
     }
 
-    public function getFileOccurrence(): FileOccurrence
+    public function getContext(): DependencyContext
     {
-        return $this->fileOccurrence;
-    }
-
-    public function getType(): DependencyType
-    {
-        return $this->dependencyType;
+        return $this->context;
     }
 }
diff --git a/src/Core/Dependency/Emitter/ClassDependencyEmitter.php b/src/Core/Dependency/Emitter/ClassDependencyEmitter.php
@@ -4,6 +4,7 @@
 
 namespace Qossmic\Deptrac\Core\Dependency\Emitter;
 
+use Qossmic\Deptrac\Contract\Ast\DependencyContext;
 use Qossmic\Deptrac\Contract\Ast\DependencyType;
 use Qossmic\Deptrac\Core\Ast\AstMap\AstMap;
 use Qossmic\Deptrac\Core\Dependency\Dependency;
@@ -22,19 +23,18 @@ public function applyDependencies(AstMap $astMap, DependencyList $dependencyList
             $classLikeName = $classReference->getToken();
 
             foreach ($classReference->dependencies as $dependency) {
-                if (DependencyType::SUPERGLOBAL_VARIABLE === $dependency->type) {
+                if (DependencyType::SUPERGLOBAL_VARIABLE === $dependency->context->dependencyType) {
                     continue;
                 }
-                if (DependencyType::UNRESOLVED_FUNCTION_CALL === $dependency->type) {
+                if (DependencyType::UNRESOLVED_FUNCTION_CALL === $dependency->context->dependencyType) {
                     continue;
                 }
 
                 $dependencyList->addDependency(
                     new Dependency(
                         $classLikeName,
                         $dependency->token,
-                        $dependency->fileOccurrence,
-                        $dependency->type
+                        $dependency->context,
                     )
                 );
             }
@@ -44,8 +44,7 @@ public function applyDependencies(AstMap $astMap, DependencyList $dependencyList
                     new Dependency(
                         $classLikeName,
                         $inherit->classLikeName,
-                        $inherit->fileOccurrence,
-                        DependencyType::INHERIT
+                        new DependencyContext($inherit->fileOccurrence, DependencyType::INHERIT),
                     )
                 );
             }

diff --git a/src/Core/Dependency/Emitter/ClassSuperglobalDependencyEmitter.php b/src/Core/Dependency/Emitter/ClassSuperglobalDependencyEmitter.php
@@ -20,15 +20,14 @@ public function applyDependencies(AstMap $astMap, DependencyList $dependencyList
     {
         foreach ($astMap->getClassLikeReferences() as $classReference) {
             foreach ($classReference->dependencies as $dependency) {
-                if (DependencyType::SUPERGLOBAL_VARIABLE !== $dependency->type) {
+                if (DependencyType::SUPERGLOBAL_VARIABLE !== $dependency->context->dependencyType) {
                     continue;
                 }
                 $dependencyList->addDependency(
                     new Dependency(
                         $classReference->getToken(),
                         $dependency->token,
-                        $dependency->fileOccurrence,
-                        $dependency->type
+                        $dependency->context,
                     )
                 );
             }