koriym / Ray.Aop

src/Compiler.php

<?php

declare(strict_types=1);

namespace Ray\Aop;

use Doctrine\Common\Annotations\AnnotationException;
use ParseError;
use Ray\Aop\Exception\CompilationFailedException;
use Ray\Aop\Exception\NotWritableException;
use ReflectionClass;

This use statement conflicts with another class in this namespace, Ray\Aop\ReflectionClass. Consider defining an alias.

use function array_keys;
use function assert;
use function class_exists;
use function file_exists;
use function file_put_contents;
use function is_writable;
use function method_exists;
use function sprintf;
use function str_replace;

use const PHP_VERSION_ID;

final class Compiler implements CompilerInterface
{
    /** @var string */
    public $classDir;

    /** @throws AnnotationException */
    public function __construct(string $classDir)
    {
        if (! is_writable($classDir)) {
            throw new NotWritableException($classDir);
        }

        $this->classDir = $classDir;
    }

    /**
     * {@inheritDoc}
     *
     * @template T of object
     */
    public function newInstance(string $class, array $args, BindInterface $bind)
    {
        $compiledClass = $this->compile($class, $bind);
        assert(class_exists($compiledClass));
        $instance = (new ReflectionClass($compiledClass))->newInstanceArgs($args);
        if (isset($instance->bindings)) {
            $instance->bindings = $bind->getBindings();
        }

        assert($instance instanceof $class);

        return $instance;

The expression return $instance also could return the type object which includes types incompatible with the return type mandated by Ray\Aop\CompilerInterface::newInstance() of Ray\Aop\T. Consider adding a type-check to rule them out.

    }

    /**
     * {@inheritDoc}
     */
    public function compile(string $class, BindInterface $bind): string
    {
        if ($this->hasNoBinding($class, $bind)) {
            return $class;
        }

        $className = new AopPostfixClassName($class, (string) $bind, $this->classDir);
        if (class_exists($className->fqn, false)) {
            return $className->fqn;
        }

        try {
            $this->requireFile($className, new ReflectionClass($class), $bind);
            // @codeCoverageIgnoreStart
        } catch (ParseError $e) {
            $msg = sprintf('class:%s Compilation failed in Ray.Aop. This is most likely a bug in Ray.Aop, please report it to the issue. https://github.com/ray-di/Ray.Aop/issues', $class);

            throw new CompilationFailedException($msg);
            // @codeCoverageIgnoreEnd
        }

        return $className->fqn;
    }

    /** @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());
        $hasMethod = false;
        foreach ($bindingMethods as $bindingMethod) {
            if (! method_exists($class, $bindingMethod)) {
                continue;
            }

            $hasMethod = true;
        }

        return $hasMethod;
    }

    /** @param ReflectionClass<object> $sourceClass */
    private function requireFile(AopPostfixClassName $className, ReflectionClass $sourceClass, BindInterface $bind): void
    {
        $file = $this->getFileName($className->fqn);
        if (! file_exists($file)) {
            $code = new AopCode(new MethodSignatureString(PHP_VERSION_ID));
            $aopCode = $code->generate($sourceClass, $bind, $className->postFix);
            file_put_contents($file, $aopCode);
        }

        require_once $file;
        class_exists($className->fqn); // ensure class is created
    }

    private function getFileName(string $aopClassName): string
    {
        $flatName = str_replace('\\', '_', $aopClassName);

        return sprintf('%s/%s.php', $this->classDir, $flatName);
    }
}