Fix checking the docblock type for a parameter, where a previous para…

…meter starts with the same string (#60)
123inkt · Aug 7, 2024 · f967dfc · f967dfc
1 parent 1b488d2
commit f967dfc
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/src/Constraint/Typehint/PhpDocParser.php b/src/Constraint/Typehint/PhpDocParser.php
@@ -17,12 +17,12 @@ public function getParamTypehint(string $parameterName, string $docComment): ?st
             return null;
         }
 
-        preg_match('/\*\s*@(?:phpstan|psalm)-param\s+(.*?)\s*(?:\.\.\.)?' . preg_quote('$' . $parameterName, '/') . '/i', $docComment, $matches);
+        preg_match('/\*\s*@(?:phpstan|psalm)-param\s+(.*?)\s*(?:\.\.\.)?' . preg_quote('$' . $parameterName, '/') . '\W/i', $docComment, $matches);
         if (isset($matches[1])) {
             return $this->normalizeDocblock((string)$matches[1]);
         }
 
-        preg_match('/\*\s*@param\s+(.*?)\s*(?:\.\.\.)?' . preg_quote('$' . $parameterName, '/') . '/i', $docComment, $matches);
+        preg_match('/\*\s*@param\s+(.*?)\s*(?:\.\.\.)?' . preg_quote('$' . $parameterName, '/') . '\W/i', $docComment, $matches);
         if (isset($matches[1])) {
             return $this->normalizeDocblock((string)$matches[1]);
         }

diff --git a/tests/Integration/data/success/Regular/Constructor/MultiParamNameOverlap.php b/tests/Integration/data/success/Regular/Constructor/MultiParamNameOverlap.php
@@ -0,0 +1,38 @@
+<?php
+declare(strict_types=1);
+
+namespace DigitalRevolution\AccessorPairConstraint\Tests\Integration\data\success\Regular\Constructor;
+
+class MultiParamNameOverlap
+{
+    /** @var string */
+    private $item;
+
+    /** @var string[] */
+    private $itemList;
+
+    /**
+     * @param string[] $itemList
+     */
+    public function __construct(string $item, array $itemList)
+    {
+        $this->item = $item;
+        $this->itemList = $itemList;
+    }
+
+    /**
+     * @return string
+     */
+    public function getItem(): string
+    {
+        return $this->item;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getItemList(): array
+    {
+        return $this->itemList;
+    }
+}
diff --git a/tests/Unit/Constraint/Typehint/PhpDocParserTest.php b/tests/Unit/Constraint/Typehint/PhpDocParserTest.php
@@ -93,6 +93,9 @@ public static function paramTypehintProvider(): Generator
         yield ['/** @param array$param */', 'array'];
         yield ['/**@param array$param*/', 'array'];
         yield ["/**\n     *@param array\$param\n     */", 'array'];
+
+        // Don't match parameters where the name is a substring of another parameter
+        yield ['/** @param string $paramList */', null];
     }
 
     /**