From 54999abc54f717ff78967ea0aff66a66f861bf5b Mon Sep 17 00:00:00 2001
From: robchett <robchett@gmail.com>
Date: Fri, 3 Nov 2023 08:45:19 +0000
Subject: [PATCH] Allow (no-)seal-(properties|methods) without the psalm-
 prefix

---
 docs/annotating_code/supported_annotations.md |  8 ++---
 .../Reflector/ClassLikeDocblockParser.php     | 24 +++++++-------
 tests/MagicMethodAnnotationTest.php           | 15 +++++++++
 tests/MagicPropertyTest.php                   | 32 +++++++++++++++++++
 4 files changed, 64 insertions(+), 15 deletions(-)

diff --git a/docs/annotating_code/supported_annotations.md b/docs/annotating_code/supported_annotations.md
index 346b525f878..ba14e7d67c9 100644
--- a/docs/annotating_code/supported_annotations.md
+++ b/docs/annotating_code/supported_annotations.md
@@ -202,7 +202,7 @@ takesFoo(getFoo());
 
 This provides the same, but for `false`. Psalm uses this internally for functions like `preg_replace`, which can return false if the given input has encoding errors, but where 99.9% of the time the function operates as expected.
 
-### `@psalm-seal-properties`, `@psalm-no-seal-properties`
+### `@psalm-seal-properties`, `@psalm-no-seal-properties`, `@seal-properties`, `@no-seal-properties`
 
 If you have a magic property getter/setter, you can use `@psalm-seal-properties` to instruct Psalm to disallow getting and setting any properties not contained in a list of `@property` (or `@property-read`/`@property-write`) annotations.
 This is automatically enabled with the configuration option `sealAllProperties` and can be disabled for a class with `@psalm-no-seal-properties`
@@ -211,7 +211,7 @@ This is automatically enabled with the configuration option `sealAllProperties`
 <?php
 /**
  * @property string $foo
- * @psalm-seal-properties
+ * @seal-properties
  */
 class A {
      public function __get(string $name): ?string {
@@ -227,7 +227,7 @@ $a = new A();
 $a->bar = 5; // this call fails
 ```
 
-### `@psalm-seal-methods`, `@psalm-no-seal-methods`
+### `@psalm-seal-methods`, `@psalm-no-seal-methods`, `@seal-methods`, `@no-seal-methods`
 
 If you have a magic method caller, you can use `@psalm-seal-methods` to instruct Psalm to disallow calling any methods not contained in a list of `@method` annotations.
 This is automatically enabled with the configuration option `sealAllMethods` and can be disabled for a class with `@psalm-no-seal-methods`
@@ -236,7 +236,7 @@ This is automatically enabled with the configuration option `sealAllMethods` and
 <?php
 /**
  * @method foo(): string
- * @psalm-seal-methods
+ * @seal-methods
  */
 class A {
      public function __call(string $name, array $args) {
diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeDocblockParser.php b/src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeDocblockParser.php
index 6e9f8715852..fcce2a1af69 100644
--- a/src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeDocblockParser.php
+++ b/src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeDocblockParser.php
@@ -240,18 +240,20 @@ public static function parse(
             }
         }
 
-        if (isset($parsed_docblock->tags['psalm-seal-properties'])) {
-            $info->sealed_properties = true;
-        }
-        if (isset($parsed_docblock->tags['psalm-no-seal-properties'])) {
-            $info->sealed_properties = false;
-        }
+        foreach (['', 'psalm-'] as $prefix) {
+            if (isset($parsed_docblock->tags[$prefix . 'seal-properties'])) {
+                $info->sealed_properties = true;
+            }
+            if (isset($parsed_docblock->tags[$prefix . 'no-seal-properties'])) {
+                $info->sealed_properties = false;
+            }
 
-        if (isset($parsed_docblock->tags['psalm-seal-methods'])) {
-            $info->sealed_methods = true;
-        }
-        if (isset($parsed_docblock->tags['psalm-no-seal-methods'])) {
-            $info->sealed_methods = false;
+            if (isset($parsed_docblock->tags[$prefix . 'seal-methods'])) {
+                $info->sealed_methods = true;
+            }
+            if (isset($parsed_docblock->tags[$prefix . 'no-seal-methods'])) {
+                $info->sealed_methods = false;
+            }
         }
 
         if (isset($parsed_docblock->tags['psalm-inheritors'])) {
diff --git a/tests/MagicMethodAnnotationTest.php b/tests/MagicMethodAnnotationTest.php
index ad157dad39b..88f5a2a478a 100644
--- a/tests/MagicMethodAnnotationTest.php
+++ b/tests/MagicMethodAnnotationTest.php
@@ -1118,6 +1118,21 @@ class B extends A {}
                     $b->foo();',
                 'error_message' => 'UndefinedMagicMethod',
             ],
+            'inheritSealedMethodsWithoutPrefix' => [
+                'code' => '<?php
+                    /**
+                     * @seal-methods
+                     */
+                    class A {
+                        public function __call(string $method, array $args) {}
+                    }
+
+                    class B extends A {}
+
+                    $b = new B();
+                    $b->foo();',
+                'error_message' => 'UndefinedMagicMethod',
+            ],
             'lonelyMethod' => [
                 'code' => '<?php
                     /**
diff --git a/tests/MagicPropertyTest.php b/tests/MagicPropertyTest.php
index d0e340719a5..bd0f03fe6ca 100644
--- a/tests/MagicPropertyTest.php
+++ b/tests/MagicPropertyTest.php
@@ -1189,6 +1189,38 @@ class A {
                     }',
                 'error_message' => 'InvalidDocblock',
             ],
+            'sealedWithNoProperties' => [
+                'code' => '<?php
+                    /**
+                     * @psalm-seal-properties
+                     */
+                    final class OrganizationObject {
+
+                        public function __get(string $key)
+                        {
+                            return [];
+                        }
+
+                    }
+                    echo (new OrganizationObject)->errors;',
+                'error_message' => 'UndefinedMagicPropertyFetch',
+            ],
+            'sealedWithNoPropertiesNoPrefix' => [
+                'code' => '<?php
+                    /**
+                     * @seal-properties
+                     */
+                    final class OrganizationObject {
+
+                        public function __get(string $key)
+                        {
+                            return [];
+                        }
+                    }
+
+                    echo (new OrganizationObject)->errors;',
+                'error_message' => 'UndefinedMagicPropertyFetch',
+            ],
         ];
     }