Merge pull request #100 from sugarmaplemedia/main

Fix: EnumTransformer properly handling single-quotes in backed enum string values

Author: rubenvanassche

src/Transformers/EnumTransformer.php

@@ -73,6 +73,22 @@ protected function toEnumValue(ReflectionEnumBackedCase $case): string
     {
         $value = $case->getBackingValue();
 
-        return is_string($value) ? "'" . str_replace('\\', '\\\\', $value) . "'" : "{$value}";
+        $newValue = "";
+
+        if (!is_string($value)) {
+            return "{$value}";
+        }
+
+        for ($i = 0; $i < strlen($value); $i++) {
+            $char = $value[$i];
+
+            $newValue .= match ($char) {
+                '\\' => '\\\\',
+                '\'' => '\\\'',
+                default => $char,
+            };
+        }
+
+        return "'" . $newValue . "'";
     }
 }

tests/FakeClasses/StringBackedEnumWithSingleQuotes.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\TypeScriptTransformer\Tests\FakeClasses;
+
+enum StringBackedEnumWithSingleQuotes: string
+{
+    case NO_QUOTE = 'no quote';
+    case HAS_QUOTE = 'has quote \'';
+}

tests/Transformers/EnumTransformerTest.php

@@ -11,6 +11,7 @@
 use ReflectionClass;
 use Spatie\TypeScriptTransformer\Tests\FakeClasses\IntBackedEnum;
 use Spatie\TypeScriptTransformer\Tests\FakeClasses\StringBackedEnum;
+use Spatie\TypeScriptTransformer\Tests\FakeClasses\StringBackedEnumWithSingleQuotes;
 use Spatie\TypeScriptTransformer\Transformers\EnumTransformer;
 use Spatie\TypeScriptTransformer\TypeScriptTransformerConfig;
 use UnitEnum;
@@ -82,7 +83,7 @@
     assertEquals('type', $type->keyword);
 });
 
-it('can transform a backed enum with integers into an enm', function () {
+it('can transform a backed enum with integers into an enum', function () {
     $transformer = new EnumTransformer(
         TypeScriptTransformerConfig::create()->transformToNativeEnums(true)
     );
@@ -113,3 +114,35 @@
     assertFalse($type->isInline);
     assertEquals('type', $type->keyword);
 });
+
+it('can transform a backed enum with strings with single-quotes into a enum', function () {
+    $transformer = new EnumTransformer(
+        TypeScriptTransformerConfig::create()->transformToNativeEnums(true)
+    );
+
+    $type = $transformer->transform(
+        new ReflectionClass(StringBackedEnumWithSingleQuotes::class),
+        'Enum'
+    );
+
+    assertEquals("'NO_QUOTE' = 'no quote', 'HAS_QUOTE' = 'has quote \''", $type->transformed);
+    assertTrue($type->missingSymbols->isEmpty());
+    assertFalse($type->isInline);
+    assertEquals('enum', $type->keyword);
+});
+
+it('can transform a backed enum with strings with single-quotes into a union', function () {
+    $transformer = new EnumTransformer(
+        TypeScriptTransformerConfig::create()->transformToNativeEnums(false)
+    );
+
+    $type = $transformer->transform(
+        new ReflectionClass(StringBackedEnumWithSingleQuotes::class),
+        'Enum'
+    );
+
+    assertEquals("'no quote' | 'has quote \''", $type->transformed);
+    assertTrue($type->missingSymbols->isEmpty());
+    assertFalse($type->isInline);
+    assertEquals('type', $type->keyword);
+});