From 5633ff78c6b76867fa1fbe24cd6c82dd7e61a13f Mon Sep 17 00:00:00 2001
From: Ondrej Vlach <ondrej@vlach.xyz>
Date: Wed, 7 Aug 2024 12:45:05 +0200
Subject: [PATCH] feat(services): add monday-friday working day determiner

---
 .../Date/MonToFriWorkingDayDeterminer.php     | 37 ++++++++++++++
 .../WorkingDayDeterminerInterface.php         | 26 ++++++++++
 .../Date/MonToFriWorkingDayDeterminerTest.php | 48 +++++++++++++++++++
 3 files changed, 111 insertions(+)
 create mode 100644 app/Services/WorkingDays/Date/MonToFriWorkingDayDeterminer.php
 create mode 100644 app/Services/WorkingDays/WorkingDayDeterminerInterface.php
 create mode 100644 tests/Unit/Services/WorkingDays/Date/MonToFriWorkingDayDeterminerTest.php

diff --git a/app/Services/WorkingDays/Date/MonToFriWorkingDayDeterminer.php b/app/Services/WorkingDays/Date/MonToFriWorkingDayDeterminer.php
new file mode 100644
index 0000000..303be3f
--- /dev/null
+++ b/app/Services/WorkingDays/Date/MonToFriWorkingDayDeterminer.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Services\WorkingDays\Date;
+
+use App\Services\WorkingDays\WorkingDayDeterminerInterface;
+
+/**
+ * Determines if a given date is a working day (Monday to Friday)
+ */
+class MonToFriWorkingDayDeterminer implements WorkingDayDeterminerInterface
+{
+    public function __construct()
+    {
+    }
+
+    public function isWorkingDay(\DateTimeImmutable $date): bool
+    {
+        $weekday = $date->format('N');
+        return $weekday <= 5; // Monday to Friday
+    }
+
+    public function getWorkingDaysCount(\DateTimeImmutable $startDate, int $workingDays): int
+    {
+        $period = new \DatePeriod($startDate, new \DateInterval('P1D'), $startDate->add(new \DateInterval(sprintf('P%dD', $workingDays))));
+        $workingDaysCount = 0;
+
+        foreach ($period as $date) {
+            if ($this->isWorkingDay($date)) {
+                $workingDaysCount++;
+            }
+        }
+
+        return $workingDaysCount;
+    }
+}
diff --git a/app/Services/WorkingDays/WorkingDayDeterminerInterface.php b/app/Services/WorkingDays/WorkingDayDeterminerInterface.php
new file mode 100644
index 0000000..ca6df45
--- /dev/null
+++ b/app/Services/WorkingDays/WorkingDayDeterminerInterface.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Services\WorkingDays;
+
+/**
+ * Determinate if a given date is a working day.
+ */
+interface WorkingDayDeterminerInterface
+{
+    /**
+     * Determinate if a given date is a working day.
+     * @param \DateTimeImmutable $date
+     * @return bool
+     */
+    public function isWorkingDay(\DateTimeImmutable $date): bool;
+
+    /**
+     * Get working days count in a given interval.
+     * @param \DateTimeImmutable $startDate
+     * @param int $workingDays
+     * @return int
+     */
+    public function getWorkingDaysCount(\DateTimeImmutable $startDate, int $workingDays): int;
+}
diff --git a/tests/Unit/Services/WorkingDays/Date/MonToFriWorkingDayDeterminerTest.php b/tests/Unit/Services/WorkingDays/Date/MonToFriWorkingDayDeterminerTest.php
new file mode 100644
index 0000000..480f6f9
--- /dev/null
+++ b/tests/Unit/Services/WorkingDays/Date/MonToFriWorkingDayDeterminerTest.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Services\WorkingDays\Date;
+
+use App\Services\WorkingDays\Date\MonToFriWorkingDayDeterminer;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+class MonToFriWorkingDayDeterminerTest extends TestCase
+{
+    #[DataProvider('nonWorkingDayProvider')]
+    public function testIsWorkingDayWillReturnFalseForSatSan(int $day): void
+    {
+        $class = new MonToFriWorkingDayDeterminer();
+
+        $this->assertFalse($class->isWorkingDay(new \DateTimeImmutable("2024-01-0" . $day)));
+    }
+
+    /**
+     * @return array<int, array<int, int>>
+     */
+    public static function nonWorkingDayProvider(): array
+    {
+        return [[6], [7]];
+    }
+
+    /**
+     * @return \Generator<int, array<int>>
+     */
+    public static function workingDayProvider(): \Generator
+    {
+        for ($isNWD = 0; $isNWD <= 1; $isNWD++) {
+            for ($x = 1; $x <= 5; $x++) {
+                yield [$x];
+            }
+        }
+    }
+
+    #[DataProvider('workingDayProvider')]
+    public function testIsWorkingDayWillCallIsNWDForWorkingDaysAndReturnValue(int $day): void
+    {
+        $class = new MonToFriWorkingDayDeterminer();
+
+        $this->assertSame(true, $class->isWorkingDay(new \DateTimeImmutable("2024-01-0" . $day)));
+    }
+}