Add byteOffsets() for Match.groups() and Match.namedGroups() (#31)

t-regx · Dec 2, 2018 · 8025c6c · 8025c6c
1 parent 654db12
commit 8025c6c
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 27 deletions.
diff --git a/src/TRegx/CleanRegex/Match/Details/Groups/AbstractMatchGroups.php b/src/TRegx/CleanRegex/Match/Details/Groups/AbstractMatchGroups.php
@@ -2,18 +2,23 @@
 namespace TRegx\CleanRegex\Match\Details\Groups;
 
 use TRegx\CleanRegex\Exception\CleanRegex\InternalCleanRegexException;
+use TRegx\CleanRegex\Internal\ByteOffset;
 use TRegx\CleanRegex\Internal\Model\Match\IRawMatchOffset;
+use TRegx\CleanRegex\Internal\Subjectable;
 
 abstract class AbstractMatchGroups implements MatchGroups
 {
     /** @var IRawMatchOffset */
     protected $match;
     /** @var int */
     protected $index;
+    /** @var Subjectable */
+    private $subjectable;
 
-    protected function __construct(IRawMatchOffset $match)
+    public function __construct(IRawMatchOffset $match, Subjectable $subjectable)
     {
         $this->match = $match;
+        $this->subjectable = $subjectable;
     }
 
     /**
@@ -28,6 +33,16 @@ public function texts(): array
      * @return (int|null)[]
      */
     public function offsets(): array
+    {
+        return array_map(function (int $offset) {
+            return ByteOffset::toCharacterOffset($this->subjectable->getSubject(), $offset);
+        }, $this->byteOffsets());
+    }
+
+    /**
+     * @return (int|null)[]
+     */
+    public function byteOffsets()
     {
         return $this->sliceAndFilter($this->match->getGroupsOffsets());
     }

diff --git a/src/TRegx/CleanRegex/Match/Details/Groups/IndexedGroups.php b/src/TRegx/CleanRegex/Match/Details/Groups/IndexedGroups.php
@@ -1,15 +1,8 @@
 <?php
 namespace TRegx\CleanRegex\Match\Details\Groups;
 
-use TRegx\CleanRegex\Internal\Model\Match\IRawMatchOffset;
-
 class IndexedGroups extends AbstractMatchGroups
 {
-    public function __construct(IRawMatchOffset $match)
-    {
-        parent::__construct($match);
-    }
-
     protected function filterGroupKey($nameOrIndex): bool
     {
         return is_int($nameOrIndex);

diff --git a/src/TRegx/CleanRegex/Match/Details/Groups/NamedGroups.php b/src/TRegx/CleanRegex/Match/Details/Groups/NamedGroups.php
@@ -1,15 +1,8 @@
 <?php
 namespace TRegx\CleanRegex\Match\Details\Groups;
 
-use TRegx\CleanRegex\Internal\Model\Match\IRawMatchOffset;
-
 class NamedGroups extends AbstractMatchGroups
 {
-    public function __construct(IRawMatchOffset $match)
-    {
-        parent::__construct($match);
-    }
-
     protected function filterGroupKey($nameOrIndex): bool
     {
         return is_string($nameOrIndex);

diff --git a/src/TRegx/CleanRegex/Match/Details/MatchImpl.php b/src/TRegx/CleanRegex/Match/Details/MatchImpl.php
@@ -98,12 +98,12 @@ public function groupNames(): array
 
     public function groups(): IndexedGroups
     {
-        return new IndexedGroups($this->match);
+        return new IndexedGroups($this->match, $this->subjectable);
     }
 
     public function namedGroups(): NamedGroups
     {
-        return new NamedGroups($this->match);
+        return new NamedGroups($this->match, $this->subjectable);
     }
 
     /**

diff --git a/test/Feature/TRegx/CleanRegex/Match/Details/groups/MatchImplTest.php b/test/Feature/TRegx/CleanRegex/Match/Details/groups/MatchImplTest.php
@@ -31,38 +31,76 @@ public function shouldGetEmptyMatchedGroup()
     /**
      * @test
      */
-    public function shouldGetGroupNames()
+    public function shouldGetNamedGroup()
     {
         // given
         pattern('(?<one>first) and (?<two>second)')
             ->match('first and second')
             ->first(function (Match $match) {
                 // when
-                $groupNames = $match->groupNames();
+                $groupNames = $match->namedGroups()->texts();
 
                 // then
-                $this->assertEquals(['one', 'two'], $groupNames);
+                $expected = [
+                    'one' => 'first',
+                    'two' => 'second'
+                ];
+                $this->assertEquals($expected, $groupNames);
             });
     }
 
     /**
      * @test
      */
-    public function shouldGetNamedGroup()
+    public function shouldGetGroupsOffsets_indexedGroups()
+    {
+        // given
+        pattern('(?<one>first ę) and (?<two>second)')
+            ->match('first ę and second')
+            ->first(function (Match $match) {
+                // when
+                $offsets = $match->groups()->offsets();
+                $byteOffsets = $match->groups()->byteOffsets();
+
+                // then
+                $this->assertEquals([0, 12], $offsets);
+                $this->assertEquals([0, 13], $byteOffsets);
+            });
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetGroupsOffsets_namedGroups()
+    {
+        // given
+        pattern('(?<one>first ę) and (?<two>second)')
+            ->match('first ę and second')
+            ->first(function (Match $match) {
+                // when
+                $offsets = $match->namedGroups()->offsets();
+                $byteOffsets = $match->namedGroups()->byteOffsets();
+
+                // then
+                $this->assertEquals(['one' => 0, 'two' => 12], $offsets);
+                $this->assertEquals(['one' => 0, 'two' => 13], $byteOffsets);
+            });
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetGroupNames()
     {
         // given
         pattern('(?<one>first) and (?<two>second)')
             ->match('first and second')
             ->first(function (Match $match) {
                 // when
-                $groupNames = $match->namedGroups()->texts();
+                $groupNames = $match->groupNames();
 
                 // then
-                $expected = [
-                    'one' => 'first',
-                    'two' => 'second'
-                ];
-                $this->assertEquals($expected, $groupNames);
+                $this->assertEquals(['one', 'two'], $groupNames);
             });
     }
 

diff --git a/test/Integration/TRegx/CleanRegex/Match/Details/Group/NotMatchedGroupTest.php b/test/Integration/TRegx/CleanRegex/Match/Details/Group/NotMatchedGroupTest.php
@@ -64,6 +64,22 @@ public function shouldGetOffset()
         $matchGroup->offset();
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetByteOffset()
+    {
+        // given
+        $matchGroup = $this->matchGroup();
+
+        // then
+        $this->expectException(GroupNotMatchedException::class);
+        $this->expectExceptionMessage("Expected to call byteOffset() for group 'first', but group was not matched at all");
+
+        // when
+        $matchGroup->byteOffset();
+    }
+
     /**
      * @test
      */