From 31779d02636a315ec3b53225308ddb95083539d4 Mon Sep 17 00:00:00 2001
From: Oliver Vogel <oliver@olivervogel.com>
Date: Sun, 11 Aug 2024 11:43:54 +0200
Subject: [PATCH] Add ability to read instances of EncodedImaged::class (#1386)

* Implement EncodedImageObjectDecoder::class
* Add tests for EncodedImageObjectDecoder::class
---
 src/Decoders/EncodedImageObjectDecoder.php    | 11 +++++++
 .../Gd/Decoders/EncodedImageObjectDecoder.php | 27 ++++++++++++++++
 .../Decoders/EncodedImageObjectDecoder.php    | 27 ++++++++++++++++
 src/InputHandler.php                          |  2 ++
 .../EncodedImageObjectDecoderTest.php         | 32 +++++++++++++++++++
 .../EncodedImageObjectDecoderTest.php         | 32 +++++++++++++++++++
 6 files changed, 131 insertions(+)
 create mode 100644 src/Decoders/EncodedImageObjectDecoder.php
 create mode 100644 src/Drivers/Gd/Decoders/EncodedImageObjectDecoder.php
 create mode 100644 src/Drivers/Imagick/Decoders/EncodedImageObjectDecoder.php
 create mode 100644 tests/Unit/Drivers/Gd/Decoders/EncodedImageObjectDecoderTest.php
 create mode 100644 tests/Unit/Drivers/Imagick/Decoders/EncodedImageObjectDecoderTest.php

diff --git a/src/Decoders/EncodedImageObjectDecoder.php b/src/Decoders/EncodedImageObjectDecoder.php
new file mode 100644
index 00000000..daddff2d
--- /dev/null
+++ b/src/Decoders/EncodedImageObjectDecoder.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Decoders;
+
+use Intervention\Image\Drivers\SpecializableDecoder;
+
+class EncodedImageObjectDecoder extends SpecializableDecoder
+{
+}
diff --git a/src/Drivers/Gd/Decoders/EncodedImageObjectDecoder.php b/src/Drivers/Gd/Decoders/EncodedImageObjectDecoder.php
new file mode 100644
index 00000000..f65d0a5b
--- /dev/null
+++ b/src/Drivers/Gd/Decoders/EncodedImageObjectDecoder.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Drivers\Gd\Decoders;
+
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Exceptions\DecoderException;
+use Intervention\Image\Interfaces\ImageInterface;
+use Intervention\Image\Interfaces\ColorInterface;
+
+class EncodedImageObjectDecoder extends BinaryImageDecoder
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
+    public function decode(mixed $input): ImageInterface|ColorInterface
+    {
+        if (!is_a($input, EncodedImage::class)) {
+            throw new DecoderException('Unable to decode input');
+        }
+
+        return parent::decode($input->toString());
+    }
+}
diff --git a/src/Drivers/Imagick/Decoders/EncodedImageObjectDecoder.php b/src/Drivers/Imagick/Decoders/EncodedImageObjectDecoder.php
new file mode 100644
index 00000000..2348a6b7
--- /dev/null
+++ b/src/Drivers/Imagick/Decoders/EncodedImageObjectDecoder.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Drivers\Imagick\Decoders;
+
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Exceptions\DecoderException;
+use Intervention\Image\Interfaces\ImageInterface;
+use Intervention\Image\Interfaces\ColorInterface;
+
+class EncodedImageObjectDecoder extends BinaryImageDecoder
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
+    public function decode(mixed $input): ImageInterface|ColorInterface
+    {
+        if (!is_a($input, EncodedImage::class)) {
+            throw new DecoderException('Unable to decode input');
+        }
+
+        return parent::decode($input->toString());
+    }
+}
diff --git a/src/InputHandler.php b/src/InputHandler.php
index 2772ec45..a0720d13 100644
--- a/src/InputHandler.php
+++ b/src/InputHandler.php
@@ -15,6 +15,7 @@
 use Intervention\Image\Decoders\BinaryImageDecoder;
 use Intervention\Image\Decoders\ColorObjectDecoder;
 use Intervention\Image\Decoders\DataUriImageDecoder;
+use Intervention\Image\Decoders\EncodedImageObjectDecoder;
 use Intervention\Image\Decoders\FilePathImageDecoder;
 use Intervention\Image\Decoders\FilePointerImageDecoder;
 use Intervention\Image\Decoders\ImageObjectDecoder;
@@ -53,6 +54,7 @@ class InputHandler implements InputHandlerInterface
         BinaryImageDecoder::class,
         DataUriImageDecoder::class,
         Base64ImageDecoder::class,
+        EncodedImageObjectDecoder::class,
     ];
 
     /**
diff --git a/tests/Unit/Drivers/Gd/Decoders/EncodedImageObjectDecoderTest.php b/tests/Unit/Drivers/Gd/Decoders/EncodedImageObjectDecoderTest.php
new file mode 100644
index 00000000..f75762f1
--- /dev/null
+++ b/tests/Unit/Drivers/Gd/Decoders/EncodedImageObjectDecoderTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Tests\Unit\Drivers\Gd\Decoders;
+
+use Intervention\Image\Drivers\Gd\Decoders\EncodedImageObjectDecoder;
+use Intervention\Image\Drivers\Gd\Driver;
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Image;
+use Intervention\Image\Tests\ImagickTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\RequiresPhpExtension;
+
+#[RequiresPhpExtension('gd')]
+#[CoversClass(EncodedImageObjectDecoder::class)]
+class EncodedImageObjectDecoderTest extends ImagickTestCase
+{
+    protected EncodedImageObjectDecoder $decoder;
+
+    protected function setUp(): void
+    {
+        $this->decoder = new EncodedImageObjectDecoder();
+        $this->decoder->setDriver(new Driver());
+    }
+
+    public function testDecode(): void
+    {
+        $result = $this->decoder->decode(new EncodedImage($this->getTestResourceData()));
+        $this->assertInstanceOf(Image::class, $result);
+    }
+}
diff --git a/tests/Unit/Drivers/Imagick/Decoders/EncodedImageObjectDecoderTest.php b/tests/Unit/Drivers/Imagick/Decoders/EncodedImageObjectDecoderTest.php
new file mode 100644
index 00000000..826498d3
--- /dev/null
+++ b/tests/Unit/Drivers/Imagick/Decoders/EncodedImageObjectDecoderTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Tests\Unit\Drivers\Imagick\Decoders;
+
+use Intervention\Image\Drivers\Imagick\Decoders\EncodedImageObjectDecoder;
+use Intervention\Image\Drivers\Imagick\Driver;
+use Intervention\Image\EncodedImage;
+use Intervention\Image\Image;
+use Intervention\Image\Tests\ImagickTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\RequiresPhpExtension;
+
+#[RequiresPhpExtension('imagick')]
+#[CoversClass(EncodedImageObjectDecoder::class)]
+class EncodedImageObjectDecoderTest extends ImagickTestCase
+{
+    protected EncodedImageObjectDecoder $decoder;
+
+    protected function setUp(): void
+    {
+        $this->decoder = new EncodedImageObjectDecoder();
+        $this->decoder->setDriver(new Driver());
+    }
+
+    public function testDecode(): void
+    {
+        $result = $this->decoder->decode(new EncodedImage($this->getTestResourceData()));
+        $this->assertInstanceOf(Image::class, $result);
+    }
+}