Entities::normalizeNames() - Code Metrics - Inspection of "Deprecate `though`, add `through` annotation stubs" - cycle/annotated - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#20)

unknown
created 2021-07-14 07:26 UTC
Entities::normalizeNames() C

↳ Parent: Entities
Complexity

Conditions	13
Paths	205
Size

Total Lines	61
Code Lines	34
Duplication

Lines	0
Ratio	0 %
Importance

Changes	3
Bugs	1	Features	0
Metric	Value
eloc	34
c	3
b	1
f	0
dl	0
loc	61
rs	5.7208
cc	13
nc	205
nop	1
How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace Cycle\Annotated;

use Cycle\Annotated\Annotation\Entity;
use Cycle\Annotated\Exception\AnnotationException;
use Cycle\Schema\Definition\Entity as EntitySchema;
use Cycle\Schema\Exception\RegistryException;
use Cycle\Schema\Exception\RelationException;
use Cycle\Schema\GeneratorInterface;
use Cycle\Schema\Registry;
use Doctrine\Common\Annotations\Reader as DoctrineReader;
use Doctrine\Inflector\Inflector;
use Doctrine\Inflector\Rules\English\InflectorFactory;
use Spiral\Attributes\ReaderInterface;
use Spiral\Tokenizer\ClassesInterface;

/**
 * Generates ORM schema based on annotated classes.
 */
final class Entities implements GeneratorInterface
{
    // table name generation
    public const TABLE_NAMING_PLURAL   = 1;
    public const TABLE_NAMING_SINGULAR = 2;
    public const TABLE_NAMING_NONE     = 3;

    /** @var ClassesInterface */
    private $locator;

    /** @var ReaderInterface */
    private $reader;

    /** @var Configurator */
    private $generator;

    /** @var int */
    private $tableNaming;

    /** @var Inflector */
    private $inflector;

    /**
     * @param ClassesInterface $locator
     * @param object<ReaderInterface|DoctrineReader>|null $reader
     * @param int $tableNaming
     */
    public function __construct(
        ClassesInterface $locator,
        object $reader = null,
        int $tableNaming = self::TABLE_NAMING_PLURAL
    ) {
        $this->locator = $locator;
        $this->reader = ReaderFactory::create($reader);
        $this->generator = new Configurator($this->reader);
        $this->tableNaming = $tableNaming;
        $this->inflector = (new InflectorFactory())->build();
    }

    /**
     * @param Registry $registry
     * @return Registry
     */
    public function run(Registry $registry): Registry
    {
        /** @var EntitySchema[] $children */
        $children = [];
        foreach ($this->locator->getClasses() as $class) {
            try {
                /** @var Entity $ann */
                $ann = $this->reader->firstClassMetadata($class, Entity::class);
            } catch (\Exception $e) {
                throw new AnnotationException($e->getMessage(), $e->getCode(), $e);
            }

            if ($ann === null) {
                continue;
            }

            $e = $this->generator->initEntity($ann, $class);

            // columns
            $this->generator->initFields($e, $class);

            // relations
            $this->generator->initRelations($e, $class);

            // additional columns (mapped to local fields automatically)
            $this->generator->initColumns($e, $ann->getColumns(), $class);

            if ($this->hasParent($registry, $e->getClass())) {
            if ($this->hasParent($registry, /** @scrutinizer ignore-type */ $e->getClass())) {
                $children[] = $e;
                continue;
            }

            // register entity (OR find parent)
            $registry->register($e);

            $registry->linkTable(
                $e,
                $ann->getDatabase(),
                $ann->getTable() ?? $this->tableName($e->getRole())
            );
        }

        foreach ($children as $e) {
            $registry->registerChild($registry->getEntity($this->findParent($registry, $e->getClass())), $e);
            $registry->registerChild($registry->getEntity(/** @scrutinizer ignore-type */ $this->findParent($registry, $e->getClass())), $e);
        }

        return $this->normalizeNames($registry);
    }

    /**
     * @param Registry $registry
     * @return Registry
     */
    protected function normalizeNames(Registry $registry): Registry
    {
        // resolve all the relation target names into roles
        foreach ($this->locator->getClasses() as $class) {
            if (!$registry->hasEntity($class->getName())) {
                continue;
            }

            $e = $registry->getEntity($class->getName());

            // relations
            foreach ($e->getRelations() as $name => $r) {
                try {
                    $r->setTarget($this->resolveTarget($registry, $r->getTarget()));

                    if ($r->getOptions()->has('though')) {
                        $though = $r->getOptions()->get('though');
                        if ($though !== null) {
                            $r->getOptions()->set(
                                'though',
                                $this->resolveTarget($registry, $though)
                            );
                        }
                    }

                    if ($r->getOptions()->has('through')) {
                        $through = $r->getOptions()->get('through');
                        if ($through !== null) {
                            $r->getOptions()->set(
                                'through',
                                $this->resolveTarget($registry, $through)
                            );
                        }
                    }

                    if ($r->getOptions()->has('throughInnerKey')) {
                        if ($throughInnerKey = (array)$r->getOptions()->get('throughInnerKey')) {
                            $r->getOptions()->set('throughInnerKey', $throughInnerKey[0]);
                        }
                    }

                    if ($r->getOptions()->has('throughOuterKey')) {
                        if ($throughOuterKey = (array)$r->getOptions()->get('throughOuterKey')) {
                            $r->getOptions()->set('throughOuterKey', $throughOuterKey[0]);
                        }
                    }
                } catch (RegistryException $ex) {
                    throw new RelationException(
                        sprintf(
                            'Unable to resolve `%s`.`%s` relation target (not found or invalid)',
                            $e->getRole(),
                            $name
                        ),
                        $ex->getCode(),
                        $ex
                    );
                }
            }
        }

        return $registry;
    }

    /**
     * @param Registry $registry
     * @param string   $name
     * @return string|null
     */
    protected function resolveTarget(Registry $registry, string $name): ?string
    {
        if (is_null($name) || interface_exists($name, true)) {
            // do not resolve interfaces
            return $name;
        }

        if (!$registry->hasEntity($name)) {
            // point all relations to the parent
            foreach ($registry as $entity) {
                foreach ($registry->getChildren($entity) as $child) {
                    if ($child->getClass() === $name || $child->getRole() === $name) {
                        return $entity->getRole();
                    }
                }
            }
        }

        return $registry->getEntity($name)->getRole();
    }

    /**
     * @param string $role
     * @return string
     */
    protected function tableName(string $role): string
    {
        $table = $this->inflector->tableize($role);

        switch ($this->tableNaming) {
            case self::TABLE_NAMING_PLURAL:
                return $this->inflector->pluralize($this->inflector->tableize($role));

            case self::TABLE_NAMING_SINGULAR:
                return $this->inflector->singularize($this->inflector->tableize($role));

            default:
                return $table;
        }
    }

    /**
     * @param Registry $registry
     * @param string   $class
     * @return bool
     */
    protected function hasParent(Registry $registry, string $class): bool
    {
        return $this->findParent($registry, $class) !== null;
    }

    /**
     * @param Registry $registry
     * @param string   $class
     * @return string|null
     */
    protected function findParent(Registry $registry, string $class): ?string
    protected function findParent(/** @scrutinizer ignore-unused */ Registry $registry, string $class): ?string
    {
        $parents = class_parents($class);

        foreach (array_reverse($parents) as $parent) {
            try {
                $class = new \ReflectionClass($parent);
            } catch (\ReflectionException $e) {
                continue;
            }

            if ($class->getDocComment() === false) {
                continue;
            }

            $ann = $this->reader->firstClassMetadata($class, Entity::class);
            if ($ann !== null) {
                return $parent;
            }
        }

        return null;
    }
}

cycle / annotated

Pull Request — master (#20)

Entities::normalizeNames() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
