violation can now contain a reference to the file path

Author: micheleorselli

src/Analyzer/FileParser.php

@@ -19,8 +19,8 @@ class FileParser implements Parser
 
     private FileVisitor $fileVisitor;
 
-    /** @var array */
-    private $parsingErrors;
+    /** @var ParsingError[] */
+    private array $parsingErrors;
 
     public function __construct(
         NodeTraverser $traverser,

src/Analyzer/FileVisitor.php

@@ -13,15 +13,15 @@ class FileVisitor extends NodeVisitorAbstract
 {
     private ClassDescriptionBuilder $classDescriptionBuilder;
 
-    /** @var array<ClassDescription> */
+    /** @var ClassDescription[] */
     private array $classDescriptions = [];
 
     public function __construct(ClassDescriptionBuilder $classDescriptionBuilder)
     {
         $this->classDescriptionBuilder = $classDescriptionBuilder;
     }
 
-    public function setFilePath(string $filePath): void
+    public function setFilePath(?string $filePath): void
     {
         $this->classDescriptionBuilder->setFilePath($filePath);
     }

src/Expression/ForClasses/DependsOnlyOnTheseNamespaces.php

@@ -15,7 +15,7 @@
 class DependsOnlyOnTheseNamespaces implements Expression
 {
     /** @var string[] */
-    private $namespaces;
+    private array $namespaces;
 
     public function __construct(string ...$namespace)
     {
@@ -49,7 +49,8 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str
                         $this->describe($theClass, $because),
                         "depends on {$dependency->getFQCN()->toString()}"
                     ),
-                    $dependency->getLine()
+                    $dependency->getLine(),
+                    $theClass->getFilePath()
                 );
 
                 $violations->add($violation);

src/Expression/ForClasses/NotDependsOnTheseNamespaces.php

@@ -15,7 +15,7 @@
 class NotDependsOnTheseNamespaces implements Expression
 {
     /** @var string[] */
-    private $namespaces;
+    private array $namespaces;
 
     public function __construct(string ...$namespace)
     {
@@ -46,7 +46,8 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str
                         $this->describe($theClass, $because),
                         "depends on {$dependency->getFQCN()->toString()}"
                     ),
-                    $dependency->getLine()
+                    $dependency->getLine(),
+                    $theClass->getFilePath()
                 );
 
                 $violations->add($violation);

src/Expression/ForClasses/NotHaveDependencyOutsideNamespace.php

@@ -14,12 +14,12 @@
 
 class NotHaveDependencyOutsideNamespace implements Expression
 {
-    /** @var string */
-    private $namespace;
-    /** @var array */
-    private $externalDependenciesToExclude;
-    /** @var bool */
-    private $excludeCoreNamespace;
+    private string $namespace;
+
+    /** @var string[] */
+    private array $externalDependenciesToExclude;
+
+    private bool $excludeCoreNamespace;
 
     public function __construct(string $namespace, array $externalDependenciesToExclude = [], bool $excludeCoreNamespace = false)
     {
@@ -59,7 +59,8 @@ public function evaluate(ClassDescription $theClass, Violations $violations, str
                     $this->describe($theClass, $because),
                     "depends on {$externalDep->getFQCN()->toString()}"
                 ),
-                $externalDep->getLine()
+                $externalDep->getLine(),
+                $theClass->getFilePath()
             );
             $violations->add($violation);
         }

src/Rules/Violation.php

@@ -10,23 +10,26 @@ class Violation implements \JsonSerializable
 
     private ?int $line;
 
+    private ?string $filePath;
+
     private string $error;
 
-    public function __construct(string $fqcn, string $error, ?int $line = null)
+    public function __construct(string $fqcn, string $error, ?int $line = null, ?string $filePath = null)
     {
         $this->fqcn = $fqcn;
         $this->error = $error;
         $this->line = $line;
+        $this->filePath = $filePath;
     }
 
     public static function create(string $fqcn, ViolationMessage $error): self
     {
         return new self($fqcn, $error->toString());
     }
 
-    public static function createWithErrorLine(string $fqcn, ViolationMessage $error, int $line): self
+    public static function createWithErrorLine(string $fqcn, ViolationMessage $error, int $line, string $filePath): self
     {
-        return new self($fqcn, $error->toString(), $line);
+        return new self($fqcn, $error->toString(), $line, $filePath);
     }
 
     public function getFqcn(): string
@@ -44,13 +47,18 @@ public function getLine(): ?int
         return $this->line;
     }
 
+    public function getFilePath(): ?string
+    {
+        return $this->filePath;
+    }
+
     public function jsonSerialize(): array
     {
         return get_object_vars($this);
     }
 
     public static function fromJson(array $json): self
     {
-        return new self($json['fqcn'], $json['error'], $json['line']);
+        return new self($json['fqcn'], $json['error'], $json['line'], $json['filePath'] ?? null);
     }
 }