Add more frequencies (#94)

- [x] Every other month
- [x] Every quarter
- [x] Every half year
- [x] Every year

Author: UnoSite

README.md

@@ -36,13 +36,14 @@
 
 - **Custom Payday Calculation:**
   - Supports various pay frequencies:
-    - **Monthly:** Options include:
-      - Last bank day of the month.
-      - First bank day of the month.
-      - Specific day of the month.
-    - **Every 28 days.**
-    - **Every 14 days.**
-    - **Weekly.**
+    - **Monthly**
+    - **Every 2 months**
+    - **Quarterly (every 3 months)**
+    - **Semi-annually (every 6 months)**
+    - **Annually**
+    - **Every 28 days**
+    - **Every 14 days**
+    - **Weekly**
 
 - **Automatic Adjustment for Holidays and Weekends:**
   - Fetches public holidays from the [Nager.Date API](https://date.nager.at).
@@ -87,13 +88,17 @@
 - **Label:** Select the payout frequency
 - **Options:**
   - `monthly`: Monthly
+  - `bimonthly`: Every 2 months
+  - `quarterly`: Every 3 months
+  - `semiannual`: Every 6 months
+  - `annual`: Every year
   - `28_days`: Every 28th day
   - `14_days`: Every 14th day
   - `weekly`: Weekly
 
 ### Step 3: Depending on the Selected Frequency
 
-- **Monthly:**
+- **Monthly / Bimonthly / Quarterly / Semiannual / Annual:**
   - **Label:** Select day of month
   - **Options:**
     - `last_bank_day`: Last bank day
@@ -108,7 +113,7 @@
   - **Label:** Select weekday
   - **Description:** Choose the weekday you receive your payment.
 
-### Additional Configuration for Monthly Frequency
+### Additional Configuration for Monthly-Based Frequencies
 
 - **If "Last bank day" is selected:**
   - **Label:** Days before last bank day

custom_components/isitpayday/config_flow.py

@@ -22,24 +22,18 @@
 
 
 async def async_get_homeassistant_country(hass: HomeAssistant) -> str | None:
-    """Get Home Assistant configured country."""
     country = getattr(hass.config, "country", None)
-
     if not country:
         _LOGGER.warning("Home Assistant country is not set.")
         return None
-
     supported_countries = await async_fetch_supported_countries()
-
     if country not in supported_countries:
         _LOGGER.warning("Country '%s' is not supported.", country)
         return None
-
     return country
 
 
 async def async_fetch_supported_countries() -> dict[str, str]:
-    """Fetch supported countries from Nager.Date API."""
     async with aiohttp.ClientSession() as session:
         async with session.get(API_COUNTRIES) as response:
             data = await response.json()
@@ -61,9 +55,7 @@ def __init__(self) -> None:
         self.reconfig_entry = None
 
     async def async_step_reconfigure(self, user_input=None):
-        """Start reconfiguration flow."""
         _LOGGER.info("Starting reconfiguration flow")
-
         entry_id = self.context.get("entry_id")
         if not entry_id:
             _LOGGER.error("Reconfiguration started without valid entry_id in context.")
@@ -84,7 +76,6 @@ async def async_step_reconfigure(self, user_input=None):
         self.last_pay_date = data.get(CONF_LAST_PAY_DATE)
         self.bank_offset = data.get(CONF_BANK_OFFSET, 0)
         self.weekday = data.get(CONF_WEEKDAY)
-
         self.country_list = await async_fetch_supported_countries()
 
         return await self.async_step_user()
@@ -93,7 +84,6 @@ async def async_step_user(self, user_input=None):
         if user_input is None:
             self.country_list = await async_fetch_supported_countries()
             current_country = self.country or await async_get_homeassistant_country(self.hass) or "DK"
-
             return self.async_show_form(
                 step_id="user",
                 data_schema=self._create_user_schema(current_country)
@@ -112,7 +102,13 @@ async def async_step_frequency(self, user_input=None):
 
         self.pay_frequency = user_input[CONF_PAY_FREQ]
 
-        if self.pay_frequency == PAY_FREQ_MONTHLY:
+        if self.pay_frequency in [
+            PAY_FREQ_MONTHLY,
+            PAY_FREQ_BIMONTHLY,
+            PAY_FREQ_QUARTERLY,
+            PAY_FREQ_SEMIANNUAL,
+            PAY_FREQ_ANNUAL
+        ]:
             return await self.async_step_monthly_day()
         elif self.pay_frequency in [PAY_FREQ_28_DAYS, PAY_FREQ_14_DAYS]:
             return await self.async_step_cycle_last_paydate()
@@ -194,7 +190,6 @@ def _create_entry(self) -> FlowResult:
             self.hass.config_entries.async_update_entry(self.reconfig_entry, data=data)
             self.hass.async_create_task(self.hass.config_entries.async_reload(self.reconfig_entry.entry_id))
 
-            # Use service call instead of direct import
             self.hass.async_create_task(self.hass.services.async_call(
                 "persistent_notification",
                 "create",

custom_components/isitpayday/const.py

@@ -29,12 +29,20 @@
 PAY_FREQ_28_DAYS = "28_days"
 PAY_FREQ_14_DAYS = "14_days"
 PAY_FREQ_WEEKLY = "weekly"
+PAY_FREQ_BIMONTHLY = "bimonthly"
+PAY_FREQ_QUARTERLY = "quarterly"
+PAY_FREQ_SEMIANNUAL = "semiannual"
+PAY_FREQ_ANNUAL = "annual"
 
 PAY_FREQ_OPTIONS = {
     PAY_FREQ_MONTHLY: "Monthly",
     PAY_FREQ_28_DAYS: "Every 28th day",
     PAY_FREQ_14_DAYS: "Every 14th day",
     PAY_FREQ_WEEKLY: "Weekly",
+    PAY_FREQ_BIMONTHLY: "Every 2 months",
+    PAY_FREQ_QUARTERLY: "Every 3 months",
+    PAY_FREQ_SEMIANNUAL: "Every 6 months",
+    PAY_FREQ_ANNUAL: "Every year",
 }
 
 # Monthly pay day options (only for monthly frequency)

custom_components/isitpayday/payday_calculator.py

@@ -9,7 +9,6 @@
 
 
 async def async_get_bank_holidays(country: str, year: int) -> list:
-    """Hent banklukkedage fra Nager.Date API for et givent land og aar."""
     url = API_HOLIDAYS.format(year=year, country=country)
     _LOGGER.debug("Henter banklukkedage fra: %s", url)
 
@@ -27,16 +26,25 @@ async def async_get_bank_holidays(country: str, year: int) -> list:
 
 
 async def async_calculate_next_payday(country: str, pay_frequency: str, pay_day=None, last_pay_date=None, weekday=None, bank_offset=0):
-    """Udregn naeste loenningsdag baseret paa konfiguration."""
     _LOGGER.info("Starter beregning af naeste loenningsdag for %s med frekvens: %s", country, pay_frequency)
 
     today = date.today()
     year = today.year
-
     bank_holidays = await async_get_bank_holidays(country, year)
 
-    if pay_frequency == PAY_FREQ_MONTHLY:
-        payday = await async_calculate_monthly(pay_day, bank_holidays, today, bank_offset)
+    if pay_frequency in (
+        PAY_FREQ_MONTHLY, PAY_FREQ_BIMONTHLY,
+        PAY_FREQ_QUARTERLY, PAY_FREQ_SEMIANNUAL,
+        PAY_FREQ_ANNUAL
+    ):
+        months = {
+            PAY_FREQ_MONTHLY: 1,
+            PAY_FREQ_BIMONTHLY: 2,
+            PAY_FREQ_QUARTERLY: 3,
+            PAY_FREQ_SEMIANNUAL: 6,
+            PAY_FREQ_ANNUAL: 12,
+        }[pay_frequency]
+        payday = await async_calculate_month_based(today, months, pay_day, bank_offset, bank_holidays)
 
     elif pay_frequency in (PAY_FREQ_28_DAYS, PAY_FREQ_14_DAYS):
         interval = 28 if pay_frequency == PAY_FREQ_28_DAYS else 14
@@ -52,37 +60,33 @@ async def async_calculate_next_payday(country: str, pay_frequency: str, pay_day=
         return None
 
     payday = await async_adjust_for_bank_holidays_and_weekends(payday, bank_holidays)
-
     _LOGGER.info("Naeste loenningsdag efter justering: %s", payday)
     return payday
 
 
-async def async_calculate_monthly(pay_day, bank_holidays, today, bank_offset):
-    """Beregner naeste maanedlige loenningsdag baseret paa pay_day type."""
+async def async_calculate_month_based(today, month_interval, pay_day, bank_offset, bank_holidays):
     year, month = today.year, today.month
 
-    if pay_day == PAY_DAY_LAST_BANK_DAY:
-        payday = await async_find_last_bank_day(year, month, bank_holidays, bank_offset)
-    elif pay_day == PAY_DAY_FIRST_BANK_DAY:
-        payday = await async_find_first_bank_day(year, month, bank_holidays)
-    elif isinstance(pay_day, int):
-        payday = await async_find_specific_day(year, month, pay_day, bank_holidays)
-    else:
-        _LOGGER.error("Ugyldig pay_day vaerdi: %s", pay_day)
-        return None
-
-    if payday < today:  # Rettet fra <= til <
-        month += 1
-        if month > 12:
-            month = 1
-            year += 1
-        return await async_calculate_monthly(pay_day, bank_holidays, date(year, month, 1), bank_offset)
+    while True:
+        if pay_day == PAY_DAY_LAST_BANK_DAY:
+            payday = await async_find_last_bank_day(year, month, bank_holidays, bank_offset)
+        elif pay_day == PAY_DAY_FIRST_BANK_DAY:
+            payday = await async_find_first_bank_day(year, month, bank_holidays)
+        elif isinstance(pay_day, int):
+            payday = await async_find_specific_day(year, month, pay_day, bank_holidays)
+        else:
+            _LOGGER.error("Ugyldig pay_day vaerdi: %s", pay_day)
+            return None
+
+        if payday >= today:
+            return payday
 
-    return payday
+        month += month_interval
+        year += (month - 1) // 12
+        month = (month - 1) % 12 + 1
 
 
 async def async_calculate_recurring(last_pay_date, interval, bank_holidays):
-    """Beregner naeste loenningsdag for 14- eller 28-dages interval."""
     if not last_pay_date:
         _LOGGER.error("Mangler sidste loenningsdato for tilbagevendende betaling.")
         return None
@@ -91,51 +95,45 @@ async def async_calculate_recurring(last_pay_date, interval, bank_holidays):
     payday = last_date + timedelta(days=interval)
 
     today = date.today()
-    while payday < today:  # Rettet fra <= til <
+    while payday < today:
         payday += timedelta(days=interval)
 
     _LOGGER.info("Naeste tilbagevendende loenningsdag beregnet til: %s", payday)
     return payday
 
 
 async def async_calculate_weekly(today, weekday, bank_holidays):
-    """Beregner naeste ugentlige loenningsdag."""
     days_ahead = (weekday - today.weekday()) % 7
     payday = today + timedelta(days=days_ahead)
-
-    payday = await async_adjust_for_bank_holidays_and_weekends(payday, bank_holidays)
-
-    _LOGGER.info("Naeste ugentlige loenningsdag beregnet til: %s", payday)
     return payday
 
 
 async def async_find_last_bank_day(year, month, bank_holidays, bank_offset):
-    """Finder sidste bankdag i maaneden."""
     day = 31
-    while True:
+    while day > 0:
         try:
             payday = date(year, month, day)
             if payday.weekday() < 5 and payday not in bank_holidays:
-                payday -= timedelta(days=bank_offset)
-                return payday
+                return payday - timedelta(days=bank_offset)
             day -= 1
         except ValueError:
             day -= 1
 
 
 async def async_find_first_bank_day(year, month, bank_holidays):
-    """Finder foerste bankdag i maaneden."""
     day = 1
-    while True:
-        payday = date(year, month, day)
-        if payday.weekday() < 5 and payday not in bank_holidays:
-            return payday
-        day += 1
+    while day <= 31:
+        try:
+            payday = date(year, month, day)
+            if payday.weekday() < 5 and payday not in bank_holidays:
+                return payday
+            day += 1
+        except ValueError:
+            day += 1
 
 
 async def async_find_specific_day(year, month, day, bank_holidays):
-    """Finder specifik dag i maaneden og flytter bagud ved helligdag/weekend."""
-    while True:
+    while day > 0:
         try:
             payday = date(year, month, day)
             if payday.weekday() < 5 and payday not in bank_holidays:
@@ -146,8 +144,6 @@ async def async_find_specific_day(year, month, day, bank_holidays):
 
 
 async def async_adjust_for_bank_holidays_and_weekends(payday, bank_holidays):
-    """Flytter dato bagud hvis den falder paa weekend eller banklukket dag."""
     while payday.weekday() >= 5 or payday in bank_holidays:
         payday -= timedelta(days=1)
-
     return payday