Supports AOP targeting PHP 8.2 readonly classes

src-php8/Php82InterceptTrait.php → src-php8/ReadOnlyInterceptTrait.php

@@ -12,16 +12,16 @@
  * @psalm-import-type MethodBindings from Types
  * @psalm-import-type Arguments from Types
  */
-trait Php82InterceptTrait
+trait ReadOnlyInterceptTrait
 {
     private readonly InterceptTraitState $_state;
 
     /**
      * @param MethodBindings $bindings
      *
-     * @see WeavedInterface::_initState()
+     * @see WeavedInterface::_setBindings()
      */
-    public function _initState(array $bindings): void
+    public function _setBindings(array $bindings): void
     {
         $this->_state = new InterceptTraitState($bindings);
     }

src/AopCode.php

@@ -139,7 +139,7 @@ private function parseClass(ReflectionClass $sourceClass, string $postfix): void
 
             $isClassSignatureEnds = $inClass && $text === '{';
             if ($isClassSignatureEnds) {
-                $this->addIntercepterTrait();
+                $this->resolveInterceptTrait($sourceClass);
 
                 return;
             }
@@ -201,11 +201,15 @@ private function addMethods(ReflectionClass $class, BindInterface $bind): void
     }
 
     /** @psalm-external-mutation-free */
-    private function addIntercepterTrait(): void
+    private function addInterceporTrait(): void
     {
-        PHP_VERSION_ID >= 80200
-            ? $this->add(sprintf("{\n    use \%s;\n}\n", Php82InterceptTrait::class))
-            : $this->add(sprintf("{\n    use \%s;\n}\n", InterceptTrait::class));
+        $this->add(sprintf("{\n    use \%s;\n}\n", InterceptTrait::class));
+    }
+
+    /** @psalm-external-mutation-free */
+    private function addReadOnlyInterceptorTrait(): void
+    {
+        $this->add(sprintf("{\n    use \%s;\n}\n", ReadOnlyInterceptTrait::class));
     }
 
     /** @psalm-external-mutation-free */
@@ -219,4 +223,16 @@ private function getCodeText(): string
 
         return $this->code;
     }
+
+    /** @param ReflectionClass<object> $sourceClass */
+    public function resolveInterceptTrait(ReflectionClass $sourceClass): void
+    {
+        if (PHP_VERSION_ID >= 80200 && $sourceClass->isReadOnly()) {
+            $this->addReadOnlyInterceptorTrait();
+
+            return;
+        }
+
+        $this->addInterceporTrait();
+    }
 }

src/Compiler.php

@@ -65,7 +65,7 @@ public function newInstance(string $class, array $args, BindInterface $bind): ob
         assert(class_exists($compiledClass));
         $instance = (new ReflectionClass($compiledClass))->newInstanceArgs($args);
         if ($instance instanceof WeavedInterface) {
-            $instance->_initState($bind->getBindings());
+            $instance->_setBindings($bind->getBindings());
         }
 
         assert($instance instanceof $class);

src/InterceptTrait.php

@@ -12,21 +12,24 @@
 trait InterceptTrait
 {
     /**
-     * @var InterceptTraitState
+     * @var MethodBindings
      * @readonly
-     * @psalm-suppress MissingConstructor
+     * @deprecated Do not use this property directly. Use the `_setBindings` setter method instead for initialization.
      */
-    private $_state;
+    public $bindings = [];
+
+    /** @var bool Flag controlling whether aspect interception is active */
+    private $_isAspect = true;
 
     /**
      * @param MethodBindings $bindings
      *
-     * @see WeavedInterface::_initState()
+     * @see WeavedInterface::_setBindings()
      * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    public function _initState(array $bindings): void // phpcs:ignore
+    public function _setBindings(array $bindings): void // @phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
     {
-        $this->_state = new InterceptTraitState($bindings);
+        $this->bindings = $bindings;
     }
 
     /**
@@ -38,15 +41,15 @@ public function _initState(array $bindings): void // phpcs:ignore
      */
     private function _intercept(string $func, array $args) // phpcs:ignore
     {
-        if (! $this->_state->isAspect) {
-            $this->_state->isAspect = true;
+        if (! $this->_isAspect) {
+            $this->_isAspect = true;
 
             return call_user_func_array([parent::class, $func], $args);
         }
 
-        $this->_state->isAspect = false;
-        $result = (new Invocation($this, $func, $args, $this->_state->bindings[$func]))->proceed();
-        $this->_state->isAspect = true;
+        $this->_isAspect = false;
+        $result = (new Invocation($this, $func, $args, $this->bindings[$func]))->proceed();
+        $this->_isAspect = true;
 
         return $result;
     }

src/InterceptTraitState.php

@@ -13,7 +13,7 @@ final class InterceptTraitState
      */
     public $bindings;
 
-    /** @var bool */
+    /** @var bool Flag controlling whether aspect interception is active */
     public $isAspect = true;
 
     /** @param MethodBindings $bindings */

src/WeavedInterface.php

@@ -12,5 +12,5 @@ interface WeavedInterface
      *
      * @SuppressWarnings(PHPMD.CamelCaseMethodName)
      */
-    public function _initState(array $bindings): void; // phpcs:ignore
+    public function _setBindings(array $bindings): void; // phpcs:ignore
 }

src/Weaver.php

@@ -62,7 +62,7 @@ public function newInstance(string $class, array $args): object
             return $instance;
         }
 
-        $instance->_initState($this->bind->getBindings());
+        $instance->_setBindings($this->bind->getBindings());
         assert($instance instanceof $class);
 
         return $instance;

tests/CompilerTest.php

@@ -21,7 +21,6 @@
 use function class_exists;
 use function file_get_contents;
 use function passthru;
-use function property_exists;
 use function serialize;
 use function unserialize;
 
@@ -115,7 +114,6 @@ public function testParentMethodIntercept(): void
     {
         $mock = $this->compiler->newInstance(FakeMockGrandChild::class, [], $this->bind);
         assert($mock instanceof FakeMockGrandChild);
-        assert(property_exists($mock, '_state'));
         $result = $mock->returnSame(1);
         $this->assertSame(2, $result);
     }
@@ -125,7 +123,6 @@ public function testTypedParentMethodIntercept(): void
         $bind = (new Bind())->bindInterceptors('passIterator', [new NullInterceptor()]);
         $mock = $this->compiler->newInstance(FakeTypedMockGrandChild::class, [], $bind);
         assert($mock instanceof FakeTypedMockGrandChild);
-        assert(property_exists($mock, '_state'));
         $result = $mock->passIterator(new ArrayIterator());
         $this->assertInstanceOf(ArrayIterator::class, $result);
     }
@@ -134,7 +131,6 @@ public function testParentOfParentMethodIntercept(): void
     {
         $mock = $this->compiler->newInstance(FakeMockChildChild::class, [], $this->bind);
         assert($mock instanceof FakeMockChild);
-        assert(property_exists($mock, '_state'));
         $result = $mock->returnSame(1);
         $this->assertSame(2, $result);
     }

tests/Fake/FakeWeavedClass.php

@@ -9,5 +9,5 @@ class FakeWeavedClass extends FakeClass implements WeavedInterface
     /**
      * {@inheritDoc}
      */
-    public function _initState(array $bindings): void {}
+    public function _setBindings(array $bindings): void {}
 }

tests/tmp_unerase/Ray_Aop_FakeWeaverMock_523567342.php

@@ -5,9 +5,9 @@
 namespace Ray\Aop;
 
 /** doc comment of FakeMock */
-class FakeWeaverMock_523567342 extends FakeWeaverMock implements \Ray\Aop\WeavedInterface 
+class FakeWeaverMock_523567342 extends FakeWeaverMock implements \Ray\Aop\WeavedInterface
 {
-    use \Ray\Aop\Php82InterceptTrait;
+    use \Ray\Aop\ReadOnlyInterceptTrait;
     /**
      * doc comment of returnSame
      */
@@ -33,4 +33,4 @@ public function getPrivateVal()
     {
         return $this->_intercept(__FUNCTION__, func_get_args());
     }
-}
+}