docassert 0.9.0__tar.gz → 0.10.1__tar.gz

{docassert-0.9.0/docassert.egg-info → docassert-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassert
-Version: 0.9.0
+Version: 0.10.1
 Summary: Unit testing for business documents — validate structured Markdown docs against a configurable audit standard.
 Author: C4G Enterprises Inc.
 License: Apache-2.0

{docassert-0.9.0 → docassert-0.10.1}/docassert/__init__.py

@@ -5,4 +5,4 @@ standard: deterministic structural checks that gate a merge, plus optional
 AI-graded semantic checks that advise.
 """
 
-__version__ = "0.9.0"
+__version__ = "0.10.1"

{docassert-0.9.0 → docassert-0.10.1}/docassert/bridge/ops.py

@@ -171,9 +171,28 @@ def reconcile(plan: BridgePlan, gh: G.GhRunner, repo: str) -> tuple[list[str], i
 
 
 def status(plan: BridgePlan, gh: G.GhRunner, repo: str) -> dict:
-    """Read-only: delivery progress per feature from issue states."""
-    by_key = _index(G.list_issues(gh, repo))
-    out: dict = {"projects": []}
+    """Read-only: delivery progress per feature, plus scope classification.
+
+    Unlike reconcile, this never labels or comments; it only reports, so it is
+    safe to run from the dashboard build.
+    """
+    issues = G.list_issues(gh, repo)
+    by_key = _index(issues)
+    managed = plan.managed_ids
+    unverified, orphaned = [], []
+    for issue in issues:
+        if issue.get("state") != "open":
+            continue
+        key = _marker_of(issue)
+        if key == SCOPE_REPORT_KEY:
+            continue
+        if key is None:
+            unverified.append({"number": issue["number"], "title": issue["title"]})
+        elif key not in managed:
+            orphaned.append({"number": issue["number"], "title": issue["title"],
+                             "doc": key})
+    out: dict = {"repo": repo, "projects": [],
+                 "scope": {"unverified": unverified, "orphaned": orphaned}}
     for p in plan.projects:
         feats = []
         for f in p["features"]:

{docassert-0.9.0 → docassert-0.10.1}/docassert/bridge/plan.py

@@ -7,6 +7,7 @@ anywhere in the bridge, writes to documents/.
 """
 from __future__ import annotations
 
+import os
 from dataclasses import dataclass, field
 from pathlib import Path
 
@@ -54,6 +55,18 @@ class BridgePlan:
         return {f.id for f in self.features} | {s.id for s in self.stories}
 
 
+def _repo_rel(path: str, documents_dir: Path) -> str:
+    """Path relative to the docs repo root (the parent of documents_dir).
+
+    Issue bodies link Source as {docs_url}/{doc_path}, and docs_url points at
+    the docs repository. When CI checks that repository out into a
+    subdirectory, load paths carry the checkout prefix; stripping down to the
+    repo root keeps the links valid wherever the docs are checked out.
+    """
+    rel = os.path.relpath(path, documents_dir.parent)
+    return path if rel.startswith("..") else Path(rel).as_posix()
+
+
 def _title(item_text: str, limit: int = 64) -> str:
     """First sentence of the item text, trimmed for an issue title."""
     first = item_text.split(". ")[0].rstrip(".")
@@ -126,14 +139,17 @@ def build_bridge_plan(documents_dir: str | Path = "documents") -> BridgePlan:
                 feat = features.get(parent.id)
                 if feat is None:
                     feat = Feature(id=parent.id, text=parent.text,
-                                   doc_path=parent.doc_path, project=proj_id)
+                                   doc_path=_repo_rel(parent.doc_path,
+                                                      documents_dir),
+                                   project=proj_id)
                     feat.acceptance = [(a.id, a.text) for a in
                                        graph.children(parent.id, "verifies", "AC")]
                     for aid, _ in feat.acceptance:
                         feat.tests += [t.id for t in graph.children(aid, "tests", "TC")]
                     features[parent.id] = feat
-                feat.stories.append(Story(id=s.id, text=s.text,
-                                          feature_id=parent.id, doc_path=s.doc_path))
+                feat.stories.append(Story(
+                    id=s.id, text=s.text, feature_id=parent.id,
+                    doc_path=_repo_rel(s.doc_path, documents_dir)))
         if problems:
             plan.skipped.append({"id": proj_id,
                                  "reason": "; ".join(problems)})

{docassert-0.9.0 → docassert-0.10.1}/docassert/cli.py

@@ -232,9 +232,19 @@ def cmd_pages(args: argparse.Namespace) -> int:
         status_mod.render_badge_json(index["overall"]["rag"]))
     (out / "badges").mkdir(exist_ok=True)
 
+    execution = {}
+    if getattr(args, "execution", None):
+        import json as _json
+        data = _json.loads(Path(args.execution).read_text())
+        for proj in data.get("projects", []):
+            execution[proj["id"]] = {**proj, "scope": data.get("scope"),
+                                     "repo": data.get("repo")}
+
     plist = projects_mod.load_projects(docs_dir)
     for p in plist:
         model = status_mod.build_status(docs_dir, project=p["id"])
+        if p["id"] in execution:
+            model["execution"] = execution[p["id"]]
         (out / f"{p['id']}.html").write_text(status_mod.render_html(model))
         (out / "badges" / f"{p['id']}.json").write_text(
             status_mod.render_badge_json(model["rag"], label=p["code"].lower()))
@@ -398,6 +408,7 @@ def main(argv: list[str] | None = None) -> int:
 
     pg = sub.add_parser("pages", help="Build the full Pages site (portfolio index + a page per project).")
     pg.add_argument("--out", default="_site", help="Output directory (default: _site).")
+    pg.add_argument("--execution", help="Optional bridge-status JSON; adds Delivery and Scope panels to project pages.")
     docs_dir_opt(pg)
     pg.set_defaults(func=cmd_pages)
 

{docassert-0.9.0 → docassert-0.10.1}/docassert/status/render.py

@@ -205,6 +205,40 @@ def render_html(model) -> str:
                         f'{note}<table><thead><tr><th>Kind</th><th>State</th></tr></thead>'
                         f'<tbody>{req_rows}{sep}{rec_rows}</tbody></table></section>')
 
+    execution_html = ""
+    ex = model.get("execution")
+    if ex:
+        feat_rows: list[str] = []
+        for f in ex.get("features", []):
+            total = f.get("stories_total", 0) or 0
+            done = f.get("stories_closed", 0) or 0
+            pct = (100 * done // total) if total else 0
+            mark = "✓" if f.get("closed") else ""
+            issue = f' · <a href="https://github.com/{esc(ex.get("repo", ""))}/issues/{f["issue"]}">#{f["issue"]}</a>' if f.get("issue") else ""
+            feat_rows.append(
+                f'<div class="sig"><div class="sig-h"><span>{esc(f["id"])} {mark}</span>'
+                f'<span>{done}/{total} stories{issue}</span></div>'
+                f'<div class="bar"><div class="bar-f" style="width:{pct}%;background:var(--ok)"></div></div></div>')
+        overall_t = ex.get("stories_total", 0) or 0
+        overall_d = ex.get("stories_closed", 0) or 0
+        execution_html = (
+            f'<section><h2>Delivery · {overall_d}/{overall_t} stories closed</h2>'
+            '<p style="color:var(--muted);font-size:13px;margin:0 0 10px">'
+            "Read from the bridge-managed issues. Scope lives in these documents; "
+            "delivery lives on the board.</p>" + "".join(feat_rows) + "</section>")
+        scope = ex.get("scope") or {}
+        bad = scope.get("unverified", []) + scope.get("orphaned", [])
+        if bad:
+            items = "".join(
+                f'<li><a href="https://github.com/{esc(ex.get("repo", ""))}/issues/{i["number"]}">#{i["number"]}</a> {esc(i["title"])}</li>'
+                for i in bad)
+            execution_html += (
+                f'<section><h2 style="color:var(--bad)">Scope · {len(bad)} unmatched item(s)</h2>'
+                f'<ul>{items}</ul></section>')
+        else:
+            execution_html += ('<section><h2>Scope</h2><p style="color:var(--ok)">'
+                               "Every open issue matches an approved item in the documents.</p></section>")
+
     title = esc(model.get("title", "Project Status"))
     pid = model.get("project")
     back = '<a class="back" href="index.html">← all projects</a>' if pid else ""
@@ -226,6 +260,7 @@ def render_html(model) -> str:
     {c['approved']} approved{scope} · generated {gen}. Do not edit — regenerated from the documents.</p>
   <section><h2>Traceability coverage</h2>{coverage}</section>
   {document_set}
+  {execution_html}
   {problems}
   <section><h2>Open risks ({len(model['risks'])})</h2><ul>{risks}</ul></section>
   <section><h2>Latest status report</h2><p>{report}</p></section>

{docassert-0.9.0 → docassert-0.10.1/docassert.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassert
-Version: 0.9.0
+Version: 0.10.1
 Summary: Unit testing for business documents — validate structured Markdown docs against a configurable audit standard.
 Author: C4G Enterprises Inc.
 License: Apache-2.0

{docassert-0.9.0 → docassert-0.10.1}/tests/test_badge.py

@@ -24,3 +24,25 @@ def test_pages_emits_badges(tmp_path, monkeypatch):
     assert overall["schemaVersion"] == 1 and overall["message"] in {"green", "amber", "red"}
     aur = json.loads((out / "badges" / "PRJ-001-AUR.json").read_text())
     assert aur["label"] == "aur" and aur["message"] in {"green", "amber", "red"}
+
+
+def test_pages_execution_panels(tmp_path, monkeypatch):
+    import json
+    monkeypatch.chdir(ROOT)
+    exec_file = tmp_path / "execution.json"
+    exec_file.write_text(json.dumps({
+        "repo": "o/r",
+        "projects": [{"id": "PRJ-001-AUR",
+                      "features": [{"id": "AUR-PR-014", "issue": 5,
+                                    "stories_total": 2, "stories_closed": 1,
+                                    "closed": False}],
+                      "stories_closed": 1, "stories_total": 2}],
+        "scope": {"unverified": [], "orphaned": []},
+    }))
+    out = tmp_path / "site"
+    assert main(["pages", "--out", str(out), "--execution", str(exec_file)]) == 0
+    html = (out / "PRJ-001-AUR.html").read_text()
+    assert "Delivery · 1/2 stories closed" in html
+    assert "AUR-PR-014" in html and "Every open issue matches" in html
+    other = (out / "PRJ-002-ATL.html").read_text()
+    assert "Delivery ·" not in other   # no execution data, no panel

{docassert-0.9.0 → docassert-0.10.1}/tests/test_bridge.py

@@ -113,6 +113,20 @@ def test_bodies_carry_marker_and_authority_note(tmp_path):
     assert f"<!-- docassert-bridge: {s.id} -->" in story_body(s, None)
 
 
+def test_doc_paths_relative_to_docs_repo_root(tmp_path):
+    """CI checks the docs repo out into a subdirectory; Source links must not
+    carry that checkout prefix (they resolve against the docs repo root)."""
+    docs = _tree(tmp_path / "pmo")
+    plan = build_bridge_plan(docs)
+    f = plan.features[0]
+    assert f.doc_path == "documents/PRJ-001-TST/prd.md"
+    assert f.stories[0].doc_path == "documents/PRJ-001-TST/user-story.md"
+    body = feature_body(f, "https://github.com/o/r/blob/main")
+    assert ("**Source:** https://github.com/o/r/blob/main/"
+            "documents/PRJ-001-TST/prd.md") in body
+    assert "/pmo/" not in body
+
+
 # ── ops against a fake runner ────────────────────────────────────────────────
 class FakeGh:
     """Records mutations; serves canned issue lists."""
@@ -320,3 +334,18 @@ def test_scaffold_syncs_board(tmp_path):
     assert any("5 item(s) synced" in a for a in actions)
     adds = [q for q in bgh.gql if "addProjectV2ItemById" in q]
     assert len(adds) == 5
+
+
+def test_status_includes_scope_classification(tmp_path):
+    plan = build_bridge_plan(_tree(tmp_path))
+    issues = [
+        _mk_issue(1, "TST-US-001"),
+        {"number": 2, "node_id": "N2", "state": "open", "title": "rogue",
+         "body": "no marker", "labels": []},
+        _mk_issue(3, "TST-US-999"),
+        _mk_issue(4, "TST-US-002", state="closed"),   # closed: not scope-checked
+    ]
+    data = ops.status(plan, FakeGh(issues), "o/r")
+    assert data["repo"] == "o/r"
+    assert [i["number"] for i in data["scope"]["unverified"]] == [2]
+    assert [i["doc"] for i in data["scope"]["orphaned"]] == ["TST-US-999"]