Merge pull request #8 from mll-lab/wells-matchers

Add methods `AbstractMicroplate::matchRow()` and `AbstractMicroplate::matchColumn()`

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v3.2.0
+
+### Added
+
+- Add methods `AbstractMicroplate::matchRow()` and `AbstractMicroplate::matchColumn()`
+
 ## v3.1.0
 
 ### Added

composer.json

@@ -35,6 +35,11 @@
     "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"
     },

src/AbstractMicroplate.php

@@ -104,4 +104,28 @@ public function filledWells(): Collection
             static fn ($value): bool => self::EMPTY_WELL !== $value
         );
     }
+
+    /**
+     * @return callable(mixed $value, string $coordinateString): bool
+     */
+    public function matchRow(string $row): callable
+    {
+        return function ($value, string $coordinateString) use ($row): bool {
+            $coordinate = Coordinate::fromString($coordinateString, $this->coordinateSystem);
+
+            return $coordinate->row === $row;
+        };
+    }
+
+    /**
+     * @return callable(mixed $value, string $coordinateString): bool
+     */
+    public function matchColumn(int $column): callable
+    {
+        return function ($value, string $coordinateString) use ($column): bool {
+            $coordinate = Coordinate::fromString($coordinateString, $this->coordinateSystem);
+
+            return $coordinate->column === $column;
+        };
+    }
 }

tests/Unit/MicroplateTest.php

@@ -13,7 +13,7 @@
 
 class MicroplateTest extends Framework\TestCase
 {
-    public function testCanAddAndRetriedWellBasedOnCoordinateSystem(): void
+    public function testCanAddAndRetrieveWellBasedOnCoordinateSystem(): void
     {
         $coordinateSystem = new CoordinateSystem96Well();
 
@@ -36,6 +36,47 @@ public function testCanAddAndRetriedWellBasedOnCoordinateSystem(): void
         $microplate->addWell($coordinateWithOtherCoordinateSystem, 'foo');
     }
 
+    public function testMatchRow(): void
+    {
+        $coordinateSystem = new CoordinateSystem96Well();
+
+        $microplate = new Microplate($coordinateSystem);
+
+        $content = 'foo';
+        $coordinate = new Coordinate('A', 1, $coordinateSystem);
+        $key = $coordinate->toString();
+        $microplate->addWell($coordinate, $content);
+
+        $microplate->addWell(new Coordinate('B', 1, $coordinateSystem), 'bar');
+
+        $wells = $microplate->wells();
+
+        $a = $wells->filter($microplate->matchRow('A'));
+        self::assertCount($coordinateSystem->columnsCount(), $a);
+        self::assertSame($content, $a[$key]);
+
+        $notA = $wells->reject($microplate->matchRow('A'));
+        self::assertCount($coordinateSystem->positionsCount() - $coordinateSystem->columnsCount(), $notA);
+
+        $noMatch = $microplate->filledWells()
+            ->filter($microplate->matchRow('C'));
+        self::assertCount(0, $noMatch);
+    }
+
+    public function testMatchColumn(): void
+    {
+        $coordinateSystem = new CoordinateSystem96Well();
+
+        $microplate = new Microplate($coordinateSystem);
+
+        $coordinateColumn1 = (new Coordinate('A', 1, $coordinateSystem))->toString();
+        $coordinateColumn2 = (new Coordinate('A', 2, $coordinateSystem))->toString();
+
+        $matchColumn = $microplate->matchColumn(1);
+        self::assertTrue($matchColumn('foo', $coordinateColumn1));
+        self::assertFalse($matchColumn('foo', $coordinateColumn2));
+    }
+
     public function testSortedWells(): void
     {
         $microplate = $this->preparePlate();