Refactor + Naming

Author: marc-mabe

README.md

@@ -18,14 +18,15 @@ if (PHP_VERSION_ID < 80100) {
 ```
 
 **Vendor\MyEnum-polyfill.php**
+
 ```php
 <?php declare(strict_types=1);
 
 namespace Vendor;
 
-use Mabe\Enum\Cl\IntEnumPolyfill;
+use Mabe\Enum\Cl\IntBackedEnum;
 
-final class MyEnum extends IntEnumPolyfill
+final class MyEnum extends IntBackedEnum
 {
     const ZERO = 0;
     const ONE = 1;
@@ -106,4 +107,3 @@ namespace Vendor;
 MyEnum::ZERO; // 1 on PHP<8.1
               // enum(MyEnum::ZERO) on PHP>=8.1
 ```
-

examples/doctrine/composer.json

@@ -9,6 +9,10 @@
         "homepage": "https://mabe.berlin/",
         "role":     "Lead"
     }],
+    "repositories": [{
+        "type": "path",
+        "url": "../.."
+    }],
     "license": "BSD-3-Clause",
     "require": {
         "php": "^7.1 | ^8.0",

examples/doctrine/src/UserStatus-polyfill.php

@@ -2,14 +2,14 @@
 
 namespace Example;
 
-use Mabe\Enum\Cl\StringEnumPolyfill;
+use Mabe\Enum\Cl\StringBackedEnum;
 
 /**
  * @method static UserStatus ACTIVE()
  * @method static UserStatus BANNED()
  * @method static UserStatus DELETED()
  */
-final class UserStatus extends StringEnumPolyfill
+final class UserStatus extends StringBackedEnum
 {
     /** @internal */
     const ACTIVE = 'active';

src/Mabe/Enum/Cl/BackedEnumPolyfill.php renamed to src/Mabe/Enum/Cl/EmulatedBackedEnum.php

@@ -21,7 +21,7 @@
  *
  * @psalm-immutable
  */
-abstract class BackedEnumPolyfill implements BackedEnum
+abstract class EmulatedBackedEnum implements BackedEnum
 {
     /**
      * The name of the current case
@@ -42,14 +42,14 @@ abstract class BackedEnumPolyfill implements BackedEnum
     /**
      * A map of case names and values by enumeration class
      *
-     * @var array<class-string<BackedEnumPolyfill>, array<string, int|string>>
+     * @var array<class-string<EmulatedBackedEnum>, array<string, int|string>>
      */
     private static $caseConstants = [];
 
     /**
      * A map of case names and instances by enumeration class
      *
-     * @var array<class-string<BackedEnumPolyfill>, array<string, BackedEnumPolyfill>>
+     * @var array<class-string<EmulatedBackedEnum>, array<string, EmulatedBackedEnum>>
      */
     private static $cases = [];
 
@@ -129,13 +129,13 @@ final public static function from($value): BackedEnum
 
         $name = \array_search($value, self::$caseConstants[static::class], true);
         if ($name === false) {
-            if (\is_subclass_of(static::class, IntEnumPolyfill::class)) {
+            if (\is_subclass_of(static::class, IntBackedEnum::class)) {
                 if (!\is_int($value)) {
                     throw new TypeError(static::class . '::from(): Argument #1 ($value) must be of type int, ' . \get_debug_type($value) . ' given');
                 }
 
                 throw new ValueError("{$value} is not a valid backing value for enum \"" . static::class . '"');
-            } elseif (\is_subclass_of(static::class, StringEnumPolyfill::class)) {
+            } elseif (\is_subclass_of(static::class, StringBackedEnum::class)) {
                 if (!\is_string($value)) {
                     throw new TypeError(static::class . '::from(): Argument #1 ($value) must be of type string, ' . \get_debug_type($value) . ' given');
                 }
@@ -214,8 +214,8 @@ private static function init(string $enumClass)
             $cases = [];
             foreach ($caseConstants as $name => $value) {
                 assert(
-                    (\is_subclass_of($enumClass, IntEnumPolyfill::class) && \is_int($value))
-                    || (\is_subclass_of($enumClass, StringEnumPolyfill::class) && \is_string($value)),
+                    (\is_subclass_of($enumClass, IntBackedEnum::class) && \is_int($value))
+                    || (\is_subclass_of($enumClass, StringBackedEnum::class) && \is_string($value)),
                     "Enum case constant \"{$enumClass}::{$name}\" does not match enum backing type"
                 );
 

src/Mabe/Enum/Cl/UnitEnumPolyfill.php renamed to src/Mabe/Enum/Cl/EmulatedUnitEnum.php

@@ -20,7 +20,7 @@
  *
  * @psalm-immutable
  */
-abstract class UnitEnumPolyfill implements UnitEnum
+abstract class EmulatedUnitEnum implements UnitEnum
 {
     /**
      * The name of the current case
@@ -33,7 +33,7 @@ abstract class UnitEnumPolyfill implements UnitEnum
     /**
      * A map of case names and instances by enumeration class
      *
-     * @var array<class-string<BackedEnumPolyfill>, array<string, BackedEnumPolyfill>>
+     * @var array<class-string<EmulatedBackedEnum>, array<string, EmulatedBackedEnum>>
      */
     private static $cases = [];
 

src/Mabe/Enum/Cl/IntEnumPolyfill.php renamed to src/Mabe/Enum/Cl/IntBackedEnum.php

@@ -11,7 +11,7 @@
  *
  * @psalm-immutable
  */
-abstract class IntEnumPolyfill extends BackedEnumPolyfill
+abstract class IntBackedEnum extends EmulatedBackedEnum
 {
     /**
     * The value of the current case

src/Mabe/Enum/Cl/StringEnumPolyfill.php renamed to src/Mabe/Enum/Cl/StringBackedEnum.php

@@ -11,7 +11,7 @@
  *
  * @psalm-immutable
  */
-abstract class StringEnumPolyfill extends BackedEnumPolyfill
+abstract class StringBackedEnum extends EmulatedBackedEnum
 {
     /**
     * The value of the current case

src/functions.php

@@ -70,8 +70,8 @@ function enum_exists(string $enum, bool $autoload = true) : bool
         }
 
         return \class_exists($enum, $autoload) && (
-            \is_a($enum, __NAMESPACE__ . '\\IntEnumPolyfill', true)
-            || \is_a($enum, __NAMESPACE__ . '\\StringEnumPolyfill', true)
+            \is_a($enum, __NAMESPACE__ . '\\IntBackedEnum', true)
+            || \is_a($enum, __NAMESPACE__ . '\\StringBackedEnum', true)
         );
     }
 }

tests/AmbiguousBackingValuesEnumEmulated.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+final class AmbiguousStringValuesEnumEmulated extends Mabe\Enum\Cl\StringBackedEnum
+{
+    const TEST1 = 'test';
+    const TEST2 = 'test';
+}
+
+final class AmbiguousIntValuesEnumEmulated extends Mabe\Enum\Cl\IntBackedEnum
+{
+    const TEST1 = 1;
+    const TEST2 = 1;
+}

tests/AmbiguousBackingValuesEnumPolyfillTest.php renamed to tests/AmbiguousBackingValuesEnumEmulatedTest.php

@@ -3,10 +3,10 @@
 use PHPUnit\Framework\TestCase;
 
 if (PHP_VERSION_ID < 80100) {
-    require_once __DIR__ . '/AmbiguousBackingValuesEnumPolyfill.php';
+    require_once __DIR__ . '/AmbiguousBackingValuesEnumEmulated.php';
 }
 
-class AmbiguousBackingValuesEnumPolyfillTest extends TestCase
+class AmbiguousBackingValuesEnumEmulatedTest extends TestCase
 {
     public function setUp(): void
     {
@@ -18,14 +18,14 @@ public function setUp(): void
     public function testAmbiguousBackingValuesForIntBackedEnum()
     {
         $this->expectException('AssertionError');
-        $this->expectExceptionMessage('Enum case value for AmbiguousIntValuesEnumPolyfill::TEST1 is ambiguous');
-        AmbiguousIntValuesEnumPolyfill::cases();
+        $this->expectExceptionMessage('Enum case value for AmbiguousIntValuesEnumEmulated::TEST1 is ambiguous');
+        AmbiguousIntValuesEnumEmulated::cases();
     }
 
     public function testAmbiguousBackingValuesEnumPolyfillForStringBackedEnum()
     {
         $this->expectException('AssertionError');
-        $this->expectExceptionMessage('Enum case value for AmbiguousStringValuesEnumPolyfill::TEST1 is ambiguous');
-        AmbiguousStringValuesEnumPolyfill::cases();
+        $this->expectExceptionMessage('Enum case value for AmbiguousStringValuesEnumEmulated::TEST1 is ambiguous');
+        AmbiguousStringValuesEnumEmulated::cases();
     }
 }