Add Coordinate#toPaddedString()

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v3.5.0
+
+### Added
+
+- Add `Coordinate#toPaddedString()`
+
 ## v3.4.0
 
 ### Added

composer.json

@@ -1,15 +1,19 @@
 {
   "name": "mll-lab/microplate",
-  "type": "library",
   "description": "PHP package to easily work with microplate data",
-  "homepage": "https://github.com/mll-lab/microplate",
   "license": "MIT",
+  "type": "library",
   "authors": [
     {
       "name": "Simon Bigelmayr",
       "email": "[email protected]"
     }
   ],
+  "homepage": "https://github.com/mll-lab/microplate",
+  "support": {
+    "issues": "https://github.com/mll-lab/microplate/issues",
+    "source": "https://github.com/mll-lab/microplate"
+  },
   "require": {
     "php": "^7.4 || ^8",
     "illuminate/support": "^7 || ^8",
@@ -34,18 +38,6 @@
     "symfony/var-dumper": "^5",
     "thecodingmachine/phpstan-safe-rule": "^1.1"
   },
-  "config": {
-    "allow-plugins": {
-      "ergebnis/composer-normalize": true,
-      "infection/extension-installer": true,
-      "phpstan/extension-installer": true
-    },
-    "platform": {
-      "php": "7.4.24"
-    },
-    "preferred-install": "dist",
-    "sort-packages": true
-  },
   "autoload": {
     "psr-4": {
       "Mll\\Microplate\\": "src/"
@@ -59,8 +51,16 @@
       "vendor/symfony/var-dumper/Resources/functions/dump.php"
     ]
   },
-  "support": {
-    "issues": "https://github.com/mll-lab/microplate/issues",
-    "source": "https://github.com/mll-lab/microplate"
+  "config": {
+    "allow-plugins": {
+      "ergebnis/composer-normalize": true,
+      "infection/extension-installer": true,
+      "phpstan/extension-installer": true
+    },
+    "platform": {
+      "php": "7.4.24"
+    },
+    "preferred-install": "dist",
+    "sort-packages": true
   }
 }

src/Coordinate.php

@@ -88,6 +88,14 @@ public function toString(): string
         return $this->row . $this->column;
     }
 
+    /**
+     * Format the coordinate with the column 0-padded so all are the same length.
+     */
+    public function toPaddedString(): string
+    {
+        return $this->row . $this->coordinateSystem->padColumn($this->column);
+    }
+
     /**
      * @param TCoordinateSystem $coordinateSystem
      *

src/CoordinateSystem.php

@@ -21,16 +21,24 @@ abstract public function columns(): array;
      */
     public function paddedColumns(): array
     {
-        $maxColumnLength = strlen((string) $this->columnsCount());
-
         $paddedColumns = [];
         foreach ($this->columns() as $column) {
-            $paddedColumns[] = str_pad((string) $column, $maxColumnLength, '0', STR_PAD_LEFT);
+            $paddedColumns[] = $this->padColumn($column);
         }
 
         return $paddedColumns;
     }
 
+    /**
+     * 0-pad column to be as long as the longest column in the coordinate system.
+     */
+    public function padColumn(int $column): string
+    {
+        $maxColumnLength = strlen((string) $this->columnsCount());
+
+        return str_pad((string) $column, $maxColumnLength, '0', STR_PAD_LEFT);
+    }
+
     public function rowForRowFlowPosition(int $position): string
     {
         return $this->rows()[floor(($position - 1) / $this->columnsCount())];
@@ -57,6 +65,10 @@ public function positionsCount(): int
     }
 
     /**
+     * Returns all possible coordinates of the system, ordered by column then row.
+     *
+     * e.g. A1, A2, B1, B2
+     *
      * @return iterable<int, Coordinate>
      */
     public function all(): iterable

tests/Unit/CoordinateTest.php

@@ -63,6 +63,7 @@ public function testFromPaddedCoordinatesString(string $paddedCoordinate, string
         $coordinateFromPadded = Coordinate::fromString($paddedCoordinate, new CoordinateSystem96Well());
         self::assertSame($row, $coordinateFromPadded->row);
         self::assertSame($column, $coordinateFromPadded->column);
+        self::assertSame($paddedCoordinate, $coordinateFromPadded->toPaddedString());
     }
 
     /**