Add FluentMatchPattern.groupByCallback() #35

t-regx · Nov 4, 2019 · a868811 · a868811
1 parent c7c1e4c
commit a868811
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 0 deletions.
diff --git a/src/TRegx/CleanRegex/Exception/CleanRegex/InvalidReturnValueException.php b/src/TRegx/CleanRegex/Exception/CleanRegex/InvalidReturnValueException.php
@@ -25,4 +25,9 @@ public static function forFilter($value): self
     {
         return new self($value, 'filter', 'bool');
     }
+
+    public static function forGroupBy($value): self
+    {
+        return new self($value, 'groupBy', 'int|string');
+    }
 }
diff --git a/src/TRegx/CleanRegex/Match/FluentMatchPattern.php b/src/TRegx/CleanRegex/Match/FluentMatchPattern.php
@@ -6,6 +6,7 @@
 use Iterator;
 use TRegx\CleanRegex\Exception\CleanRegex\FluentMatchPatternException;
 use TRegx\CleanRegex\Exception\CleanRegex\IntegerFormatException;
+use TRegx\CleanRegex\Exception\CleanRegex\InvalidReturnValueException;
 use TRegx\CleanRegex\Exception\CleanRegex\NoFirstElementFluentException;
 use TRegx\CleanRegex\Internal\Factory\NotMatchedFluentOptionalWorker;
 use TRegx\CleanRegex\Internal\Factory\NotMatchedWorker;
@@ -131,6 +132,20 @@ public function asInt(): FluentMatchPattern
         });
     }
 
+    public function groupByCallback(callable $groupMapper): FluentMatchPattern
+    {
+        $map = [];
+        foreach ($this->elements as $element) {
+            $key = $groupMapper($element);
+            if (\is_int($key) || \is_string($key)) {
+                $map[$key][] = $element;
+            } else {
+                throw InvalidReturnValueException::forGroupBy($key);
+            }
+        }
+        return $this->next($map);
+    }
+
     private function next(array $elements): FluentMatchPattern
     {
         return new FluentMatchPattern($elements, $this->worker);

diff --git a/test/Unit/TRegx/CleanRegex/Internal/Match/FluentMatchPatternTest.php b/test/Unit/TRegx/CleanRegex/Internal/Match/FluentMatchPatternTest.php
@@ -282,6 +282,48 @@ public function shouldThrowForNonStringAndNonInt()
         $pattern->asInt();
     }
 
+    /**
+     * @test
+     */
+    public function shouldGroupBy()
+    {
+        // given
+        $pattern = new FluentMatchPattern(['Father', 'Mother', 'Maiden', 'Crone', 'Warrior', 'Smith', 'Stranger'], $this->mock());
+
+        // when
+        $result = $pattern->groupByCallback(function (string $fucker) {
+            return $fucker[0];
+        });
+
+        // then
+        $expected = [
+            'F' => ['Father'],
+            'M' => ['Mother', 'Maiden'],
+            'C' => ['Crone'],
+            'W' => ['Warrior'],
+            'S' => ['Smith', 'Stranger'],
+        ];
+        $this->assertSame($expected, $result->all());
+    }
+
+    /**
+     * @test
+     */
+    public function shouldThrowForInvalidGroupByType()
+    {
+        // given
+        $pattern = new FluentMatchPattern([''], $this->mock());
+
+        // then
+        $this->expectException(InvalidReturnValueException::class);
+        $this->expectExceptionMessage('Invalid groupBy() callback return type. Expected int|string, but array (0) given');
+
+        // when
+        $pattern->groupByCallback(function () {
+            return [];
+        });
+    }
+
     private function mock(): NotMatchedWorker
     {
         /** @var NotMatchedWorker $mockObject */