ww-stas / yaml-to-object-mapper

src/Mapper.php

<?php declare(strict_types=1);

namespace Diezz\YamlToObjectMapper;

use Diezz\YamlToObjectMapper\Attributes\DefaultValueResolver;
use Diezz\YamlToObjectMapper\Resolver\ArgumentResolver;
use Diezz\YamlToObjectMapper\Resolver\ArgumentResolverFactory;
use Diezz\YamlToObjectMapper\Resolver\Context;
use Diezz\YamlToObjectMapper\Resolver\InstanceArgumentResolver;
use Diezz\YamlToObjectMapper\Resolver\ListArgumentResolver;
use Diezz\YamlToObjectMapper\Resolver\Parser\Parser;
use Diezz\YamlToObjectMapper\Resolver\ScalarArgumentResolver;
use ReflectionException;
use Symfony\Component\Yaml\Yaml;

class Mapper
{
    private ArgumentResolverFactory $argumentResolverFactory;

    public function __construct(ArgumentResolverFactory $argumentResolverFactory = null)
    {
        if (null === $argumentResolverFactory) {
            $argumentResolverFactory = new ArgumentResolverFactory();
        }
        $this->argumentResolverFactory = $argumentResolverFactory;
    }

    public static function make(): static
    {
        return new static();
    }

    /**
     * Register new custom argument resolver.
     *
     * @param string $resolverAlias     - resolver name
     * @param string $resolverClassName - class name of argument resolver
     *
     * @return void
     */
    public function registerCustomArgumentResolver(string $resolverAlias, string $resolverClassName): void
    {
        $this->argumentResolverFactory->addResolver($resolverAlias, $resolverClassName);
    }

    /**
     * @template T
     *
     * @param class-string<T> $targetClass

The doc comment class-string<T> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>.

     *
     * @throws ReflectionException
     * @throws ValidationException
     * @throws Resolver\ArgumentResolverException
     * @throws Resolver\Parser\SyntaxException
     * @return T
     *
     */
    public function mapFromFile(string $targetClass, string $configFile): object
    {
        $config = Yaml::parseFile($configFile);

        return $this->map($targetClass, $config);
    }

    /**
     * @template T
     *
     * @param class-string<T> $targetClass

The doc comment class-string<T> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>.

     *
     * @throws ValidationException
     * @throws ReflectionException|Resolver\ArgumentResolverException|Resolver\Parser\SyntaxException
     *
     * @return T
     */
    public function map(string $targetClass, array $config): object
    {
        $instance = new $targetClass;
        $classInfoReflector = new ClassInfoReflector();
        $classInfo = $classInfoReflector->introspect($targetClass);
        $validationResult = $this->validate($classInfo, $config);

        if (!$validationResult->isValid()) {
            throw new ValidationException($validationResult);
        }

        $mappingConfig = $this->getMappingConfig($classInfo, $config, $instance);
        $rootResolver = new InstanceArgumentResolver($classInfo, $mappingConfig);

        return $rootResolver->resolve(new Context($config, $rootResolver));
    }

    /**
     * @template T
     *
     * @param class-string<T> $targetClass

The doc comment class-string<T> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>.

     *
     * @throws ValidationException
     * @throws ReflectionException|Resolver\ArgumentResolverException|Resolver\Parser\SyntaxException
     *
     * @return T
     */
    public function mapFromString(string $targetClass, string $yaml): object
    {
        $config = Yaml::parse($yaml);

        return $this->map($targetClass, $config);
    }

    /**
     * @throws Resolver\ArgumentResolverException
     * @throws Resolver\Parser\SyntaxException
     */
    private function getMappingConfig(ClassInfo $classInfo, ?array $config, $parentKey = null): array
    {
        $mappingConfig = [];

        if ($config === null) {

The condition $config === null is always false.

            $config = [];
        }

        foreach ($classInfo->getFields() as $field) {
            $fieldName = $field->getName();
            if (!array_key_exists($fieldName, $config)) {
                //Skip values that doesn't exist in config file but has a default values
                if (!$field->hasDefaultValueResolver()) {
                    continue;
                }

                //fallback to defaultValueResolver
                switch ($field->getDefaultValueResolver()) {
                    case DefaultValueResolver::PARENT_KEY:
                    {
                        $rawValue = $parentKey;
                        break;
                    }
                    case DefaultValueResolver::NESTED_LIST:
                    {
                        $rawValue = $config;
                        $config = [];
                        break;
                    }
                }
            } else {
                $rawValue = $config[$fieldName];
                unset($config[$fieldName]);
            }

            $mappingConfig[$fieldName] = $this->toArgumentResolver($field, $rawValue);

The variable $rawValue does not seem to be defined for all execution paths leading up to this point.

        }

        if (!empty($config) && !$classInfo->isIgnoreUnknown()) {
            throw new InvalidConfigPathException($config, $classInfo);
        }
        foreach ($config as $fieldName => $rawValue) {
            $mappingConfig[$fieldName] = $this->createArgumentResolverForPrimitive($rawValue);
        }

        return $mappingConfig;
    }


    /**
     * @param ClassField $field
     * @param mixed      $rawValue
     *
     * @throws Resolver\ArgumentResolverException
     * @throws Resolver\Parser\SyntaxException
     * @return ArgumentResolver
     */
    private function toArgumentResolver(ClassField $field, mixed $rawValue): ArgumentResolver
    {
        if ($field->isPrimitive()) {
            $argResolver = $this->createArgumentResolverForPrimitive($rawValue);
        } else if ($field->isList()) {
            $argResolver = new ListArgumentResolver($this->doMapList($field, $rawValue));
        } else {
            $argResolver = new InstanceArgumentResolver($field->getClassInfo(), $this->getMappingConfig($field->getClassInfo(), $rawValue, $field->newInstance()));

It seems like $field->getClassInfo() can also be of type null; however, parameter $classInfo of Diezz\YamlToObjectMapper\Mapper::getMappingConfig() does only seem to accept Diezz\YamlToObjectMapper\ClassInfo, maybe add an additional type check?

It seems like $field->getClassInfo() can also be of type null; however, parameter $classInfo of Diezz\YamlToObjectMapper\Resolver\InstanceArgumentResolver::__construct() does only seem to accept Diezz\YamlToObjectMapper\ClassInfo, maybe add an additional type check?

        }

        return $argResolver;
    }

    /**
     * @param ClassField $field
     * @param mixed      $rawValue
     *
     * @throws Resolver\ArgumentResolverException
     * @throws Resolver\Parser\SyntaxException
     * @return array
     */
    private function doMapList(ClassField $field, mixed $rawValue): array
    {
        $value = [];
        if ($field->isTypedCollection() && $field->getClassInfo() !== null) {
            foreach ($rawValue as $key => $item) {
                $value[] = new InstanceArgumentResolver($field->getClassInfo(), $this->getMappingConfig($field->getClassInfo(), $item, $key));
            }
        } else {
            $value = $this->doMapArray($rawValue);
        }

        return $value;
    }

    /**
     * @param mixed $rawValue
     *
     * @throws Resolver\Parser\SyntaxException
     * @return ArgumentResolver
     */
    private function createArgumentResolverForPrimitive(mixed $rawValue): ArgumentResolver
    {
        if (is_bool($rawValue) || is_int($rawValue) || is_array($rawValue)) {
            return new ScalarArgumentResolver($rawValue);
        }

        return $this->processExpression($rawValue);
    }

    /**
     * @throws Resolver\Parser\SyntaxException
     */
    private function processExpression(string $expression): ArgumentResolver
    {
        $parser = new Parser($expression);

        return $parser->parse()->toResolver($this->argumentResolverFactory);
    }

    /**
     * @throws Resolver\Parser\SyntaxException
     */
    private function doMapArray(array $array): array
    {
        $result = [];
        foreach ($array as $key => $value) {
            if (is_array($value)) {
                $result[$key] = $this->doMapArray($value);
            } else if (is_string($value)) {
                $result[$key] = $this->processExpression($value);
            } else {
                $result[$key] = new ScalarArgumentResolver($value);
            }
        }

        return $result;
    }

    private function validate(ClassInfo $classInfo, ?array $config, ?array $parent = [], ?ValidationResult $validationResult = null): ValidationResult
    {
        if (null === $validationResult) {
            $validationResult = new ValidationResult();
        }

        $pathFunction = static fn(array $path) => implode(".", $path);

        //Check for required fields
        foreach ($classInfo->getFields() as $field) {
            $fieldName = $field->getName();
            $isFieldExistsInConfig = $config !== null && array_key_exists($fieldName, $config);
            $isRequired = $field->isRequired();
            $path = $parent;
            $path[] = $fieldName;

            if ($isRequired && !$isFieldExistsInConfig) {
                if ($field->hasDefaultValueResolver()) {
                    $defaultValueResolver = $field->getDefaultValueResolver();
                    switch ($defaultValueResolver) {
                        case DefaultValueResolver::PARENT_KEY:
                            $parentKeyExists = !empty($parent);
                            if (!$parentKeyExists) {
                                $validationResult->addError($path, sprintf("Field '%s' is required but not found in the config file", $pathFunction($path)));
                            }
                            break;
                        case DefaultValueResolver::NESTED_LIST:
                            if (empty($config) || !is_array($config)) {
                                $validationResult->addError($path, sprintf("Field '%s' is required but not found in the config file", $pathFunction($path)));
                            }
                            break;
                    }
                } else {
                    $validationResult->addError($path, sprintf("Field '%s' is required but not found in the config file", $pathFunction($path)));
                    continue;
                }
            }

            if (null !== $field->getClassInfo()) {
                if ($field->isTypedCollection()) {
                    if ($isRequired === false && !$isFieldExistsInConfig) {
                        continue;
                    }
                    foreach ($config[$fieldName] as $key => $value) {
                        $path[] = $key;
                        $validationResult = $this->validate($field->getClassInfo(), $value, $path, $validationResult);
                    }
                } else {
                    $validationResult = $this->validate($field->getClassInfo(), $config[$fieldName], $path, $validationResult);
                }
            }
        }

        return $validationResult;
    }
}