bug #46361 [PropertyInfo] Ignore empty doc-block for promoted properties in PhpStanExtractor (BoShurik)

nicolas-grekas · nicolas-grekas · commit 9fafd822d475 · 2022-05-17T10:51:48.000+02:00
This PR was merged into the 6.1 branch. Discussion ---------- [PropertyInfo] Ignore empty doc-block for promoted properties in PhpStanExtractor | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | -  | License | MIT | Doc PR | symfony/symfony-docs#...  Fix processing empty doc-block for promoted properties (introduced in #46056)  Commits ------- 410d7f2 [PropertyInfo] Ignore empty doc-block for promoted properties in PhpStanExtractor
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpStanExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpStanExtractor.php
@@ -227,7 +227,11 @@ private function getDocBlockFromProperty(string $class, string $property): ?arra
             $constructor = new \ReflectionMethod($class, '__construct');
             $rawDocNode = $constructor->getDocComment();
             $source = self::MUTATOR;
-        } elseif (null === $rawDocNode = $reflectionProperty->getDocComment() ?: null) {
+        } else {
+            $rawDocNode = $reflectionProperty->getDocComment();
+        }
+
+        if (!$rawDocNode) {
             return null;
         }
 
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php
@@ -18,6 +18,7 @@
 use Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\ParentDummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\Php80Dummy;
+use Symfony\Component\PropertyInfo\Tests\Fixtures\Php80PromotedDummy;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\RootDummy\RootDummyItem;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\DummyUsedInTrait;
 use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\DummyUsingTrait;
@@ -439,15 +440,16 @@ public function testDummyNamespaceWithProperty()
     /**
      * @dataProvider php80TypesProvider
      */
-    public function testExtractPhp80Type($property, array $type = null)
+    public function testExtractPhp80Type(string $class, $property, array $type = null)
     {
-        $this->assertEquals($type, $this->extractor->getTypes(Php80Dummy::class, $property, []));
+        $this->assertEquals($type, $this->extractor->getTypes($class, $property, []));
     }
 
     public function php80TypesProvider()
     {
         return [
-            ['promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],
+            [Php80Dummy::class, 'promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],
+            [Php80PromotedDummy::class, 'promoted', null],
         ];
     }
 }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Php80PromotedDummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Php80PromotedDummy.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyInfo\Tests\Fixtures;
+
+class Php80PromotedDummy
+{
+    public function __construct(private string $promoted)
+    {
+    }
+
+    public function getPromoted(): string
+    {
+        return $this->promoted;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@`
`18`	`18`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy;`
`19`	`19`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\ParentDummy;`
`20`	`20`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\Php80Dummy;`
	`21`	`+use Symfony\Component\PropertyInfo\Tests\Fixtures\Php80PromotedDummy;`
`21`	`22`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\RootDummy\RootDummyItem;`
`22`	`23`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\DummyUsedInTrait;`
`23`	`24`	`use Symfony\Component\PropertyInfo\Tests\Fixtures\TraitUsage\DummyUsingTrait;`
`@@ -439,15 +440,16 @@ public function testDummyNamespaceWithProperty()`
`439`	`440`	`/**`
`440`	`441`	`* @dataProvider php80TypesProvider`
`441`	`442`	`*/`
`442`		`- public function testExtractPhp80Type($property, array $type = null)`
	`443`	`+ public function testExtractPhp80Type(string $class, $property, array $type = null)`
`443`	`444`	`{`
`444`		`- $this->assertEquals($type, $this->extractor->getTypes(Php80Dummy::class, $property, []));`
	`445`	`+ $this->assertEquals($type, $this->extractor->getTypes($class, $property, []));`
`445`	`446`	`}`
`446`	`447`
`447`	`448`	`public function php80TypesProvider()`
`448`	`449`	`{`
`449`	`450`	`return [`
`450`		`- ['promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],`
	`451`	`+ [Php80Dummy::class, 'promotedAndMutated', [new Type(Type::BUILTIN_TYPE_STRING)]],`
	`452`	`+ [Php80PromotedDummy::class, 'promoted', null],`
`451`	`453`	`];`
`452`	`454`	`}`
`453`	`455`	`}`