[JsonEncoder] Add Encodable attribute

mtarld · mtarld · commit b70b7ea29317 · 2025-01-07T16:53:09.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/JsonEncoderTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/JsonEncoderTest.php
@@ -44,4 +44,21 @@ public function testDecode()
 
         $this->assertEquals($expected, $decoder->decode('{"@name": "DUMMY", "range": "0..1"}', Type::object(Dummy::class)));
     }
+
+    public function testWarmupEncodableClasses()
+    {
+        static::bootKernel(['test_case' => 'JsonEncoder']);
+
+        // clear already created encoders
+        $encodersDir = \sprintf('%s/json_encoder/encoder/', static::getContainer()->getParameter('kernel.cache_dir'));
+        if (is_dir($encodersDir)) {
+            array_map('unlink', glob($encodersDir.'/*'));
+            rmdir($encodersDir);
+        }
+
+        static::getContainer()->get('json_encoder.cache_warmer.encoder_decoder.alias')->warmUp(static::getContainer()->getParameter('kernel.cache_dir'));
+
+        $this->assertFileExists($encodersDir);
+        $this->assertCount(1, glob($encodersDir.'/*'));
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/Dto/Dummy.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/Dto/Dummy.php
@@ -12,13 +12,15 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\Dto;
 
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\RangeNormalizer;
+use Symfony\Component\JsonEncoder\Attribute\Encodable;
 use Symfony\Component\JsonEncoder\Attribute\Denormalizer;
 use Symfony\Component\JsonEncoder\Attribute\EncodedName;
 use Symfony\Component\JsonEncoder\Attribute\Normalizer;
 
 /**
  * @author Mathias Arlaud <mathias.arlaud@gmail.com>
  */
+#[Encodable]
 class Dummy
 {
     #[EncodedName('@name')]
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/JsonEncoder/config.yml
@@ -18,4 +18,9 @@ services:
         alias: json_encoder.decoder
         public: true
 
+    json_encoder.cache_warmer.encoder_decoder.alias:
+        alias: .json_encoder.cache_warmer.encoder_decoder
+        public: true
+
+    Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\Dto\Dummy: ~
     Symfony\Bundle\FrameworkBundle\Tests\Functional\app\JsonEncoder\RangeNormalizer: ~
diff --git a/src/Symfony/Component/JsonEncoder/Attribute/Encodable.php b/src/Symfony/Component/JsonEncoder/Attribute/Encodable.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\JsonEncoder\Attribute;
+
+use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
+
+/**
+ * Autoconfigure "json_encoder.encodable" tag.
+ *
+ * @author Mathias Arlaud <mathias.arlaud@gmail.com>
+ *
+ * @experimental
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class Encodable extends AutoconfigureTag
+{
+    public function __construct()
+    {
+        parent::__construct('json_encoder.encodable');
+    }
+}
