fix(recent): keep recent list collapsed unless user toggles

Recording a new entry or loading persisted entries no longer auto-expands
the recent list. Pruning still collapses an emptied list, but no longer
expands a non-empty one. This makes expansion state fully user-controlled.

Author: guanzo

cue_lib/audio/recent.py

@@ -26,8 +26,9 @@ class CueRecentManager(object):
     """Most-recent-first persistent list of heterogeneous used entries.
 
     expand-state (toggle) is session-local -- only the entries are persisted.
-    expanded defaults to True whenever the list has entries, so a non-empty
-    list shows open until the user collapses it.
+    The list opens only when the user toggles it; recording a use or loading
+    persisted entries never auto-expands.  prune only collapses a list that
+    has been emptied of valid refs.
     """
 
     def __init__(self, key, keep):
@@ -59,14 +60,13 @@ def save(self):
 
     def record(self, kind, ref):
         # type: (str, str) -> None
-        """Mark an attempt to use (kind, ref): move to front, cap, expand."""
+        """Mark an attempt to use (kind, ref): move to front, cap."""
         for i, e in enumerate(self._entries):
             if e["type"] == kind and e["ref"] == ref:
                 del self._entries[i]
                 break
         self._entries.insert(0, {"type": kind, "ref": ref})
         del self._entries[CUE_RECENT_MAX_ENTRIES:]
-        self.expanded = True
         self.save()
 
     def entries(self):
@@ -84,7 +84,8 @@ def prune(self):
         self._entries = [e for e in self._entries
                          if self._keep(e["type"], e["ref"])]
         del self._entries[CUE_RECENT_MAX_ENTRIES:]
-        self.expanded = bool(self._entries)
+        if not self._entries:
+            self.expanded = False
         self.save()
 
 

test_game/templates/testcases_legacy.rpy

@@ -120,7 +120,7 @@ testcase sfx_recently_used:
     $ _ok = _ok and not _cue.sfx_manager._recent.expanded
     run Function(_cue.markers.image.send_file, 0)
     $ _ok = _ok and _cue.sfx_manager._recent.entries() == [{"type": "file", "ref": _cue.sfx_manager.files[0]}]
-    $ _ok = _ok and _cue.sfx_manager._recent.expanded
+    $ _ok = _ok and not _cue.sfx_manager._recent.expanded
     run Function(_cue.markers.image.send_folder, "Sub/")
     $ _ok = _ok and _cue.sfx_manager._recent.entries()[0] == {"type": "folder", "ref": "Sub/"}
     $ _ok = _ok and len(_cue.sfx_manager._recent.entries()) == 2
@@ -144,7 +144,7 @@ testcase music_recently_used:
     $ _ok = _ok and not _cue.music._recent.expanded
     run Function(_cue.music.add_user_song_to_trigger, "music/song_001.ogg")
     $ _ok = _ok and _cue.music._recent.entries() == [{"type": "file", "ref": "u:music/song_001.ogg"}]
-    $ _ok = _ok and _cue.music._recent.expanded
+    $ _ok = _ok and not _cue.music._recent.expanded
     run Function(_cue.music.add_user_folder_to_trigger, "music/")
     $ _ok = _ok and _cue.music._recent.entries()[0] == {"type": "folder", "ref": "u:music/"}
     $ _ok = _ok and len(_cue.music._recent.entries()) == 2

test_game/templates/testcases_modern.rpy

@@ -83,10 +83,10 @@ testcase sfx_recently_used:
     assert eval (_cue.sfx_manager._recent is not None)
     assert eval (_cue.sfx_manager._recent.entries() == [])
     assert eval (not _cue.sfx_manager._recent.expanded)
-    # A file send records the resolved path and expands the list.
+    # A file send records the resolved path; it does not expand the list.
     run Function(_cue.markers.image.send_file, 0)
     assert eval (_cue.sfx_manager._recent.entries() == [{"type": "file", "ref": _cue.sfx_manager.files[0]}])
-    assert eval (_cue.sfx_manager._recent.expanded)
+    assert eval (not _cue.sfx_manager._recent.expanded)
     # A folder send normalizes its ref and bumps to front.
     run Function(_cue.markers.image.send_folder, "Sub/")
     assert eval (_cue.sfx_manager._recent.entries()[0] == {"type": "folder", "ref": "Sub/"})
@@ -107,10 +107,10 @@ testcase music_recently_used:
     assert eval (_cue.music._recent is not None)
     assert eval (_cue.music._recent.entries() == [])
     assert eval (not _cue.music._recent.expanded)
-    # Adding a My Music song records its u:-tagged ref and expands the list.
+    # Adding a My Music song records its u:-tagged ref; it does not expand.
     run Function(_cue.music.add_user_song_to_trigger, "music/song_001.ogg")
     assert eval (_cue.music._recent.entries() == [{"type": "file", "ref": "u:music/song_001.ogg"}])
-    assert eval (_cue.music._recent.expanded)
+    assert eval (not _cue.music._recent.expanded)
     # A folder add normalizes its ref and bumps to front.
     run Function(_cue.music.add_user_folder_to_trigger, "music/")
     assert eval (_cue.music._recent.entries()[0] == {"type": "folder", "ref": "u:music/"})

tests/test_recent.py

@@ -28,7 +28,7 @@ def _all_keep(kind, ref):
 
 
 # ---------------------------------------------------------------------------
-# record: dedup, MRU order, cap, expand-on-first
+# record: dedup, MRU order, cap (no auto-expand)
 # ---------------------------------------------------------------------------
 
 def test_record_moves_existing_entry_to_front():
@@ -55,11 +55,10 @@ def test_record_caps_at_max_entries():
     assert m.entries()[0]["ref"] == "f{}.ogg".format(CUE_RECENT_MAX_ENTRIES + 2)
 
 
-def test_first_record_expands_list():
+def test_record_does_not_expand_list():
     m = CueRecentManager("recent_entries", _all_keep)
-    assert m.expanded is False
     m.record("file", "a.ogg")
-    assert m.expanded is True
+    assert m.expanded is False
 
 
 # ---------------------------------------------------------------------------
@@ -85,13 +84,13 @@ def test_record_writes_to_persistent():
     assert persistent._cue["recent_entries"] == [{"type": "file", "ref": "a.ogg"}]
 
 
-def test_load_roundtrips_entries_and_expands():
+def test_load_roundtrips_entries_without_expanding():
     m = CueRecentManager("recent_entries", _all_keep)
     m.record("preset", "Hurt")
     m2 = CueRecentManager("recent_entries", _all_keep)
     m2.load()
     assert [e["ref"] for e in m2.entries()] == ["Hurt"]
-    assert m2.expanded is True
+    assert m2.expanded is False
 
 
 def test_load_no_entries_when_key_absent():
@@ -117,7 +116,7 @@ def test_load_prunes_stale_entries():
                           lambda kind, ref: ref == "keep.ogg")
     m2.load()
     assert [e["ref"] for e in m2.entries()] == ["keep.ogg"]
-    assert m2.expanded is True
+    assert m2.expanded is False
 
 
 def test_load_collapses_when_all_stale():
@@ -139,13 +138,15 @@ def test_prune_drops_stale_entries():
     m.record("file", "gone.ogg")
     m.record("file", "keep.ogg")
     m.record("folder", "sfx/keep/")
+    m.expanded = True
     m.prune()
     assert [e["ref"] for e in m.entries()] == ["sfx/keep/", "keep.ogg"]
     assert m.expanded is True
 
 
 def test_prune_empty_when_all_stale_collapses():
     m = CueRecentManager("recent_entries", lambda kind, ref: False)
+    m.expanded = True
     m.record("file", "a.ogg")
     m.prune()
     assert m.entries() == []