eliashaeussler/phpunit-attributes

<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "eliashaeussler/phpunit-attributes".
 *
 * Copyright (C) 2024 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace EliasHaeussler\PHPUnitAttributes\TextUI;

use PHPUnit\Metadata;

use function sprintf;
use function str_contains;

/**
 * Messages.
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-3.0-or-later
 */
final class Messages
{
    /**
     * @param non-empty-string $packageName
     *
     * @return non-empty-string
     */
    public static function forMissingRequiredPackage(
        string $packageName,
        ?Metadata\Version\Requirement $versionRequirement = null,
    ): string {
        return sprintf(
            '%s "%s"%s is required.',
            str_contains($packageName, '*') ? 'Any package matching' : 'Package',
            $packageName,
            null !== $versionRequirement ? ' ('.$versionRequirement->asString().')' : '',
        );
    }

    /**
     * @param class-string $className
     *
     * @return non-empty-string
     */
    public static function forMissingClass(string $className): string
    {
        return sprintf('Class "%s" is required.', $className);
    }
}