improved --cider mode (thx Claude)

Author: dg

phpstan-baseline.neon

@@ -66,6 +66,18 @@ parameters:
 			count: 1
 			path: src/Runner/PhpInterpreter.php
 
+		-
+			message: '#^Call to function method_exists\(\) with Tester\\Runner\\OutputHandler and ''jobStarted'' will always evaluate to true\.$#'
+			identifier: function.alreadyNarrowedType
+			count: 1
+			path: src/Runner/Runner.php
+
+		-
+			message: '#^Call to function method_exists\(\) with Tester\\Runner\\OutputHandler and ''tick'' will always evaluate to true\.$#'
+			identifier: function.alreadyNarrowedType
+			count: 1
+			path: src/Runner/Runner.php
+
 		-
 			message: '#^If condition is always false\.$#'
 			identifier: if.alwaysFalse

src/Framework/Ansi.php

@@ -76,6 +76,20 @@ public static function hideCursor(): string
 	}
 
 
+	public static function cursorMove(int $x = 0, int $y = 0): string
+	{
+		return match (true) {
+			$x < 0 => "\e[" . (-$x) . 'D',
+			$x > 0 => "\e[{$x}C",
+			default => '',
+		} . match (true) {
+			$y < 0 => "\e[" . (-$y) . 'A',
+			$y > 0 => "\e[{$y}B",
+			default => '',
+		};
+	}
+
+
 	/**
 	 * Returns ANSI sequence to clear from cursor to end of line.
 	 */
@@ -108,7 +122,57 @@ public static function reset(): string
 	 */
 	public static function textWidth(string $text): int
 	{
+		$text = self::stripAnsi($text);
 		return preg_match_all('/./su', $text)
 			+ preg_match_all('/[\x{1F300}-\x{1F9FF}]/u', $text); // emoji are 2-wide
 	}
+
+
+	/**
+	 * Pads text to specified display width.
+	 * @param STR_PAD_LEFT|STR_PAD_RIGHT|STR_PAD_BOTH  $type
+	 */
+	public static function pad(
+		string $text,
+		int $width,
+		string $char = ' ',
+		int $type = STR_PAD_RIGHT,
+	): string
+	{
+		$padding = $width - self::textWidth($text);
+		if ($padding <= 0) {
+			return $text;
+		}
+
+		return match ($type) {
+			STR_PAD_LEFT => str_repeat($char, $padding) . $text,
+			STR_PAD_RIGHT => $text . str_repeat($char, $padding),
+			STR_PAD_BOTH => str_repeat($char, intdiv($padding, 2)) . $text . str_repeat($char, $padding - intdiv($padding, 2)),
+		};
+	}
+
+
+	/**
+	 * Truncates text to max display width, adding ellipsis if needed.
+	 */
+	public static function truncate(string $text, int $maxWidth, string $ellipsis = '…'): string
+	{
+		if (self::textWidth($text) <= $maxWidth) {
+			return $text;
+		}
+
+		$maxWidth -= self::textWidth($ellipsis);
+		$res = '';
+		$width = 0;
+		foreach (preg_split('//u', $text, -1, PREG_SPLIT_NO_EMPTY) as $char) {
+			$charWidth = preg_match('/[\x{1F300}-\x{1F9FF}]/u', $char) ? 2 : 1;
+			if ($width + $charWidth > $maxWidth) {
+				break;
+			}
+			$res .= $char;
+			$width += $charWidth;
+		}
+
+		return $res . $ellipsis;
+	}
 }

src/Runner/Output/ConsolePrinter.php

@@ -9,10 +9,11 @@
 
 use Tester;
 use Tester\Ansi;
+use Tester\Environment;
+use Tester\Runner\Job;
 use Tester\Runner\Runner;
 use Tester\Runner\Test;
-use function sprintf, strlen;
-use const DIRECTORY_SEPARATOR;
+use function count, fwrite, sprintf, str_repeat, strlen;
 
 
 /**
@@ -24,6 +25,8 @@ class ConsolePrinter implements Tester\Runner\OutputHandler
 	public const ModeCider = 2;
 	public const ModeLines = 3;
 
+	private const MaxDisplayedThreads = 20;
+
 	/** @var resource */
 	private $file;
 	private string $buffer;
@@ -33,6 +36,11 @@ class ConsolePrinter implements Tester\Runner\OutputHandler
 	/** @var array<Test::Passed|Test::Skipped|Test::Failed, int>  result type => count */
 	private array $results;
 	private ?string $baseDir;
+	private int $panelWidth = 60;
+	private int $panelHeight = 0;
+
+	/** @var \WeakMap<Job, float> */
+	private \WeakMap $startTimes;
 
 
 	public function __construct(
@@ -43,6 +51,7 @@ public function __construct(
 		private int $mode = self::ModeDots,
 	) {
 		$this->file = fopen($file ?? 'php://output', 'w') ?: throw new \RuntimeException("Cannot open file '$file' for writing.");
+		$this->startTimes = new \WeakMap;
 	}
 
 
@@ -53,6 +62,9 @@ public function begin(): void
 		$this->baseDir = null;
 		$this->results = [Test::Passed => 0, Test::Skipped => 0, Test::Failed => 0];
 		$this->time = -microtime(as_float: true);
+		if ($this->mode === self::ModeCider && $this->runner->threadCount < 2) {
+			$this->mode = self::ModeLines;
+		}
 		fwrite($this->file, $this->runner->getInterpreter()->getShortInfo()
 			. ' | ' . $this->runner->getInterpreter()->getCommandLine()
 			. " | {$this->runner->threadCount} thread" . ($this->runner->threadCount > 1 ? 's' : '') . "\n\n");
@@ -89,7 +101,7 @@ public function finish(Test $test): void
 		$this->results[$result]++;
 		fwrite($this->file, match ($this->mode) {
 			self::ModeDots => [Test::Passed => '.', Test::Skipped => 's', Test::Failed => Ansi::colorize('F', 'white/red')][$result],
-			self::ModeCider => [Test::Passed => '🍏', Test::Skipped => 's', Test::Failed => '🍎'][$result],
+			self::ModeCider => '',
 			self::ModeLines => $this->generateFinishLine($test),
 		});
 
@@ -106,6 +118,12 @@ public function finish(Test $test): void
 
 	public function end(): void
 	{
+		if ($this->panelHeight) {
+			fwrite($this->file, Ansi::cursorMove(y: -$this->panelHeight)
+				. str_repeat(Ansi::clearLine() . "\n", $this->panelHeight)
+				. Ansi::cursorMove(y: -$this->panelHeight));
+		}
+
 		$run = array_sum($this->results);
 		fwrite($this->file, !$this->count ? "No tests found\n" :
 			"\n\n" . $this->buffer . "\n"
@@ -158,4 +176,76 @@ private function generateFinishLine(Test $test): string
 			$message,
 		);
 	}
+
+
+	public function jobStarted(Job $job): void
+	{
+		$this->startTimes[$job] = microtime(true);
+	}
+
+
+	/**
+	 * @param Job[]  $running
+	 */
+	public function tick(array $running): void
+	{
+		if ($this->mode !== self::ModeCider) {
+			return;
+		}
+
+		// Move cursor up to overwrite previous output
+		if ($this->panelHeight) {
+			fwrite($this->file, Ansi::cursorMove(y: -$this->panelHeight));
+		}
+
+		$lines = [];
+
+		// Header with progress bar
+		$barWidth = $this->panelWidth - 12;
+		$filled = (int) round($barWidth * ($this->runner->getFinishedCount() / $this->runner->getJobCount()));
+		$lines[] = '╭' . Ansi::pad(' ' . str_repeat('█', $filled) . str_repeat('░', $barWidth - $filled) . ' ', $this->panelWidth - 2, '─', STR_PAD_BOTH) . '╮';
+
+		$threadJobs = [];
+		foreach ($running as $job) {
+			$threadJobs[(int) $job->getEnvironmentVariable(Environment::VariableThread)] = $job;
+		}
+
+		// Thread lines
+		$numWidth = strlen((string) $this->runner->threadCount);
+		$displayCount = min($this->runner->threadCount, self::MaxDisplayedThreads);
+
+		for ($t = 1; $t <= $displayCount; $t++) {
+			if (isset($threadJobs[$t])) {
+				$job = $threadJobs[$t];
+				$name = basename($job->getTest()->getFile());
+				$time = sprintf('%0.1fs', microtime(true) - ($this->startTimes[$job] ?? microtime(true)));
+				$nameWidth = $this->panelWidth - $numWidth - strlen($time) - 7;
+				$name = Ansi::pad(Ansi::truncate($name, $nameWidth), $nameWidth);
+				$line = Ansi::colorize(sprintf("%{$numWidth}d:", $t), 'lime') . " $name " . Ansi::colorize($time, 'yellow');
+			} else {
+				$line = Ansi::pad(Ansi::colorize(sprintf("%{$numWidth}d: -", $t), 'gray'), $this->panelWidth - 4);
+			}
+			$lines[] = '│ ' . $line . ' │';
+		}
+
+		if ($this->runner->threadCount > self::MaxDisplayedThreads) {
+			$more = $this->runner->threadCount - self::MaxDisplayedThreads;
+			$ellipsis = Ansi::colorize("… and $more more", 'gray');
+			$lines[] = '│' . Ansi::pad($ellipsis, $this->panelWidth - 2) . '│';
+		}
+
+		// Footer: (85 tests, 🍏×74 🍎×2, 9.0s)
+		$summary = "($this->count tests, "
+			. ($this->results[Test::Passed] ? "🍏×{$this->results[Test::Passed]}" : '')
+			. ($this->results[Test::Failed] ? " 🍎×{$this->results[Test::Failed]}" : '')
+			. ', ' . sprintf('%0.1fs', $this->time + microtime(true)) . ')';
+		$lines[] = '╰' . Ansi::pad($summary, $this->panelWidth - 2, '─', STR_PAD_BOTH) . '╯';
+
+		foreach ($lines as $line) {
+			fwrite($this->file, "\r" . $line . Ansi::clearLine() . "\n");
+		}
+		fflush($this->file);
+
+		$this->panelHeight = count($lines);
+	}
 }

src/Runner/OutputHandler.php

@@ -10,6 +10,8 @@
 
 /**
  * Runner output.
+ * @method void jobStarted(Job $job) called when a job starts running
+ * @method void tick(Job[] $running) called periodically during test execution
  */
 interface OutputHandler
 {

src/Runner/Runner.php

@@ -42,6 +42,8 @@ class Runner
 
 	/** @var array<string, int>  test signature => result (Test::Prepared|Passed|Failed|Skipped) */
 	private array $lastResults = [];
+	private int $jobCount = 0;
+	private int $finishedCount = 0;
 
 
 	public function __construct(PhpInterpreter $interpreter)
@@ -93,6 +95,8 @@ public function run(): bool
 		foreach ($this->paths as $path) {
 			$this->findTests($path);
 		}
+		$this->finishedCount = 0;
+		$this->jobCount = count($this->jobs);
 
 		if ($this->tempDir) {
 			usort(
@@ -102,18 +106,28 @@ public function run(): bool
 		}
 
 		$threads = range(1, $this->threadCount);
-
 		$async = $this->threadCount > 1 && count($this->jobs) > 1;
 
 		try {
 			while (($this->jobs || $running) && !$this->interrupted) {
 				while ($threads && $this->jobs) {
 					$running[] = $job = array_shift($this->jobs);
 					$job->setEnvironmentVariable(Environment::VariableThread, (string) array_shift($threads));
+					foreach ($this->outputHandlers as $handler) {
+						if (method_exists($handler, 'jobStarted')) {
+							$handler->jobStarted($job);
+						}
+					}
 					$job->run(async: $async);
 				}
 
 				if ($async) {
+					foreach ($this->outputHandlers as $handler) {
+						if (method_exists($handler, 'tick')) {
+							$handler->tick($running);
+						}
+					}
+
 					Job::waitForActivity($running);
 				}
 
@@ -124,6 +138,7 @@ public function run(): bool
 
 					if (!$job->isRunning()) {
 						$threads[] = $job->getEnvironmentVariable(Environment::VariableThread);
+						$this->finishedCount++;
 						$this->testHandler->assess($job);
 						unset($running[$key]);
 					}
@@ -214,6 +229,18 @@ public function getInterpreter(): PhpInterpreter
 	}
 
 
+	public function getJobCount(): int
+	{
+		return $this->jobCount;
+	}
+
+
+	public function getFinishedCount(): int
+	{
+		return $this->finishedCount;
+	}
+
+
 	private function getLastResult(Test $test): int
 	{
 		$signature = $test->getSignature();

tests/Framework/Ansi.pad.phpt

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+
+use Tester\Ansi;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+// pad() - right (default)
+Assert::same('hello     ', Ansi::pad('hello', 10));
+Assert::same('hello     ', Ansi::pad('hello', 10, ' ', STR_PAD_RIGHT));
+
+// pad() - left
+Assert::same('     hello', Ansi::pad('hello', 10, ' ', STR_PAD_LEFT));
+
+// pad() - center (both)
+Assert::same('  hello   ', Ansi::pad('hello', 10, ' ', STR_PAD_BOTH));
+Assert::same('   hi   ', Ansi::pad('hi', 8, ' ', STR_PAD_BOTH)); // odd padding: 3 left, 3 right
+Assert::same('  hi   ', Ansi::pad('hi', 7, ' ', STR_PAD_BOTH)); // odd padding: 2 left, 3 right
+
+// pad() - text already at width
+Assert::same('hello', Ansi::pad('hello', 5));
+Assert::same('hello', Ansi::pad('hello', 3)); // over width, no change
+
+// pad() - unicode padding character
+Assert::same('hello─────', Ansi::pad('hello', 10, '─'));
+Assert::same('─────hello', Ansi::pad('hello', 10, '─', STR_PAD_LEFT));
+Assert::same('──hello───', Ansi::pad('hello', 10, '─', STR_PAD_BOTH));
+
+// pad() - text with emoji (emoji is 2-wide)
+Assert::same('🍏×5    ', Ansi::pad('🍏×5', 8)); // 🍏(2) + ×(1) + 5(1) = 4 width, need 4 spaces
+Assert::same('    🍏×5', Ansi::pad('🍏×5', 8, ' ', STR_PAD_LEFT));
+
+// pad() - empty string
+Assert::same('     ', Ansi::pad('', 5));