add ability to retrieve periods from limiter

src/rate/Limit.php

@@ -62,31 +62,31 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function getName(): string
     {
         return $this->name;
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function getLimit(): int
     {
         return $this->limit;
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function getDuration(): int
     {
         return $this->duration;
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function isHidden(): bool
     {

src/rate/limit/Period.php

@@ -43,6 +43,16 @@ public function __construct(
         $this->timeout = $timeout;
     }
 
+    /**
+     * Retrieve the limit instance
+     *
+     * @return \sndsgd\rate\LimitInterface
+     */
+    public function getLimit(): \sndsgd\rate\LimitInterface
+    {
+        return $this->limit;
+    }
+
     /**
      * Determine whether the limit has been exceeded
      *

src/rate/limiter/LimiterAbstract.php

@@ -16,7 +16,7 @@ abstract class LimiterAbstract implements LimiterInterface
      *
      * @var array<\sndsgd\rate\limit\Period>
      */
-    protected $periods = [];
+    protected $periods;
 
     /**
      * @param array<\sndsgd\rate\Limit> $limits
@@ -35,16 +35,12 @@ public function __construct(array $limits)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function isExceeded(): bool
     {
-        if (empty($this->periods)) {
-            $this->increment();
-        }
-
         $result = false;
-        foreach ($this->periods as $period) {
+        foreach ($this->getPeriods() as $period) {
             if ($period->isLimitExceeded()) {
                 return true;
             }
@@ -53,17 +49,28 @@ public function isExceeded(): bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function getHeaders(): array
     {
         $ret = [];
-        foreach ($this->periods as $period) {
+        foreach ($this->getPeriods() as $period) {
             $header = $period->getHeader();
             if ($header !== "") {
                 $ret[] = $header;
             }
         }
         return $ret;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPeriods(): array
+    {
+        if ($this->periods === null) {
+            $this->increment();
+        }
+        return $this->periods ?? [];
+    }
 }

src/rate/limiter/LimiterInterface.php

@@ -28,4 +28,11 @@ public function isExceeded(): bool;
      * @return array<string,string>
      */
     public function getHeaders(): array;
+
+    /**
+     * Retrieve an array of rate limit periods
+     *
+     * @return array<\sndsgd\rate\limit\Period>
+     */
+    public function getPeriods(): array;
 }

src/rate/limiter/RedisLimiter.php

@@ -22,7 +22,7 @@ public function __construct(\Redis $redis, array $limits)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function increment(int $incrementBy = 1): LimiterInterface
     {

tests/unit/rate/limit/PeriodTest.php

@@ -4,6 +4,13 @@
 
 class PeriodTest extends \PHPUnit_Framework_TestCase
 {
+    public function testGetLimit()
+    {
+        $limit = new \sndsgd\rate\Limit('', '');
+        $period = new Period($limit);
+        $this->assertSame($limit, $period->getLimit());
+    }
+
     /**
      * @dataProvider providerIsLimitExceeded
      */

tests/unit/rate/limiter/LimiterAbstractTest.php

@@ -99,4 +99,15 @@ public function providerGetHeaders()
             [[$makePeriod("a"), $makePeriod("b")], ["a", "b"]],
         ];
     }
+
+    public function testGetPeriods()
+    {
+        $mock = $this->getMockBuilder(LimiterAbstract::class)
+            ->disableOriginalConstructor()
+            ->setMethods(["increment"])
+            ->getMockForAbstractClass();
+
+        $mock->expects($this->once())->method("increment");
+        $mock->getPeriods();
+    }
 }