nazonohito51 / dependency-analyzer

src/DependencyGraphBuilder.php

<?php
declare(strict_types=1);

namespace DependencyAnalyzer;

use DependencyAnalyzer\DependencyGraph\DependencyTypes\Base as DependencyType;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\ConstantFetch;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\ExtendsClass;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\ImplementsClass;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\MethodCall;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\NewObject;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\PropertyFetch;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\SomeDependency;
use DependencyAnalyzer\DependencyGraph\DependencyTypes\UseTrait;
use DependencyAnalyzer\DependencyGraph\ExtraPhpDocTags\DepsInternal;
use DependencyAnalyzer\DependencyGraph\ExtraPhpDocTags\Internal;
use DependencyAnalyzer\DependencyGraph\FullyQualifiedStructuralElementName;
use DependencyAnalyzer\DependencyGraphBuilder\ExtraPhpDocTagResolver;
use DependencyAnalyzer\DependencyGraphBuilder\ObserverInterface;
use DependencyAnalyzer\DependencyGraphBuilder\UnknownReflectionClass;
use DependencyAnalyzer\Exceptions\LogicException;
use Fhaculty\Graph\Graph;
use Fhaculty\Graph\Vertex;
use ReflectionClass;

class DependencyGraphBuilder
{
    /**
     * @var Graph
     */
    protected $graph;

    /**
     * @var ExtraPhpDocTagResolver
     */
    protected $extraPhpDocTagResolver;

    public function __construct(ExtraPhpDocTagResolver $extraPhpDocTagResolver)
    {
        $this->graph = new Graph;
        $this->extraPhpDocTagResolver = $extraPhpDocTagResolver;
    }

    public function setObserver(ObserverInterface $observer): void
    {
        $this->extraPhpDocTagResolver->setObserver($observer);
    }

    protected function getVertex(ReflectionClass $class): Vertex
    {
        $vertexId = FullyQualifiedStructuralElementName::createClass($class->getName())->toString();
        if ($this->graph->hasVertex($vertexId)) {
            return $this->graph->getVertex($vertexId);
        }

        $vertex = $this->graph->createVertex($vertexId);

$vertexId of type string is incompatible with the type integer|null expected by parameter $id of Fhaculty\Graph\Graph::createVertex().

        $vertex->setAttribute('reflection', $class);
        $vertex->setAttribute(DepsInternal::getTagName(), array_merge(
            $this->extraPhpDocTagResolver->resolveDepsInternalTag($class),
            $this->extraPhpDocTagResolver->resolveCanOnlyUsedByTag($class)
        ));
        $vertex->setAttribute(Internal::getTagName(), $this->extraPhpDocTagResolver->resolveInternalTag($class));

        return $vertex;
    }

    protected function getUnknownClassVertex(string $className): Vertex
    {
        $vertexId = FullyQualifiedStructuralElementName::createClass($className)->toString();
        if ($this->graph->hasVertex($vertexId)) {
            $vertex = $this->graph->getVertex($vertexId);
            if (!$vertex->getAttribute('reflection') instanceof UnknownReflectionClass) {
                throw new LogicException("{$className} is not UnknownClassReflection");
            }

            return $vertex;
        }

        $vertex = $this->graph->createVertex($vertexId);

$vertexId of type string is incompatible with the type integer|null expected by parameter $id of Fhaculty\Graph\Graph::createVertex().

        $vertex->setAttribute('reflection', new UnknownReflectionClass($className));
        $vertex->setAttribute(DepsInternal::getTagName(), []);
        $vertex->setAttribute(Internal::getTagName(), []);

        return $vertex;
    }

    protected function addDependencyType(Vertex $depender, Vertex $dependee, DependencyType $additional): void
    {
        if (count($edges = $depender->getEdgesTo($dependee)) === 0) {
            $depender->createEdgeTo($dependee);
        }

        $edge = $depender->getEdgesTo($dependee)->getEdgeFirst();
        $types = $edge->getAttribute(DependencyGraph::DEPENDENCY_TYPE_KEY) ?? [];

        foreach ($types as $type) {
            /** @var DependencyType $type */
            if ($type->isEqual($additional)) {
                return;
            }
        }

        $types[] = $additional;
        $edge->setAttribute(DependencyGraph::DEPENDENCY_TYPE_KEY, $types);
    }

    /**
     * @param ReflectionClass $dependerReflection
     * @param ReflectionClass $dependeeReflection
     */
    public function addDependency(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection): void
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new SomeDependency()
            );
        }
    }

    public function addUnknownDependency(ReflectionClass $dependerReflection, string $dependeeName)
    {
        $this->addDependencyType(
            $this->getVertex($dependerReflection),
            $this->getUnknownClassVertex($dependeeName),
            new SomeDependency()
        );
    }

    public function addNew(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection, string $caller = null)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new NewObject($caller)
            );
        }
    }

    public function addMethodCall(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection, string $callee, string $caller = null)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new MethodCall($callee, $caller)
            );
        }
    }

    public function addPropertyFetch(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection, string $propertyName, string $caller = null)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new PropertyFetch($propertyName, $caller)
            );
        }
    }

    public function addConstFetch(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection, string $constantName, string $caller = null)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new ConstantFetch($constantName, $caller)
            );
        }
    }

    public function addExtends(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new ExtendsClass()
            );
        }
    }

    public function addImplements(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new ImplementsClass()
            );
        }
    }

    public function addUseTrait(ReflectionClass $dependerReflection, ReflectionClass $dependeeReflection)
    {
        if ($dependerReflection->getName() !== $dependeeReflection->getName()) {
            $this->addDependencyType(
                $this->getVertex($dependerReflection),
                $this->getVertex($dependeeReflection),
                new UseTrait()
            );
        }
    }

    public function build(): DependencyGraph
    {
        return new DependencyGraph($this->graph);
    }
}