From 5e84deefabf7d1a5f799be7e2e4cdf3dd2e07ecf Mon Sep 17 00:00:00 2001
From: ignace nyamagana butera <nyamsprod@gmail.com>
Date: Mon, 22 Jan 2024 07:34:00 +0100
Subject: [PATCH] Improve Info Test

---
 src/Enum/Info.php     |  9 +++++++++
 src/Enum/InfoTest.php | 20 ++++++++++++++++++++
 src/Enum/README.md    |  9 +++++++--
 3 files changed, 36 insertions(+), 2 deletions(-)

diff --git a/src/Enum/Info.php b/src/Enum/Info.php
index 22e9dd3..49a0e2c 100644
--- a/src/Enum/Info.php
+++ b/src/Enum/Info.php
@@ -72,4 +72,13 @@ public static function nameOf(string|int $value): ?string
             default => $res,
         };
     }
+
+    /**
+     * Convert the Enum into a Javascript structure.
+     */
+    public static function toJavascript(): string
+    {
+        return JavascriptConverter::new()
+            ->convertToObject(static::class); /* @phpstan-ignore-line */
+    }
 }
diff --git a/src/Enum/InfoTest.php b/src/Enum/InfoTest.php
index 488d064..de4b212 100644
--- a/src/Enum/InfoTest.php
+++ b/src/Enum/InfoTest.php
@@ -19,6 +19,16 @@ public function it_can_get_information_from_a_pure_enumeration(): void
         self::assertSame(['Top', 'Down', 'Left', 'Right'], Direction::names());
         self::assertSame([], Direction::values());
         self::assertNull(Direction::nameOf('Up'));
+        $expected = <<<JS
+const Direction = Object.freeze({
+  Top: Symbol(0),
+  Down: Symbol(1),
+  Left: Symbol(2),
+  Right: Symbol(3),
+})
+
+JS;
+        self::assertSame($expected, Direction::toJavascript());
     }
 
     #[Test]
@@ -31,6 +41,16 @@ public function it_can_get_information_from_a_backed_enumeration(): void
         self::assertSame(['North', 'South', 'East', 'West'], Cardinal::names());
         self::assertSame(['north', 'south', 'east', 'west'], Cardinal::values());
         self::assertSame('West', Cardinal::nameOf('west'));
+        $expected = <<<JS
+const Cardinal = Object.freeze({
+  North: "north",
+  South: "south",
+  East: "east",
+  West: "west",
+})
+
+JS;
+        self::assertSame($expected, Cardinal::toJavascript());
     }
 }
 
diff --git a/src/Enum/README.md b/src/Enum/README.md
index 2861bf2..fe5d002 100644
--- a/src/Enum/README.md
+++ b/src/Enum/README.md
@@ -69,17 +69,19 @@ Gather information regarding the current Enum via **public static methods**. Thi
 - the possible values for the Enum with the `values` method;
 - the `associative` method which returns an associative array contains the string name and their respective values;
 - the `nameOf` which returns the name associated with a specific `value`
+- the `toJavascript` which returns a Javascript structure equivalent to the current Enum.(see `JavascriptConverter` for more details)
 
 ```php
 <?php
 
 HttpMethod::size();        //returns the number of cases
 HttpMethod::isBacked();
-HttpMethod::isPure(); // returns the inverse of the `isBacked` method
+HttpMethod::isPure();      // returns the inverse of the `isBacked` method
 HttpMethod::names();       // returns a list of all the names in the enumeration
 HttpMethod::values();      // returns a list of all the names in the enumeration
 HttpMethod::nameOf(404);   // returns the name associated with the given value
                            // or null if it does not exist for the submitted value.
+HttpMethod::toJavascript(); // returns a Javascript structure equivalent
 ```
 
 You need the `Bakame\Aide\Enum\Info` trait to expose the new API.
@@ -198,8 +200,11 @@ enum HttpMethod: string
 ### Converting the Enum into a Javascript structure
 
 The `JavascriptConverter` enables converting your PHP Enum into an equivalent structure in Javascript.
+This is the mechanism used to implement the `Info::toJavascript` method. You can still override
+the method and return a more fine-tuned representation that suite your constraints better.
+
 Because there are two (2) ways to create an Enum like structure in Javascript, the class provides
-two (2) methods to allow the conversion.
+two (2) methods to allow the conversion. 
 
 In both cases, the conversion is configurable via wither methods to control the formatting and the
 Javascript structure properties.