"""Collecting Day and date-related items."""
-from datetime import datetime
+from __future__ import annotations
+from datetime import datetime, timedelta
+from plomtask.db import DatabaseConnection, BaseModel
+from plomtask.todos import Todo
+from plomtask.dating import (DATE_FORMAT, valid_date)
-DATE_FORMAT = '%Y-%m-%d'
-
-class Day:
+class Day(BaseModel[str]):
"""Individual days defined by their dates."""
+ table_name = 'days'
+ to_save = ['comment']
+
+ def __init__(self, date: str, comment: str = '') -> None:
+ id_ = valid_date(date)
+ super().__init__(id_)
+ self.datetime = datetime.strptime(self.date, DATE_FORMAT)
+ self.comment = comment
+ self.calendarized_todos: list[Todo] = []
+
+ def __lt__(self, other: Day) -> bool:
+ return self.date < other.date
- def __init__(self, date: str):
- self.date = date
- self.datetime = datetime.strptime(date, DATE_FORMAT)
+ @classmethod
+ def by_date_range_filled(cls, db_conn: DatabaseConnection,
+ start: str, end: str) -> list[Day]:
+ """Return days existing and non-existing between dates start/end."""
+ ret = cls.by_date_range_with_limits(db_conn, (start, end), 'id')
+ days, start_date, end_date = ret
+ return cls.with_filled_gaps(days, start_date, end_date)
+
+ @classmethod
+ def with_filled_gaps(cls, days: list[Day], start_date: str, end_date: str
+ ) -> list[Day]:
+ """In days, fill with (un-saved) Days gaps between start/end_date."""
+ if start_date > end_date:
+ return days
+ days.sort()
+ if start_date not in [d.date for d in days]:
+ days[:] = [Day(start_date)] + days
+ if end_date not in [d.date for d in days]:
+ days += [Day(end_date)]
+ if len(days) > 1:
+ gapless_days = []
+ for i, day in enumerate(days):
+ gapless_days += [day]
+ if i < len(days) - 1:
+ while day.next_date != days[i+1].date:
+ day = Day(day.next_date)
+ gapless_days += [day]
+ days[:] = gapless_days
+ return days
+
+ @property
+ def date(self) -> str:
+ """Return self.id_ under the assumption it's a date string."""
+ assert isinstance(self.id_, str)
+ return self.id_
@property
- def weekday(self):
+ def first_of_month(self) -> bool:
+ """Return what month self.date is part of."""
+ assert isinstance(self.id_, str)
+ return self.id_[-2:] == '01'
+
+ @property
+ def month_name(self) -> str:
+ """Return what month self.date is part of."""
+ return self.datetime.strftime('%B')
+
+ @property
+ def weekday(self) -> str:
"""Return what weekday matches self.date."""
return self.datetime.strftime('%A')
- def __eq__(self, other: object):
- return isinstance(other, self.__class__) and self.date == other.date
+ @property
+ def prev_date(self) -> str:
+ """Return date preceding date of this Day."""
+ prev_datetime = self.datetime - timedelta(days=1)
+ return prev_datetime.strftime(DATE_FORMAT)
- def __lt__(self, other):
- return self.date < other.date
+ @property
+ def next_date(self) -> str:
+ """Return date succeeding date of this Day."""
+ next_datetime = self.datetime + timedelta(days=1)
+ return next_datetime.strftime(DATE_FORMAT)
+
+ def collect_calendarized_todos(self, db_conn: DatabaseConnection) -> None:
+ """Fill self.calendarized_todos."""
+ self.calendarized_todos = [t for t in Todo.by_date(db_conn, self.date)
+ if t.calendarize]