Allow dynamic properties from PHPDoc

fluffycondor · May 4, 2023 · c69620d · c69620d
1 parent fc233da
commit c69620d
Show file tree

Hide file tree

Showing 6 changed files with 118 additions and 2 deletions.
diff --git a/src/Psalm/Internal/Analyzer/ClassLikeAnalyzer.php b/src/Psalm/Internal/Analyzer/ClassLikeAnalyzer.php
@@ -389,6 +389,8 @@ public static function checkFullyQualifiedClassLikeName(
 
     /**
      * Gets the fully-qualified class name from a Name object
+     *
+     * @return class-string
      */
     public static function getFQCLNFromNameObject(
         PhpParser\Node\Name $class_name,

diff --git a/src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzer.php
@@ -1197,7 +1197,8 @@ private static function handleNonExistentProperty(
         ?string $var_id,
         bool &$has_valid_fetch_type
     ): void {
-        if ($config->use_phpdoc_property_without_magic_or_parent
+        if (($config->use_phpdoc_property_without_magic_or_parent
+            || $class_storage->hasAttributeIncludingParents('AllowDynamicProperties', $codebase))
             && isset($class_storage->pseudo_property_get_types['$' . $prop_name])
         ) {
             $stmt_type = $class_storage->pseudo_property_get_types['$' . $prop_name];

diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/AttributeResolver.php b/src/Psalm/Internal/PhpVisitor/Reflector/AttributeResolver.php
@@ -31,6 +31,7 @@ public static function resolve(
         ?string $fq_classlike_name
     ): AttributeStorage {
         if ($stmt->name instanceof PhpParser\Node\Name\FullyQualified) {
+            /** @var class-string $fq_type_string */
             $fq_type_string = (string)$stmt->name;
         } else {
             $fq_type_string = ClassLikeAnalyzer::getFQCLNFromNameObject($stmt->name, $aliases);

diff --git a/src/Psalm/Storage/AttributeStorage.php b/src/Psalm/Storage/AttributeStorage.php
@@ -11,7 +11,7 @@ final class AttributeStorage
 {
     use ImmutableNonCloneableTrait;
     /**
-     * @var string
+     * @var class-string
      */
     public $fq_class_name;
 
@@ -33,6 +33,7 @@ final class AttributeStorage
     public $name_location;
 
     /**
+     * @param class-string $fq_class_name
      * @param list<AttributeArg> $args
      */
     public function __construct(

diff --git a/src/Psalm/Storage/ClassLikeStorage.php b/src/Psalm/Storage/ClassLikeStorage.php
@@ -4,6 +4,7 @@
 
 use Psalm\Aliases;
 use Psalm\CodeLocation;
+use Psalm\Codebase;
 use Psalm\Config;
 use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
 use Psalm\Internal\MethodIdentifier;
@@ -13,7 +14,9 @@
 use Psalm\Type\Atomic\TTemplateParam;
 use Psalm\Type\Union;
 
+use function array_map;
 use function array_values;
+use function in_array;
 
 final class ClassLikeStorage implements HasAttributesInterface
 {
@@ -486,6 +489,24 @@ public function getAttributeStorages(): array
         return $this->attributes;
     }
 
+    public function hasAttributeIncludingParents(
+        string $fq_class_name,
+        Codebase $codebase,
+    ): bool {
+        if ($this->hasAttribute($fq_class_name)) {
+            return true;
+        }
+
+        foreach ($this->parent_classes as $parent_class) {
+            $parent_class_storage = $codebase->classlike_storage_provider->get($parent_class);
+            if ($parent_class_storage->hasAttribute($fq_class_name)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * Get the template constraint types for the class.
      *
@@ -511,4 +532,19 @@ public function hasSealedMethods(Config $config): bool
     {
         return $this->sealed_methods ?? $config->seal_all_methods;
     }
+
+    /**
+     * @param class-string $fq_class_name
+     */
+    private function hasAttribute(string $fq_class_name): bool
+    {
+        return in_array(
+            $fq_class_name,
+            array_map(
+                fn(AttributeStorage $storage) => $storage->fq_class_name,
+                $this->attributes,
+            ),
+            true,
+        );
+    }
 }
diff --git a/tests/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzerTest.php b/tests/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzerTest.php
@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psalm\Tests\Internal\Analyzer\Statements\Expression\Fetch;
+
+use Psalm\Tests\TestCase;
+use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;
+
+final class AtomicPropertyFetchAnalyzerTest extends TestCase
+{
+    use ValidCodeAnalysisTestTrait;
+
+    public function providerValidCodeParse(): iterable
+    {
+        return [
+            'allowDynamicProperties' => [
+                'code' => '<?php
+                    /** @property-read string $foo */
+                    #[\AllowDynamicProperties]
+                    class A {
+                        public function __construct(string $key, string $value)
+                        {
+                            $this->$key = $value;
+                        }
+                    }
+
+                    echo (new A("foo", "bar"))->foo;
+                    ',
+                'assertions' => [],
+                'ignores_issues' => [],
+                'php_version' => '8.2',
+            ],
+            'allowDynamicProperties for child' => [
+                'code' => '<?php
+                    /** @property-read string $foo */
+                    #[\AllowDynamicProperties]
+                    class A {
+                        public function __construct(string $key, string $value)
+                        {
+                            $this->$key = $value;
+                        }
+                    }
+
+                    class B extends A {}
+
+                    echo (new B("foo", "bar"))->foo;
+                    ',
+                'assertions' => [],
+                'ignores_issues' => [],
+                'php_version' => '8.2',
+            ],
+            'allowDynamicProperties for grandchild' => [
+                'code' => '<?php
+                    /** @property-read string $foo */
+                    #[\AllowDynamicProperties]
+                    class A {
+                        public function __construct(string $key, string $value)
+                        {
+                            $this->$key = $value;
+                        }
+                    }
+
+                    class B extends A {}
+                    class C extends B {}
+
+                    echo (new C("foo", "bar"))->foo;
+                    ',
+                'assertions' => [],
+                'ignores_issues' => [],
+                'php_version' => '8.2',
+            ],
+        ];
+    }
+}