intervention_image/tests/Unit/Encoders/FileExtensionEncoderTest.php

<?php

declare(strict_types=1);

namespace Intervention\Image\Tests\Unit\Encoders;

use Intervention\Image\Encoders\AvifEncoder;
use Intervention\Image\Encoders\BmpEncoder;
use Intervention\Image\Encoders\FileExtensionEncoder;
use Intervention\Image\Encoders\GifEncoder;
use Intervention\Image\Encoders\HeicEncoder;
use Intervention\Image\Encoders\Jpeg2000Encoder;
use Intervention\Image\Encoders\JpegEncoder;
use Intervention\Image\Encoders\PngEncoder;
use Intervention\Image\Encoders\TiffEncoder;
use Intervention\Image\Encoders\WebpEncoder;
use Intervention\Image\Exceptions\EncoderException;
use Intervention\Image\FileExtension;
use Intervention\Image\Interfaces\EncoderInterface;
use Intervention\Image\Tests\BaseTestCase;
use PHPUnit\Framework\Attributes\DataProvider;

final class FileExtensionEncoderTest extends BaseTestCase
{
    private function testEncoder(string|FileExtension $extension, array $options = []): EncoderInterface
    {
        $encoder = new class ($extension, ...$options) extends FileExtensionEncoder
        {
            public function __construct($mediaType, ...$options)
            {
                parent::__construct($mediaType, ...$options);
            }

            public function test($extension)
            {
                return $this->encoderByFileExtension($extension);
            }
        };

        return $encoder->test($extension);
    }

    #[DataProvider('targetEncoderProvider')]
    public function testEncoderByFileExtensionString(
        string|FileExtension $fileExtension,
        string $targetEncoderClassname,
    ): void {
        $this->assertInstanceOf(
            $targetEncoderClassname,
            $this->testEncoder($fileExtension),
        );
    }

    public static function targetEncoderProvider(): array
    {
        return [
            ['webp', WebpEncoder::class],
            ['avif', AvifEncoder::class],
            ['jpeg', JpegEncoder::class],
            ['jpg', JpegEncoder::class],
            ['bmp', BmpEncoder::class],
            ['gif', GifEncoder::class],
            ['png', PngEncoder::class],
            ['tiff', TiffEncoder::class],
            ['tif', TiffEncoder::class],
            ['jp2', Jpeg2000Encoder::class],
            ['heic', HeicEncoder::class],
            [FileExtension::WEBP, WebpEncoder::class],
            [FileExtension::AVIF, AvifEncoder::class],
            [FileExtension::JPG, JpegEncoder::class],
            [FileExtension::BMP, BmpEncoder::class],
            [FileExtension::GIF, GifEncoder::class],
            [FileExtension::PNG, PngEncoder::class],
            [FileExtension::TIF, TiffEncoder::class],
            [FileExtension::TIFF, TiffEncoder::class],
            [FileExtension::JP2, Jpeg2000Encoder::class],
            [FileExtension::HEIC, HeicEncoder::class],
        ];
    }

    public function testArgumentsNotSupportedByTargetEncoder(): void
    {
        $encoder = $this->testEncoder(
            'png',
            [
                'interlaced' => true, // is not ignored
                'quality' => 10, // is ignored because png encoder has no quality argument
            ],
        );

        $this->assertInstanceOf(PngEncoder::class, $encoder);
        $this->assertTrue($encoder->interlaced);
    }

    public function testEncoderByFileExtensionUnknown(): void
    {
        $this->expectException(EncoderException::class);
        $this->testEncoder('test');
    }
}