Add coordinate system CoordinateSystem2x16, generalize scalars for rows and columns

Author: fischerl

CHANGELOG.md

@@ -9,6 +9,17 @@ See [GitHub releases](https://github.com/mll-lab/php-utils/releases).
 
 ## Unreleased
 
+## v5.0.0
+
+### Added
+
+- Add coordinate system `CoordinateSystem2x16`
+
+### Changed
+
+- Breaking Change: Renamed class `Column96Well` to `Column12`
+- Breaking Change: Renamed class `Row96Well` to `Row8`
+-
 ## v4.1.0
 
 ### Added

composer.json

@@ -26,7 +26,7 @@
   "require-dev": {
     "ergebnis/composer-normalize": "^2",
     "jangregor/phpstan-prophecy": "^1",
-    "mll-lab/graphql-php-scalars": "^6",
+    "mll-lab/graphql-php-scalars": "^6.3",
     "mll-lab/php-cs-fixer-config": "^5",
     "phpstan/extension-installer": "^1",
     "phpstan/phpstan": "^1",
@@ -38,7 +38,7 @@
     "thecodingmachine/phpstan-safe-rule": "^1.2"
   },
   "suggest": {
-    "mll-lab/graphql-php-scalars": "To use the provided scalar types for GraphQL servers, requires version ^6"
+    "mll-lab/graphql-php-scalars": "To use the provided scalar types for GraphQL servers, requires version ^6.3"
   },
   "autoload": {
     "psr-4": {

src/Microplate/CoordinateSystem2x16.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\Microplate;
+
+class CoordinateSystem2x16 extends CoordinateSystem
+{
+    /** Duplicates @see CoordinateSystem::positionsCount() for static contexts. */
+    public const POSITIONS_COUNT = 32;
+
+    public function rows(): array
+    {
+        return range('A', 'P');
+    }
+
+    public function columns(): array
+    {
+        return range(1, 2);
+    }
+}

src/Microplate/Scalars/Column12.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\Microplate\Scalars;
+
+use MLL\GraphQLScalars\IntRange;
+
+class Column12 extends IntRange
+{
+    public ?string $description = 'Represents a column in a coordinate system with 12 columns. Allowed values range from 1-12.';
+
+    protected static function min(): int
+    {
+        return 1;
+    }
+
+    protected static function max(): int
+    {
+        return 12;
+    }
+}

src/Microplate/Scalars/Column2.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\Microplate\Scalars;
+
+use MLL\GraphQLScalars\IntRange;
+
+class Column2 extends IntRange
+{
+    public ?string $description = 'Represents a column in a coordinate system with 2 columns. Allowed values range from 1-2.';
+
+    protected static function min(): int
+    {
+        return 1;
+    }
+
+    protected static function max(): int
+    {
+        return 2;
+    }
+}

src/Microplate/Scalars/Column96Well.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\Microplate\Scalars;
+
+use MLL\GraphQLScalars\Regex;
+
+class Row16 extends Regex
+{
+    public ?string $description = 'Represents a row in a coordinate system with 16 rows. Allowed values range from A-P.';
+
+    public static function regex(): string
+    {
+        return '/^[A-P]$/';
+    }
+}

src/Microplate/Scalars/Row16.php

@@ -4,9 +4,9 @@
 
 use MLL\GraphQLScalars\Regex;
 
-class Row96Well extends Regex
+class Row8 extends Regex
 {
-    public ?string $description = 'Checks if the given row is of the format 96-well row';
+    public ?string $description = 'Represents a row in a coordinate system with 8 rows. Allowed values range from A-H.';
 
     public static function regex(): string
     {

src/Microplate/Scalars/Row96Well.php renamed to src/Microplate/Scalars/Row8.php

@@ -4,6 +4,7 @@
 
 use MLL\Utils\Microplate\CoordinateSystem;
 use MLL\Utils\Microplate\CoordinateSystem12Well;
+use MLL\Utils\Microplate\CoordinateSystem2x16;
 use MLL\Utils\Microplate\CoordinateSystem48Well;
 use MLL\Utils\Microplate\CoordinateSystem96Well;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -30,12 +31,14 @@ public static function firstLast(): iterable
         yield [new CoordinateSystem12Well(), 'A1', 'C4'];
         yield [new CoordinateSystem48Well(), 'A1', 'F8'];
         yield [new CoordinateSystem96Well(), 'A1', 'H12'];
+        yield [new CoordinateSystem2x16(), 'A1', 'P2'];
     }
 
     public function testPositionsCount(): void
     {
         self::assertSame(CoordinateSystem12Well::POSITIONS_COUNT, (new CoordinateSystem12Well())->positionsCount());
         self::assertSame(CoordinateSystem48Well::POSITIONS_COUNT, (new CoordinateSystem48Well())->positionsCount());
         self::assertSame(CoordinateSystem96Well::POSITIONS_COUNT, (new CoordinateSystem96Well())->positionsCount());
+        self::assertSame(CoordinateSystem2x16::POSITIONS_COUNT, (new CoordinateSystem2x16())->positionsCount());
     }
 }