From 5b0e6836de9f70a5bf3195ea8c67ca74dd32708a Mon Sep 17 00:00:00 2001
From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com>
Date: Tue, 11 Aug 2026 16:52:18 +0200
Subject: [PATCH] refactor: split the problem-files gap section
generate_gap_analysis reached complexity 56. Its problem-files section
is the one that stands alone -- it reads platform_problems and nothing
else -- so it becomes its own function and the caller drops to 43.
The neighbouring sections were tried too and put back: they share
gap_report and the resolved core list, so pulling them out turns a
render pass into an argument-threading exercise for no gain. Verified
by generating the site with both versions against the same data: 529 of
530 pages identical, the odd one a wiki page another run had edited.
---
scripts/generate_site.py | 186 +++++++++++++++++++++------------------
1 file changed, 100 insertions(+), 86 deletions(-)
diff --git a/scripts/generate_site.py b/scripts/generate_site.py
index e8e5d3ad..992facce 100644
--- a/scripts/generate_site.py
+++ b/scripts/generate_site.py
@@ -2664,6 +2664,105 @@ def generate_emulator_page(
# Contributing page
+def _render_problem_files(platform_problems: list) -> list[str]:
+ """Files a platform declares that its own check then rejects.
+
+ Split out of generate_gap_analysis, which reached complexity 56. This
+ section is the one that stands alone: it reads platform_problems and
+ nothing else, where the sections around it share gap_report and the
+ resolved core list.
+ """
+ lines: list[str] = []
+ # ---- Section 2: Problem files ----
+
+ missing_files: dict[str, dict] = {}
+ untested_files: dict[str, dict] = {}
+ mismatch_files: dict[str, dict] = {}
+
+ for p in platform_problems:
+ fname = p["name"]
+ if p["status"] == "missing":
+ entry = missing_files.setdefault(fname, {
+ "name": fname, "required": p["required"],
+ "platforms": [], "reason": p["reason"],
+ })
+ entry["platforms"].append(p["platform"])
+ if p["required"]:
+ entry["required"] = True
+ elif p["status"] == "untested":
+ entry = untested_files.setdefault(fname, {
+ "name": fname, "required": p["required"],
+ "platforms": [], "reason": p["reason"],
+ })
+ entry["platforms"].append(p["platform"])
+ if p.get("discrepancy"):
+ entry = mismatch_files.setdefault(fname, {
+ "name": fname, "platforms": [],
+ "discrepancy": p["discrepancy"],
+ })
+ entry["platforms"].append(p["platform"])
+
+ total_problems = len(missing_files) + len(untested_files) + len(mismatch_files)
+
+ if total_problems > 0:
+ lines.extend([
+ "## Problem Files",
+ "",
+ f"{len(missing_files)} missing, {len(untested_files)} untested, "
+ f"{len(mismatch_files)} hash mismatch.",
+ "",
+ ])
+
+ if missing_files:
+ lines.extend([
+ f'### Missing '
+ f"{len(missing_files)} files",
+ "",
+ "| File | Required | Platforms |",
+ "|------|----------|-----------|",
+ ])
+ for fname in sorted(missing_files):
+ f = missing_files[fname]
+ req = "yes" if f["required"] else "no"
+ plats = ", ".join(sorted(set(f["platforms"])))
+ lines.append(f"| `{fname}` | {req} | {plats} |")
+ lines.append("")
+
+ if untested_files:
+ lines.extend([
+ f'### Untested '
+ f"{len(untested_files)} files",
+ "",
+ "Present but hash not verified.",
+ "",
+ "| File | Platforms | Reason |",
+ "|------|----------|--------|",
+ ])
+ for fname in sorted(untested_files):
+ f = untested_files[fname]
+ plats = ", ".join(sorted(set(f["platforms"])))
+ lines.append(f"| `{fname}` | {plats} | {f['reason']} |")
+ lines.append("")
+
+ if mismatch_files:
+ lines.extend([
+ f'### Hash Mismatch '
+ f"{len(mismatch_files)} files",
+ "",
+ "Platform says OK but emulator validation disagrees.",
+ "",
+ "| File | Platforms | Discrepancy |",
+ "|------|----------|-------------|",
+ ])
+ for fname in sorted(mismatch_files):
+ f = mismatch_files[fname]
+ plats = ", ".join(sorted(set(f["platforms"])))
+ lines.append(f"| `{fname}` | {plats} | {f['discrepancy']} |")
+ lines.append("")
+
+ return lines
+
+
def generate_gap_analysis(
profiles: dict,
coverages: dict,
@@ -2894,92 +2993,7 @@ def generate_gap_analysis(
"",
])
- # ---- Section 2: Problem files ----
-
- missing_files: dict[str, dict] = {}
- untested_files: dict[str, dict] = {}
- mismatch_files: dict[str, dict] = {}
-
- for p in platform_problems:
- fname = p["name"]
- if p["status"] == "missing":
- entry = missing_files.setdefault(fname, {
- "name": fname, "required": p["required"],
- "platforms": [], "reason": p["reason"],
- })
- entry["platforms"].append(p["platform"])
- if p["required"]:
- entry["required"] = True
- elif p["status"] == "untested":
- entry = untested_files.setdefault(fname, {
- "name": fname, "required": p["required"],
- "platforms": [], "reason": p["reason"],
- })
- entry["platforms"].append(p["platform"])
- if p.get("discrepancy"):
- entry = mismatch_files.setdefault(fname, {
- "name": fname, "platforms": [],
- "discrepancy": p["discrepancy"],
- })
- entry["platforms"].append(p["platform"])
-
- total_problems = len(missing_files) + len(untested_files) + len(mismatch_files)
-
- if total_problems > 0:
- lines.extend([
- "## Problem Files",
- "",
- f"{len(missing_files)} missing, {len(untested_files)} untested, "
- f"{len(mismatch_files)} hash mismatch.",
- "",
- ])
-
- if missing_files:
- lines.extend([
- f'### Missing '
- f"{len(missing_files)} files",
- "",
- "| File | Required | Platforms |",
- "|------|----------|-----------|",
- ])
- for fname in sorted(missing_files):
- f = missing_files[fname]
- req = "yes" if f["required"] else "no"
- plats = ", ".join(sorted(set(f["platforms"])))
- lines.append(f"| `{fname}` | {req} | {plats} |")
- lines.append("")
-
- if untested_files:
- lines.extend([
- f'### Untested '
- f"{len(untested_files)} files",
- "",
- "Present but hash not verified.",
- "",
- "| File | Platforms | Reason |",
- "|------|----------|--------|",
- ])
- for fname in sorted(untested_files):
- f = untested_files[fname]
- plats = ", ".join(sorted(set(f["platforms"])))
- lines.append(f"| `{fname}` | {plats} | {f['reason']} |")
- lines.append("")
-
- if mismatch_files:
- lines.extend([
- f'### Hash Mismatch '
- f"{len(mismatch_files)} files",
- "",
- "Platform says OK but emulator validation disagrees.",
- "",
- "| File | Platforms | Discrepancy |",
- "|------|----------|-------------|",
- ])
- for fname in sorted(mismatch_files):
- f = mismatch_files[fname]
- plats = ", ".join(sorted(set(f["platforms"])))
- lines.append(f"| `{fname}` | {plats} | {f['discrepancy']} |")
- lines.append("")
+ lines.extend(_render_problem_files(platform_problems))
# ---- Section 3: Core complement (cross-reference provenance) ----