Added more tests. Refactored. Fixed some styles

Author: mcustiel

.gitignore

@@ -1,5 +1,8 @@
 composer.phar
 vendor/
+.buildpath
+.project
+.settings/
 
 # Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file

src/AbstractMatch.php

@@ -0,0 +1,29 @@
+<?php
+namespace Mcustiel\PhpSimpleRegex;
+
+abstract class AbstractMatch
+{
+    /**
+     *
+     * @var array
+     */
+    protected $element;
+
+    /**
+     *
+     * @param array $responseElement
+     */
+    public function __construct(array $responseElement)
+    {
+        $this->element = $responseElement;
+    }
+
+    /**
+     *
+     * @return mixed
+     */
+    public function getFullMatch()
+    {
+        return empty($this->element) ? null : $this->element[0];
+    }
+}

src/Match.php

@@ -2,38 +2,24 @@
 namespace Mcustiel\PhpSimpleRegex;
 
 /**
+ *
  * @author mcustiel
  *
  */
-class Match extends \ArrayIterator
+class Match extends AbstractMatch
 {
     /**
-     * @param array $responseElement
-     */
-    public function __construct(array $responseElement)
-    {
-        parent::__construct($responseElement);
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getFullMatch()
-    {
-        return parent::offsetGet(0);
-    }
-
-    /**
+     *
      * @param unknown $index
      * @throws \OutOfBoundsException
      * @return mixed
      */
-    public function getMatchAt($index)
+    public function getSubMatchAt($index)
     {
-        if (!parent::offsetExists($index)) {
+        if (! isset($this->element[$index]) || $index == 0) {
             throw new \OutOfBoundsException('Trying to access invalid submatch index');
         }
 
-        return parent::offsetGet($index);
+        return $this->element[$index];
     }
 }

src/OffsetMatch.php

@@ -0,0 +1,10 @@
+<?php
+namespace Mcustiel\PhpSimpleRegex;
+
+class OffsetMatch extends AbstractMatch
+{
+    public function getOffset()
+    {
+        return empty($this->element) ? null : $this->element[1];
+    }
+}

src/RegexExecutor.php

@@ -2,12 +2,15 @@
 namespace Mcustiel\PhpSimpleRegex;
 
 /**
+ *
  * @author mcustiel
  *
  */
 class RegexExecutor
 {
+
     /**
+     *
      * @param string $pattern
      * @param string $subject
      * @param number $offset

src/RegexOffsetResponse.php

@@ -0,0 +1,25 @@
+<?php
+namespace Mcustiel\PhpSimpleRegex;
+
+class RegexOffsetResponse extends RegexResponse
+{
+/**
+     *
+     * @param unknown $index
+     * @throws \OutOfBoundsException
+     * @return \Mcustiel\PhpSimpleRegex\Match
+     */
+    public function getMatchAt($index)
+    {
+        if (! isset($this->response[$index])) {
+            throw new \OutOfBoundsException('Trying to access a match at an invalid index');
+        }
+
+        return new OffsetMatch($this->response[$index]);
+    }
+
+    public function current()
+    {
+        return new OffsetMatch($this->response[$this->current]);
+    }
+}

src/RegexResponse.php

@@ -2,25 +2,29 @@
 namespace Mcustiel\PhpSimpleRegex;
 
 /**
+ *
  * @author mcustiel
  *
  */
 class RegexResponse implements \Iterator
 {
-    private $response;
+    protected $response;
     private $current;
     private $count;
 
     /**
+     *
      * @param array $regex
      */
-    public function __construct(array $regexResponse) {
+    public function __construct(array $regexResponse)
+    {
         $this->response = $regexResponse;
         $this->count = count($this->response);
         $this->current = 0;
     }
 
     /**
+     *
      * @return number
      */
     public function getMatchesCount()
@@ -29,13 +33,14 @@ public function getMatchesCount()
     }
 
     /**
+     *
      * @param unknown $index
      * @throws \OutOfBoundsException
      * @return \Mcustiel\PhpSimpleRegex\Match
      */
     public function getMatchAt($index)
     {
-        if (!isset($this->response[$index])) {
+        if (! isset($this->response[$index])) {
             throw new \OutOfBoundsException('Trying to access a match at an invalid index');
         }
 
@@ -47,24 +52,23 @@ public function current()
         return new Match($this->response[$this->current]);
     }
 
-	public function next()
-	{
-
-	    return new Match($this->response[++$this->current]);
-	}
+    public function next()
+    {
+        ++ $this->current;
+    }
 
-	public function key()
-	{
+    public function key()
+    {
         return $this->current;
-	}
+    }
 
-	public function valid()
-	{
+    public function valid()
+    {
         return $this->current < $this->count;
-	}
+    }
 
-	public function rewind ()
-	{
+    public function rewind()
+    {
         $this->current = 0;
-	}
+    }
 }

src/ReplaceResponse.php

@@ -2,6 +2,7 @@
 namespace Mcustiel\PhpSimpleRegex;
 
 /**
+ *
  * @author mcustiel
  */
 class ReplaceResponse
@@ -10,7 +11,8 @@ class ReplaceResponse
     private $replacements;
 
     /**
-     * @param string  $result
+     *
+     * @param string $result
      * @param integer $replacements
      */
     public function __construct($result, $replacements)
@@ -20,15 +22,13 @@ public function __construct($result, $replacements)
     }
 
     /**
-     *
      */
     public function getResult()
     {
         return $this->result;
     }
 
     /**
-     *
      */
     public function getReplacements()
     {

tests/unit/Test/MatchTest.php

@@ -36,7 +36,7 @@ public function shouldReturnTheFullMatch()
      */
     public function shouldReturnTheInnerMatch()
     {
-        $this->assertEquals('123456', $this->result->getMatchAt(1));
+        $this->assertEquals('123456', $this->result->getSubMatchAt(1));
     }
 
     /**
@@ -46,6 +46,6 @@ public function shouldReturnTheInnerMatch()
      */
     public function shouldThrowAnExceptionWhenOffsetIsNotValid()
     {
-        $this->result->getMatchAt(2);
+        $this->result->getSubMatchAt(2);
     }
 }

tests/unit/Test/RegexResponseTest.php

@@ -0,0 +1,62 @@
+<?php
+namespace Test\Mcustiel\PhpSimpleRegex;
+
+use Mcustiel\PhpSimpleRegex\RegexResponse;
+use Mcustiel\PhpSimpleRegex\Match;
+class RegexResponseTest extends \PHPUnit_Framework_TestCase
+{
+    const PATTERN = '|(\d{4})-(\d{2})-(\d{2})|';
+    const SUBJECT =
+        'Date 1: 2015-01-01, Date 2: 2015-02-02, Date 3: 2015-03-03, Date 4: 2015-04-04, Date 5: 2015-05-05';
+
+    private $result;
+
+    /**
+     * @before
+     */
+    public function createRegexResult()
+    {
+        $result = [];
+        preg_match_all(self::PATTERN, self::SUBJECT, $result, PREG_SET_ORDER);
+        $this->result = new RegexResponse($result);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetValidMatchesCount()
+    {
+        $this->assertEquals(5, $this->result->getMatchesCount());
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetTheCorrectMatchWhenRequested()
+    {
+        $match = $this->result->getMatchAt(2);
+        $this->assertInstanceOf(Match::class, $match);
+        $this->assertEquals('2015-03-03', $match->getFullMatch());
+    }
+
+    /**
+     * @test
+     * @expectedException        \OutOfBoundsException
+     * @expectedExceptionMessage Trying to access a match at an invalid index
+     */
+    public function shouldThrowAnExceptionWhenInvalidMatchIsRequested()
+    {
+        $this->result->getMatchAt(10);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldIterateAsAnArray()
+    {
+        foreach ($this->result as $index => $match) {
+            $this->assertInstanceOf(Match::class, $match);
+            $this->assertEquals($this->result->getMatchAt($index), $match);
+        }
+    }
+}