thunderer · thunderer · Feb 3, 2024 · Jan 30, 2024
diff --git a/psalm.xml b/psalm.xml
@@ -9,6 +9,7 @@
 
     <projectFiles>
         <directory name="src" />
+        <directory name="tests/Psalm" />
         <ignoreFiles>
             <directory name="vendor" />
         </ignoreFiles>
@@ -30,6 +31,11 @@
                 <file name="src/Doctrine/PlatenumDoctrineType.php" />
             </errorLevel>
         </DeprecatedMethod>
+        <DocblockTypeContradiction errorLevel="error">
+            <errorLevel type="suppress">
+                <file name="src/Enum/EnumTrait.php" /> <!-- PHP 7.2 only? -->
+            </errorLevel>
+        </DocblockTypeContradiction>
     </issueHandlers>
 
 </psalm>
diff --git a/src/Enum/AbstractAttributeEnum.php b/src/Enum/AbstractAttributeEnum.php
@@ -3,9 +3,13 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 abstract class AbstractAttributeEnum implements \JsonSerializable
 {
+    /** @use AttributeEnumTrait<TMember,TValue> */
     use AttributeEnumTrait;
 }
diff --git a/src/Enum/AbstractCallbackEnum.php b/src/Enum/AbstractCallbackEnum.php
@@ -3,9 +3,13 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 abstract class AbstractCallbackEnum implements \JsonSerializable
 {
+    /** @use CallbackEnumTrait<TMember,TValue> */
     use CallbackEnumTrait;
 }
diff --git a/src/Enum/AbstractConstantsEnum.php b/src/Enum/AbstractConstantsEnum.php
@@ -3,9 +3,13 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 abstract class AbstractConstantsEnum implements \JsonSerializable
 {
+    /** @use ConstantsEnumTrait<TMember,TValue> */
     use ConstantsEnumTrait;
 }
diff --git a/src/Enum/AbstractDocblockEnum.php b/src/Enum/AbstractDocblockEnum.php
@@ -3,9 +3,13 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 abstract class AbstractDocblockEnum implements \JsonSerializable
 {
+    /** @use DocblockEnumTrait<TMember,TValue> */
     use DocblockEnumTrait;
 }
diff --git a/src/Enum/AbstractStaticEnum.php b/src/Enum/AbstractStaticEnum.php
@@ -3,10 +3,14 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 abstract class AbstractStaticEnum implements \JsonSerializable
 {
+    /** @use StaticEnumTrait<TMember,TValue> */
     use StaticEnumTrait;
 
     /** @var array */

diff --git a/src/Enum/AttributeEnumTrait.php b/src/Enum/AttributeEnumTrait.php
@@ -3,10 +3,14 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait AttributeEnumTrait
 {
+    /** @use EnumTrait<TMember,TValue> */
     use EnumTrait;
 
     /** @psalm-suppress UndefinedDocblockClass, UndefinedMethod because there is no ReflectionAttribute on PHP <8.0 */

diff --git a/src/Enum/CallbackEnumTrait.php b/src/Enum/CallbackEnumTrait.php
@@ -5,10 +5,14 @@
 use Thunder\Platenum\Exception\PlatenumException;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait CallbackEnumTrait
 {
+    /** @use EnumTrait<TMember,TValue> */
     use EnumTrait;
 
     /** @var non-empty-array<class-string,callable():array<string,int|string>> */

diff --git a/src/Enum/ConstantsEnumTrait.php b/src/Enum/ConstantsEnumTrait.php
@@ -3,10 +3,14 @@
 namespace Thunder\Platenum\Enum;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait ConstantsEnumTrait
 {
+    /** @use EnumTrait<TMember,TValue> */
     use EnumTrait;
 
     private static function resolve(): array

diff --git a/src/Enum/DocblockEnumTrait.php b/src/Enum/DocblockEnumTrait.php
@@ -5,10 +5,14 @@
 use Thunder\Platenum\Exception\PlatenumException;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait DocblockEnumTrait
 {
+    /** @use EnumTrait<TMember,TValue> */
     use EnumTrait;
 
     private static function resolve(): array

diff --git a/src/Enum/EnumTrait.php b/src/Enum/EnumTrait.php
@@ -5,21 +5,28 @@
 use Thunder\Platenum\Exception\PlatenumException;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait EnumTrait
 {
-    /** @var string */
+    /** @var TMember */
     private $member;
-    /** @var int|string */
+    /** @var TValue */
     private $value;
 
     /** @var non-empty-array<string,non-empty-array<string,int|string>> */
     protected static $members = [];
     /** @var array<string,array<string,static>> */
     protected static $instances = [];
 
-    /** @param int|string $value */
+
+    /**
+     * @param TMember $member
+     * @param TValue $value
+     */
     /* final */ private function __construct(string $member, $value)
     {
         $this->member = $member;
@@ -51,7 +58,7 @@
             static::throwDefaultInvalidMemberException($member);
         }
 
-        /** @psalm-suppress UnsafeInstantiation */
+        /** @psalm-suppress UnsafeInstantiation,ArgumentTypeCoercion,PropertyTypeCoercion */
         return static::$instances[$class][$member] = new static($member, static::$members[$class][$member]);
     }
 
@@ -91,6 +98,7 @@
     }
 
     /**
+     * @psalm-suppress ReferenceConstraintViolation
      * @param static $enum
      * @param-out AbstractConstantsEnum|AbstractDocblockEnum|AbstractStaticEnum|AbstractCallbackEnum|AbstractAttributeEnum $enum
      */
@@ -105,9 +113,9 @@
     */
    final public static function getInstances(): array
    {
        static::resolveMembers();
        foreach(static::$members[static::class] as $member => $value) {
            static::fromMember($member);
        }

        return array_values(static::$instances[static::class]);
@@ -149,17 +157,19 @@
 
     /* --- TRANSFORM --- */
 
+    /** @return TMember */
     final public function getMember(): string
     {
         return $this->member;
     }
 
-    /** @return int|string */
+    /** @return TValue */
     final public function getValue()
     {
         return $this->value;
     }
 
+    /** @psalm-suppress MissingReturnType */
     #[\ReturnTypeWillChange]
     final public function jsonSerialize()
     {
@@ -204,24 +214,25 @@
         return [] !== array_intersect(static::$members[static::class], $values);
     }
 
-    final public function hasMember(string $members): bool
+    /** @param TMember $member */
+    final public function hasMember(string $member): bool
     {
-        return $members === $this->member;
+        return $member === $this->member;
     }
 
-    /** @param int|string $value */
+    /** @param TValue $value */
     final public function hasValue($value): bool
     {
         return $value === $this->value;
     }
 
-    /** @param list<string> $members */
+    /** @param list<TMember> $members */
     final public function hasMemberIn(array $members): bool
     {
         return in_array($this->member, $members, true);
     }
 
-    /** @param list<int|string> $values */
+    /** @param list<TValue> $values */
     final public function hasValueIn(array $values): bool
     {
         return in_array($this->value, $values, true);

diff --git a/src/Enum/StaticEnumTrait.php b/src/Enum/StaticEnumTrait.php
@@ -5,10 +5,14 @@
 use Thunder\Platenum\Exception\PlatenumException;
 
 /**
+ * @template TMember
+ * @template TValue
+ *
  * @author Tomasz Kowalczyk <[email protected]>
  */
 trait StaticEnumTrait
 {
+    /** @use EnumTrait<TMember,TValue> */
     use EnumTrait;
 
     private static function resolve(): array

diff --git a/tests/Psalm/SeasonsExtend.php b/tests/Psalm/SeasonsExtend.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+namespace Thunder\Platenum\Tests\Psalm;
+
+use Thunder\Platenum\Enum\AbstractConstantsEnum;
+
+/**
+ * @method static static SPRING()
+ * @method static static SUMMER()
+ * @method static static AUTUMN()
+ * @method static static WINTER()
+ *
+ * @extends AbstractConstantsEnum<'SPRING'|'SUMMER'|'AUTUMN'|'WINTER',SeasonsExtend::*>
+ * @psalm-suppress PropertyNotSetInConstructor
+ */
+final class SeasonsExtend extends AbstractConstantsEnum
+{
+    private const SPRING = 1;
+    private const SUMMER = 2;
+    private const AUTUMN = 3;
+    private const WINTER = 4;
+}
+
+$spring = SeasonsExtend::SPRING();
+/** @psalm-suppress InvalidArgument */
+$spring->hasMember('INVALID');
+/** @psalm-suppress InvalidArgument */
+$spring->hasValue(9);
diff --git a/tests/Psalm/SeasonsTrait.php b/tests/Psalm/SeasonsTrait.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+namespace Thunder\Platenum\Tests\Psalm;
+
+use Thunder\Platenum\Enum\ConstantsEnumTrait;
+
+/**
+ * @method static static SPRING()
+ * @method static static SUMMER()
+ * @method static static AUTUMN()
+ * @method static static WINTER()
+ */
+final class SeasonsTrait
+{
+    private const SPRING = 1;
+    private const SUMMER = 2;
+    private const AUTUMN = 3;
+    private const WINTER = 4;
+
+    /** @use ConstantsEnumTrait<'SPRING'|'SUMMER'|'AUTUMN'|'WINTER',SeasonsTrait::*> */
+    use ConstantsEnumTrait;
+}
+
+$spring = SeasonsTrait::SPRING();
+/** @psalm-suppress InvalidArgument */
+$spring->hasMember('INVALID');
+/** @psalm-suppress InvalidArgument */
+$spring->hasValue(9);