Bootstrap encoder for documents

src/Bundle/ChillDocGeneratorBundle/Serializer/Encoder/DocGenEncoder.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Chill\DocGeneratorBundle\Serializer\Encoder;
+
+use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+
+class DocGenEncoder implements \Symfony\Component\Serializer\Encoder\EncoderInterface
+{
+
+    /**
+     * @inheritDoc
+     */
+    public function encode($data, string $format, array $context = [])
+    {
+        if (!$this->isAssociative($data)) {
+            throw new UnexpectedValueException("Only associative arrays are allowed; lists are not allowed");
+        }
+
+        $result = [];
+        $this->recusiveEncoding($data, $result, '');
+
+        return $result;
+    }
+
+    private function recusiveEncoding(array $data, array &$result, $path)
+    {
+        if ($this->isAssociative($data)) {
+            foreach ($data as $key => $value) {
+                if (\is_array($value)) {
+                    $this->recusiveEncoding($value, $result, $this->canonicalizeKey($path, $key));
+                } else {
+                    $result[$this->canonicalizeKey($path, $key)] = $value;
+                }
+            }
+        } else {
+            foreach ($data as $elem) {
+
+                if (!$this->isAssociative($elem)) {
+                    throw new UnexpectedValueException(sprintf("Embedded loops are not allowed. See data under %s path", $path));
+                }
+
+                $sub = [];
+                $this->recusiveEncoding($elem, $sub, '');
+                $result[$path][] = $sub;
+            }
+        }
+    }
+
+    private function canonicalizeKey(string $path, string $key): string
+    {
+        return $path === '' ? $key : $path.'_'.$key;
+    }
+
+    private function isAssociative(array $data)
+    {
+        $keys = \array_keys($data);
+
+        return $keys !== \array_keys($keys);
+    }
+
+
+    /**
+     * @inheritDoc
+     */
+    public function supportsEncoding(string $format)
+    {
+        return $format === 'docgen';
+    }
+}

src/Bundle/ChillDocGeneratorBundle/Serializer/Helper/NormalizeNullValueHelper.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Chill\DocGeneratorBundle\Serializer\Helper;
+
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class NormalizeNullValueHelper
+{
+    private NormalizerInterface $normalizer;
+
+    public function __construct(NormalizerInterface $normalizer)
+    {
+        $this->normalizer = $normalizer;
+    }
+
+    public function normalize(array $attributes, string $format = 'docgen', ?array $context = [])
+    {
+        $data = [];
+
+        foreach ($attributes as $key => $class) {
+            if (is_numeric($key)) {
+                $data[$class] = '';
+            } else {
+                switch ($class) {
+                    case 'array':
+                    case 'bool':
+                    case 'double':
+                    case 'float':
+                    case 'int':
+                    case 'resource':
+                    case 'string':
+                    case 'null':
+                        $data[$key] = '';
+                        break;
+                    default:
+                        $data[$key] = $this->normalizer->normalize(null, $format, \array_merge(
+                            $context,
+                            ['docgen:expects' => $class]
+                        ));
+                        break;
+                }
+            }
+        }
+
+        return $data;
+    }
+}

src/Bundle/ChillDocGeneratorBundle/Serializer/Normalizer/DocGenObjectNormalizer.php

@@ -0,0 +1,177 @@
+<?php
+
+namespace Chill\DocGeneratorBundle\Serializer\Normalizer;
+
+use Chill\DocGeneratorBundle\Serializer\Helper\NormalizeNullValueHelper;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+use Symfony\Component\PropertyAccess\PropertyAccessor;
+use Symfony\Component\Serializer\Exception\ExceptionInterface;
+use Symfony\Component\Serializer\Exception\LogicException;
+use Symfony\Component\Serializer\Mapping\AttributeMetadata;
+use Symfony\Component\Serializer\Mapping\ClassMetadata;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class DocGenObjectNormalizer implements NormalizerInterface, NormalizerAwareInterface
+{
+    use NormalizerAwareTrait;
+
+    private ClassMetadataFactoryInterface $classMetadataFactory;
+    private PropertyAccessor $propertyAccess;
+
+    public function __construct(ClassMetadataFactoryInterface $classMetadataFactory)
+    {
+        $this->classMetadataFactory = $classMetadataFactory;
+        $this->propertyAccess = PropertyAccess::createPropertyAccessor();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function normalize($object, string $format = null, array $context = [])
+    {
+        $classMetadataKey = $object ?? $context['docgen:expects'];
+
+        if (!$this->classMetadataFactory->hasMetadataFor($classMetadataKey)) {
+            throw new LogicException(sprintf("This object does not have metadata: %s. Add groups on this entity to allow to serialize with the format %s and groups %s", is_object($object) ? get_class($object) : $context['docgen:expects'], $format, \implode(', ', $context['groups'])));
+        }
+
+        $metadata = $this->classMetadataFactory->getMetadataFor($classMetadataKey);
+        $expectedGroups = \array_key_exists(AbstractNormalizer::GROUPS, $context) ?
+            \is_array($context[AbstractNormalizer::GROUPS]) ? $context[AbstractNormalizer::GROUPS] : [$context[AbstractNormalizer::GROUPS]]
+            : [];
+        $attributes = \array_filter(
+            $metadata->getAttributesMetadata(),
+            function (AttributeMetadata $a) use ($expectedGroups) {
+                foreach ($a->getGroups() as $g) {
+                    if (\in_array($g, $expectedGroups, true)) {
+                        return true;
+                    }
+                }
+
+                return false;
+            });
+
+        if (null === $object) {
+            return $this->normalizeNullData($format, $context, $metadata, $attributes);
+        }
+
+        return $this->normalizeObject($object, $format, $context, $expectedGroups, $metadata, $attributes);
+    }
+
+    /**
+     * @param string $format
+     * @param array $context
+     * @param array $expectedGroups
+     * @param ClassMetadata $metadata
+     * @param array|AttributeMetadata[] $attributes
+     */
+    private function normalizeNullData(string $format, array $context, ClassMetadata $metadata, array $attributes): array
+    {
+        $keys = [];
+
+        foreach ($attributes as $attribute) {
+            $key = $attribute->getSerializedName() ?? $attribute->getName();
+            $keys[$key] = $this->getExpectedType($attribute, $metadata->getReflectionClass());
+        }
+
+        $normalizer = new NormalizeNullValueHelper($this->normalizer);
+
+        return $normalizer->normalize($keys, $format, $context);
+    }
+
+    /**
+     * @param $object
+     * @param $format
+     * @param array $context
+     * @param array $expectedGroups
+     * @param ClassMetadata $metadata
+     * @param array|AttributeMetadata[] $attributes
+     * @return array
+     * @throws ExceptionInterface
+     */
+    private function normalizeObject($object, $format, array $context, array $expectedGroups, ClassMetadata $metadata, array $attributes)
+    {
+        $data = [];
+        $reflection = $metadata->getReflectionClass();
+
+        foreach ($attributes as $attribute) {
+            /** @var AttributeMetadata $attribute */
+            $value = $this->propertyAccess->getValue($object, $attribute->getName());
+            $key = $attribute->getSerializedName() ?? $attribute->getName();
+
+            if (is_object($value)) {
+                $data[$key] =
+                    $this->normalizer->normalize($value, $format, \array_merge(
+                        $context, $attribute->getNormalizationContextForGroups($expectedGroups)
+                    ));
+            } elseif (null === $value) {
+                $data[$key] = $this->normalizeNullOutputValue($format, $context, $attribute, $reflection);
+            } else {
+                $data[$key] = (string) $value;
+            }
+        }
+
+        return $data;
+    }
+
+    private function getExpectedType(AttributeMetadata $attribute, \ReflectionClass $reflection): string
+    {
+        // we have to get the expected content
+        if ($reflection->hasProperty($attribute->getName())) {
+            $type = $reflection->getProperty($attribute->getName())->getType();
+        } elseif ($reflection->hasMethod($attribute->getName())) {
+            $type = $reflection->getMethod($attribute->getName())->getReturnType();
+        } else {
+            throw new \LogicException(sprintf(
+                "Could not determine how the content is determined for the attribute %s. Add attribute property only on property or method", $attribute->getName()
+            ));
+        }
+
+        if (null === $type) {
+            throw new \LogicException(sprintf(
+                "Could not determine the type for this attribute: %s. Add a return type to the method or property declaration", $attribute->getName()
+            ));
+        }
+
+        return $type->getName();
+    }
+
+    /**
+     */
+    private function normalizeNullOutputValue($format, array $context, AttributeMetadata $attribute, \ReflectionClass $reflection)
+    {
+        $type = $this->getExpectedType($attribute, $reflection);
+
+        switch ($type) {
+            case 'array':
+            case 'bool':
+            case 'double':
+            case 'float':
+            case 'int':
+            case 'resource':
+            case 'string':
+                return '';
+            default:
+                return $this->normalizer->normalize(
+                    null,
+                    $format,
+                    \array_merge(
+                        $context,
+                        ['docgen:expects' => $type]
+                    )
+                );
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function supportsNormalization($data, string $format = null): bool
+    {
+        return $format === 'docgen' && (is_object($data) || null === $data);
+    }
+}

src/Bundle/ChillDocGeneratorBundle/config/services.yaml

@@ -8,3 +8,10 @@ services:
         autowire: true
         autoconfigure: true
         resource: '../Repository/'
+
+    Chill\DocGeneratorBundle\Serializer\Normalizer\:
+        autowire: true
+        autoconfigure: true
+        resource: '../Serializer/Normalizer/'
+        tags:
+            - { name: 'serializer.normalizer', priority: -152 }

src/Bundle/ChillDocGeneratorBundle/tests/Serializer/Encoder/DocGenEncoderTest.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace Chill\DocGeneratorBundle\Tests\Serializer\Encoder;
+
+use Chill\DocGeneratorBundle\Serializer\Encoder\DocGenEncoder;
+use Doctrine\ORM\EntityRepository;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Exception\UnexpectedValueException;
+
+class DocGenEncoderTest extends TestCase
+{
+    private DocGenEncoder $encoder;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->encoder = new DocGenEncoder();
+    }
+
+    /**
+     * @dataProvider generateEncodeData
+     */
+    public function testEncode($expected, $data, string $msg)
+    {
+        $generated = $this->encoder->encode($data, 'docgen');
+        $this->assertEquals($expected, $generated, $msg);
+    }
+
+    public function testEmbeddedLoopsThrowsException()
+    {
+        $this->expectException(UnexpectedValueException::class);
+
+        $data = [
+            'data' => [
+                ['item' => 'one'],
+                [
+                    'embedded' => [
+                        [
+                            ['subitem' => 'two'],
+                            ['subitem' => 'three']
+                        ]
+                    ]
+                ],
+            ]
+        ];
+
+        $this->encoder->encode($data, 'docgen');
+    }
+
+    public function generateEncodeData()
+    {
+       yield [ ['tests' => 'ok'], ['tests' => 'ok'], "A simple test with a simple array"];
+
+       yield [
+           // expected:
+           ['item_subitem' => 'value'],
+           // data:
+           ['item' => ['subitem' => 'value']],
+           "A test with multidimensional array"
+       ];
+
+       yield [
+           // expected:
+           [ 'data' => [['item' => 'one'], ['item' => 'two']] ],
+           // data:
+           [ 'data' => [['item' => 'one'], ['item' => 'two']] ],
+           "a list of items"
+       ];
+
+        yield [
+            // expected:
+            [ 'data' => [['item_subitem' => 'alpha'], ['item' => 'two']] ],
+            // data:
+            [ 'data' => [['item' => ['subitem' => 'alpha']], ['item' => 'two'] ] ],
+            "a list of items with multidimensional array inside item"
+        ];
+
+        yield [
+            // expected:
+            [
+                'persons' => [
+                    [
+                        'firstname' => 'Jonathan',
+                        'lastname' => 'Dupont',
+                        'dateOfBirth_long' => '16 juin 1981',
+                        'dateOfBirth_short' => '16/06/1981',
+                        'father_firstname' => 'Marcel',
+                        'father_lastname' => 'Dupont',
+                        'father_dateOfBirth_long' => '10 novembre 1953',
+                        'father_dateOfBirth_short' => '10/11/1953'
+                    ],
+                ]
+            ],
+            // data:
+            [
+                'persons' => [
+                    [
+                        'firstname' => 'Jonathan',
+                        'lastname' => 'Dupont',
+                        'dateOfBirth' => [ 'long' => '16 juin 1981', 'short' => '16/06/1981'],
+                        'father' => [
+                            'firstname' => 'Marcel',
+                            'lastname' => 'Dupont',
+                            'dateOfBirth' => ['long' => '10 novembre 1953', 'short' => '10/11/1953']
+                        ]
+                    ],
+                ]
+            ],
+            "a longer list, with near real data inside and embedded associative arrays"
+        ];
+    }
+}

src/Bundle/ChillDocGeneratorBundle/tests/Serializer/Normalizer/DocGenObjectNormalizerTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Chill\DocGeneratorBundle\tests\Serializer\Normalizer;
+
+use Chill\MainBundle\Entity\Center;
+use Chill\MainBundle\Entity\User;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class DocGenObjectNormalizerTest extends KernelTestCase
+{
+    private NormalizerInterface $normalizer;
+
+
+    protected function setUp()
+    {
+        parent::setUp();
+        self::bootKernel();
+
+        $this->normalizer = self::$container->get(NormalizerInterface::class);
+    }
+
+    public function testNormalizationBasic()
+    {
+        $user = new User();
+        $user->setUsername('User Test');
+        $user->setMainCenter($center = new Center());
+        $center->setName('test');
+
+        $normalized = $this->normalizer->normalize($user, 'docgen', [ AbstractNormalizer::GROUPS => ['docgen:read']]);
+        $expected = [
+            'label' => 'User Test',
+            'email' => '',
+            'mainCenter' => [
+                'name' => 'test'
+            ]
+        ];
+
+        $this->assertEquals($expected, $normalized, "test normalization fo an user");
+    }
+
+    public function testNormalizeWithNullValueEmbedded()
+    {
+        $user = new User();
+        $user->setUsername('User Test');
+
+        $normalized = $this->normalizer->normalize($user, 'docgen', [ AbstractNormalizer::GROUPS => ['docgen:read']]);
+        $expected = [
+            'label' => 'User Test',
+            'email' => '',
+            'mainCenter' => [
+                'name' => ''
+            ]
+        ];
+
+        $this->assertEquals($expected, $normalized, "test normalization fo an user with null center");
+    }
+
+    public function testNormalizeNullObjectWithObjectEmbedded()
+    {
+        $normalized = $this->normalizer->normalize(null, 'docgen', [
+            AbstractNormalizer::GROUPS => ['docgen:read'],
+            'docgen:expects' => User::class,
+        ]);
+
+        $expected = [
+            'label' => '',
+            'email' => '',
+            'mainCenter' => [
+                'name' => ''
+            ]
+        ];
+
+        $this->assertEquals($expected, $normalized, "test normalization for a null user");
+
+    }
+
+
+}