Merge branch 'master' into php-ext-with-deprecation

# Conflicts: # src/Psalm/Config.php
vimeo · Dec 12, 2022 · 1115cfb · 1115cfb
2 parents c8b6b0b + 72e7386
commit 1115cfb
Show file tree

Hide file tree

Showing 15 changed files with 735 additions and 48 deletions.
diff --git a/config.xsd b/config.xsd
@@ -264,6 +264,7 @@
             <xs:element name="InvalidDocblockParamName" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="InvalidEnumBackingType" type="ClassIssueHandlerType" minOccurs="0" />
             <xs:element name="InvalidEnumCaseValue" type="ClassIssueHandlerType" minOccurs="0" />
+            <xs:element name="InvalidEnumMethod" type="MethodIssueHandlerType" minOccurs="0" />
             <xs:element name="InvalidExtendClass" type="ClassIssueHandlerType" minOccurs="0" />
             <xs:element name="InvalidFalsableReturnType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="InvalidFunctionCall" type="IssueHandlerType" minOccurs="0" />

diff --git a/docs/running_psalm/error_levels.md b/docs/running_psalm/error_levels.md
@@ -45,6 +45,7 @@ Level 5 and above allows a more non-verifiable code, and higher levels are even
  - [InaccessibleProperty](issues/InaccessibleProperty.md)
  - [InterfaceInstantiation](issues/InterfaceInstantiation.md)
  - [InvalidAttribute](issues/InvalidAttribute.md)
+ - [InvalidEnumMethod](issues/InvalidEnumMethod.md)
  - [InvalidExtendClass](issues/InvalidExtendClass.md)
  - [InvalidGlobal](issues/InvalidGlobal.md)
  - [InvalidParamDefault](issues/InvalidParamDefault.md)

diff --git a/docs/running_psalm/issues.md b/docs/running_psalm/issues.md
@@ -69,6 +69,7 @@
  - [InvalidDocblockParamName](issues/InvalidDocblockParamName.md)
  - [InvalidEnumBackingType](issues/InvalidEnumBackingType.md)
  - [InvalidEnumCaseValue](issues/InvalidEnumCaseValue.md)
+ - [InvalidEnumMethod](issues/InvalidEnumMethod.md)
  - [InvalidExtendClass](issues/InvalidExtendClass.md)
  - [InvalidFalsableReturnType](issues/InvalidFalsableReturnType.md)
  - [InvalidFunctionCall](issues/InvalidFunctionCall.md)

diff --git a/docs/running_psalm/issues/InvalidEnumMethod.md b/docs/running_psalm/issues/InvalidEnumMethod.md
@@ -0,0 +1,15 @@
+# InvalidEnumMethod
+
+Enums may not define most of the magic methods like `__get`, `__toString`, etc.
+
+```php
+<?php
+enum Status: string {
+    case Open = 'open';
+    case Closed = 'closed';
+
+    public function __toString(): string {
+        return "SomeStatus";
+    }
+}
+```
diff --git a/src/Psalm/Config.php b/src/Psalm/Config.php
@@ -2077,6 +2077,16 @@ public function visitPreloadedStubFiles(Codebase $codebase, ?Progress $progress
             $core_generic_files[] = $stringable_path;
         }
 
+        if (PHP_VERSION_ID < 8_02_00 && $codebase->analysis_php_version_id >= 8_02_00) {
+            $stringable_path = dirname(__DIR__, 2) . '/stubs/Php82.phpstub';
+
+            if (!file_exists($stringable_path)) {
+                throw new UnexpectedValueException('Cannot locate PHP 8.2 classes');
+            }
+
+            $core_generic_files[] = $stringable_path;
+        }
+
         $stub_files = array_merge($core_generic_files, $this->preloaded_stub_files);
 
         if (!$stub_files) {
@@ -2117,16 +2127,21 @@ public function visitStubFiles(Codebase $codebase, ?Progress $progress = null):
             $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'SPL.phpstub',
         ];
 
-        if (PHP_VERSION_ID >= 8_00_00 && $codebase->analysis_php_version_id >= 8_00_00) {
+        if ($codebase->analysis_php_version_id >= 8_00_00) {
             $stringable_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Php80.phpstub';
             $this->internal_stubs[] = $stringable_path;
         }
 
-        if (PHP_VERSION_ID >= 8_01_00 && $codebase->analysis_php_version_id >= 8_01_00) {
+        if ($codebase->analysis_php_version_id >= 8_01_00) {
             $stringable_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Php81.phpstub';
             $this->internal_stubs[] = $stringable_path;
         }
 
+        if ($codebase->analysis_php_version_id >= 8_02_00) {
+            $stringable_path = $dir_lvl_2 . DIRECTORY_SEPARATOR . 'stubs' . DIRECTORY_SEPARATOR . 'Php82.phpstub';
+            $this->internal_stubs[] = $stringable_path;
+        }
+
         $ext_stubs_dir = $dir_lvl_2 . DIRECTORY_SEPARATOR . "stubs" . DIRECTORY_SEPARATOR . "extensions";
         foreach ($this->php_extensions as $ext => $enabled) {
             if ($enabled) {

diff --git a/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php b/src/Psalm/Internal/Analyzer/FunctionLikeAnalyzer.php
@@ -2020,6 +2020,10 @@ private function getFunctionInformation(
 
             MethodAnalyzer::checkMethodSignatureMustOmitReturnType($storage, $codeLocation);
 
+            if ($appearing_class_storage->is_enum) {
+                MethodAnalyzer::checkForbiddenEnumMethod($storage);
+            }
+
             if (!$context->calling_method_id || !$context->collect_initializations) {
                 $context->calling_method_id = strtolower((string)$method_id);
             }

diff --git a/src/Psalm/Internal/Analyzer/MethodAnalyzer.php b/src/Psalm/Internal/Analyzer/MethodAnalyzer.php
@@ -9,6 +9,7 @@
 use Psalm\Context;
 use Psalm\Internal\Codebase\InternalCallMapHandler;
 use Psalm\Internal\MethodIdentifier;
+use Psalm\Issue\InvalidEnumMethod;
 use Psalm\Issue\InvalidStaticInvocation;
 use Psalm\Issue\MethodSignatureMustOmitReturnType;
 use Psalm\Issue\NonStaticSelfCall;
@@ -27,6 +28,24 @@
  */
 class MethodAnalyzer extends FunctionLikeAnalyzer
 {
+    // https://github.com/php/php-src/blob/a83923044c48982c80804ae1b45e761c271966d3/Zend/zend_enum.c#L77-L95
+    private const FORBIDDEN_ENUM_METHODS = [
+        '__construct',
+        '__destruct',
+        '__clone',
+        '__get',
+        '__set',
+        '__unset',
+        '__isset',
+        '__tostring',
+        '__debuginfo',
+        '__serialize',
+        '__unserialize',
+        '__sleep',
+        '__wakeup',
+        '__set_state',
+    ];
+
     /** @psalm-external-mutation-free */
     public function __construct(
         PhpParser\Node\Stmt\ClassMethod $function,
@@ -266,13 +285,17 @@ public static function checkMethodSignatureMustOmitReturnType(
             return;
         }
 
-        $cased_method_name = $method_storage->cased_name;
+        if ($method_storage->cased_name === null) {
+            return;
+        }
+
+        $method_name_lc = strtolower($method_storage->cased_name);
         $methodsOfInterest = ['__clone', '__construct', '__destruct'];
 
-        if (in_array($cased_method_name, $methodsOfInterest)) {
+        if (in_array($method_name_lc, $methodsOfInterest, true)) {
             IssueBuffer::maybeAdd(
                 new MethodSignatureMustOmitReturnType(
-                    'Method ' . $cased_method_name . ' must not declare a return type',
+                    'Method ' . $method_storage->cased_name . ' must not declare a return type',
                     $code_location
                 )
             );
@@ -288,4 +311,20 @@ public function getMethodId(?string $context_self = null): MethodIdentifier
             strtolower($function_name)
         );
     }
+
+    public static function checkForbiddenEnumMethod(MethodStorage $method_storage): void
+    {
+        if ($method_storage->cased_name === null || $method_storage->location === null) {
+            return;
+        }
+
+        $method_name_lc = strtolower($method_storage->cased_name);
+        if (in_array($method_name_lc, self::FORBIDDEN_ENUM_METHODS, true)) {
+            IssueBuffer::maybeAdd(new InvalidEnumMethod(
+                'Enums cannot define ' . $method_storage->cased_name,
+                $method_storage->location,
+                $method_storage->defining_fqcln . '::' . $method_storage->cased_name
+            ));
+        }
+    }
 }
diff --git a/src/Psalm/Issue/InvalidEnumMethod.php b/src/Psalm/Issue/InvalidEnumMethod.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Psalm\Issue;
+
+final class InvalidEnumMethod extends MethodIssue
+{
+    public const ERROR_LEVEL = -1;
+    public const SHORTCODE = 314;
+}
diff --git a/stubs/Php80.phpstub b/stubs/Php80.phpstub
@@ -17,14 +17,24 @@ class ReflectionAttribute
     {
     }
 
+    /**
+     * @return non-empty-string
+     *
+     * @psalm-pure
+     */
     public function getName() : string
     {
     }
 
+    /**
+     * @psalm-pure
+     * @return int-mask-of<Attribute::TARGET_*>
+     */
     public function getTarget() : int
     {
     }
 
+    /** @psalm-pure */
     public function isRepeated() : bool
     {
     }
@@ -48,13 +58,101 @@ class ReflectionAttribute
     }
 }
 
+/**
+ * @template-covariant T as object
+ *
+ * @property-read class-string<T> $name
+ */
+class ReflectionClass implements Reflector {
+    /**
+     * @return non-empty-string|false
+     * @psalm-pure
+     */
+    public function getFileName(): string|false {}
+
+    /**
+     * @return positive-int|false
+     * @psalm-pure
+     */
+    public function getStartLine(): int|false {}
+
+    /**
+     * @return positive-int|false
+     * @psalm-pure
+     */
+    public function getEndLine(): int|false {}
+
+    /**
+     * @return non-empty-string|false
+     * @psalm-pure
+     */
+    public function getDocComment(): string|false {}
+
+    /**
+     * @param ReflectionClass|class-string $class
+     *
+     * @psalm-pure
+     */
+    public function isSubclassOf(self|string $class): bool {}
+
+    /**
+     * @param self|class-string $interface
+     *
+     * @psalm-pure
+     */
+    public function implementsInterface(self|string $interface): bool {}
+
+    /**
+     * @return non-empty-string|false
+     *
+     * @psalm-pure
+     */
+    public function getExtensionName(): string|false {}
+}
+
+/** @psalm-immutable */
 class ReflectionClassConstant
 {
     public const IS_PUBLIC = 1;
     public const IS_PROTECTED = 2;
     public const IS_PRIVATE = 4;
+
+    /** @return non-empty-string|false */
+    public function getDocComment(): string|false {}
+}
+
+abstract class ReflectionFunctionAbstract implements Reflector
+{
+    /**
+     * @return non-empty-string|false
+     *
+     * @psalm-pure
+     */
+    public function getDocComment(): string|false {}
+
+    /**
+     * @return positive-int|false
+     *
+     * @psalm-pure
+     */
+    public function getStartLine(): int|false {}
+
+    /**
+     * @return positive-int|false
+     *
+     * @psalm-pure
+     */
+    public function getEndLine(): int|false {}
+
+    /**
+     * @return non-empty-string|false
+     *
+     * @psalm-pure
+     */
+    public function getFileName(): string|false {}
 }
 
+/** @psalm-immutable */
 class Attribute
 {
     public int $flags;
@@ -76,11 +174,20 @@ class Attribute
     }
 }
 
-class ReflectionUnionType extends ReflectionType {
+class ReflectionProperty implements Reflector
+{
     /**
-     * @return non-empty-list<ReflectionNamedType>
+     * @return non-empty-string|false
+     *
+     * @psalm-pure
      */
-    public function getTypes() {}
+    public function getDocComment(): string|false {}
+}
+
+/** @psalm-immutable */
+class ReflectionUnionType extends ReflectionType {
+    /** @return non-empty-list<ReflectionNamedType> */
+    public function getTypes(): array {}
 }
 
 class UnhandledMatchError extends Error {}