Merge pull request #530 from propcgamer20-png/fix/report-reference-more-groups-notice

fix: show "N more groups" notice on the reference-baseline sub-table

Author: yakew7

faircode/report.py

@@ -87,10 +87,13 @@ def to_terminal(result: dict) -> str:
         if meta:
             add(f"  ({'  '.join(meta)})")
         if d.get("reference"):
+            ref_groups = d["reference"]["groups"]
             add(f"  reference (deviation {d['reference']['deviation'] * 100:.1f}%):")
-            for g in d["reference"]["groups"][:DISPLAY_GROUPS]:
+            for g in ref_groups[:DISPLAY_GROUPS]:
                 add(f"    {g['label'][:16]:<16} exp {g['expected'] * 100:5.1f}%  "
                     f"act {g['actual'] * 100:5.1f}%  ({g['delta'] * 100:+5.1f} pp)")
+            if len(ref_groups) > DISPLAY_GROUPS:
+                add(f"    … and {len(ref_groups) - DISPLAY_GROUPS} more groups")
         add("")
 
     if result["flags"]:
@@ -231,13 +234,19 @@ def esc(s) -> str:
                 f'<td class="num">{g["delta"] * 100:+.1f} pp</td></tr>'
                 for g in ref["groups"][:DISPLAY_GROUPS]
             )
+            ref_more = ""
+            if len(ref["groups"]) > DISPLAY_GROUPS:
+                ref_more = (
+                    f'<div class="dim-more">… and '
+                    f'{len(ref["groups"]) - DISPLAY_GROUPS} more groups</div>'
+                )
             reference_html = (
                 f'<div class="reference"><h3>Reference '
                 f'<span class="kind">deviation {ref["deviation"] * 100:.1f}%</span></h3>'
                 f'<table><caption>Expected vs. actual share - {esc(d["name"])}</caption>'
                 f'<tr><th scope="col"></th><th scope="col" class="num">Expected</th>'
                 f'<th scope="col" class="num">Actual</th><th scope="col" class="num">Delta</th></tr>'
-                f'{ref_rows}</table></div>'
+                f'{ref_rows}</table>{ref_more}</div>'
             )
 
         meta_parts = []

tests/test_report.py

@@ -145,6 +145,25 @@ def test_to_html_renders_reference_baseline_section(mock_profile_result):
     assert "-5.0 pp" in html_out
 
 
+def test_to_html_reports_reference_groups_omitted_by_display_cap(mock_profile_result):
+    """Mirrors test_to_html_reports_groups_omitted_by_display_cap for the
+    reference-baseline sub-table, which was silently truncated with no
+    dim-more notice."""
+    mock_profile_result["dimensions"][0]["reference"] = {
+        "deviation": 0.1,
+        "groups": [
+            {"label": f"Group {i}", "expected": 1 / 15, "actual": 1 / 15, "delta": 0.0}
+            for i in range(15)
+        ],
+    }
+
+    html_out = to_html(mock_profile_result)
+
+    assert "Group 11" in html_out
+    assert "Group 12" not in html_out
+    assert '<div class="dim-more">… and 3 more groups</div>' in html_out
+
+
 def test_to_html_omits_reference_section_when_absent(mock_profile_result):
     html_out = to_html(mock_profile_result)
 
@@ -268,6 +287,25 @@ def test_to_terminal_truncates_a_long_reference_group_label(mock_profile_result)
     assert ref_label not in out
 
 
+def test_to_terminal_reports_reference_groups_omitted_by_display_cap(mock_profile_result):
+    """SPEC section 7: every report surface that truncates a group list must
+    state how many groups were omitted. The reference sub-table used to be
+    silently capped at DISPLAY_GROUPS with no notice."""
+    mock_profile_result["dimensions"][0]["reference"] = {
+        "deviation": 0.1,
+        "groups": [
+            {"label": f"Group {i}", "expected": 1 / 15, "actual": 1 / 15, "delta": 0.0}
+            for i in range(15)
+        ],
+    }
+
+    out = to_terminal(mock_profile_result)
+
+    assert "Group 11" in out
+    assert "Group 12" not in out
+    assert "… and 3 more groups" in out
+
+
 def test_to_terminal_renders_flags_section(mock_profile_result):
     out = to_terminal(mock_profile_result)