[feat] implement iran holidays

src/Countries/Iran.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Spatie\Holidays\Countries;
+
+use Carbon\CarbonImmutable;
+
+class Iran extends Country
+{
+    public function countryCode(): string
+    {
+        return 'ir';
+    }
+
+    protected function allHolidays(int $year): array
+    {
+        return array_merge([
+            'Islamic Revolution Day' => '02-11',
+            'Nationalization of Oil Industry Day' => '03-19',
+            'Nowruz First Day' => '03-20',
+            'Nowruz Second Day' => '03-21',
+            'Nowruz Third Day' => '03-22',
+            'Nowruz Fourth Day' => '03-23',
+            'Islamic Republic Day' => '03-31',
+            'Nature Day' => '04-01',
+            'Death of Khomeini Day' => '06-03',
+            'Revolt of Khordad 15 Day' => '06-04',
+        ], $this->variableHolidays($year));
+    }
+
+    /** @return array<string, CarbonImmutable> */
+    protected function variableHolidays(int $year): array
+    {
+
+        return [
+            //add more holidays
+        ];
+    }
+}

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

@@ -0,0 +1,42 @@
+[
+    {
+        "name": "Islamic Revolution Day",
+        "date": "2024-02-11"
+    },
+    {
+        "name": "Nationalization of Oil Industry Day",
+        "date": "2024-03-19"
+    },
+    {
+        "name": "Nowruz First Day",
+        "date": "2024-03-20"
+    },
+    {
+        "name": "Nowruz Second Day",
+        "date": "2024-03-21"
+    },
+    {
+        "name": "Nowruz Third Day",
+        "date": "2024-03-22"
+    },
+    {
+        "name": "Nowruz Fourth Day",
+        "date": "2024-03-23"
+    },
+    {
+        "name": "Islamic Republic Day",
+        "date": "2024-03-31"
+    },
+    {
+        "name": "Nature Day",
+        "date": "2024-04-01"
+    },
+    {
+        "name": "Death of Khomeini Day",
+        "date": "2024-06-03"
+    },
+    {
+        "name": "Revolt of Khordad 15 Day",
+        "date": "2024-06-04"
+    }
+]

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::setTestNow('2024-01-01');
+
+    $holidays = Holidays::for(country: 'ir')->get();
+
+    expect($holidays)
+        ->toBeArray()
+        ->not()->toBeEmpty();
+
+    expect(formatDates($holidays))->toMatchSnapshot();
+});