Merge pull request #62 from spatie/period-collection-filter

Add `filter` to `PeriodCollection`

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `period` will be documented in this file
 
+## 1.5.0 - 2020-03-31
+
+- Add `filter` to `PeriodCollection` 
+
 ## 1.4.5 - 2020-02-05
 
 - Fix for PeriodCollection::gaps() with excluded boundaries (#58)

README.md

@@ -121,6 +121,7 @@ $period->diff(Period ...$periods): PeriodCollection
 $periodCollection->overlap(PeriodCollection ...$periodCollections): PeriodCollection
 $periodCollection->overlapSingle(PeriodCollection $periodCollection): PeriodCollection
 $periodCollection->map(Closure<Period> $closure): PeriodCollection
+$periodCollection->filter(Closure<Period> $closure): PeriodCollection
 $periodCollection->reduce(Closure<mixed, Period> $closure): mixed
 ```
 

src/PeriodCollection.php

@@ -186,6 +186,20 @@ public function reduce(Closure $closure, $initial = null)
         return $carry;
     }
 
+    /**
+     * @param  \Closure  $closure
+     *
+     * @return static
+     */
+    public function filter(Closure $closure): PeriodCollection
+    {
+        $collection = clone $this;
+
+        $collection->periods = array_filter($collection->periods, $closure);
+
+        return $collection;
+    }
+
     public function isEmpty(): bool
     {
         return count($this->periods) === 0;

tests/PeriodCollectionTest.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\Period\Tests;
 
+use DateTime;
 use DateTimeImmutable;
 use PHPUnit\Framework\TestCase;
 use Spatie\Period\Boundaries;
@@ -227,4 +228,20 @@ public function reduce()
 
         $this->assertEquals(4, $totalLength);
     }
+
+    /** @test */
+    public function filter()
+    {
+        $collection = new PeriodCollection(
+            Period::make('2019-01-01', '2019-01-02'),
+            Period::make('2019-02-01', '2019-02-02')
+        );
+
+        $filtered = $collection->filter(function (Period $period) {
+            return $period->startsAt(new DateTime('2019-01-01'));
+        });
+
+        $this->assertCount(1, $filtered);
+        $this->assertTrue($filtered[0]->equals($collection[0]));
+    }
 }