ray-di / Ray.Di

src/di/SpyCompiler.php

<?php

declare(strict_types=1);

namespace Ray\Di;

use LogicException;
use Ray\Aop\BindInterface;
use Ray\Aop\CompilerInterface;

use function array_keys;
use function implode;
use function method_exists;
use function sprintf;

/**
 * @codeCoverageIgnore
 */
final class SpyCompiler implements CompilerInterface
{
    /**
     * {@inheritDoc}
     *
     * @phpstan-return never
     *
     * @psalm-suppress InvalidReturnType
     * @template T of object
     */
    public function newInstance(string $class, array $args, BindInterface $bind)
    {
        // never called
        throw new LogicException('SpyCompiler::newInstance() should never be called');
    }

    /**
     * Return "logging" class name
     *
     * Dummy classes are used for logging and don't really exist.
     * So the code breaks the QA rules as shown below.
     * NOTE: psalm-suppress is acceptable here for dummy/logging infrastructure
     *
     * @psalm-suppress MoreSpecificReturnType
     * @psalm-suppress LessSpecificReturnStatement
     */
    public function compile(string $class, BindInterface $bind): string
    {
        if ($this->hasNoBinding($class, $bind)) {
            return $class;
        }

        return $class . $this->getInterceptors($bind); // @phpstan-ignore-line
    }

    /**
     * @param class-string $class

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

     */
    private function hasNoBinding(string $class, BindInterface $bind): bool
    {
        $hasMethod = $this->hasBoundMethod($class, $bind);

        return ! $bind->getBindings() && ! $hasMethod;
    }

    /**
     * @param class-string $class

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

     */
    private function hasBoundMethod(string $class, BindInterface $bind): bool
    {
        $bindingMethods = array_keys($bind->getBindings());

$bind->getBindings() of type Ray\Aop\MethodBindings is incompatible with the type array expected by parameter $array of array_keys().

        $hasMethod = false;
        foreach ($bindingMethods as $bindingMethod) {
            if (method_exists($class, $bindingMethod)) {
                $hasMethod = true;
            }
        }

        return $hasMethod;
    }

    private function getInterceptors(BindInterface $bind): string
    {
        $bindings = $bind->getBindings();
        if (! $bindings) {

$bindings is of type Ray\Aop\MethodBindings, thus it always evaluated to true.

            return ''; // @codeCoverageIgnore
        }

        $log = ' (aop)';
        foreach ($bindings as $method => $interceptors) {
            /**
             * @phpstan-var array<string> $interceptors
             * @psalm-ignore-var
             */
            $log .= sprintf(
                ' +%s(%s)',
                $method,
                implode(', ', $interceptors)
            );
        }

        return $log;
    }
}