endtoend-test-psl/tests/Psl/Math/ClampTest.php

<?php

declare(strict_types=1);

namespace Psl\Tests\Math;

use PHPUnit\Framework\TestCase;
use Psl\Exception;
use Psl\Math;

final class ClampTest extends TestCase
{
    /**
     * @dataProvider provideData
     */
    public function testClamp($expected, $number, $min, $max): void
    {
        static::assertSame($expected, Math\clamp($number, $min, $max));
    }

    public function testInvalidMinMax(): void
    {
        $this->expectException(Exception\InvariantViolationException::class);
        $this->expectExceptionMessage('Expected $min to be lower or equal to $max.');

        Math\clamp(10, 20, 10);
    }

    public function provideData(): array
    {
        return [
            [
                'expected' => 10,
                'number' => 10,
                'min' => 2,
                'max' => 20
            ],
            [
                'expected' => 10,
                'number' => 20,
                'min' => 1,
                'max' => 10
            ],
            [
                'expected' => 10,
                'number' => 5,
                'min' => 10,
                'max' => 20
            ],
            [
                'expected' => 10,
                'number' => 10,
                'min' => 10,
                'max' => 20
            ],
            [
                'expected' => 10,
                'number' => 10,
                'min' => 1,
                'max' => 10
            ],
            [
                'expected' => 10,
                'number' => 20,
                'min' => 10,
                'max' => 10
            ],
            [
                'expected' => 10.0,
                'number' => 10.0,
                'min' => 2.0,
                'max' => 20.0
            ],
        ];
    }
}