kryten-webqueue 0.9.6__tar.gz → 0.9.7__tar.gz

{kryten_webqueue-0.9.6 → kryten_webqueue-0.9.7}/CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [Unreleased]
 
+## [0.9.7] — 2026-06-11
+
+### Changed
+
+- **Paid-queue chat announcement reworded.** A purchased item now announces as `"<title> added to the queue with Zcoin by <user> and is now <position>."` where `<position>` is `next` for the item immediately after the currently-playing one, or an English ordinal counting the now-playing item as first (e.g. `third`, `forty-second`, `one hundred seventh`). Position is computed relative to the currently-playing item and wraps around the playlist.
+- **Admin queueing is no longer announced** in the channel chat (only paid placements are announced).
+- Renamed the admin Schedules heading from “Scheduled Fires” to “Scheduled Events”.
+
 ## [0.9.6] — 2026-06-11
 
 ### Added

{kryten_webqueue-0.9.6 → kryten_webqueue-0.9.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kryten-webqueue
-Version: 0.9.6
+Version: 0.9.7
 Summary: Netflix/Tubi-style catalog browser and pay-to-play queue management for CyTube
 Author: grobertson
 License-Expression: MIT

{kryten_webqueue-0.9.6 → kryten_webqueue-0.9.7}/kryten_webqueue/queue/ordering.py

@@ -26,7 +26,7 @@ def _add_failure_reason(add_result: dict | None, exc: httpx.HTTPStatusError | No
 
 
 def _announcement_position(shadow, uid: int) -> int | None:
-    """Position of the item for chat announcement.
+    """Position of the item for chat announcement (deprecated; kept for tests).
 
     Counting starts at the currently-playing item (position 0), so the next
     item to play is position 1. The shadow mirrors the full CyTube playlist
@@ -39,13 +39,80 @@ def _announcement_position(shadow, uid: int) -> int | None:
     return None
 
 
-async def _announce_queued(api_gate, shadow, *, uid: int, title: str, username: str) -> None:
-    """Announce a successful queue placement to the channel chat."""
-    pos = _announcement_position(shadow, uid)
-    if pos is None:
+_ONES_ORDINAL = {
+    "one": "first", "two": "second", "three": "third", "five": "fifth",
+    "eight": "eighth", "nine": "ninth", "twelve": "twelfth",
+}
+_ONES = ["", "one", "two", "three", "four", "five", "six", "seven", "eight",
+         "nine", "ten", "eleven", "twelve", "thirteen", "fourteen", "fifteen",
+         "sixteen", "seventeen", "eighteen", "nineteen"]
+_TENS = ["", "", "twenty", "thirty", "forty", "fifty", "sixty", "seventy",
+         "eighty", "ninety"]
+
+
+def _cardinal_words(n: int) -> str:
+    """English cardinal words for 1..999 (queue positions never exceed this)."""
+    if n < 20:
+        return _ONES[n]
+    if n < 100:
+        tens, ones = divmod(n, 10)
+        return _TENS[tens] + (f"-{_ONES[ones]}" if ones else "")
+    hundreds, rem = divmod(n, 100)
+    head = f"{_ONES[hundreds]} hundred"
+    return f"{head} {_cardinal_words(rem)}" if rem else head
+
+
+def _to_ordinal_word(word: str) -> str:
+    """Convert a single cardinal word to its ordinal form."""
+    if word in _ONES_ORDINAL:
+        return _ONES_ORDINAL[word]
+    if word.endswith("y"):
+        return word[:-1] + "ieth"
+    return word + "th"
+
+
+def _ordinal_words(n: int) -> str:
+    """English ordinal words for n (e.g. 3 -> 'third', 42 -> 'forty-second')."""
+    cardinal = _cardinal_words(n)
+    # Convert only the final word (handles 'forty-two'->'forty-second',
+    # 'one hundred seven'->'one hundred seventh').
+    if "-" in cardinal:
+        head, last = cardinal.rsplit("-", 1)
+        return f"{head}-{_to_ordinal_word(last)}"
+    parts = cardinal.rsplit(" ", 1)
+    if len(parts) == 2:
+        return f"{parts[0]} {_to_ordinal_word(parts[1])}"
+    return _to_ordinal_word(cardinal)
+
+
+async def _announce_paid_queued(api_gate, shadow, *, uid: int, title: str, username: str) -> None:
+    """Announce a paid queue placement to the channel chat.
+
+    Position is counted from the currently-playing item, wrapping around the
+    playlist (CyTube loops). The item immediately after now-playing reads
+    "next"; everything else uses an English ordinal counting the now-playing
+    item as first (so the item two slots away is "third").
+    """
+    items = shadow.items
+    np_uid = await _now_playing_uid(api_gate, shadow)
+    np_index = None
+    item_index = None
+    for i, it in enumerate(items):
+        if it.get("uid") == np_uid:
+            np_index = i
+        if it.get("uid") == uid:
+            item_index = i
+    if item_index is None:
         return
+    n = len(items)
+    offset = item_index if np_index is None else (item_index - np_index) % n
+    if offset <= 0:
+        return
+    position = "next" if offset == 1 else _ordinal_words(offset + 1)
     try:
-        await api_gate.send_chat(f"{title} has been queued in position {pos} by {username}")
+        await api_gate.send_chat(
+            f"{title} added to the queue with Zcoin by {username} and is now {position}."
+        )
     except Exception:
         logger.warning("Failed to send queue announcement", exc_info=True)
 
@@ -238,7 +305,7 @@ async def insert_pay_queue(
         )
 
         # Announce placement to the channel
-        await _announce_queued(api_gate, shadow, uid=uid, title=title, username=username)
+        await _announce_paid_queued(api_gate, shadow, uid=uid, title=title, username=username)
 
         return {"success": True, "uid": uid, "request_id": request_id}
 
@@ -351,7 +418,7 @@ async def insert_pay_playnext(
         )
 
         # Announce placement to the channel
-        await _announce_queued(api_gate, shadow, uid=uid, title=title, username=username)
+        await _announce_paid_queued(api_gate, shadow, uid=uid, title=title, username=username)
 
         return {"success": True, "uid": uid, "request_id": request_id}
 
@@ -479,8 +546,7 @@ async def insert_admin_queue(
             title=title, tier="admin", z_cost=0,
         )
 
-        # Announce placement to the channel
-        await _announce_queued(api_gate, shadow, uid=uid, title=title, username=username)
+        # Admin queueing is intentionally NOT announced in the channel.
 
         return {"success": True, "uid": uid, "refunded": removed}
 

{kryten_webqueue-0.9.6 → kryten_webqueue-0.9.7}/kryten_webqueue/templates/admin/schedules.html

@@ -11,7 +11,7 @@
 
     <div class="admin-section">
         <div class="section-head">
-            <h2>Scheduled Fires</h2>
+            <h2>Scheduled Events</h2>
             <button class="btn btn-primary" onclick="showScheduleModal()">+ New Schedule</button>
         </div>
         <div id="schedules-list">Loading…</div>

{kryten_webqueue-0.9.6 → kryten_webqueue-0.9.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kryten-webqueue"
-version = "0.9.6"
+version = "0.9.7"
 description = "Netflix/Tubi-style catalog browser and pay-to-play queue management for CyTube"
 readme = "README.md"
 license = "MIT"

kryten_webqueue-0.9.7/tests/test_queue_announce.py

@@ -0,0 +1,106 @@
+"""Queue chat-announcement behaviour (v0.9.7).
+
+Covers the English-ordinal position words, the paid-queue announcement message
+format/position (counted from now-playing, wrapping), and that admin queueing
+is not announced.
+"""
+
+import pytest
+
+from kryten_webqueue.queue import ordering
+from kryten_webqueue.queue.ordering import _ordinal_words, _announce_paid_queued
+
+
+class _FakeApiGate:
+    def __init__(self, np_uid=None):
+        self.sent = []
+        self._np_uid = np_uid
+
+    async def get_now_playing(self):
+        return {"uid": self._np_uid} if self._np_uid is not None else None
+
+    async def send_chat(self, message):
+        self.sent.append(message)
+        return {"success": True}
+
+
+class _FakeShadow:
+    def __init__(self, items, now_playing=None):
+        self._items = items
+        self.now_playing = now_playing
+
+    @property
+    def items(self):
+        return self._items
+
+
+@pytest.mark.parametrize("n,word", [
+    (2, "second"),
+    (3, "third"),
+    (4, "fourth"),
+    (5, "fifth"),
+    (8, "eighth"),
+    (9, "ninth"),
+    (11, "eleventh"),
+    (12, "twelfth"),
+    (20, "twentieth"),
+    (21, "twenty-first"),
+    (42, "forty-second"),
+    (53, "fifty-third"),
+    (100, "one hundredth"),
+    (107, "one hundred seventh"),
+    (123, "one hundred twenty-third"),
+])
+def test_ordinal_words(n, word):
+    assert _ordinal_words(n) == word
+
+
+def _items(*uids):
+    return [{"uid": u, "title": f"Item {u}"} for u in uids]
+
+
+async def test_paid_announcement_next():
+    # now-playing uid=10 at index 0; the new item uid=11 is immediately next.
+    api = _FakeApiGate(np_uid=10)
+    shadow = _FakeShadow(_items(10, 11))
+    await _announce_paid_queued(api, shadow, uid=11, title="Airplane (1980)", username="Hollis")
+    assert api.sent == [
+        "Airplane (1980) added to the queue with Zcoin by Hollis and is now next."
+    ]
+
+
+async def test_paid_announcement_third():
+    # now-playing uid=10 at index 0; new item is two slots away -> "third".
+    api = _FakeApiGate(np_uid=10)
+    shadow = _FakeShadow(_items(10, 99, 11))
+    await _announce_paid_queued(api, shadow, uid=11, title="Airplane (1980)", username="Hollis")
+    assert api.sent == [
+        "Airplane (1980) added to the queue with Zcoin by Hollis and is now third."
+    ]
+
+
+async def test_paid_announcement_wraps_around():
+    # now-playing is uid=99 at index 2; list wraps: after 99 comes 10 (next),
+    # then 11 (third).
+    api = _FakeApiGate(np_uid=99)
+    shadow = _FakeShadow(_items(10, 11, 99))
+    await _announce_paid_queued(api, shadow, uid=11, title="X", username="U")
+    assert api.sent == ["X added to the queue with Zcoin by U and is now third."]
+
+
+async def test_admin_queue_not_announced(monkeypatch):
+    """insert_admin_queue must never call the announcement helper."""
+    called = False
+
+    async def _fail(*a, **k):
+        nonlocal called
+        called = True
+
+    monkeypatch.setattr(ordering, "_announce_paid_queued", _fail)
+    # Source check: the admin path has no announce call (the helper is only wired
+    # to the paid paths). This guards against a regression re-adding it.
+    import inspect
+    src = inspect.getsource(ordering.insert_admin_queue)
+    assert "_announce_paid_queued" not in src
+    assert "_announce_queued" not in src
+    assert called is False