Merge pull request #1431 from Nyholm/give-hint

Add support for CodeLocationMissing to give a hint what code is missing
Roave · Jun 17, 2024 · 1e01cdb · 1e01cdb
2 parents 10a3873 + d53940c
commit 1e01cdb
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 10 deletions.
diff --git a/src/Reflection/Exception/CodeLocationMissing.php b/src/Reflection/Exception/CodeLocationMissing.php
@@ -8,8 +8,13 @@
 
 class CodeLocationMissing extends RuntimeException
 {
-    public static function create(): self
+    public static function create(string|null $hint = null): self
     {
-        return new self('Code location is missing');
+        $message = 'Code location is missing';
+        if ($hint !== null) {
+            $message .= '. ' . $hint;
+        }
+
+        return new self($message);
     }
 }
diff --git a/src/Reflection/ReflectionParameter.php b/src/Reflection/ReflectionParameter.php
@@ -487,7 +487,7 @@ public function getDefaultValueConstantName(): string
     public function getStartLine(): int
     {
         if ($this->startLine === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for parameter "$%s".', $this->name));
         }
 
         return $this->startLine;
@@ -501,7 +501,7 @@ public function getStartLine(): int
     public function getEndLine(): int
     {
         if ($this->endLine === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for parameter "$%s".', $this->name));
         }
 
         return $this->endLine;
@@ -515,7 +515,7 @@ public function getEndLine(): int
     public function getStartColumn(): int
     {
         if ($this->startColumn === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for parameter "$%s".', $this->name));
         }
 
         return $this->startColumn;
@@ -529,7 +529,7 @@ public function getStartColumn(): int
     public function getEndColumn(): int
     {
         if ($this->endColumn === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for parameter "$%s".', $this->name));
         }
 
         return $this->endColumn;

diff --git a/src/Reflection/ReflectionProperty.php b/src/Reflection/ReflectionProperty.php
@@ -367,7 +367,7 @@ public function isDeprecated(): bool
     public function getStartLine(): int
     {
         if ($this->startLine === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for property "$%s" in "%s".', $this->name, $this->implementingClass->getName()));
         }
 
         return $this->startLine;
@@ -383,7 +383,7 @@ public function getStartLine(): int
     public function getEndLine(): int
     {
         if ($this->endLine === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for property "$%s" in "%s".', $this->name, $this->implementingClass->getName()));
         }
 
         return $this->endLine;
@@ -397,7 +397,7 @@ public function getEndLine(): int
     public function getStartColumn(): int
     {
         if ($this->startColumn === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for property "$%s" in "%s".', $this->name, $this->implementingClass->getName()));
         }
 
         return $this->startColumn;
@@ -411,7 +411,7 @@ public function getStartColumn(): int
     public function getEndColumn(): int
     {
         if ($this->endColumn === null) {
-            throw CodeLocationMissing::create();
+            throw CodeLocationMissing::create(sprintf('Was looking for property "$%s" in "%s".', $this->name, $this->implementingClass->getName()));
         }
 
         return $this->endColumn;

diff --git a/test/unit/Reflection/Exception/CodeLocationMissingTest.php b/test/unit/Reflection/Exception/CodeLocationMissingTest.php
@@ -18,4 +18,12 @@ public function testCreate(): void
         self::assertInstanceOf(CodeLocationMissing::class, $exception);
         self::assertSame('Code location is missing', $exception->getMessage());
     }
+
+    public function testCreateWithHint(): void
+    {
+        $exception = CodeLocationMissing::create('Foobar');
+
+        self::assertInstanceOf(CodeLocationMissing::class, $exception);
+        self::assertSame('Code location is missing. Foobar', $exception->getMessage());
+    }
 }