Add DayOfWeek::isWeekday() and isWeekend()

brick · Jun 30, 2021 · da6c257 · da6c257
1 parent 7407a79
commit da6c257
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 0 deletions.
diff --git a/src/DayOfWeek.php b/src/DayOfWeek.php
@@ -191,6 +191,22 @@ public function isEqualTo(DayOfWeek $that) : bool
         return $this->value === $that->value;
     }
 
+    /**
+     * Returns whether this DayOfWeek is Monday to Friday.
+     */
+    public function isWeekday() : bool
+    {
+        return $this->value >= self::MONDAY && $this->value <= self::FRIDAY;
+    }
+
+    /**
+     * Returns whether this DayOfWeek is Saturday or Sunday.
+     */
+    public function isWeekend() : bool
+    {
+        return $this->value === self::SATURDAY || $this->value === self::SUNDAY;
+    }
+
     /**
      * Returns the DayOfWeek that is the specified number of days after this one.
      */

diff --git a/tests/DayOfWeekTest.php b/tests/DayOfWeekTest.php
@@ -153,6 +153,48 @@ public function testIsEqualTo(): void
         }
     }
 
+    /**
+     * @dataProvider providerIsWeekday
+     */
+    public function testIsWeekday(DayOfWeek $dayOfWeek, bool $isWeekday): void
+    {
+        $this->assertSame($isWeekday, $dayOfWeek->isWeekday());
+    }
+
+    public function providerIsWeekday(): array
+    {
+        return [
+            [DayOfWeek::monday(), true],
+            [DayOfWeek::tuesday(), true],
+            [DayOfWeek::wednesday(), true],
+            [DayOfWeek::thursday(), true],
+            [DayOfWeek::friday(), true],
+            [DayOfWeek::saturday(), false],
+            [DayOfWeek::sunday(), false],
+        ];
+    }
+
+    /**
+     * @dataProvider providerIsWeekend
+     */
+    public function testIsWeekend(DayOfWeek $dayOfWeek, bool $isWeekend): void
+    {
+        $this->assertSame($isWeekend, $dayOfWeek->isWeekend());
+    }
+
+    public function providerIsWeekend(): array
+    {
+        return [
+            [DayOfWeek::monday(), false],
+            [DayOfWeek::tuesday(), false],
+            [DayOfWeek::wednesday(), false],
+            [DayOfWeek::thursday(), false],
+            [DayOfWeek::friday(), false],
+            [DayOfWeek::saturday(), true],
+            [DayOfWeek::sunday(), true],
+        ];
+    }
+
     /**
      * @dataProvider providerPlus
      *