screen-locker/screen_locker/_extra_benefits.py
Krzysztof kuhy Rudnicki fc5453495c
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
pre-commit / pre-commit (${{ matrix.group }}) (flutter, flutter-analyze, ) (push) Waiting to run
pre-commit / pre-commit (${{ matrix.group }}) (mypy, mypy, ) (push) Waiting to run
pre-commit / pre-commit (${{ matrix.group }}) (pylint, pylint, ) (push) Waiting to run
pre-commit / pre-commit (${{ matrix.group }}) (rest, , mypy,pylint,flutter-analyze) (push) Waiting to run
Tests / test (push) Waiting to run
Tests / lock-popup-safety (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (0) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (1) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (2) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (3) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (4) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (5) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (6) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (7) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (8) (push) Waiting to run
Tests / flutter test (shard ${{ matrix.shard }}) (9) (push) Waiting to run
Tests / flutter-coverage (push) Blocked by required conditions
Tests / web-coverage (push) Waiting to run
repo-contract / repo contract (push) Waiting to run
drop the weekly shutdown bonus entirely; every bonus stops at the shutdown ceiling
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-10 08:59:50 +02:00

150 lines
5.3 KiB
Python

"""Extra benefits for exceeding the weekly workout minimum.
Tracks:
- Consecutive weeks with 5+ workouts (streak counter).
- ISO weeks in which the early-bird window is extended to 09:00.
There is no weekly shutdown-time bonus (dropped entirely 2026-10-10, hours
already banked for 2026-W41 included): every shutdown minute comes from the
``earned_time`` ladder and stops at its daily ceiling. A legacy
``weekly_shutdown_bonus_hours`` map in an old state file is ignored, and
dropped at the next week transition's write.
State is persisted in ``extra_benefits_state.json`` next to this file.
"""
from __future__ import annotations
from datetime import UTC, datetime, timedelta
import json
import logging
from typing import TYPE_CHECKING, Any
from screen_locker._weekly_check import count_weekly_workouts
if TYPE_CHECKING:
from pathlib import Path
_logger = logging.getLogger(__name__)
_BONUS_THRESHOLD = 5 # workouts/week required to extend the streak + early-bird
# The removed weekly shutdown bonus's map; ignored on read, dropped on write.
_LEGACY_BONUS_KEY = "weekly_shutdown_bonus_hours"
def _load_state(state_file: Path) -> dict[str, Any]:
"""Load benefits state, returning defaults if missing or corrupt."""
if not state_file.exists():
return {}
try:
with state_file.open() as f:
return json.load(f)
except (OSError, json.JSONDecodeError) as exc:
_logger.warning(
"Could not read extra-benefits state from %s: %s — starting from "
"empty state, so the workout streak and early-bird extension are "
"lost for this run",
state_file,
exc,
)
return {}
def _save_state(state_file: Path, state: dict[str, Any]) -> None:
"""Persist benefits state to disk."""
try:
with state_file.open("w") as f:
json.dump(state, f, indent=2)
except OSError as exc:
_logger.warning("Failed to save extra benefits state: %s", exc)
def _current_iso_week(now: datetime) -> str:
"""Return *now*'s ISO week as ``YYYY-Www``."""
year, week, _ = now.isocalendar()
return f"{year}-W{week:02d}"
def process_week_transition(log_file: Path, state_file: Path) -> list[str]:
"""Process last week's results if we've entered a new ISO week.
Counts workouts from the previous ISO week. If count >= 5:
- Increments the consecutive-streak counter.
- Marks the *current* ISO week as having extended early-bird (09:00).
Otherwise the streak resets to 0. No shutdown-time hours are banked.
Returns a list of human-readable reward strings (empty if no transition).
"""
now = datetime.now(tz=UTC).astimezone()
current_week_str = _current_iso_week(now)
state = _load_state(state_file)
if state.get("last_processed_iso_week") == current_week_str:
return []
# Count workouts in the previous ISO week (Mon through Sun).
monday_this_week = now.date() - timedelta(days=now.weekday())
sunday_prev_week = monday_this_week - timedelta(days=1)
prev_week_dt = datetime(
sunday_prev_week.year,
sunday_prev_week.month,
sunday_prev_week.day,
23,
59,
59,
tzinfo=UTC,
)
prev_week_count = count_weekly_workouts(log_file, today=prev_week_dt)
streak = int(state.get("consecutive_5plus_weeks", 0))
eb_weeks: list[str] = list(state.get("extended_early_bird_iso_weeks", []))
rewards: list[str] = []
prev_year, prev_week, _ = sunday_prev_week.isocalendar()
prev_week_str = f"{prev_year}-W{prev_week:02d}"
if prev_week_count >= _BONUS_THRESHOLD:
streak += 1
if current_week_str not in eb_weeks:
eb_weeks.append(current_week_str)
rewards.append(
f"{prev_week_count} workouts in {prev_week_str}! "
f"{streak}-week streak, early-bird extended to 09:00 this week"
)
else:
if streak > 0:
rewards.append(f"Streak reset (was {streak} weeks of 5+ workouts)")
streak = 0
# Merge onto the loaded state rather than rebuilding it from these three
# keys: sibling fields written by the recovery scripts (e.g.
# ``shutdown_bonus_granted_for``) live in this file too, and rebuilding
# would drop them at the next weekly rollover. Only the dead weekly-bonus
# map is dropped, so no reader can mistake it for live state.
updated = dict(state)
updated.pop(_LEGACY_BONUS_KEY, None)
updated.update(
{
"consecutive_5plus_weeks": streak,
"last_processed_iso_week": current_week_str,
"extended_early_bird_iso_weeks": eb_weeks,
}
)
_save_state(state_file, updated)
return rewards
def current_streak(state_file: Path) -> int:
"""Return the current consecutive-5plus-weeks streak count."""
return int(_load_state(state_file).get("consecutive_5plus_weeks", 0))
def has_extended_early_bird(state_file: Path, *, today: datetime | None = None) -> bool:
"""Return True if the current ISO week has an extended early-bird window (09:00)."""
now = today if today is not None else datetime.now(tz=UTC).astimezone()
current_week_str = _current_iso_week(now)
eb_weeks: list[str] = _load_state(state_file).get(
"extended_early_bird_iso_weeks", []
)
return current_week_str in eb_weeks