TestDoxBuilder.php

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Event\Code;

use PHPUnit\Framework\TestCase;
use PHPUnit\Logging\TestDox\NamePrettifier;

/**
 * @internal This class is not covered by the backward compatibility promise for PHPUnit
 */
final readonly class TestDoxBuilder
{
    public static function fromTestCase(TestCase $testCase, bool $colorize): TestDox
    {
        $prettifier = new NamePrettifier;

        $prettyTestCase = $prettifier->prettifyTestCase($testCase, false);

        if ($colorize) {
            $prettyTestCaseColorized = $prettifier->prettifyTestCase($testCase, true);
        } else {
            $prettyTestCaseColorized = $prettyTestCase;
        }

        return new TestDox(
            $prettifier->prettifyTestClassName($testCase::class),
            $prettyTestCase,
            $prettyTestCaseColorized,
        );
    }

    /**
     * @psalm-param class-string $className
     * @psalm-param non-empty-string $methodName
     */
    public static function fromClassNameAndMethodName(string $className, string $methodName): TestDox
    {
        $prettifier           = new NamePrettifier;
        $prettifiedMethodName = $prettifier->prettifyTestMethodName($methodName);

        return new TestDox(
            $prettifier->prettifyTestClassName($className),
            $prettifiedMethodName,
            $prettifiedMethodName,
        );
    }
}