Move value calculation to sensor description

Author: tsvi

homeassistant/components/jewish_calendar/entity.py

@@ -2,19 +2,35 @@
 
 from dataclasses import dataclass
 import datetime as dt
+import logging
 
-from hdate import Location, Zmanim
+from hdate import HDateInfo, Location, Zmanim
 from hdate.translator import Language, set_language
 
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import SUN_EVENT_SUNSET
 from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
 from homeassistant.helpers.entity import Entity, EntityDescription
+from homeassistant.helpers.sun import get_astral_event_date
+from homeassistant.util import dt as dt_util
 
 from .const import DOMAIN
 
+_LOGGER = logging.getLogger(__name__)
+
 type JewishCalendarConfigEntry = ConfigEntry[JewishCalendarData]
 
 
+@dataclass
+class JewishCalendarDataResults:
+    """Jewish Calendar results dataclass."""
+
+    daytime_date: HDateInfo
+    after_shkia_date: HDateInfo
+    after_tzais_date: HDateInfo
+    zmanim: Zmanim
+
+
 @dataclass
 class JewishCalendarData:
     """Jewish Calendar runtime dataclass."""
@@ -24,6 +40,7 @@ class JewishCalendarData:
     location: Location
     candle_lighting_offset: int
     havdalah_offset: int
+    results: JewishCalendarDataResults | None = None
 
 
 class JewishCalendarEntity(Entity):
@@ -54,3 +71,42 @@ def make_zmanim(self, date: dt.date) -> Zmanim:
             candle_lighting_offset=self.data.candle_lighting_offset,
             havdalah_offset=self.data.havdalah_offset,
         )
+
+    async def async_update_data(self) -> None:
+        """Update the state of the sensor."""
+        now = dt_util.now()
+        _LOGGER.debug("Now: %s Location: %r", now, self.data.location)
+
+        today = now.date()
+        event_date = get_astral_event_date(self.hass, SUN_EVENT_SUNSET, today)
+
+        if event_date is None:
+            _LOGGER.error("Can't get sunset event date for %s", today)
+            return
+
+        sunset = dt_util.as_local(event_date)
+
+        _LOGGER.debug("Now: %s Sunset: %s", now, sunset)
+
+        daytime_date = HDateInfo(today, diaspora=self.data.diaspora)
+
+        # The Jewish day starts after darkness (called "tzais") and finishes at
+        # sunset ("shkia"). The time in between is a gray area
+        # (aka "Bein Hashmashot"  # codespell:ignore
+        # - literally: "in between the sun and the moon").
+
+        # For some sensors, it is more interesting to consider the date to be
+        # tomorrow based on sunset ("shkia"), for others based on "tzais".
+        # Hence the following variables.
+        after_tzais_date = after_shkia_date = daytime_date
+        today_times = self.make_zmanim(today)
+
+        if now > sunset:
+            after_shkia_date = daytime_date.next_day
+
+        if today_times.havdalah and now > today_times.havdalah:
+            after_tzais_date = daytime_date.next_day
+
+        self.data.results = JewishCalendarDataResults(
+            daytime_date, after_shkia_date, after_tzais_date, today_times
+        )