Merge pull request #26 from kirschbaum-development/feature/escape-string-values

Escape string values and method outputs in generated enums

Author: brandonferens

.github/workflows/run-tests.yml

@@ -11,14 +11,9 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4 ]
         laravel: [ 10.*, 11.*, 12.* ]
         include:
-          - php: 8.1
-            laravel: 10.*
-            pest: 2.*
-            testbench: 8.*
-            larastan: 2.*
           - php: 8.2
             laravel: 10.*
             pest: 2.*
@@ -64,11 +59,6 @@ jobs:
             pest: 3.*
             testbench: 10.*
             larastan: 3.*
-        exclude:
-          - php: 8.1
-            laravel: 11.*
-          - php: 8.1
-            laravel: 12.*
 
     name: Paragon Tests - PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 

src/Concerns/Builders/EnumJsBuilder.php

@@ -35,6 +35,8 @@ public function fileExtension(): string
 
     /**
      * Prepare the method and its respective values so it can get injected into the case object.
+     *
+     * @throws \JsonException
      */
     public function caseMethod(ReflectionMethod $method, ReflectionEnumUnitCase|ReflectionEnumBackedCase $case): string
     {
@@ -46,7 +48,7 @@ public function caseMethod(ReflectionMethod $method, ReflectionEnumUnitCase|Refl
                 $value instanceof BackedEnum => "=> {$class}.{$value->name}",
                 is_numeric($value) => "=> {$value}",
                 is_null($value) => '=> null',
-                default => "=> '{$value}'"
+                default => '=> ' . json_encode($value, JSON_THROW_ON_ERROR)
             })
             ->append(',');
     }

src/Concerns/Builders/EnumTsBuilder.php

@@ -35,6 +35,8 @@ public function fileExtension(): string
 
     /**
      * Prepare the method and its respective values so it can get injected into the case object.
+     *
+     * @throws \JsonException
      */
     public function caseMethod(ReflectionMethod $method, ReflectionEnumUnitCase|ReflectionEnumBackedCase $case): string
     {
@@ -46,7 +48,7 @@ public function caseMethod(ReflectionMethod $method, ReflectionEnumUnitCase|Refl
                 $value instanceof BackedEnum => "object => {$class}.{$value->name}",
                 is_numeric($value) => "number => {$value}",
                 is_null($value) => 'null => null',
-                default => "string => '{$value}'"
+                default => 'string => ' . json_encode($value, JSON_THROW_ON_ERROR)
             })
             ->append(',');
     }

src/Generators/EnumGenerator.php

@@ -216,6 +216,8 @@ protected function buildCases(Collection $cases): string
 
     /**
      * Prepare the value of the enum case object if it is a backed enum.
+     *
+     * @throws \JsonException
      */
     protected function caseValueProperty(ReflectionEnumUnitCase|ReflectionEnumBackedCase $case): string
     {
@@ -228,7 +230,7 @@ protected function caseValueProperty(ReflectionEnumUnitCase|ReflectionEnumBacked
                         ? $string->append("{$case->getValue()->value}")
                         : $string,
                     fn ($string) => $case->getValue() instanceof BackedEnum
-                        ? $string->append("'{$case->getValue()->value}'")
+                        ? $string->append(json_encode($case->getValue()->value, JSON_THROW_ON_ERROR))
                         : $string,
                 )
                 ->append(',');

tests/Fixtures/EscapedStringBacked.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Enums;
+
+enum EscapedStringBacked: string
+{
+    case Quote = 'it\'s a "test"';
+
+    public function label(): string
+    {
+        return 'can\'t "stop"';
+    }
+}

tests/Unit/Commands/GenerateEnumsCommandTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use App\Enums\EscapedStringBacked;
 use App\Enums\IntegerBacked;
 use App\Enums\NonBacked;
 use App\Enums\StringBacked;
@@ -20,7 +21,7 @@
         ->toContain('class StringBacked extends Enum')
         ->toContain(StringBacked::Active->name . ': Object.freeze({')
         ->toContain("name: '" . StringBacked::Active->name . "',")
-        ->toContain("value: '" . StringBacked::Active->value . "',")
+        ->toContain('value: ' . json_encode(StringBacked::Active->value) . ',')
         ->toContain('export default StringBacked;');
 });
 
@@ -62,6 +63,41 @@
         ->toContain('export default NonBacked;');
 });
 
+it('escapes string values and method return values that need it', function () {
+    // Act.
+    $this->artisan(GenerateEnumsCommand::class);
+
+    $path = resource_path(config('paragon.enums.paths.generated') . DIRECTORY_SEPARATOR . 'EscapedStringBacked.ts');
+    $file = file_get_contents($path);
+
+    // Assert.
+    expect($path)->toBeFile()
+        ->and($file)
+        ->toContain('value: ' . json_encode(EscapedStringBacked::Quote->value) . ',')
+        ->toContain('label: (): string => ' . json_encode(EscapedStringBacked::Quote->label()) . ',');
+});
+
+it('throws instead of writing broken output for a value that cannot be encoded as JSON', function () {
+    // Arrange.
+    // Written directly into app_path() rather than tests/Fixtures: GenerateEnumsCommand
+    // processes every enum under that path in a single pass, so a fixture there that
+    // intentionally fails generation would break every test that runs the command.
+    file_put_contents(app_path('Enums/InvalidUtf8Backed.php'), <<<'PHP'
+        <?php
+
+        namespace App\Enums;
+
+        enum InvalidUtf8Backed: string
+        {
+            case Bad = "\xB1\x31";
+        }
+
+        PHP);
+
+    // Act.
+    $this->artisan(GenerateEnumsCommand::class);
+})->throws(JsonException::class);
+
 it('generates enums recursively', function () {
     // Act.
     $this->artisan(GenerateEnumsCommand::class);
@@ -102,7 +138,7 @@
         // type definition
         ->toContain('label();')
         // items objects
-        ->toContain("label: (): string => '" . StringBacked::Active->label() . "',");
+        ->toContain('label: (): string => ' . json_encode(StringBacked::Active->label()) . ',');
 });
 
 it('ignores methods with \'IgnoreParagon\' attribute', function () {

tests/Unit/Commands/GenerateJsEnumsCommandTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use App\Enums\EscapedStringBacked;
 use App\Enums\IntegerBacked;
 use App\Enums\NonBacked;
 use App\Enums\StringBacked;
@@ -20,7 +21,7 @@
         ->toContain('class StringBacked extends Enum')
         ->toContain(StringBacked::Active->name . ': Object.freeze({')
         ->toContain("name: '" . StringBacked::Active->name . "',")
-        ->toContain("value: '" . StringBacked::Active->value . "',")
+        ->toContain('value: ' . json_encode(StringBacked::Active->value) . ',')
         ->toContain('export default StringBacked;');
 });
 
@@ -62,6 +63,20 @@
         ->toContain('export default NonBacked;');
 });
 
+it('escapes string values and method return values that need it', function () {
+    // Act.
+    $this->artisan(GenerateEnumsCommand::class, ['--javascript' => true]);
+
+    $path = resource_path(config('paragon.enums.paths.generated') . DIRECTORY_SEPARATOR . 'EscapedStringBacked.js');
+    $file = file_get_contents($path);
+
+    // Assert.
+    expect($path)->toBeFile()
+        ->and($file)
+        ->toContain('value: ' . json_encode(EscapedStringBacked::Quote->value) . ',')
+        ->toContain('label: () => ' . json_encode(EscapedStringBacked::Quote->label()) . ',');
+});
+
 it('generates enums recursively', function () {
     // Act.
     $this->artisan(GenerateEnumsCommand::class, ['--javascript' => true]);
@@ -102,7 +117,7 @@
         // type definition
         ->not->toContain('label();')
         // items objects
-        ->toContain("label: () => '" . StringBacked::Active->label() . "',");
+        ->toContain('label: () => ' . json_encode(StringBacked::Active->label()) . ',');
 });
 
 it('ignores methods with \'IgnoreParagon\' attribute', function () {