Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt\UseStmtPrefixer

Complexity

Total Complexity

15

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	findUseType()	0	10	2
A	__construct()	0	5	1
A	enterNode()	0	13	3
A	shouldPrefixConstantUseStmt()	0	9	3
A	shouldPrefixUseStmt()	0	27	6

<?php

declare(strict_types=1);

/*
 * This file is part of the humbug/php-scoper package.
 *
 * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
 *                    Pádraic Brady <padraic.brady@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt;

use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
use Humbug\PhpScoper\Reflector;
use Humbug\PhpScoper\Whitelist;
use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\Stmt\UseUse;
use PhpParser\NodeVisitorAbstract;
use function count;

/**
 * Prefixes the use statements.
 *
 * @private
 */
final class UseStmtPrefixer extends NodeVisitorAbstract
{
    private string $prefix;
    private Whitelist $whitelist;
    private Reflector $reflector;

    public function __construct(string $prefix, Whitelist $whitelist, Reflector $reflector)
    {
        $this->prefix = $prefix;
        $this->reflector = $reflector;
        $this->whitelist = $whitelist;
    }

    public function enterNode(Node $node): Node
    {
        if ($node instanceof UseUse && $this->shouldPrefixUseStmt($node)) {
            $previousName = $node->name;

            /** @var Name $prefixedName */
            $prefixedName = Name::concat($this->prefix, $node->name, $node->name->getAttributes());
            $node->name = $prefixedName;

            UseStmtManipulator::setOriginalName($node, $previousName);
        }

        return $node;
    }

    private function shouldPrefixUseStmt(UseUse $use): bool
    {
        $useType = $this->findUseType($use);

        // If is already from the prefix namespace
        if ($this->prefix === $use->name->getFirst()) {
            return false;
        }

        // If is whitelisted
        if ($this->whitelist->belongsToWhitelistedNamespace((string) $use->name)) {
            return false;
        }

        if (Use_::TYPE_FUNCTION === $useType) {
            return false === $this->reflector->isFunctionInternal((string) $use->name);
        }

        if (Use_::TYPE_CONSTANT === $useType) {
            return self::shouldPrefixConstantUseStmt(
                $use->name->toString(),
                $this->whitelist,
                $this->reflector,
            );
        }

        return Use_::TYPE_NORMAL !== $useType || false === $this->reflector->isClassInternal((string) $use->name);
    }

    private static function shouldPrefixConstantUseStmt(
        string $name,
        Whitelist $whitelist,
        Reflector $reflector
    ): bool
    {
        return !$whitelist->isGlobalWhitelistedConstant($name)
            && !$whitelist->isSymbolWhitelisted($name)
            && !$reflector->isConstantInternal($name);
    }

    /**
     * Finds the type of the use statement.
     *
     * @param UseUse $use
     *
     * @return int See \PhpParser\Node\Stmt\Use_ type constants.
     */
    private function findUseType(UseUse $use): int
    {
        if (Use_::TYPE_UNKNOWN === $use->type) {
            /** @var Use_ $parentNode */
            $parentNode = ParentNodeAppender::getParent($use);

            return $parentNode->type;
        }

        return $use->type;
    }
}