FakerDataFiller::getObject() - Code Metrics - Inspection of "Mess detector fixes" - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#214)

by joseph
created 2019-08-14 10:39 UTC
FakerDataFiller::getObject() A

↳ Parent: FakerDataFiller
Complexity

Conditions	1
Paths	1
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	7
nc	1
nop	0
dl	0
loc	10
ccs	0
cts	8
cp	0
crap	2
rs	10
c	0
b	0
f	0
<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Entity\Testing\EntityGenerator;

use Closure;
use Doctrine\Common\Collections\Collection;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\Mapping\MappingException;
use EdmondsCommerce\DoctrineStaticMeta\CodeGeneration\NamespaceHelper;
use EdmondsCommerce\DoctrineStaticMeta\DoctrineStaticMeta;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Interfaces\DataTransferObjectInterface;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Testing\EntityGenerator\Faker\ColumnTypeGuesser;
use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
use Faker;
use Faker\Guesser\Name;
use InvalidArgumentException;
use ReflectionException;
use ReflectionMethod;
use RuntimeException;
use ts\Reflection\ReflectionClass;
use function get_class;
use function is_callable;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 *
 */
class FakerDataFiller implements FakerDataFillerInterface
{
    public const DEFAULT_SEED = 688377.0;
    /**
     * @var Faker\Generator
     */
    private static $generator;
    /**
     * These two are used to keep track of unique fields and ensure we dont accidently make apply none unique values
     *
     * @var array
     */
    private static $uniqueStrings = [];
    /**
     * @var int
     */
    private static $uniqueInt;
    /**
     * @var array
     */
    private static $processedDtos = [];
    /**
     * An array of fieldNames to class names that are to be instantiated as column formatters as required
     *
     * @var array|string[]
     */
    private $fakerDataProviderClasses;
    /**
     * A cache of instantiated column data providers
     *
     * @var array
     */
    private $fakerDataProviderObjects = [];
    /**
     * @var array
     */
    private $columnFormatters;
    /**
     * @var DoctrineStaticMeta
     */
    private $testedEntityDsm;
    /**
     * @var Name
     */
    private $nameGuesser;
    /**
     * @var ColumnTypeGuesser
     */
    private $columnTypeGuesser;
    /**
     * @var NamespaceHelper
     */
    private $namespaceHelper;
    /**
     * @var FakerDataFillerFactory
     */
    private $fakerDataFillerFactory;

    public function __construct(
        FakerDataFillerFactory $fakerDataFillerFactory,
        DoctrineStaticMeta $testedEntityDsm,
        NamespaceHelper $namespaceHelper,
        array $fakerDataProviderClasses,
        ?float $seed = null
    ) {
        $this->initFakerGenerator($seed);
        $this->testedEntityDsm          = $testedEntityDsm;
        $this->fakerDataProviderClasses = $fakerDataProviderClasses;
        $this->nameGuesser              = new Name(self::$generator);
        $this->columnTypeGuesser        = new ColumnTypeGuesser(self::$generator);
        $this->namespaceHelper          = $namespaceHelper;
        $this->checkFakerClassesRootNamespaceMatchesEntityFqn(
            $this->testedEntityDsm->getReflectionClass()->getName()
        );
        $this->generateColumnFormatters();
        $this->fakerDataFillerFactory = $fakerDataFillerFactory;
    }


    /**
     * @param float|null $seed
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    private function initFakerGenerator(?float $seed): void
    {
        if (null === self::$generator) {
            self::$generator = Faker\Factory::create();
        }
        self::$generator->seed($seed ?? self::DEFAULT_SEED);
    }

    private function checkFakerClassesRootNamespaceMatchesEntityFqn(string $fakedEntityFqn): void
    {
        if ([] === $this->fakerDataProviderClasses) {
            return;
        }
        $projectRootNamespace = null;
        foreach (array_keys($this->fakerDataProviderClasses) as $classField) {
            if (false === \ts\stringContains($classField, '-')) {
                continue;
            }
            list($entityFqn,) = explode('-', $classField);
            $rootNamespace = $this->namespaceHelper->getProjectNamespaceRootFromEntityFqn($entityFqn);
            if (null === $projectRootNamespace) {
                $projectRootNamespace = $rootNamespace;
                continue;
            }
            if ($rootNamespace !== $projectRootNamespace) {
                throw new RuntimeException(
                    'Found unexpected root namespace ' .
                    $rootNamespace .
                    ', expecting ' .
                    $projectRootNamespace .
                    /** @scrutinizer ignore-type */ $projectRootNamespace .
                    ', do we have mixed fakerProviderClasses? ' .
                    print_r($this->fakerDataProviderClasses, true)
                );
            }
        }
        if (null === $projectRootNamespace) {
            return;
        }
        $fakedEntityRootNamespace = $this->namespaceHelper->getProjectNamespaceRootFromEntityFqn($fakedEntityFqn);
        if ($fakedEntityRootNamespace === $projectRootNamespace) {
            return;
        }
        throw new RuntimeException('Faked entity FQN ' .
                                   $fakedEntityFqn .
                                   ' project root namespace does not match the faker classes root namespace ' .
                                   $projectRootNamespace);
    }

    /**
     * @throws MappingException
     */
    private function generateColumnFormatters(): void
    {
        $entityFqn  = $this->testedEntityDsm->getReflectionClass()->getName();
        $meta       = $this->testedEntityDsm->getMetaData();
        $fieldNames = $meta->getFieldNames();
        foreach ($fieldNames as $fieldName) {
            if (isset($this->columnFormatters[$fieldName])) {
                continue;
            }
            if (true === $this->addFakerDataProviderToColumnFormatters($fieldName, $entityFqn)) {
                continue;
            }
            $fieldMapping = $meta->getFieldMapping($fieldName);
            if (true === ($fieldMapping['unique'] ?? false)) {
                $this->addUniqueColumnFormatter($fieldMapping, $fieldName);
                continue;
            }
        }
        $this->guessMissingColumnFormatters();
    }

    /**
     * Add a faker data provider to the columnFormatters array (by reference) if there is one available
     *
     * Handles instantiating and caching of the data providers
     *
     * @param string $fieldName
     *
     * @param string $entityFqn
     *
     * @return bool
     */
    private function addFakerDataProviderToColumnFormatters(
        string $fieldName,
        string $entityFqn
    ): bool {
        foreach ([
                     $entityFqn . '-' . $fieldName,
                     $fieldName,
                 ] as $key) {
            if (!isset($this->fakerDataProviderClasses[$key])) {
                continue;
            }
            if (!isset($this->fakerDataProviderObjects[$key])) {
                $class                                = $this->fakerDataProviderClasses[$key];
                $this->fakerDataProviderObjects[$key] = new $class(self::$generator);
            }
            $this->columnFormatters[$fieldName] = $this->fakerDataProviderObjects[$key];

            return true;
        }

        return false;
    }

    private function addUniqueColumnFormatter(array &$fieldMapping, string $fieldName): void
    {
        switch ($fieldMapping['type']) {
            case MappingHelper::TYPE_UUID:
            case MappingHelper::TYPE_NON_ORDERED_BINARY_UUID:
            case MappingHelper::TYPE_NON_BINARY_UUID:
                return;
            case MappingHelper::TYPE_STRING:
                $this->columnFormatters[$fieldName] = function () {
                    return $this->getUniqueString();
                };
                break;
            case MappingHelper::TYPE_INTEGER:
            case Type::BIGINT:
                $this->columnFormatters[$fieldName] = function () {
                    return $this->getUniqueInt();
                };
                break;
            default:
                throw new InvalidArgumentException('unique field has an unsupported type: '
                                                   . print_r($fieldMapping, true));
        }
    }

    private function getUniqueString(): string
    {
        $string = 'unique string: ' . $this->getUniqueInt() . md5((string)time());
        while (isset(self::$uniqueStrings[$string])) {
            $string                       = md5((string)time());
            self::$uniqueStrings[$string] = true;
        }

        return $string;
    }

    private function getUniqueInt(): int
    {
        return ++self::$uniqueInt;
    }

    /**
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     */
    private function guessMissingColumnFormatters(): void
    {

        $meta = $this->testedEntityDsm->getMetaData();
        foreach ($meta->getFieldNames() as $fieldName) {
            if (isset($this->columnFormatters[$fieldName])) {
                continue;
            }
            if ($meta->isIdentifier($fieldName) || !$meta->hasField($fieldName)) {
                continue;
            }
            if (false !== \ts\stringContains($fieldName, '.')) {
                continue;
            }
            if (null === $this->testedEntityDsm->getSetterNameFromPropertyName($fieldName)) {
                continue;
            }

            $size = $meta->fieldMappings[$fieldName]['length'] ?? null;
            if (null !== $formatter = $this->guessByName($fieldName, $size)) {
                $this->columnFormatters[$fieldName] = $formatter;
                continue;
            }
            if (null !== $formatter = $this->columnTypeGuesser->guessFormat($fieldName, $meta)) {
                $this->columnFormatters[$fieldName] = $formatter;
                continue;
            }
            if (MappingHelper::TYPE_ARRAY === $meta->fieldMappings[$fieldName]['type']) {
                $this->columnFormatters[$fieldName] = $this->getArray();
            }
            if (MappingHelper::TYPE_OBJECT === $meta->fieldMappings[$fieldName]['type']) {
                $this->columnFormatters[$fieldName] = $this->getObject();
            }
        }
    }

    private function guessByName(string $fieldName, ?int $size): ?Closure
    {
        $formatter = $this->nameGuesser->guessFormat($fieldName, $size);
        if (null !== $formatter) {

            return $formatter;
        }
        if (false !== \ts\stringContains($fieldName, 'email')) {
            return static function () {
                return self::$generator->email;
            };
        }

        return null;
    }

    /**
     * Json should not be a string, it should be data that is then encoded to Json by the Json Type
     *
     * @return callable
     * @see \Doctrine\DBAL\Types\JsonType::convertToDatabaseValue
     */
    private function getArray(): callable
    {
        return static function () {
            $toEncode                     = [];
            $toEncode['string']           = self::$generator->text;
            $toEncode['float']            = self::$generator->randomFloat();
            $toEncode['nested']['string'] = self::$generator->text;
            $toEncode['nested']['float']  = self::$generator->randomFloat();

            return $toEncode;
        };
    }

    private function getObject(): callable
    {
        return static function () {
            $toEncode                 = new \stdClass();
            $toEncode->string         = self::$generator->text;
            $toEncode->float          = self::$generator->randomFloat();
            $toEncode->nested->string = self::$generator->text;
            $toEncode->nested->float  = self::$generator->randomFloat();

            return $toEncode;
        };
    }

    public function updateDtoWithFakeData(DataTransferObjectInterface $dto): void
    {
        $this->update($dto, true);
    }

    /**
     * @param DataTransferObjectInterface $dto
     * @param bool                        $isRootDto
     *
     * @throws ReflectionException
     * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
     */
    public function update(DataTransferObjectInterface $dto, $isRootDto = false): void
    {
        if (true === $isRootDto) {
            self::$processedDtos = [];
        }
        if (true === $this->processed($dto)) {
            return;
        }

        $dtoHash                       = spl_object_hash($dto);
        self::$processedDtos[$dtoHash] = true;
        $this->updateFieldsWithFakeData($dto);
        $this->updateNestedDtosWithFakeData($dto);
    }

    private function processed(DataTransferObjectInterface $dto): bool
    {
        return array_key_exists(spl_object_hash($dto), self::$processedDtos);
    }

    private function updateFieldsWithFakeData(DataTransferObjectInterface $dto): void
    {
        if (null === $this->columnFormatters) {
            return;
        }
        foreach ($this->columnFormatters as $field => $formatter) {
            if (null === $formatter) {
                continue;
            }
            try {
                $value  = is_callable($formatter) ? $formatter($dto) : $formatter;
                $setter = 'set' . $field;
                $dto->$setter($value);
            } catch (InvalidArgumentException $ex) {
                throw new InvalidArgumentException(
                    sprintf(
                        'Failed to generate a value for %s::%s: %s',
                        get_class($dto),
                        $field,
                        $ex->getMessage()
                    )
                );
            }
        }
    }

    /**
     * @param DataTransferObjectInterface $dto
     *
     * @throws ReflectionException
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     */
    private function updateNestedDtosWithFakeData(DataTransferObjectInterface $dto): void
    {
        $reflection = new ReflectionClass(get_class($dto));

        $reflectionMethods = $reflection->getMethods(ReflectionMethod::IS_PUBLIC);
        foreach ($reflectionMethods as $reflectionMethod) {
            $reflectionMethodReturnType = $reflectionMethod->getReturnType();
            if (null === $reflectionMethodReturnType) {
                continue;
            }
            $returnTypeName = $reflectionMethodReturnType->getName();
            $methodName     = $reflectionMethod->getName();
            if (false === \ts\stringStartsWith($methodName, 'get')) {
                continue;
            }
            if (substr($returnTypeName, -3) === 'Dto') {
                $isDtoMethod = 'isset' . substr($methodName, 3, -3) . 'AsDto';
                if (false === $dto->$isDtoMethod()) {
                    continue;
                }
                $got = $dto->$methodName();
                if ($got instanceof DataTransferObjectInterface) {
                    $this->updateNestedDtoUsingNewFakerFiller($got);
                }
                continue;
            }
            if ($returnTypeName === Collection::class) {
                /**
                 * @var Collection
                 */
                $collection = $dto->$methodName();
                foreach ($collection as $got) {
                    if ($got instanceof DataTransferObjectInterface) {
                        $this->updateNestedDtoUsingNewFakerFiller($got);
                    }
                }
                continue;
            }
        }
    }

    /**
     * Get an instance of the Faker filler for this DTO, but do not regard it as root
     *
     * @param DataTransferObjectInterface $dto
     */
    private function updateNestedDtoUsingNewFakerFiller(DataTransferObjectInterface $dto): void
    {
        $dtoFqn = get_class($dto);
        $this->fakerDataFillerFactory
            ->getInstanceFromDataTransferObjectFqn($dtoFqn)
            ->update($dto, false);
    }
}

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Pull Request — master (#214)

FakerDataFiller::getObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
