add GSAVE/GRESTORE constants and expand test coverage for Draw, Gradient, and Raw

Author: nicolaasuni

VERSION

@@ -1 +1 @@
-2.4.23
+2.4.24

src/Base.php

@@ -98,6 +98,20 @@ abstract class Base
      */
     public const IDMATRIX = [1.0, 0.0, 0.0, 1.0, 0.0, 0.0];
 
+    /**
+     * PDF graphics state save operator.
+     *
+     * @var string
+     */
+    protected const GSAVE = 'q' . "\n";
+
+    /**
+     * PDF graphics state restore operator.
+     *
+     * @var string
+     */
+    protected const GRESTORE = 'Q' . "\n";
+
     /**
      * Current PDF object number
      */
@@ -123,6 +137,8 @@ abstract class Base
      */
     protected int $styleid = -1;
 
+
+
     /**
      * Stack containing style data.
      *

src/Draw.php

@@ -263,6 +263,10 @@ public function getBasicPolygon(
         array $style = [],
     ): string {
         $nco = \count($points); // number of coordinates
+        if ($nco < 4) {
+            return ''; // need at least 2 points (4 coordinates)
+        }
+
         $out = $this->getStyleCmd($style)
             . $this->getRawPoint($points[0], $points[1]);
         for ($idx = 2; $idx < $nco; $idx += 2) {
@@ -287,10 +291,6 @@ protected function getDefaultSegStyle(array $styles = []): string
             $out .= $this->getStyleCmd($styles['all']);
         }
 
-        if (empty($styles[0])) {
-            $styles[0] = [];
-        }
-
         return $out;
     }
 

src/Gradient.php

@@ -621,6 +621,10 @@ public function getCoonsPatchMesh(
             return '';
         }
 
+        if ($coords_max <= $coords_min) {
+            throw new GraphException('coords_max must be greater than coords_min');
+        }
+
         $ngr = (1 + \count($this->gradients));
         $this->gradients[$ngr] = [
             'antialias' => $antialias,

src/Raw.php

@@ -261,7 +261,7 @@ public function getRawEllipticalArc(
             return '';
         }
 
-        $bbox = [PHP_INT_MAX, PHP_INT_MAX, 0, 0];
+        $bbox = [PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MIN, PHP_INT_MIN];
         if ($pie) {
             $out .= $this->getRawPoint($posxc, $posyc); // center of the arc
         }

src/Style.php

@@ -368,7 +368,8 @@ protected function getLineModeCmd(array $style = []): string
                 $style['dashPhase'] = 0;
             }
 
-            return $out .= \sprintf('[%s] %F d' . "\n", \implode(' ', $dash), $style['dashPhase']);
+            $out .= \sprintf('[%s] %F d' . "\n", \implode(' ', $dash), $style['dashPhase']);
+            return $out;
         }
 
         return $out;

src/Transform.php

@@ -72,7 +72,7 @@ public function getStartTransform(): string
     {
         $this->saveStyleStatus();
         $this->ctm[++$this->ctmid] = [];
-        return 'q' . "\n";
+        return Base::GSAVE;
     }
 
     /**
@@ -88,7 +88,7 @@ public function getStopTransform(): string
         unset($this->ctm[$this->ctmid]);
         --$this->ctmid;
         $this->restoreStyleStatus();
-        return 'Q' . "\n";
+        return Base::GRESTORE;
     }
 
     /**
@@ -202,7 +202,7 @@ public function getHorizMirroring(float $posx): string
     }
 
     /**
-     * Verical Mirroring.
+     * Vertical Mirroring.
      *
      * @param float $posy Ordinate of the mirroring line.
      *
@@ -292,7 +292,7 @@ public function getVertTranslation(float $try): string
     public function getSkewing(float $angx, float $angy, float $posx, float $posy): string
     {
         if (($angx <= -90) || ($angx >= 90) || ($angy <= -90) || ($angy >= 90)) {
-            throw new GraphException('Angle values must be beweeen -90 and +90 degrees.');
+            throw new GraphException('Angle values must be between -90 and +90 degrees.');
         }
 
         $posy = (($this->pageh - $posy) * $this->kunit);

test/DrawTest.php

@@ -1096,4 +1096,13 @@ public function testGetRegistrationMarkInvalidColor(): void
         $draw = $this->getTestObject();
         $draw->getRegistrationMark(3, 5, 7, false, 'not-a-valid-color');
     }
+
+    public function testGetBasicPolygonTooFewPoints(): void
+    {
+        $draw = $this->getTestObject();
+        // empty array: no points at all
+        $this->assertEquals('', $draw->getBasicPolygon([]));
+        // two coordinates = one point, not enough to draw anything
+        $this->assertEquals('', $draw->getBasicPolygon([3, 5]));
+    }
 }

test/GradientTest.php

@@ -720,4 +720,40 @@ public function testGetCropMarkInvalidType(): void
             $res
         );
     }
+
+    public function testGetCoonsPatchMeshInvalidCoordsLess(): void
+    {
+        $this->bcExpectException('\\' . \Com\Tecnick\Pdf\Graph\Exception::class);
+        $draw = $this->getTestObject();
+        // coords_max < coords_min must throw
+        $draw->getCoonsPatchMesh(3, 5, 7, 11, [], 1.0, 0.5);
+    }
+
+    public function testGetCoonsPatchMeshInvalidCoordsEqual(): void
+    {
+        $this->bcExpectException('\\' . \Com\Tecnick\Pdf\Graph\Exception::class);
+        $draw = $this->getTestObject();
+        // coords_max == coords_min would cause division by zero
+        $draw->getCoonsPatchMesh(3, 5, 7, 11, [], 1.0, 1.0);
+    }
+
+    public function testGetGradientStopsDefaultsAndAutoOffset(): void
+    {
+        $draw = $this->getTestObject();
+        // middle stop has no explicit offset, exponent, or opacity
+        $stops = [
+            ['color' => 'red',  'offset' => 0.0],
+            ['color' => 'green'],
+            ['color' => 'blue', 'offset' => 1.0],
+        ];
+        $draw->getGradient(2, [0, 0, 1, 0], $stops, '', false);
+        $gradients = $draw->getGradientsArray();
+        $this->assertCount(1, $gradients);
+        $mid = $gradients[1]['colors'][1];
+        // auto-offset for the middle stop should be 0.5
+        $this->bcAssertEqualsWithDelta(0.5, $mid['offset'] ?? -1.0, 0.01);
+        // default exponent and opacity should be applied
+        $this->assertEquals(1, $mid['exponent'] ?? null);
+        $this->assertEquals(1, $mid['opacity'] ?? null);
+    }
 }

test/RawTest.php

@@ -172,4 +172,32 @@ public function testGetVectorsAngle(): void
         $res = $draw->getVectorsAngle(1, 0, -1, 0);
         $this->bcAssertEqualsWithDelta(M_PI, $res);
     }
+
+    public function testGetRawEllipticalArcBboxPopulated(): void
+    {
+        $draw = $this->getTestObject();
+        $bbox = [];
+        // full circle: bbox should be fully populated (no sentinel values remaining)
+        $draw->getRawEllipticalArc(3, 5, 7, 11, 0, 0, 360, false, 2, true, true, false, $bbox);
+        $this->assertCount(4, $bbox);
+        $this->assertLessThan(PHP_INT_MAX, $bbox[0]); // min-x was updated
+        $this->assertLessThan(PHP_INT_MAX, $bbox[1]); // min-y was updated
+        $this->assertGreaterThan(PHP_INT_MIN, $bbox[2]); // max-x was updated
+        $this->assertGreaterThan(PHP_INT_MIN, $bbox[3]); // max-y was updated
+    }
+
+    public function testGetRawEllipticalArcBboxNegativeMaxValues(): void
+    {
+        $draw = $this->getTestObject();
+        // Arc from 45° to 90° with centre at (0, 0) and vertical radius 5.
+        // In this range every cy control point is negative (cy = -rdv * sin(ang)).
+        // The PHP_INT_MIN initialisation ensures the max values are updated correctly
+        // even when all sampled points are negative.
+        $bbox = [];
+        $draw->getRawEllipticalArc(0, 0, 7, 5, 0, 45, 90, false, 2, true, true, false, $bbox);
+        $this->assertCount(4, $bbox);
+        $this->assertGreaterThan(PHP_INT_MIN, $bbox[2]); // max-x was updated from sentinel
+        $this->assertGreaterThan(PHP_INT_MIN, $bbox[3]); // max-y was updated from sentinel
+        $this->assertLessThan(0, $bbox[3]);              // all cy values in this arc are < 0
+    }
 }