implement twig serialize filter

Author: jrushlow

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.3.0
+-----
+
+* Added a new `serialize` filter to serialize objects using the Serializer component
+
 5.2.0
 -----
 

Extension/SerializerExtension.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Extension;
+
+use Twig\Extension\AbstractExtension;
+use Twig\TwigFilter;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+final class SerializerExtension extends AbstractExtension
+{
+    public function getFilters(): array
+    {
+        return [
+            new TwigFilter('serialize', [SerializerRuntime::class, 'serialize']),
+        ];
+    }
+}

Extension/SerializerRuntime.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Extension;
+
+use Symfony\Component\Serializer\SerializerInterface;
+use Twig\Extension\RuntimeExtensionInterface;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+final class SerializerRuntime implements RuntimeExtensionInterface
+{
+    private $serializer;
+
+    public function __construct(SerializerInterface $serializer)
+    {
+        $this->serializer = $serializer;
+    }
+
+    public function serialize($data, string $format = 'json', array $context = []): string
+    {
+        return $this->serializer->serialize($data, $format, $context);
+    }
+}

Tests/Extension/Fixtures/SerializerModelFixture.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Symfony\Bridge\Twig\Tests\Extension\Fixtures;
+
+use Symfony\Component\Serializer\Annotation\Groups;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+class SerializerModelFixture
+{
+    /**
+     * @Groups({"read"})
+     */
+    public $name = 'howdy';
+
+    public $title = 'fixture';
+}

Tests/Extension/SerializerExtensionTest.php

@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Tests\Extension;
+
+use Doctrine\Common\Annotations\AnnotationReader;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Twig\Extension\SerializerExtension;
+use Symfony\Bridge\Twig\Extension\SerializerRuntime;
+use Symfony\Bridge\Twig\Tests\Extension\Fixtures\SerializerModelFixture;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Encoder\YamlEncoder;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Serializer;
+use Twig\Environment;
+use Twig\Loader\ArrayLoader;
+use Twig\RuntimeLoader\RuntimeLoaderInterface;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+class SerializerExtensionTest extends TestCase
+{
+    /**
+     * @dataProvider serializerDataProvider
+     */
+    public function testSerializeFilter(string $template, string $expectedResult)
+    {
+        $twig = $this->getTwig($template);
+
+        self::assertSame($expectedResult, $twig->render('template', ['object' => new SerializerModelFixture()]));
+    }
+
+    public function serializerDataProvider(): \Generator
+    {
+        yield ['{{ object|serialize }}', '{&quot;name&quot;:&quot;howdy&quot;,&quot;title&quot;:&quot;fixture&quot;}'];
+        yield ['{{ object|serialize(\'yaml\') }}', '{ name: howdy, title: fixture }'];
+        yield ['{{ object|serialize(\'yaml\', {groups: \'read\'}) }}', '{ name: howdy }'];
+    }
+
+    private function getTwig(string $template): Environment
+    {
+        $meta = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $runtime = new SerializerRuntime(new Serializer([new ObjectNormalizer($meta)], [new JsonEncoder(), new YamlEncoder()]));
+
+        $mockRuntimeLoader = $this->createMock(RuntimeLoaderInterface::class);
+        $mockRuntimeLoader
+            ->method('load')
+            ->willReturnMap([
+                ['Symfony\Bridge\Twig\Extension\SerializerRuntime', $runtime],
+            ])
+        ;
+
+        $twig = new Environment(new ArrayLoader(['template' => $template]));
+        $twig->addExtension(new SerializerExtension());
+        $twig->addRuntimeLoader($mockRuntimeLoader);
+
+        return $twig;
+    }
+}

composer.json

@@ -22,6 +22,7 @@
         "twig/twig": "^2.13|^3.0.4"
     },
     "require-dev": {
+        "doctrine/annotations": "^1.12",
         "egulias/email-validator": "^2.1.10",
         "phpdocumentor/reflection-docblock": "^3.0|^4.0|^5.0",
         "symfony/asset": "^4.4|^5.0",