[feat] implement iran holidays

src/Countries/Iran.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Spatie\Holidays\Countries;
+
+use Carbon\CarbonImmutable;
+
+class Iran extends Country
+{
+    public function countryCode(): string
+    {
+        return 'ir';
+    }
+
+    /** @return array<string, CarbonImmutable> */
+    protected function allHolidays(int $year): array
+    {
+        return array_merge([
+            'Islamic Revolution Day' => '02-11',
+            'Nourouz' => '03-19',
+            'National Oil Industry Day' => '03-20',
+            'Nourouz' => '03-21',
+            'Nourouz' => '03-22',
+            'Nourouz' => '03-23',
+            'Islamic Republic Day' => '03-31',
+            'Nature Day' => '04-01',
+            'Death of Khomeini' => '04-06',
+            '15th Khordad March' => '04-07',
+        ], $this->variableHolidays($year));
+    }
+
+    /** @return array<string, CarbonImmutable> */
+    protected function variableHolidays(int $year): array
+    {
+        $easter = CarbonImmutable::createFromTimestamp(easter_date($year))
+            ->setTimezone('Asia/Tehran');
+
+        return [
+          //add more holidays
+        ];
+    }
+}

tests/.pest/snapshots/Countries/IranTest/it_can_calculate_iran_holidays.snap

@@ -0,0 +1,30 @@
+[
+    {
+        "name": "Islamic Revolution Day",
+        "date": "2024-02-11"
+    },
+    {
+        "name": "National Oil Industry Day",
+        "date": "2024-03-20"
+    },
+    {
+        "name": "Nourouz",
+        "date": "2024-03-23"
+    },
+    {
+        "name": "Islamic Republic Day",
+        "date": "2024-03-31"
+    },
+    {
+        "name": "Nature Day",
+        "date": "2024-04-01"
+    },
+    {
+        "name": "Death of Khomeini",
+        "date": "2024-04-06"
+    },
+    {
+        "name": "15th Khordad March",
+        "date": "2024-04-07"
+    }
+]

tests/Countries/IranTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Spatie\Holidays\Tests\Countries;
+
+use Carbon\CarbonImmutable;
+use Spatie\Holidays\Holidays;
+
+it('can calculate iran holidays', function () {
+    CarbonImmutable::setTestNowAndTimezone('2024-01-01');
+
+    $holidays = Holidays::for(country: 'ir')->get();
+
+    expect($holidays)
+        ->toBeArray()
+        ->not()->toBeEmpty();
+
+    expect(formatDates($holidays))->toMatchSnapshot();
+});