Fix mis-clamped focal point crops

Author: timkelty

src/imagetransforms/ImageTransform.php

@@ -70,7 +70,7 @@ class ImageTransform extends \craft\models\ImageTransform
     public ?float $gamma = null;
 
     /**
-     * @var 'auto'|'face'|'left'|'right'|'top'|'bottom'|array{x?: float, y?: float}|null
+     * @var 'auto'|'face'|'left'|'right'|'top'|'bottom'|array{x?: float, y?: float, mode?: 'remainder'|'box-center'}|null
      */
     public string|array|null $gravity = null;
 

src/imagetransforms/ImageTransformer.php

@@ -50,9 +50,7 @@ public function getTransformUrl(Asset $asset, \craft\models\ImageTransform $imag
             $imageTransform = Craft::createObject(ImageTransform::class, [$imageTransform->toArray()]);
         }
 
-        if ($asset->getHasFocalPoint() && !isset($imageTransform->gravity)) {
-            $imageTransform->gravity = $asset->getFocalPoint();
-        }
+        $this->applyAssetFocalPointGravity($asset, $imageTransform);
 
         $query = Query::fromVariable($imageTransform->toOptions());
         $uri = Modifier::wrap(Uri::new($assetUrl))
@@ -66,6 +64,20 @@ public function invalidateAssetTransforms(Asset $asset): void
     {
     }
 
+    protected function applyAssetFocalPointGravity(Asset $asset, ImageTransform $imageTransform): void
+    {
+        if (!$asset->getHasFocalPoint() || isset($imageTransform->gravity) || $imageTransform->mode !== 'crop') {
+            return;
+        }
+
+        $focalPoint = $asset->getFocalPoint();
+        $imageTransform->gravity = [
+            'x' => $focalPoint['x'],
+            'y' => $focalPoint['y'],
+            'mode' => 'box-center',
+        ];
+    }
+
     private function sign(UriInterface $uri): UriInterface
     {
         $data = "{$uri->getPath()}#?{$uri->getQuery()}";

tests/unit/ImageTransformTest.php

@@ -0,0 +1,117 @@
+<?php
+
+namespace craft\cloud\tests\unit;
+
+use Codeception\Test\Unit;
+use craft\cloud\imagetransforms\ImageTransform;
+use craft\cloud\imagetransforms\ImageTransformer;
+use craft\elements\Asset;
+
+class ImageTransformTest extends Unit
+{
+    /**
+     * @var \UnitTester
+     */
+    protected $tester;
+
+    public function testCropModeWithExplicitGravityModePreservesItInOptions(): void
+    {
+        $transform = new ImageTransform([
+            'mode' => 'crop',
+            'width' => 1200,
+            'height' => 750,
+            'gravity' => [
+                'x' => 0.57,
+                'y' => 0.7707,
+                'mode' => 'box-center',
+            ],
+        ]);
+
+        $this->assertSame([
+            'fit' => 'cover',
+            'gravity' => [
+                'x' => 0.57,
+                'y' => 0.7707,
+                'mode' => 'box-center',
+            ],
+            'height' => 750,
+            'width' => 1200,
+        ], $transform->toOptions());
+    }
+
+    public function testCropModeWithoutGravityUsesPositionMapping(): void
+    {
+        $transform = new ImageTransform([
+            'mode' => 'crop',
+            'position' => 'top-center',
+            'width' => 1200,
+            'height' => 750,
+        ]);
+
+        $this->assertSame([
+            'fit' => 'cover',
+            'gravity' => [
+                'x' => 0.5,
+                'y' => 0,
+            ],
+            'height' => 750,
+            'width' => 1200,
+        ], $transform->toOptions());
+    }
+
+    public function testFocalPointCropUsesBoxCenteredGravity(): void
+    {
+        $asset = $this->makeAssetStub(true, ['x' => 0.57, 'y' => 0.7707]);
+        $transform = new ImageTransform([
+            'mode' => 'crop',
+            'width' => 1200,
+            'height' => 750,
+            'position' => 'top-center',
+        ]);
+
+        (new TestImageTransformer())->applyFocalPointGravity($asset, $transform);
+
+        $this->assertSame([
+            'x' => 0.57,
+            'y' => 0.7707,
+            'mode' => 'box-center',
+        ], $transform->gravity);
+    }
+
+    private function makeAssetStub(bool $hasFocalPoint, array $focalPoint): Asset
+    {
+        return new class($hasFocalPoint, $focalPoint) extends Asset {
+            public function __construct(private bool $hasFocalPoint, private array $focalPoint)
+            {
+                parent::__construct();
+            }
+
+            public function getHasFocalPoint(): bool
+            {
+                return $this->hasFocalPoint;
+            }
+
+            public function getFocalPoint(bool $asCss = false): array|string|null
+            {
+                if ($asCss) {
+                    return ($this->focalPoint['x'] * 100) . '% ' . ($this->focalPoint['y'] * 100) . '%';
+                }
+
+                return $this->focalPoint;
+            }
+
+            public function getMimeType(mixed $transform = null): ?string
+            {
+                return 'image/jpeg';
+            }
+        };
+    }
+}
+
+class TestImageTransformer extends ImageTransformer
+{
+    public function applyFocalPointGravity(Asset $asset, ImageTransform $imageTransform): void
+    {
+        $this->applyAssetFocalPointGravity($asset, $imageTransform);
+    }
+}