Added missing immutability annotation to Holidays interface

aeon-php · Jun 2, 2020 · bab8a69 · bab8a69
1 parent 836234e
commit bab8a69
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 8 deletions.
diff --git a/composer.json b/composer.json
@@ -40,6 +40,11 @@
         }
     },
     "scripts": {
+        "build": [
+            "@static:analyze",
+            "@test",
+            "@test:mutation"
+        ],
         "test": [
             "phpunit"
         ],

diff --git a/composer.lock b/composer.lock
diff --git a/src/Aeon/Calendar/Gregorian/Holidays.php b/src/Aeon/Calendar/Gregorian/Holidays.php
@@ -6,6 +6,9 @@
 
 use Aeon\Calendar\Gregorian\Holidays\Holiday;
 
+/**
+ * @psalm-immutable
+ */
 interface Holidays
 {
     public function isHoliday(Day $day) : bool;

diff --git a/src/Aeon/Calendar/Gregorian/Holidays/GoogleCalendarRegionalHolidays.php b/src/Aeon/Calendar/Gregorian/Holidays/GoogleCalendarRegionalHolidays.php
@@ -9,6 +9,9 @@
 use Aeon\Calendar\Gregorian\Holidays;
 use Webmozart\Assert\Assert;
 
+/**
+ * @psalm-immutable
+ */
 final class GoogleCalendarRegionalHolidays implements Holidays
 {
     /**
@@ -38,6 +41,11 @@ function (string $countryCode) : string {
         $this->calendars = null;
     }
 
+    /**
+     * @param Day $day
+     * @return bool
+     * @throws HolidayYearException
+     */
     public function isHoliday(Day $day) : bool
     {
         if ($this->calendars === null) {
@@ -100,6 +108,7 @@ private function loadCalendars() : void
         }
     }
 
+    /** @psalm-suppress InaccessibleProperty */
     private function loadCalendar(string $countryCode) : void
     {
         /**