Mock readonly classes on PHP 82

.gitattributes

@@ -2,6 +2,7 @@
 
 /.github export-ignore
 /docker export-ignore
+/fixtures export-ignore
 /tests export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore

.github/workflows/tests.yml

@@ -14,6 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
         php: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
         dependencies: ['lowest','highest','locked']

fixtures/PHP81/User.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP81;
+
+class User {
+    public readonly int $uid;
+    public readonly string $username;
+}

fixtures/PHP82/ReadOnlyClass.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+readonly class ReadOnlyClass
+{
+    public string $myValue;
+}

fixtures/PHP82/ReadOnlyClassAbstract.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+abstract readonly class ReadOnlyClassAbstract
+{
+}

fixtures/PHP82/ReadOnlyClassFinal.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+final readonly class ReadOnlyClassFinal
+{
+}

fixtures/PHP82/ReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#AllowDynamicProperties
+ */
+#[AllowDynamicProperties]
+readonly class ReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute
+{
+    public string $test;
+}

fixtures/PHP82/ReadonlyClassesMustNotUseDynamicProperties.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#dynamic-properties
+ */
+readonly class ReadonlyClassesMustNotUseDynamicProperties
+{
+    public string $test;
+}

fixtures/PHP82/ReadonlyClassesMustOnlyContainTypedProperties.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#typed-only
+ */
+readonly class ReadonlyClassesMustOnlyContainTypedProperties
+{
+    public $test;
+}

fixtures/PHP82/Subclass/ReadonlySubclassMustAlsoBeDeclaredReadonlyChildInvalid.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82\Subclass;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#subclass-readonly
+ */
+readonly class ReadonlySubclassMustAlsoBeDeclaredReadonlyChildInvalid extends ReadonlySubclassMustAlsoBeDeclaredReadonlyParentInvalid
+{
+}

fixtures/PHP82/Subclass/ReadonlySubclassMustAlsoBeDeclaredReadonlyChildValid.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82\Subclass;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#subclass-readonly
+ */
+readonly class ReadonlySubclassMustAlsoBeDeclaredReadonlyChildValid extends ReadonlySubclassMustAlsoBeDeclaredReadonlyParentValid
+{
+}

fixtures/PHP82/Subclass/ReadonlySubclassMustAlsoBeDeclaredReadonlyParentInvalid.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82\Subclass;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#subclass-readonly
+ */
+readonly class ReadonlySubclassMustAlsoBeDeclaredReadonlyParentInvalid
+{
+}

fixtures/PHP82/Subclass/ReadonlySubclassMustAlsoBeDeclaredReadonlyParentValid.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82\Subclass;
+
+/**
+ * @see https://php.watch/versions/8.2/readonly-classes#subclass-readonly
+ */
+readonly class ReadonlySubclassMustAlsoBeDeclaredReadonlyParentValid
+{
+}

fixtures/PHP82/User.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Mockery\Tests\Fixtures\PHP82;
+
+readonly class User {
+    public int $uid;
+    public string $username;
+}

library/Mockery/Generator/DefinedTargetClass.php

@@ -124,4 +124,13 @@ public function hasInternalAncestor()
 
         return false;
     }
+
+    public function isReadOnly(): bool
+    {
+        if (PHP_VERSION_ID >= 80200) {
+            return $this->rfc->isReadOnly();
+        }
+
+        return false;
+    }
 }

library/Mockery/Generator/StringManipulation/Pass/ClassNamePass.php

@@ -28,6 +28,23 @@ public function apply($code, MockConfiguration $config)
             $code
         );
 
+        $target = $config->getTargetClass();
+        if ($target && $target->isReadOnly()) {
+            // dd($config, $namespace, $className);
+            $code = str_replace(
+                'class Mock',
+                'readonly class Mock',
+                $code
+            );
+
+            // remove \AllowDynamicProperties trait
+            $code = str_replace(
+                '#[\AllowDynamicProperties]',
+                '',
+                $code
+            );
+        }
+
         $code = str_replace(
             'class Mock',
             'class ' . $className,

library/Mockery/Generator/TargetClassInterface.php

@@ -102,4 +102,9 @@ public function implementsInterface($interface);
      * @return boolean
      */
     public function hasInternalAncestor();
+
+    /**
+     * Returns whether the targetClass is readonly.
+     */
+    public function isReadOnly(): bool;
 }

library/Mockery/Generator/UndefinedTargetClass.php

@@ -88,4 +88,9 @@ public function __toString()
     {
         return $this->name;
     }
+
+    public function isReadOnly(): bool
+    {
+        return false;
+    }
 }

tests/Bootstrap.php

@@ -35,15 +35,15 @@ function isAbsolutePath($path)
 $root = realpath(dirname(dirname(__FILE__)));
 $composerVendorDirectory = getenv('COMPOSER_VENDOR_DIR') ?: 'vendor';
 
-if (! isAbsolutePath($composerVendorDirectory)) {
+if (!isAbsolutePath($composerVendorDirectory)) {
     $composerVendorDirectory = $root . DIRECTORY_SEPARATOR . $composerVendorDirectory;
 }
 
 /**
  * Check that composer installation was done
  */
 $autoloadPath = $composerVendorDirectory . DIRECTORY_SEPARATOR . 'autoload.php';
-if (! file_exists($autoloadPath)) {
+if (!file_exists($autoloadPath)) {
     throw new Exception(
         'Please run "php composer.phar install" in root directory '
         . 'to setup unit test dependencies before running the tests'
@@ -67,17 +67,16 @@ function isAbsolutePath($path)
  */
 unset($root, $autoloadPath, $hamcrestPath, $composerVendorDirectory);
 
-$dev = false;
 
-if ($dev) {
-    $mocksDirectory = __DIR__ . '/_mocks/';
-    if (! file_exists($mocksDirectory)) {
-        mkdir($mocksDirectory, 0777, true);
-    }
+$mocksDirectory = __DIR__ . '/_mocks/';
+if (!file_exists($mocksDirectory)) {
+    mkdir($mocksDirectory, 0777, true);
+}
 
-    Mockery::setLoader(new Mockery\Loader\RequireLoader($mocksDirectory));
+Mockery::setLoader(new Mockery\Loader\RequireLoader($mocksDirectory));
 
-    function vdd()
+if (!function_exists('dd')) {
+    function dd(): void
     {
         var_dump(func_get_args());
 

tests/Unit/PHP82/Php82LanguageFeaturesTest.php

@@ -5,7 +5,18 @@
 use Generator;
 use Mockery\Adapter\Phpunit\MockeryTestCase;
 use Mockery\Reflector;
+use Mockery\Tests\Fixtures\PHP82\Subclass\ReadonlySubclassMustAlsoBeDeclaredReadonlyChildInvalid;
+use Mockery\Tests\Fixtures\PHP82\Subclass\ReadonlySubclassMustAlsoBeDeclaredReadonlyChildValid;
+use Mockery\Tests\Fixtures\PHP82\ReadOnlyClass;
+use Mockery\Tests\Fixtures\PHP82\ReadOnlyClassAbstract;
+use Mockery\Tests\Fixtures\PHP82\ReadOnlyClassFinal;
+use Mockery\Tests\Fixtures\PHP82\ReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute;
+use Mockery\Tests\Fixtures\PHP82\ReadonlyClassesMustNotUseDynamicProperties;
+use Mockery\Tests\Fixtures\PHP82\ReadonlyClassesMustOnlyContainTypedProperties;
+use Mockery\Tests\Fixtures\PHP82\User;
+use ReflectionClass;
 use ReflectionType;
+use stdClass;
 
 /**
  * @requires PHP 8.2.0-dev
@@ -18,15 +29,15 @@ class Php82LanguageFeaturesTest extends MockeryTestCase
      */
     public function testMockParameterDisjunctiveNormalFormTypes(string $fullyQualifiedClassName): void
     {
-        $expectedReflectionClass = new \ReflectionClass($fullyQualifiedClassName);
+        $expectedReflectionClass = new ReflectionClass($fullyQualifiedClassName);
         $expectedMethod = $expectedReflectionClass->getMethods()[0];
         $expectedType = $expectedMethod
             ->getParameters()[0]
             ->getType();
 
         $mock = mock($fullyQualifiedClassName);
 
-        $reflectionClass = new \ReflectionClass($mock);
+        $reflectionClass = new ReflectionClass($mock);
         $type = $reflectionClass->getMethod($expectedMethod->getName())
             ->getParameters()[0]
             ->getType();
@@ -119,6 +130,49 @@ public function testTypeHintIIterableStdClassString(): void
             Reflector::getTypeHint($refParam)
         );
     }
+
+    public function testMockReadOnlyClassAbstract(): void
+    {
+        self::assertSame(ReadOnlyClassAbstract::class, mock(ReadOnlyClassAbstract::class));
+    }
+
+    public function testMockReadOnlyClassFinal(): void
+    {
+        self::assertSame(ReadOnlyClassFinal::class, mock(ReadOnlyClassFinal::class));
+    }
+
+    public function testMockReadOnlyClass(): void
+    {
+        self::assertSame(ReadOnlyClass::class, mock(ReadOnlyClass::class));
+    }
+
+    public function testMockUser(): void
+    {
+        self::assertSame(User::class, mock(User::class));
+    }
+    public function testReadonlySubclassMustAlsoBeDeclaredReadonlyInvalid(): void
+    {
+        self::assertSame(ReadonlySubclassMustAlsoBeDeclaredReadonlyChildInvalid::class, mock(ReadonlySubclassMustAlsoBeDeclaredReadonlyChildInvalid::class));
+    }
+    public function testReadonlySubclassMustAlsoBeDeclaredReadonlyValid(): void
+    {
+        self::assertSame(ReadonlySubclassMustAlsoBeDeclaredReadonlyChildValid::class, mock(ReadonlySubclassMustAlsoBeDeclaredReadonlyChildValid::class));
+    }
+
+    public function testMockReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute(): void
+    {
+        self::assertSame(ReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute::class, mock(ReadonlyClassesMustNotUseAllowDynamicPropertiesAttribute::class));
+    }
+
+    public function testMockReadonlyClassesMustNotUseDynamicProperties(): void
+    {
+        self::assertSame(ReadonlyClassesMustNotUseDynamicProperties::class, mock(ReadonlyClassesMustNotUseDynamicProperties::class));
+    }
+
+    public function testMockReadonlyClassesMustOnlyContainTypedProperties(): void
+    {
+        self::assertSame(ReadonlyClassesMustOnlyContainTypedProperties::class, mock(ReadonlyClassesMustOnlyContainTypedProperties::class));
+    }
 }
 
 class IterableObject