maint/add-docs-for-enum-support (#29)

* maint/add-docs-for-enum-support Updated `README.md`.

* maint/add-docs-for-enum-support Updated `tests/Unit/MapOf/Array/ArrayTest.php`.

* maint/add-docs-for-enum-support Created `tests/Unit/MapOf/Array/Name.php`.

* maint/add-docs-for-enum-support Updated `tests/Unit/MapOf/Array/User.php`.

Author: zero-to-prod

README.md

@@ -119,6 +119,8 @@ class User
 
 In this case the `mapOf()` method returns an array of `Alias` instances.
 
+This method will also work with enums.
+
 ```php
 use Zerotoprod\DataModel\Describe;
 
@@ -134,6 +136,13 @@ class User
         'required',                        // Throws PropertyRequiredException when value not present
     ])]
     public array $Aliases;
+    
+    /** @var Name[] $Names */
+    #[Describe([
+        'cast' => [self::class, 'mapOf'],
+        'type' => Name::class,
+    ])]
+    public ?array $Names;
 }
 
 class Alias
@@ -143,15 +152,27 @@ class Alias
     public string $name;
 }
 
+enum Name: string
+{
+    case Tom = 'Tom';
+    case John = 'John';
+}
+
 $User = User::from([
     'Aliases' => [
         ['name' => 'John Doe'],
         ['name' => 'John Smith'],
+    ],
+    'Names' => [
+        'Tom',
+        'John',
     ]
 ]);
 
 echo $User->Aliases[0]->name; // Outputs: John Doe
 echo $User->Aliases[1]->name; // Outputs: John Smith
+echo $User->Names[0]; // Enum Name::Tom
+echo $User->Names[1]; // Enum Name::John
 ```
 
 #### Laravel Collection Example

tests/Unit/MapOf/Array/ArrayTest.php

@@ -13,11 +13,16 @@ class ArrayTest extends TestCase
             'Aliases' => [
                 ['name' => 'John Doe'],
                 ['name' => 'John Smith'],
+            ],
+            'Names' => [
+                Name::Tom->value,
+                Name::John->value,
             ]
         ]);
 
         self::assertEquals('John Doe', $User->Aliases[0]->name);
         self::assertEquals('John Smith', $User->Aliases[1]->name);
+        self::assertEquals(Name::Tom, $User->Names[0]);
     }
 
     #[Test] public function nested(): void

tests/Unit/MapOf/Array/Name.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Tests\Unit\MapOf\Array;
+
+enum Name: string
+{
+    case Tom = 'Tom';
+    case John = 'John';
+}

tests/Unit/MapOf/Array/User.php

@@ -25,4 +25,11 @@ class User
         'level' => 2,
     ])]
     public ?array $AliasesNested;
+
+    /** @var Name[] $Names */
+    #[Describe([
+        'cast' => [self::class, 'mapOf'],
+        'type' => Name::class,
+    ])]
+    public ?array $Names;
 }