Refactor media dimensions to use float type for width and height (#23)

j4ceee · web-flow · commit 67734d8284ab · 2025-11-04T23:22:15.000+01:00
diff --git a/src/Builder/MediaBuilder.php b/src/Builder/MediaBuilder.php
@@ -10,7 +10,7 @@ trait MediaBuilder
 {
     use BuilderInterface;
 
-    public function media(string $id, string $mediaType, string $collection, ?int $width = null, ?int $height = null, ?string $occurrenceKey = null): Media
+    public function media(string $id, string $mediaType, string $collection, ?float $width = null, ?float $height = null, ?string $occurrenceKey = null): Media
     {
         $block = new Media($id, $mediaType, $collection, $width, $height, $occurrenceKey, $this);
         $this->append($block);
diff --git a/src/Builder/MediaSingleBuilder.php b/src/Builder/MediaSingleBuilder.php
@@ -10,7 +10,7 @@ trait MediaSingleBuilder
 {
     use BuilderInterface;
 
-    public function mediaSingle(string $layout, ?int $width = null): MediaSingle
+    public function mediaSingle(string $layout, ?float $width = null): MediaSingle
     {
         $block = new MediaSingle($layout, $width, $this);
         $this->append($block);
diff --git a/src/Node/Block/MediaSingle.php b/src/Node/Block/MediaSingle.php
@@ -31,9 +31,9 @@ class MediaSingle extends BlockNode implements JsonSerializable
         Media::class,
     ];
     private string $layout;
-    private ?int $width;
+    private ?float $width;
 
-    public function __construct(string $layout, ?int $width = null, ?BlockNode $parent = null)
+    public function __construct(string $layout, ?float $width = null, ?BlockNode $parent = null)
     {
         if (!\in_array($layout, [
             self::LAYOUT_WRAP_LEFT,
@@ -49,6 +49,9 @@ public function __construct(string $layout, ?int $width = null, ?BlockNode $pare
 
         parent::__construct($parent);
         $this->layout = $layout;
+
+        if (is_float($width))
+            $width = round($width, 2);
         $this->width = $width;
     }
 
@@ -77,7 +80,7 @@ public function getLayout(): string
         return $this->layout;
     }
 
-    public function getWidth(): ?int
+    public function getWidth(): ?float
     {
         return $this->width;
     }
diff --git a/src/Node/Child/Media.php b/src/Node/Child/Media.php
@@ -21,10 +21,10 @@ class Media extends Node
     private string $mediaType;
     private string $collection;
     private ?string $occurrenceKey;
-    private ?int $width;
-    private ?int $height;
+    private ?float $width;
+    private ?float $height;
 
-    public function __construct(string $id, string $mediaType, string $collection, ?int $width = null, ?int $height = null, ?string $occurrenceKey = null, ?BlockNode $parent = null)
+    public function __construct(string $id, string $mediaType, string $collection, ?float $width = null, ?float $height = null, ?string $occurrenceKey = null, ?BlockNode $parent = null)
     {
         if (!\in_array($mediaType, [self::TYPE_FILE, self::TYPE_LINK], true)) {
             throw new InvalidArgumentException('Invalid media type');
@@ -35,7 +35,13 @@ public function __construct(string $id, string $mediaType, string $collection, ?
         $this->mediaType = $mediaType;
         $this->collection = $collection;
         $this->occurrenceKey = $occurrenceKey;
+
+        if (is_float($width))
+            $width = round($width, 2);
         $this->width = $width;
+
+        if (is_float($height))
+            $height = round($height, 2);
         $this->height = $height;
     }
 
@@ -75,12 +81,12 @@ public function getOccurrenceKey(): ?string
         return $this->occurrenceKey;
     }
 
-    public function getWidth(): ?int
+    public function getWidth(): ?float
     {
         return $this->width;
     }
 
-    public function getHeight(): ?int
+    public function getHeight(): ?float
     {
         return $this->height;
     }
diff --git a/tests/Exporter/Html/Block/DocumentExporterTest.php b/tests/Exporter/Html/Block/DocumentExporterTest.php
@@ -211,28 +211,28 @@ public function testDocumentWithMediaSingle(): void
     {
         $document = (new Document())
             ->mediaSingle(MediaSingle::LAYOUT_WIDE)
-            ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100, 200)
+            ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 110.7, 200)
             ->end()
             ->end()
         ;
         $exporter = new DocumentExporter($document);
 
-        self::assertSame('<div class="adf-container"><div class="adf-mediasingle"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
+        self::assertSame('<div class="adf-container"><div class="adf-mediasingle"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":110.7,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
     }
 
     public function testDocumentWithMediaGroup(): void
     {
         $document = (new Document())
             ->mediaGroup()
-            ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100, 200)
+            ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100.335, 200)
             ->end()
-            ->media('7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7', Media::TYPE_FILE, 'my project files', 100, 200)
+            ->media('7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7', Media::TYPE_FILE, 'my project files', 100, 220.5)
             ->end()
             ->end()
         ;
         $exporter = new DocumentExporter($document);
 
-        self::assertSame('<div class="adf-container"><div class="adf-mediagroup"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div><div class="adf-media"><!--{"type":"media","attrs":{"id":"7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
+        self::assertSame('<div class="adf-container"><div class="adf-mediagroup"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100.34,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div><div class="adf-media"><!--{"type":"media","attrs":{"id":"7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7","type":"file","collection":"my project files","width":100,"height":220.5}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
     }
 
     public function testDocumentWithTable(): void

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ trait MediaBuilder`
`10`	`10`	`{`
`11`	`11`	`use BuilderInterface;`
`12`	`12`
`13`		`- public function media(string $id, string $mediaType, string $collection, ?int $width = null, ?int $height = null, ?string $occurrenceKey = null): Media`
	`13`	`+ public function media(string $id, string $mediaType, string $collection, ?float $width = null, ?float $height = null, ?string $occurrenceKey = null): Media`
`14`	`14`	`{`
`15`	`15`	`$block = new Media($id, $mediaType, $collection, $width, $height, $occurrenceKey, $this);`
`16`	`16`	`$this->append($block);`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ trait MediaSingleBuilder`
`10`	`10`	`{`
`11`	`11`	`use BuilderInterface;`
`12`	`12`
`13`		`- public function mediaSingle(string $layout, ?int $width = null): MediaSingle`
	`13`	`+ public function mediaSingle(string $layout, ?float $width = null): MediaSingle`
`14`	`14`	`{`
`15`	`15`	`$block = new MediaSingle($layout, $width, $this);`
`16`	`16`	`$this->append($block);`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,9 @@ class MediaSingle extends BlockNode implements JsonSerializable`
`31`	`31`	`Media::class,`
`32`	`32`	`];`
`33`	`33`	`private string $layout;`
`34`		`- private ?int $width;`
	`34`	`+ private ?float $width;`
`35`	`35`
`36`		`- public function __construct(string $layout, ?int $width = null, ?BlockNode $parent = null)`
	`36`	`+ public function __construct(string $layout, ?float $width = null, ?BlockNode $parent = null)`
`37`	`37`	`{`
`38`	`38`	`if (!\in_array($layout, [`
`39`	`39`	`self::LAYOUT_WRAP_LEFT,`
`@@ -49,6 +49,9 @@ public function __construct(string $layout, ?int $width = null, ?BlockNode $pare`
`49`	`49`
`50`	`50`	`parent::__construct($parent);`
`51`	`51`	`$this->layout = $layout;`
	`52`	`+`
	`53`	`+ if (is_float($width))`
	`54`	`+ $width = round($width, 2);`
`52`	`55`	`$this->width = $width;`
`53`	`56`	`}`
`54`	`57`
`@@ -77,7 +80,7 @@ public function getLayout(): string`
`77`	`80`	`return $this->layout;`
`78`	`81`	`}`
`79`	`82`
`80`		`- public function getWidth(): ?int`
	`83`	`+ public function getWidth(): ?float`
`81`	`84`	`{`
`82`	`85`	`return $this->width;`
`83`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ class Media extends Node`
`21`	`21`	`private string $mediaType;`
`22`	`22`	`private string $collection;`
`23`	`23`	`private ?string $occurrenceKey;`
`24`		`- private ?int $width;`
`25`		`- private ?int $height;`
	`24`	`+ private ?float $width;`
	`25`	`+ private ?float $height;`
`26`	`26`
`27`		`- public function __construct(string $id, string $mediaType, string $collection, ?int $width = null, ?int $height = null, ?string $occurrenceKey = null, ?BlockNode $parent = null)`
	`27`	`+ public function __construct(string $id, string $mediaType, string $collection, ?float $width = null, ?float $height = null, ?string $occurrenceKey = null, ?BlockNode $parent = null)`
`28`	`28`	`{`
`29`	`29`	`if (!\in_array($mediaType, [self::TYPE_FILE, self::TYPE_LINK], true)) {`
`30`	`30`	`throw new InvalidArgumentException('Invalid media type');`
`@@ -35,7 +35,13 @@ public function __construct(string $id, string $mediaType, string $collection, ?`
`35`	`35`	`$this->mediaType = $mediaType;`
`36`	`36`	`$this->collection = $collection;`
`37`	`37`	`$this->occurrenceKey = $occurrenceKey;`
	`38`	`+`
	`39`	`+ if (is_float($width))`
	`40`	`+ $width = round($width, 2);`
`38`	`41`	`$this->width = $width;`
	`42`	`+`
	`43`	`+ if (is_float($height))`
	`44`	`+ $height = round($height, 2);`
`39`	`45`	`$this->height = $height;`
`40`	`46`	`}`
`41`	`47`
`@@ -75,12 +81,12 @@ public function getOccurrenceKey(): ?string`
`75`	`81`	`return $this->occurrenceKey;`
`76`	`82`	`}`
`77`	`83`
`78`		`- public function getWidth(): ?int`
	`84`	`+ public function getWidth(): ?float`
`79`	`85`	`{`
`80`	`86`	`return $this->width;`
`81`	`87`	`}`
`82`	`88`
`83`		`- public function getHeight(): ?int`
	`89`	`+ public function getHeight(): ?float`
`84`	`90`	`{`
`85`	`91`	`return $this->height;`
`86`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -211,28 +211,28 @@ public function testDocumentWithMediaSingle(): void`
`211`	`211`	`{`
`212`	`212`	`$document = (new Document())`
`213`	`213`	`->mediaSingle(MediaSingle::LAYOUT_WIDE)`
`214`		`- ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100, 200)`
	`214`	`+ ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 110.7, 200)`
`215`	`215`	`->end()`
`216`	`216`	`->end()`
`217`	`217`	`;`
`218`	`218`	`$exporter = new DocumentExporter($document);`
`219`	`219`
`220`		`- self::assertSame('<div class="adf-container"><div class="adf-mediasingle"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());`
	`220`	`+ self::assertSame('<div class="adf-container"><div class="adf-mediasingle"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":110.7,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`public function testDocumentWithMediaGroup(): void`
`224`	`224`	`{`
`225`	`225`	`$document = (new Document())`
`226`	`226`	`->mediaGroup()`
`227`		`- ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100, 200)`
	`227`	`+ ->media('6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5', Media::TYPE_FILE, 'my project files', 100.335, 200)`
`228`	`228`	`->end()`
`229`		`- ->media('7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7', Media::TYPE_FILE, 'my project files', 100, 200)`
	`229`	`+ ->media('7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7', Media::TYPE_FILE, 'my project files', 100, 220.5)`
`230`	`230`	`->end()`
`231`	`231`	`->end()`
`232`	`232`	`;`
`233`	`233`	`$exporter = new DocumentExporter($document);`
`234`	`234`
`235`		- self::assertSame('<div class="adf-container"><div class="adf-mediagroup"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div><div class="adf-media"><!--{"type":"media","attrs":{"id":"7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7","type":"file","collection":"my project files","width":100,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
	`235`	+ self::assertSame('<div class="adf-container"><div class="adf-mediagroup"><div class="adf-media"><!--{"type":"media","attrs":{"id":"6e7c7f2c-dd7a-499c-bceb-6f32bfbf30b5","type":"file","collection":"my project files","width":100.34,"height":200}}--><p>Atlassian Media API is not publicly available at the moment.</p></div><div class="adf-media"><!--{"type":"media","attrs":{"id":"7a7c7f2c-dd7a-499c-bceb-6f32bfbf30c7","type":"file","collection":"my project files","width":100,"height":220.5}}--><p>Atlassian Media API is not publicly available at the moment.</p></div></div></div>', $exporter->export());
`236`	`236`	`}`
`237`	`237`
`238`	`238`	`public function testDocumentWithTable(): void`