Merge branch 'feature/initial-enums' into feature/unit-tests

Author: JasonTheAdams

.gitignore

@@ -12,5 +12,16 @@ vendor/
 [Dd]esktop.ini
 *.DS_store
 .DS_store?
+
+############
+## AI Tools
+############
+
 .claude/
+CLAUDE.md
+
+############
+## PHPUnit
+############
+
 .phpunit.cache/

CLAUDE.md

@@ -40,25 +40,25 @@ abstract class AbstractEnum
     /**
      * @var string The name of the enum constant
      */
-    private $name;
+    private string $name;
 
     /**
      * @var array<string, array<string, string|int>> Cache for reflection data
      */
-    private static $cache = [];
+    private static array $cache = [];
 
     /**
      * @var array<string, array<string, self>> Cache for enum instances
      */
-    private static $instances = [];
+    private static array $instances = [];
 
     /**
      * Constructor is private to ensure instances are created through static methods
      *
      * @param string|int $value The enum value
      * @param string $name The constant name
      */
-    private function __construct($value, string $name)
+    final private function __construct($value, string $name)
     {
         $this->value = $value;
         $this->name = $name;
@@ -71,7 +71,7 @@ private function __construct($value, string $name)
      * @return mixed
      * @throws BadMethodCallException If property doesn't exist
      */
-    public function __get(string $property)
+    final public function __get(string $property)
     {
         if ($property === 'value' || $property === 'name') {
             return $this->$property;
@@ -89,7 +89,7 @@ public function __get(string $property)
      * @param mixed $value The value to set
      * @throws BadMethodCallException Always, as enum properties are read-only
      */
-    public function __set(string $property, $value): void
+    final public function __set(string $property, $value): void
     {
         throw new BadMethodCallException(
             sprintf('Cannot modify property %s::%s - enum properties are read-only', static::class, $property)
@@ -103,7 +103,7 @@ public function __set(string $property, $value): void
      * @return static
      * @throws InvalidArgumentException If the value is not valid
      */
-    public static function from($value): self
+    final public static function from($value): self
     {
         $instance = self::tryFrom($value);
         if ($instance === null) {
@@ -120,7 +120,7 @@ public static function from($value): self
      * @param string|int $value The enum value
      * @return static|null
      */
-    public static function tryFrom($value): ?self
+    final public static function tryFrom($value): ?self
     {
         $constants = self::getConstants();
         foreach ($constants as $name => $constantValue) {
@@ -136,7 +136,7 @@ public static function tryFrom($value): ?self
      *
      * @return static[]
      */
-    public static function cases(): array
+    final public static function cases(): array
     {
         $cases = [];
         $constants = self::getConstants();
@@ -152,7 +152,7 @@ public static function cases(): array
      * @param string|int|self $other The value or enum to compare
      * @return bool
      */
-    public function equals($other): bool
+    final public function equals($other): bool
     {
         if ($other instanceof self) {
             return $this->is($other);
@@ -167,7 +167,7 @@ public function equals($other): bool
      * @param self $other The other enum to compare
      * @return bool
      */
-    public function is(self $other): bool
+    final public function is(self $other): bool
     {
         return $this === $other; // Since we're using singletons, we can use identity comparison
     }
@@ -177,7 +177,7 @@ public function is(self $other): bool
      *
      * @return array<string, string|int>
      */
-    public static function getValues(): array
+    final public static function getValues(): array
     {
         return self::getConstants();
     }
@@ -188,48 +188,33 @@ public static function getValues(): array
      * @param string|int $value The value to check
      * @return bool
      */
-    public static function isValidValue($value): bool
+    final public static function isValidValue($value): bool
     {
         return in_array($value, self::getValues(), true);
     }
 
-    /**
-     * Create an enum instance from a value (deprecated, use from() instead)
-     *
-     * @param string|int $value The enum value
-     * @return static
-     * @throws InvalidArgumentException If the value is not valid
-     * @deprecated Use from() method instead
-     */
-    public static function fromValue($value): self
-    {
-        return self::from($value);
-    }
-
     /**
      * Get or create a singleton instance for the given value and name
      *
      * @param string|int $value The enum value
      * @param string $name The constant name
      * @return static
-     * @phpstan-return static
      */
     private static function getInstance($value, string $name): self
     {
         $className = static::class;
-        $key = $name;
 
         if (!isset(self::$instances[$className])) {
             self::$instances[$className] = [];
         }
 
-        if (!isset(self::$instances[$className][$key])) {
+        if (!isset(self::$instances[$className][$name])) {
             $instance = new $className($value, $name);
-            self::$instances[$className][$key] = $instance;
+            self::$instances[$className][$name] = $instance;
         }
 
         /** @var static */
-        return self::$instances[$className][$key];
+        return self::$instances[$className][$name];
     }
 
     /**
@@ -238,7 +223,7 @@ private static function getInstance($value, string $name): self
      * @return array<string, string|int>
      * @throws \RuntimeException If invalid constant found
      */
-    protected static function getConstants(): array
+    final protected static function getConstants(): array
     {
         $className = static::class;
 
@@ -283,14 +268,14 @@ protected static function getConstants(): array
     }
 
     /**
-     * Handle dynamic method calls for enum creation and checking
+     * Handle dynamic method calls for enum checking
      *
      * @param string $name The method name
      * @param array<mixed> $arguments The method arguments
      * @return bool
      * @throws BadMethodCallException If the method doesn't exist
      */
-    public function __call(string $name, array $arguments)
+    final public function __call(string $name, array $arguments): bool
     {
         // Handle is* methods
         if (strpos($name, 'is') === 0) {
@@ -315,7 +300,7 @@ public function __call(string $name, array $arguments)
      * @return static
      * @throws BadMethodCallException If the method doesn't exist
      */
-    public static function __callStatic(string $name, array $arguments)
+    final public static function __callStatic(string $name, array $arguments): self
     {
         $constantName = self::camelCaseToConstant($name);
         $constants = self::getConstants();
@@ -349,7 +334,7 @@ private static function camelCaseToConstant(string $camelCase): string
      *
      * @return string
      */
-    public function __toString(): string
+    final public function __toString(): string
     {
         return (string) $this->value;
     }