fix: replace visibility-less readonly with public instead of removing it (#72) [Closes #49]

"readonly T $x" without an explicit visibility modifier is valid PHP 8.4+
constructor promotion syntax. Stripping readonly entirely turned the promoted
property into a plain constructor argument, making $this->x inaccessible.

removeTokens() now decides each 'final'/'readonly' token with a match on the
surrounding significant tokens: drop it, keep it, or - for a visibility-less
promoted readonly - replace it with "public" so it stays a promoted property.
Visibility detection covers PHP 8.4 asymmetric modifiers (private(set) etc.)
and tolerates comments between tokens.

Closes #49

Signed-off-by: Guillaume Delré <delre.guillaume@gmail.com>

Author: dg

src/BypassFinals.php

@@ -182,7 +182,17 @@ public static function removeTokens(string $code): string
 		foreach ($tokens as $i => $token) {
 			if (!is_array($token)) {
 				$code .= $token;
-			} elseif (!isset(self::$tokens[$token[0]]) || !self::shouldRemoveToken($tokens, $i)) {
+			} elseif ($token[0] === T_FINAL && isset(self::$tokens[T_FINAL])) {
+				// drop 'final' before class/function/readonly, but keep e.g. "final const"
+				$next = self::significantToken($tokens, $i, 1);
+				$code .= is_array($next) && in_array($next[0], [T_CLASS, T_FUNCTION, T_READONLY], true) ? '' : $token[1];
+			} elseif ($token[0] === T_READONLY && isset(self::$tokens[T_READONLY])) {
+				// drop 'readonly' before a class or after a visibility modifier; a visibility-less
+				// promoted "readonly T $x" (PHP 8.4+) becomes "public" to stay a promoted property
+				$next = self::significantToken($tokens, $i, 1);
+				$prev = self::significantToken($tokens, $i, -1);
+				$code .= (is_array($next) && $next[0] === T_CLASS) || is_array($prev) ? '' : 'public';
+			} else {
 				$code .= $token[1];
 			}
 		}
@@ -192,26 +202,20 @@ public static function removeTokens(string $code): string
 
 
 	/**
-	 * Determines if a token should be removed based on its context.
+	 * Returns the nearest token in the given direction (+1/-1) that is not whitespace or a comment.
+	 * @return string|array{int, string, int}|null
 	 */
-	private static function shouldRemoveToken(array $tokens, int $index): bool
+	private static function significantToken(array $tokens, int $index, int $direction)
 	{
-		$tokenType = $tokens[$index][0];
-
-		if ($tokenType === T_FINAL) {
-			for ($index++; $index < count($tokens); $index++) {
-				$token = $tokens[$index];
-				if (is_array($token) && $token[0] === T_WHITESPACE) {
-					continue;
-				}
-
-				return is_array($token) && in_array($token[0], [T_CLASS, T_FUNCTION, T_READONLY], true);
+		for ($j = $index + $direction; isset($tokens[$j]); $j += $direction) {
+			$t = $tokens[$j];
+			if (is_array($t) && in_array($t[0], [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT], true)) {
+				continue;
 			}
-		} elseif ($tokenType === T_READONLY) {
-			return true;
+			return $t;
 		}
 
-		return false;
+		return null;
 	}
 
 

tests/BypassFinals/removeTokens.readonly-asymmetric.phpt

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+/** @phpVersion 8.4 */
+
+// Removing readonly must not break PHP 8.4+ asymmetric visibility (private(set) etc.).
+
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+DG\BypassFinals::enable(bypassReadOnly: true, bypassFinal: false);
+
+$originalCode = <<<'XX'
+	<?php declare(strict_types=1);
+
+	final class ReadonlyAsymmetric
+	{
+		public function __construct(
+			public private(set) readonly string $a,
+		) {
+		}
+	}
+	XX;
+
+$modifiedCode = DG\BypassFinals::removeTokens($originalCode);
+
+Assert::match(<<<'XX'
+	<?php declare(strict_types=1);
+
+	final class ReadonlyAsymmetric
+	{
+		public function __construct(
+			public private(set)  string $a,
+		) {
+		}
+	}
+	XX, $modifiedCode);

tests/BypassFinals/removeTokens.readonly-no-visibility.phpt

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+
+/** @phpVersion 8.4 */
+
+// Visibility-less promoted "readonly $x" (PHP 8.4+) must become "public", not be dropped.
+
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+DG\BypassFinals::enable(bypassReadOnly: true, bypassFinal: false);
+
+$originalCode = <<<'XX'
+	<?php declare(strict_types=1);
+
+	final class ReadonlyNoVisibility
+	{
+		public function __construct(
+			readonly string $a,
+			public readonly string $b,
+		) {
+		}
+	}
+	XX;
+
+$modifiedCode = DG\BypassFinals::removeTokens($originalCode);
+
+Assert::match(<<<'XX'
+	<?php declare(strict_types=1);
+
+	final class ReadonlyNoVisibility
+	{
+		public function __construct(
+			public string $a,
+			public  string $b,
+		) {
+		}
+	}
+	XX, $modifiedCode);