Image Encoding Before Save

- added method `ResourceInterface::getEncodedImage()`
- method `ImagePersister::save()` now uses the `getEncodedImage()` from a resource during saving
- fixed unit tests

Author: tg666

src/Bridge/Nette/DI/ImageStorageExtension.php

@@ -386,6 +386,7 @@ public function createFileStorage(string $name, FileStorageConfig $config): Serv
                 new Reference($this->prefix('filesystem.' . $name)),
                 new Reference($this->prefix('image_manager')),
                 new Reference($this->prefix('modifier_facade.' . $name)),
+                new Reference($this->prefix('config.' . $name)),
             ])
             ->setAutowired(false);
 
@@ -419,7 +420,6 @@ public function createFileStorage(string $name, FileStorageConfig $config): Serv
             ->setType(ImagePersisterInterface::class)
             ->setFactory(ImagePersister::class, [
                 new Reference($this->prefix('filesystem.' . $name)),
-                new Reference($this->prefix('config.' . $name)),
             ])
             ->setAutowired(false);
 

src/Persistence/ImagePersister.php

@@ -8,11 +8,9 @@
 use League\Flysystem\FilesystemOperator;
 use League\Flysystem\FilesystemReader;
 use League\Flysystem\StorageAttributes;
-use SixtyEightPublishers\FileStorage\Config\ConfigInterface;
 use SixtyEightPublishers\FileStorage\Exception\FilesystemException;
 use SixtyEightPublishers\FileStorage\PathInfoInterface as FilePathInfoInterface;
 use SixtyEightPublishers\FileStorage\Resource\ResourceInterface;
-use SixtyEightPublishers\ImageStorage\Config\Config;
 use SixtyEightPublishers\ImageStorage\Exception\InvalidArgumentException;
 use SixtyEightPublishers\ImageStorage\PathInfoInterface as ImagePathInfoInterface;
 use SixtyEightPublishers\ImageStorage\Resource\ResourceInterface as ImageResourceInterface;
@@ -26,7 +24,6 @@ final class ImagePersister implements ImagePersisterInterface
 {
     public function __construct(
         private readonly FilesystemOperator $filesystemOperator,
-        private readonly ConfigInterface $config,
     ) {}
 
     public function getFilesystem(): FilesystemOperator
@@ -63,7 +60,7 @@ public function save(ResourceInterface $resource, array $config = []): string
         $flushCache = self::FILESYSTEM_PREFIX_SOURCE === $prefix && $this->exists($pathInfo);
 
         try {
-            $this->filesystemOperator->write($prefix . $path, $this->encodeImage($resource), $config);
+            $this->filesystemOperator->write($prefix . $path, $resource->getEncodedImage(), $config);
 
             if ($flushCache) {
                 $this->delete($pathInfo, [
@@ -127,24 +124,6 @@ public function delete(FilePathInfoInterface $pathInfo, array $config = []): voi
         $this->deleteFile(self::FILESYSTEM_PREFIX_SOURCE . $pathInfo->getPath(), $config);
     }
 
-    private function encodeImage(ImageResourceInterface $resource): string
-    {
-        if (!$resource->hasBeenModified()) {
-            $contents = @file_get_contents($resource->getLocalFilename());
-
-            if (false !== $contents) {
-                return $contents;
-            }
-        }
-
-        $quality = (int) ($resource->getEncodeQuality() ?? $this->config[Config::ENCODE_QUALITY] ?? 90);
-        $format = $resource->getEncodeFormat() ?? '';
-        $image = $resource->getSource();
-        $image = $image->encode($format, $quality);
-
-        return $image->getEncoded();
-    }
-
     /**
      * @param  array<string, mixed> $config
      * @throws FilesystemException

src/Resource/ImageResource.php

@@ -7,20 +7,22 @@
 use Intervention\Image\Image;
 use SixtyEightPublishers\FileStorage\PathInfoInterface;
 use SixtyEightPublishers\ImageStorage\Modifier\Facade\ModifierFacadeInterface;
+use function file_get_contents;
 
 class ImageResource implements ResourceInterface
 {
     private bool $modified = false;
 
     private ?string $encodeFormat = null;
 
-    private ?int $encodeQuality = null;
+    private ?string $encodedImage = null;
 
     public function __construct(
         private PathInfoInterface $pathInfo,
         private Image $image,
         private readonly string $localFilename,
         private readonly ModifierFacadeInterface $modifierFacade,
+        private int $encodeQuality,
     ) {}
 
     public function getPathInfo(): PathInfoInterface
@@ -59,6 +61,7 @@ public function modifyImage(string|array $modifiers, bool $stripMeta = false): s
 
         if ($modifyResult->modified) {
             $resource->modified = $modifyResult->modified;
+            $resource->encodedImage = null;
         }
 
         if (null !== $modifyResult->encodeFormat) {
@@ -84,7 +87,7 @@ public function getFilesize(): ?int
         return false !== $filesize ? (int) $filesize : null;
     }
 
-    public function getEncodeQuality(): ?int
+    public function getEncodeQuality(): int
     {
         return $this->encodeQuality;
     }
@@ -93,4 +96,25 @@ public function getEncodeFormat(): ?string
     {
         return $this->encodeFormat;
     }
+
+    public function getEncodedImage(): string
+    {
+        if (null !== $this->encodedImage) {
+            return $this->encodedImage;
+        }
+
+        if (!$this->hasBeenModified()) {
+            $contents = @file_get_contents($this->getLocalFilename());
+
+            if (false !== $contents) {
+                return $this->encodedImage = $contents;
+            }
+        }
+
+        $format = $this->getEncodeFormat() ?? '';
+        $image = $this->getSource();
+        $image = $image->encode($format, $this->getEncodeQuality());
+
+        return $this->encodedImage = $image->getEncoded();
+    }
 }

src/Resource/ResourceFactory.php

@@ -12,11 +12,13 @@
 use League\Flysystem\UnableToReadFile;
 use Psr\Http\Message\StreamInterface;
 use RuntimeException;
+use SixtyEightPublishers\FileStorage\Config\ConfigInterface;
 use SixtyEightPublishers\FileStorage\Exception\FileNotFoundException;
 use SixtyEightPublishers\FileStorage\Exception\FilesystemException;
 use SixtyEightPublishers\FileStorage\PathInfoInterface;
 use SixtyEightPublishers\FileStorage\Resource\ResourceFactoryInterface;
 use SixtyEightPublishers\FileStorage\Resource\ResourceInterface;
+use SixtyEightPublishers\ImageStorage\Config\Config;
 use SixtyEightPublishers\ImageStorage\Modifier\Facade\ModifierFacadeInterface;
 use SixtyEightPublishers\ImageStorage\PathInfoInterface as ImagePathInfoInterface;
 use SixtyEightPublishers\ImageStorage\Persistence\ImagePersisterInterface;
@@ -43,6 +45,7 @@ public function __construct(
         private readonly FilesystemReader $filesystemReader,
         private readonly ImageManager $imageManager,
         private readonly ModifierFacadeInterface $modifierFacade,
+        private readonly ConfigInterface $config,
     ) {}
 
     /**
@@ -92,6 +95,7 @@ public function createResourceFromFile(PathInfoInterface $pathInfo, string $file
                 ),
                 localFilename: $filename,
                 modifierFacade: $this->modifierFacade,
+                encodeQuality: (int) ($this->config[Config::ENCODE_QUALITY] ?? 90),
             );
         }
 
@@ -173,6 +177,7 @@ public function createResourceFromPsrStream(PathInfoInterface $pathInfo, StreamI
                 ),
                 localFilename: $uri,
                 modifierFacade: $this->modifierFacade,
+                encodeQuality: (int) ($this->config[Config::ENCODE_QUALITY] ?? 90),
             );
         }
 
@@ -240,6 +245,7 @@ private function createTmpFileResource(PathInfoInterface $pathInfo, string $loca
                 location: $location,
             ),
             modifierFacade: $this->modifierFacade,
+            encodeQuality: (int) ($this->config[Config::ENCODE_QUALITY] ?? 90),
             tmpFile: new TmpFile($tmpFilename),
         );
     }

src/Resource/ResourceInterface.php

@@ -20,7 +20,9 @@ public function hasBeenModified(): bool;
      */
     public function modifyImage(string|array $modifiers, bool $stripMeta = false): self;
 
-    public function getEncodeQuality(): ?int;
+    public function getEncodeQuality(): int;
 
     public function getEncodeFormat(): ?string;
+
+    public function getEncodedImage(): string;
 }

src/Resource/TmpFileImageResource.php

@@ -14,13 +14,15 @@ public function __construct(
         PathInfoInterface $pathInfo,
         Image $image,
         ModifierFacadeInterface $modifierFacade,
+        int $encodeQuality,
         private readonly TmpFile $tmpFile,
     ) {
         parent::__construct(
             pathInfo: $pathInfo,
             image: $image,
             localFilename: $this->tmpFile->filename,
             modifierFacade: $modifierFacade,
+            encodeQuality: $encodeQuality,
         );
     }