Merge pull request #258 from spatie/feature/fit-fill-max

Implement Fit::FillMax

docs/image-manipulations/resizing-images.md

@@ -70,7 +70,7 @@ Resizes the image to fit within the width and height boundaries without cropping
 # Example of how to set background colour to fill remaining pixels
 
 $image
-    ->fit(fit: Fit::Fill, desiredWidth:  497,  desiredHeight: 290, backgroundColor: '#ff5733');
+    ->fit(fit: Fit::Fit::FillMax, desiredWidth:  497,  desiredHeight: 290, backgroundColor: '#ff5733');
 ```
 
 ![Blue background on fit filled JPG](../../images/example-background.png)

src/Drivers/Gd/GdDriver.php

@@ -22,6 +22,7 @@
 use Spatie\Image\Enums\Orientation;
 use Spatie\Image\Exceptions\CouldNotLoadImage;
 use Spatie\Image\Exceptions\InvalidFont;
+use Spatie\Image\Exceptions\MissingParameter;
 use Spatie\Image\Exceptions\UnsupportedImageFormat;
 use Spatie\Image\Point;
 use Spatie\Image\Size;
@@ -236,6 +237,14 @@ public function fit(
             return $this->fitCrop($fit, $this->getWidth(), $this->getHeight(), $desiredWidth, $desiredHeight);
         }
 
+        if ($fit === Fit::FillMax) {
+            if (is_null($desiredWidth) || is_null($desiredHeight)) {
+                throw new MissingParameter('Both desiredWidth and desiredHeight must be set when using Fit::FillMax');
+            }
+
+            return $this->fitFillMax($desiredWidth, $desiredHeight, $backgroundColor);
+        }
+
         $calculatedSize = $fit->calculateSize(
             $this->getWidth(),
             $this->getHeight(),
@@ -259,6 +268,14 @@ public function fit(
         return $this;
     }
 
+    public function fitFillMax(int $desiredWidth, int $desiredHeight, string $backgroundColor, bool $relative = false): static
+    {
+        $this->resize($desiredWidth, $desiredHeight, [Constraint::PreserveAspectRatio]);
+        $this->resizeCanvas($desiredWidth, $desiredHeight, AlignPosition::Center, $relative, $backgroundColor);
+
+        return $this;
+    }
+
     protected function modify(
         int $desiredWidth,
         int $desiredHeight,

src/Drivers/Imagick/ImagickDriver.php

@@ -22,6 +22,7 @@
 use Spatie\Image\Enums\FlipDirection;
 use Spatie\Image\Enums\Orientation;
 use Spatie\Image\Exceptions\InvalidFont;
+use Spatie\Image\Exceptions\MissingParameter;
 use Spatie\Image\Exceptions\UnsupportedImageFormat;
 use Spatie\Image\Point;
 use Spatie\Image\Size;
@@ -131,6 +132,14 @@ public function fit(
             return $this->fitCrop($fit, $this->getWidth(), $this->getHeight(), $desiredWidth, $desiredHeight);
         }
 
+        if ($fit === Fit::FillMax) {
+            if (is_null($desiredWidth) || is_null($desiredHeight)) {
+                throw new MissingParameter('Both desiredWidth and desiredHeight must be set when using Fit::FillMax');
+            }
+
+            return $this->fitFillMax($desiredWidth, $desiredHeight, $backgroundColor);
+        }
+
         $calculatedSize = $fit->calculateSize(
             $this->getWidth(),
             $this->getHeight(),
@@ -149,6 +158,14 @@ public function fit(
         return $this;
     }
 
+    public function fitFillMax(int $desiredWidth, int $desiredHeight, string $backgroundColor, bool $relative = false): static
+    {
+        $this->resize($desiredWidth, $desiredHeight, [Constraint::PreserveAspectRatio]);
+        $this->resizeCanvas($desiredWidth, $desiredHeight, AlignPosition::Center, $relative, $backgroundColor);
+
+        return $this;
+    }
+
     public function resizeCanvas(
         ?int $width = null,
         ?int $height = null,

src/Enums/Fit.php

@@ -12,6 +12,8 @@ enum Fit: string
     case Stretch = 'stretch';
     case Crop = 'crop';
 
+    case FillMax = 'fill-max';
+
     public function calculateSize(
         int $originalWidth,
         int $originalHeight,
@@ -25,7 +27,7 @@ public function calculateSize(
 
         $constraints = match ($this) {
             Fit::Contain => [Constraint::PreserveAspectRatio],
-            Fit::Fill, Fit::Max => [Constraint::PreserveAspectRatio, Constraint::DoNotUpsize],
+            Fit::Fill, Fit::Max, Fit::FillMax => [Constraint::PreserveAspectRatio, Constraint::DoNotUpsize],
             Fit::Stretch, Fit::Crop => [],
         };
 
@@ -34,6 +36,6 @@ public function calculateSize(
 
     public function shouldResizeCanvas(): bool
     {
-        return in_array($this, [self::Fill]);
+        return in_array($this, [self::Fill, self::FillMax]);
     }
 }

src/Exceptions/MissingParameter.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Spatie\Image\Exceptions;
+
+use Exception;
+
+class MissingParameter extends Exception
+{
+}

tests/Manipulations/FitTest.php

@@ -93,7 +93,7 @@
     $targetFile = $this->tempDir->path("{$driver->driverName()}/fit-background.png");
 
     $driver->loadFile(getTestJpg())
-        ->fit(fit: Fit::Fill, desiredWidth: 800, desiredHeight: 200, backgroundColor: '#0073ff')
+        ->fit(fit: Fit::FillMax, desiredWidth: 800, desiredHeight: 400, backgroundColor: '#0073ff')
         ->save($targetFile);
 
     assertMatchesImageSnapshot($targetFile);