Add voted_on, for the Elections documentation

Author: encukou

docs/operations/elections.rst

@@ -8,11 +8,11 @@ Volby do výboru probíhají asynchronně a zpravidla trvají týden, aby stihli
 Kdy se volí
 -----------
 
-+------------------------------------+--------------------+
-| |:ballot_box:| Předchozí volba     | |board_start|      |
-+------------------------------------+--------------------+
-| |:warning:| Příští volba           | |board_end|        |
-+------------------------------------+--------------------+
++------------------------------------+------------------------+
+| |:ballot_box:| Předchozí volba     | |board_vote_date|      |
++------------------------------------+------------------------+
+| |:warning:| Příští volba           | |next_board_vote_date| |
++------------------------------------+------------------------+
 
 Příprava
 --------

src/pyvec_docs/boards.py

@@ -40,10 +40,17 @@ def is_treasurer(self) -> bool:
 
 class Board(BaseModel):
     start_on: date | None = None
+    voted_on: date
     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)
+
     @property
     def years(self) -> tuple[int, int] | tuple[None, None]:
         if self.start_on is None:
@@ -64,7 +71,7 @@ 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(**board) for board in data["board"]),
+        (Board.make(**board) for board in data["board"]),
         key=attrgetter('sort_key'),
         reverse=True,
     )

src/pyvec_docs/boards.toml

@@ -4,8 +4,13 @@
 #
 # "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. If missing, defaults to
+# "start_on" as an approximation.
+
 
 [[board]]
+voted_on = "2025-05-07"
 
 [[board.members]]
 name = "Jakub Vysoký"

src/pyvec_docs/ext/board_dates.py

@@ -4,21 +4,20 @@
 from sphinx.application import Sphinx
 from sphinx.config import Config
 
-from pyvec_docs.boards import BOARDS_MANDATE_LENGTH, load_current_board
+from pyvec_docs.boards import BOARDS_MANDATE_LENGTH, load_boards
 
 
 def board_dates(app: Sphinx, config: Config):
-    board = load_current_board()
-    assert board.start_on is not None
+    board = load_boards()[0]
 
-    board_start = board.start_on
-    board_end = board_start + timedelta(days=BOARDS_MANDATE_LENGTH * 365)
+    last_vote = board.voted_on
+    next_vote = last_vote + timedelta(days=BOARDS_MANDATE_LENGTH * 365)
 
     existing_epilog = app.config.rst_epilog or ""
     app.config.rst_epilog = (
         f"{existing_epilog}\n\n"
-        f".. |board_start| replace:: {board_start:%-d.%-m.%Y}\n"
-        f".. |board_end| replace:: {board_end:%Y}\n"
+        f".. |board_vote_date| replace:: {last_vote:%-d.%-m.%Y}\n"
+        f".. |next_board_vote_date| replace:: {next_vote:%Y}\n"
     )
 
 

tests/test_scripts_generate_grants.py

@@ -14,15 +14,16 @@
 @pytest.fixture
 def boards():
     return [  # sorted!
-        Board(
+        Board.make(
             **{
                 # No start_on; votes don't count
+                "voted_on": date(2023, 1, 1),
                 "members": [
                     {"name": "Bob", "github": "bobby"},
                 ],
             }
         ),
-        Board(
+        Board.make(
             **{
                 "start_on": date(2020, 1, 1),
                 "members": [
@@ -31,9 +32,10 @@ def boards():
                 ],
             }
         ),
-        Board(
+        Board.make(
             **{
                 "start_on": date(2019, 1, 1),
+                "voted_on": date(2018, 12, 1),
                 "members": [
                     {"name": "Bob", "github": "bobby"},
                 ],
@@ -46,6 +48,14 @@ 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
+        date(2018, 12, 1),  # explicit
+    ]
+
+
 def test_to_date():
     assert to_date("2020-02-12T13:22:01Z") == date(2020, 2, 12)