UnionHandler::isPrimitiveType() - Code Metrics - Inspection of "Union types discriminated" - schmittjoh/serializer - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#1553)

unknown
created 2024-08-12 18:42 UTC
UnionHandler::isPrimitiveType() A

↳ Parent: UnionHandler
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10
<?php

declare(strict_types=1);

namespace JMS\Serializer\Handler;

use JMS\Serializer\Context;
use JMS\Serializer\DeserializationContext;
use JMS\Serializer\Exception\NonVisitableTypeException;
use JMS\Serializer\Exception\RuntimeException;
use JMS\Serializer\GraphNavigatorInterface;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\Visitor\DeserializationVisitorInterface;
use JMS\Serializer\Visitor\SerializationVisitorInterface;

final class UnionHandler implements SubscribingHandlerInterface
{
    private static $aliases = ['boolean' => 'bool', 'integer' => 'int', 'double' => 'float'];


    /**
     * {@inheritdoc}
     */
    public static function getSubscribingMethods()
    {
        $methods = [];
        $formats = ['json', 'xml'];

        foreach ($formats as $format) {
            $methods[] = [
                'type' => 'union',
                'format' => $format,
                'direction' => GraphNavigatorInterface::DIRECTION_DESERIALIZATION,
                'method' => 'deserializeUnion',
            ];
            $methods[] = [
                'type' => 'union',
                'format' => $format,
                'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
                'method' => 'serializeUnion',
            ];
        }

        return $methods;
    }

    public function serializeUnion(
        SerializationVisitorInterface $visitor,
        /** @scrutinizer ignore-unused */ SerializationVisitorInterface $visitor,
        mixed $data,
        array $type,
        SerializationContext $context
    ): mixed {
        if ($this->isPrimitiveType(gettype($data))) {
            return $this->matchSimpleType($data, $type, $context);
        } else {
            $resolvedType = [
                'name' => get_class($data),
                'params' => [],
            ];

            return $context->getNavigator()->accept($data, $resolvedType);
        }
    }

    public function deserializeUnion(DeserializationVisitorInterface $visitor, mixed $data, array $type, DeserializationContext $context): mixed
    public function deserializeUnion(/** @scrutinizer ignore-unused */ DeserializationVisitorInterface $visitor, mixed $data, array $type, DeserializationContext $context): mixed
    {
        if ($data instanceof \SimpleXMLElement) {
            throw new RuntimeException('XML deserialisation into union types is not supported yet.');
        }

        $finalType = null;
        if (1 === count($type['params'])) {
            if ($data[$type['params'][0]]) {
                $lookupField = $type['params'][0];

                if (!array_key_exists($lookupField, $data)) {
                    throw new NonVisitableTypeException('Union Discriminator Field \'' . $lookupField . '\' not found in data');
                }

                $lkup = $data[$lookupField];
                $finalType = [
                    'name' => $lkup,
                    'params' => [],
                ];
            }
        } elseif (2 === count($type['params'])) {
            if (is_array($type['params'][1]) && !array_key_exists('name', $type['params'][1])) {
                $lookupField = $type['params'][0];
                $unionMap = $type['params'][1];

                if (!array_key_exists($lookupField, $data)) {
                    throw new NonVisitableTypeException('Union Discriminator Field \'' . $lookupField . '\' not found in data');
                }

                $lkup = $data[$lookupField];
                if (!empty($unionMap)) {
                    if (array_key_exists($lkup, $unionMap)) {
                        $finalType = [
                            'name' => $unionMap[$lkup],
                            'params' => [],
                        ];
                    } else {
                        throw new NonVisitableTypeException('Union Discriminator Map does not contain key \'' . $lkup . '\'');
                    }
                } else {
                    $finalType = [
                        'name' => $lkup,
                        'params' => [],
                    ];
                }
            }
        }

        if (null !== $finalType && null !== $finalType['name']) {
            return $context->getNavigator()->accept($data, $finalType);
        } else {
            foreach ($type['params'] as $possibleType) {
                $finalType = null;


                if ($this->isPrimitiveType($possibleType['name']) && $this->testPrimitive($data, $possibleType['name'], $context->getFormat())) {
                    return $context->getNavigator()->accept($data, $possibleType);
                }
            }
        }

        return null;
    }

    private function matchSimpleType(mixed $data, array $type, Context $context): mixed
    {
        foreach ($type['params'] as $possibleType) {
            if ($this->isPrimitiveType($possibleType['name']) && !$this->testPrimitive($data, $possibleType['name'], $context->getFormat())) {
                continue;
            }

            try {
                return $context->getNavigator()->accept($data, $possibleType);
            } catch (NonVisitableTypeException $e) {
                continue;
            }
        }

        return null;
    }

    private function isPrimitiveType(string $type): bool
    {
        return in_array($type, ['int', 'integer', 'float', 'double', 'bool', 'boolean', 'string']);
    }

    private function testPrimitive(mixed $data, string $type, string $format): bool
    private function testPrimitive(mixed $data, string $type, /** @scrutinizer ignore-unused */ string $format): bool
    {
        switch ($type) {
            case 'integer':
            case 'int':
                return (string) (int) $data === (string) $data;

            case 'double':
            case 'float':
                return (string) (float) $data === (string) $data;

            case 'bool':
            case 'boolean':
                return (string) (bool) $data === (string) $data;

            case 'string':
                return (string) $data === (string) $data;
        }

        return false;
    }
}

schmittjoh / serializer

Pull Request — master (#1553)

UnionHandler::isPrimitiveType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
