Make dates non-optional; add has_started

Author: encukou

docs/operations/boards.rst

@@ -37,7 +37,7 @@ Nově zvolený výbor
      * `@JakubDotPy <https://github.com/JakubDotPy>`_
      *
 
-Výbor od 9.4.2022
+Výbor od 1.9.2022
 -------------------------------------------------
 
 .. list-table::
@@ -62,7 +62,7 @@ Výbor od 9.4.2022
      * `@sairon <https://github.com/sairon>`_
      * |:moneybag:|
 
-Výbor od 8.4.2019
+Výbor od 4.5.2019
 -------------------------------------------------
 
 .. list-table::

docs/operations/boards.rst.jinja

@@ -12,12 +12,12 @@ Kanonickým zdrojem pravdy je ale `výpis na justice.cz <https://or.justice.cz/i
 
 
 {% for board in boards %}
-{%- if board.start_on == None %}
-Nově zvolený výbor
-------------------
-{%- else %}
+{%- if board.has_started %}
 Výbor od {{ board.start_on.strftime("%-d.%-m.%Y") }}
 -------------------------------------------------
+{%- else %}
+Nově zvolený výbor
+------------------
 {%- endif %}
 
 .. list-table::

src/pyvec_docs/boards.py

@@ -39,47 +39,44 @@ def is_treasurer(self) -> bool:
 
 
 class Board(BaseModel):
-    start_on: date | None = None
+    start_on: date
     voted_on: date
+    has_started: bool
     members: list[BoardMember]
 
     model_config = {"extra": "forbid", "frozen": True}
 
     @classmethod
-    def make(cls, voted_on=None, start_on=None, **kwargs):
-        if voted_on is None:
-            voted_on = start_on
-        return cls(voted_on=voted_on, start_on=start_on, **kwargs)
+    def create(cls, voted_on=None, start_on=None, **kwargs):
+        if start_on is None:
+            start_on = voted_on
+            has_started = False
+        else:
+            has_started = True
+        return cls(
+            voted_on=voted_on,
+            start_on=start_on,
+            has_started=has_started,
+            **kwargs,
+        )
 
     @property
-    def years(self) -> tuple[int, int] | tuple[None, None]:
-        if self.start_on is None:
-            return None, None
+    def years(self) -> tuple[int, int]:
         start_year = self.start_on.year
         return (start_year, start_year + BOARDS_MANDATE_LENGTH)
 
-    @property
-    def sort_key(self):
-        # Boards without a start date sort as starting in the future
-        if self.start_on is None:
-            return (1, None)
-        return (0, self.start_on)
-
 
 @cache
 def load_boards(path: Path | str = BOARDS_CONFIG_PATH) -> list[Board]:
     """Load all boards, including inactive ones"""
     data = tomllib.loads(Path(path).read_text())
     return sorted(
-        (Board.make(**board) for board in data["board"]),
-        key=attrgetter('sort_key'),
+        (Board.create(**board) for board in data["board"]),
+        key=attrgetter('start_on'),
         reverse=True,
     )
 
 @cache
 def load_current_board(path: Path | str = BOARDS_CONFIG_PATH) -> Board:
     """Load the board that is currently in power"""
-    return [
-        board for board in load_boards(path)
-        if board.start_on is not None
-    ][0]
+    return next(board for board in load_boards(path) if board.has_started)

src/pyvec_docs/boards.toml

@@ -2,11 +2,12 @@
 # The most recent board is first, previous boards are listed in descending order
 # Each member has a `name`, `github`, and optionally a `roles` array
 #
-# "start_on" should ideally be the date from justice.cz. If missing, the board
-# doesn't officially have power yet.
+# "voted_on" is the day when we voted for the board. It's approximate, since
+# votes can take longer than a day.
 #
-# "voted_on" is the day when we voted for the board. If missing, defaults to
-# "start_on" as an approximation.
+# "start_on" should ideally be the date from justice.cz.
+# If the board doesn't officially have power yet, leave it out; "voted_on` will
+# be used as default.
 
 
 [[board]]
@@ -36,7 +37,8 @@ github = "JakubDotPy"
 
 
 [[board]]
-start_on = "2022-04-09"
+start_on = "2022-09-01"
+voted_on = "2022-04-09"
 
 [[board.members]]
 name = "Barbora Drbohlavová"
@@ -63,7 +65,8 @@ roles = ["treasurer"]
 
 
 [[board]]
-start_on = "2019-04-08"
+start_on = "2019-05-04"
+voted_on = "2019-04-08"
 
 [[board.members]]
 name = "Martin Bílek"
@@ -90,6 +93,7 @@ github = "whiskybar"
 
 [[board]]
 start_on = "2012-03-27"
+voted_on = "2012-03-27"  # approximation
 
 [[board.members]]
 name = "Martin Bílek"

src/pyvec_docs/grants.py

@@ -18,7 +18,7 @@ def remove_comments(html):
 
 def get_board_member_name(username, voted_at, boards: list[Board]):
     for board in boards:  # sorted from the most recent
-        if board.start_on is None:
+        if not board.has_started:
             continue
         if voted_at > board.start_on:
             for member in board.members:

tests/test_scripts_generate_grants.py

@@ -14,7 +14,7 @@
 @pytest.fixture
 def boards():
     return [  # sorted!
-        Board.make(
+        Board.create(
             **{
                 # No start_on; votes don't count
                 "voted_on": date(2023, 1, 1),
@@ -23,16 +23,17 @@ def boards():
                 ],
             }
         ),
-        Board.make(
+        Board.create(
             **{
                 "start_on": date(2020, 1, 1),
+                "voted_on": date(2019, 12, 1),
                 "members": [
                     {"name": "Alice", "github": "alice"},
                     {"name": "Doubravka", "github": "doubravka"},
                 ],
             }
         ),
-        Board.make(
+        Board.create(
             **{
                 "start_on": date(2019, 1, 1),
                 "voted_on": date(2018, 12, 1),
@@ -48,14 +49,18 @@ def assert_boards_sorted(boards):
     assert boards == sorted(boards)
 
 
-def assert_voted_on_defaults(boards):
-    assert [b.voted_on for b in boards] == [
-        date(2023, 1, 1),  # explicit
-        date(2020, 1, 1),  # from start_on
+def assert_start_on_defaults(boards):
+    assert [b.start_on for b in boards] == [
+        date(2023, 1, 1),  # from voted_on
+        date(2020, 1, 1),  # explicit
         date(2018, 12, 1),  # explicit
     ]
 
 
+def assert_started_values(boards):
+    assert [b.start_on for b in boards] == [False, True, True]
+
+
 def test_to_date():
     assert to_date("2020-02-12T13:22:01Z") == date(2020, 2, 12)