reqtable 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
reqtable/markdown.py ADDED
@@ -0,0 +1,127 @@
1
+ from __future__ import annotations
2
+
3
+ import html
4
+ import re
5
+
6
+
7
+ _SAFE_LINK = re.compile(r"^(?:https?://|mailto:)", re.IGNORECASE)
8
+
9
+
10
+ def _inline(text: str) -> str:
11
+ escaped = html.escape(text, quote=True)
12
+ code_values: list[str] = []
13
+
14
+ def save_code(match: re.Match[str]) -> str:
15
+ code_values.append(f"<code>{match.group(1)}</code>")
16
+ return f"\x00CODE{len(code_values) - 1}\x00"
17
+
18
+ escaped = re.sub(r"`([^`\n]+)`", save_code, escaped)
19
+
20
+ def link(match: re.Match[str]) -> str:
21
+ label, target = match.group(1), html.unescape(match.group(2)).strip()
22
+ if _SAFE_LINK.match(target):
23
+ return f'<a href="{html.escape(target, quote=True)}">{label}</a>'
24
+ return f"{label} ({html.escape(target)})"
25
+
26
+ escaped = re.sub(r"\[([^\]\n]+)\]\(([^)\n]+)\)", link, escaped)
27
+ escaped = re.sub(r"\*\*([^*\n]+)\*\*", r"<strong>\1</strong>", escaped)
28
+ escaped = re.sub(r"__([^_\n]+)__", r"<strong>\1</strong>", escaped)
29
+ escaped = re.sub(r"(?<!\*)\*([^*\n]+)\*(?!\*)", r"<em>\1</em>", escaped)
30
+ escaped = re.sub(r"(?<!_)_([^_\n]+)_(?!_)", r"<em>\1</em>", escaped)
31
+ for index, value in enumerate(code_values):
32
+ escaped = escaped.replace(f"\x00CODE{index}\x00", value)
33
+ return escaped
34
+
35
+
36
+ def render_markdown(source: str) -> str:
37
+ """Render the deliberately small, safe Markdown subset used by reports."""
38
+ if source == "":
39
+ return '<span class="empty-value">Empty</span>'
40
+ lines = source.split("\n")
41
+ output: list[str] = []
42
+ paragraph: list[str] = []
43
+ list_type: str | None = None
44
+ quote_lines: list[str] = []
45
+ code_lines: list[str] | None = None
46
+
47
+ def flush_paragraph() -> None:
48
+ if paragraph:
49
+ output.append(
50
+ "<p>" + "<br>".join(_inline(line) for line in paragraph) + "</p>"
51
+ )
52
+ paragraph.clear()
53
+
54
+ def close_list() -> None:
55
+ nonlocal list_type
56
+ if list_type:
57
+ output.append(f"</{list_type}>")
58
+ list_type = None
59
+
60
+ def flush_quote() -> None:
61
+ if quote_lines:
62
+ output.append(
63
+ "<blockquote>"
64
+ + "<br>".join(_inline(line) for line in quote_lines)
65
+ + "</blockquote>"
66
+ )
67
+ quote_lines.clear()
68
+
69
+ for line in lines:
70
+ if code_lines is not None:
71
+ if line.startswith("```"):
72
+ output.append(
73
+ "<pre><code>" + html.escape("\n".join(code_lines)) + "</code></pre>"
74
+ )
75
+ code_lines = None
76
+ else:
77
+ code_lines.append(line)
78
+ continue
79
+ if line.startswith("```"):
80
+ flush_paragraph()
81
+ close_list()
82
+ flush_quote()
83
+ code_lines = []
84
+ continue
85
+ heading = re.match(r"^(#{1,6})\s+(.+)$", line)
86
+ if heading:
87
+ flush_paragraph()
88
+ close_list()
89
+ flush_quote()
90
+ level = min(6, len(heading.group(1)) + 2)
91
+ output.append(f"<h{level}>{_inline(heading.group(2))}</h{level}>")
92
+ continue
93
+ item = re.match(r"^\s*([-+*])\s+(.+)$", line)
94
+ ordered = re.match(r"^\s*\d+[.)]\s+(.+)$", line)
95
+ if item or ordered:
96
+ flush_paragraph()
97
+ flush_quote()
98
+ desired = "ul" if item else "ol"
99
+ if list_type != desired:
100
+ close_list()
101
+ output.append(f"<{desired}>")
102
+ list_type = desired
103
+ output.append(
104
+ f"<li>{_inline((item or ordered).group(2 if item else 1))}</li>"
105
+ )
106
+ continue
107
+ if line.startswith(">"):
108
+ flush_paragraph()
109
+ close_list()
110
+ quote_lines.append(line[1:].lstrip())
111
+ continue
112
+ if line.strip() == "":
113
+ flush_paragraph()
114
+ close_list()
115
+ flush_quote()
116
+ else:
117
+ close_list()
118
+ flush_quote()
119
+ paragraph.append(line)
120
+ if code_lines is not None:
121
+ output.append(
122
+ "<pre><code>" + html.escape("\n".join(code_lines)) + "</code></pre>"
123
+ )
124
+ flush_paragraph()
125
+ close_list()
126
+ flush_quote()
127
+ return "".join(output)
reqtable/package.py ADDED
@@ -0,0 +1,163 @@
1
+ """Gate package cover, sign-off table and decision recording for Review-mode reports."""
2
+
3
+ PACKAGE_HTML = '<section id="package-cover" class="package-cover" aria-labelledby="package-title" hidden></section>\n<div id="package-footer" class="package-footer" aria-hidden="true"></div>'
4
+
5
+ PACKAGE_CSS = r"""
6
+ .package-cover{margin:0 0 10px;padding:12px 14px;border:1px solid var(--line);border-radius:7px;background:var(--panel)}
7
+ .package-cover[hidden]{display:none}
8
+ .package-cover h2{margin:0 0 8px;font-size:1.25rem}
9
+ .package-cover h3{margin:14px 0 6px;font-size:1rem}
10
+ .package-facts{display:grid;grid-template-columns:max-content 1fr;gap:3px 14px;margin:0}
11
+ .package-facts dt{color:var(--muted)}
12
+ .package-facts dd{margin:0;overflow-wrap:anywhere}
13
+ .package-hash{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;user-select:all}
14
+ .package-warning{margin:8px 0 0;padding:6px 9px;border-radius:5px;background:var(--remove)}
15
+ .package-warning[hidden]{display:none}
16
+ .package-approval{display:flex;align-items:center;gap:8px;margin:14px 0 6px}
17
+ .package-approval h3{margin:0}
18
+ .badge.approved{background:var(--add)}
19
+ .badge.not-approved{background:var(--remove)}
20
+ .signoff-table{width:100%;min-width:0;table-layout:auto;border:1px solid var(--line);border-bottom:0}
21
+ .signoff-table th,.signoff-table td{font-size:.92rem;border-left:0}
22
+ .signoff-table th:nth-child(-n+2),.signoff-table td:nth-child(-n+2){white-space:nowrap;overflow-wrap:normal;width:1%}
23
+ .waiver-table th:nth-child(2),.waiver-table td:nth-child(2){white-space:normal;overflow-wrap:anywhere;width:auto}
24
+ .signoff-table thead th{position:static;height:auto}
25
+ .signoff-table ul{margin:0;padding:0;list-style:none}
26
+ .signoff-table li+li{margin-top:4px}
27
+ .signoff-none{color:var(--muted)}
28
+ .signoff-excluded{color:var(--muted);font-style:italic}
29
+ .decision-remove{margin-inline-start:6px;padding:0 6px;font-size:.8rem}
30
+ .decision-form{display:flex;flex-wrap:wrap;gap:8px 10px;align-items:flex-end;margin-top:6px}
31
+ .decision-form label{display:flex;flex-direction:column;gap:2px;font-size:.88rem;color:var(--muted)}
32
+ .decision-form input,.decision-form select{min-width:9rem}
33
+ .decision-form .decision-note{min-width:16rem;flex:1}
34
+ .package-footer{display:none}
35
+ @media print{
36
+ .package-cover{border:0;padding:0;background:none;break-after:page;page-break-after:always}
37
+ .decision-form,.decision-remove{display:none!important}
38
+ body:has(#package-cover:not([hidden])),body:has(#package-cover:not([hidden])) .page{background:#fff}
39
+ body:has(#package-cover:not([hidden])) #filter-row,body:has(#package-cover:not([hidden])) .comment-button:not(.has-comments){display:none}
40
+ body:has(#package-cover:not([hidden])) .selected-cell{background:none!important;box-shadow:none}
41
+ body:has(#package-cover:not([hidden])) .status-cell .badge.unchanged{visibility:hidden}
42
+ .badge.approved,.badge.not-approved{border-color:#000;background:none;color:#000}
43
+ .package-warning{border:1px solid #000;background:none}
44
+ .signoff-table{border-color:#000}
45
+ .signoff-table th,.signoff-table td{border-color:#000}
46
+ .signoff-table tr{break-inside:avoid}
47
+ .package-cover,.package-cover .package-facts dt,.signoff-none,.signoff-excluded{color:#000}
48
+ }
49
+ """
50
+
51
+ PACKAGE_MODEL_JS = r"""
52
+ const VERIFICATION_LABELS={good:"Signature good",signaturegood:"Signature good",unsigned:"Unsigned",bad:"Bad signature",badsignature:"Bad signature",unverifiable:"Cannot verify",cannotverify:"Cannot verify"};
53
+ function verificationLabel(verification){return VERIFICATION_LABELS[String(verification??"").toLowerCase().replace(/[\s_-]+/g,"")]??"Recorded";}
54
+ function signoffTable(pkg,decisions){
55
+ const roles=pkg.roles.map(({role,min})=>({role,min}));
56
+ for(const {role} of [...pkg.signoffs,...decisions])if(!roles.some(r=>r.role===role))roles.push({role,min:null});
57
+ return roles.map(({role,min})=>({role,min,
58
+ signoffs:pkg.signoffs.filter(s=>s.role===role).map(s=>({user:s.user,decision:s.decision,date:s.date,note:s.note??"",
59
+ verification:verificationLabel(s.verification),counts:s.counts!==false})),
60
+ pending:decisions.filter(d=>d.role===role)}));
61
+ }
62
+ function waiverRows(waivers){
63
+ return (waivers??[]).map(w=>({check:w.check,description:w.description??"",reason:w.reason,user:w.user,date:w.date,records:(w.failing??[]).length}));
64
+ }
65
+ function isoWithOffset(d){
66
+ const off=-d.getTimezoneOffset(),pad=n=>String(Math.abs(n)).padStart(2,"0");
67
+ return `${d.getFullYear()}-${pad(d.getMonth()+1)}-${pad(d.getDate())}T${pad(d.getHours())}:${pad(d.getMinutes())}:${pad(d.getSeconds())}${off>=0?"+":"-"}${pad(Math.trunc(Math.abs(off)/60))}:${pad(Math.abs(off)%60)}`;
68
+ }
69
+ function createDecision({role,user,decision,note},now){
70
+ const record={role:String(role??"").trim(),user:String(user??"").trim(),decision:String(decision??"").trim(),date:isoWithOffset(now),note:String(note??"").trim()};
71
+ const missing=["user","role","decision"].find(field=>!record[field]);
72
+ return missing?{error:`Enter a ${missing}.`}:{record};
73
+ }
74
+ const sameDecision=(a,b)=>a.role===b.role&&a.user===b.user&&a.date===b.date;
75
+ function removeDecision(decisions,record){return decisions.filter(d=>!sameDecision(d,record));}
76
+ function packageFooterText(pkg){return `${pkg.baseline.name} · ${pkg.baseline.hash}`;}
77
+ """
78
+
79
+ PACKAGE_JS = (
80
+ PACKAGE_MODEL_JS
81
+ + r"""
82
+ const packageCover=data.package?$("#package-cover"):null;
83
+ function packageFacts(pkg){
84
+ const {baseline,gate}=pkg,scope=baseline.system?`System ${baseline.system}`:"Whole table";
85
+ return [["Baseline",baseline.name],["Produces",gate.produces],["Scope",scope],
86
+ ["Created",`${baseline.created}${baseline.createdBy?` by ${baseline.createdBy}`:""}`],
87
+ ["Content hash",`<span class="package-hash">${escapeHtml(baseline.hash)}</span>`,true],
88
+ ["Compared with",pkg.previous??"No earlier baseline"]]
89
+ .map(([term,value,raw])=>`<dt>${term}</dt><dd>${raw?value:escapeHtml(value??"")}</dd>`).join("");
90
+ }
91
+ function packageWaivers(pkg){
92
+ const rows=waiverRows(pkg.waivers);
93
+ if(!rows.length)return "";
94
+ const body=rows.map(w=>`<tr><th scope="row">${escapeHtml(w.check)}</th><td>${escapeHtml(w.description)}</td><td>${escapeHtml(w.reason)}</td><td>${escapeHtml(w.user)}</td><td>${escapeHtml(displayTimestamp(w.date))}</td><td>${w.records}</td></tr>`).join("");
95
+ return `<h3>Waivers</h3>
96
+ <table class="signoff-table waiver-table" id="package-waiver-table"><thead><tr><th scope="col">Check</th><th scope="col">Description</th><th scope="col">Reason</th><th scope="col">Waived by</th><th scope="col">Date</th><th scope="col">Records</th></tr></thead><tbody>${body}</tbody></table>`;
97
+ }
98
+ function signoffItem(s){
99
+ return `<li class="signoff${s.counts?"":" signoff-excluded"}">${escapeHtml(s.user)}: ${escapeHtml(s.decision)}, ${escapeHtml(s.date)}, ${escapeHtml(s.verification)}${s.counts?"":" (does not count)"}${s.note?` <span class="meta">${escapeHtml(s.note)}</span>`:""}</li>`;
100
+ }
101
+ function pendingItem(d){
102
+ const index=state.decisions.findIndex(x=>sameDecision(x,d));
103
+ return `<li class="decision-recorded">${escapeHtml(d.user)}: ${escapeHtml(d.decision)}, ${escapeHtml(displayTimestamp(d.date))}${d.note?` <span class="meta">${escapeHtml(d.note)}</span>`:""}<button type="button" class="decision-remove" data-remove-decision="${index}" aria-label="Remove ${escapeHtml(d.decision)} by ${escapeHtml(d.user)} as ${escapeHtml(d.role)}">Remove</button></li>`;
104
+ }
105
+ function renderPackage(){
106
+ if(!packageCover)return;
107
+ const list=(items,render)=>items.length?`<ul>${items.map(render).join("")}</ul>`:'<span class="signoff-none">None</span>',
108
+ approved=data.package.approval.approved;
109
+ $("#package-approval").innerHTML=`<h3>Sign-offs</h3><span class="badge ${approved?"approved":"not-approved"}">${approved?"Approved":"Not approved"}</span>`;
110
+ $("#package-signoffs").innerHTML=signoffTable(data.package,state.decisions).map(r=>`<tr data-role="${escapeHtml(r.role)}"><th scope="row">${escapeHtml(r.role)}</th><td>${r.min??""}</td><td>${list(r.signoffs,signoffItem)}</td><td>${list(r.pending,pendingItem)}</td></tr>`).join("");
111
+ }
112
+ function buildPackageCover(){
113
+ if(!packageCover)return;
114
+ const pkg=data.package;
115
+ packageCover.innerHTML=`<h2 id="package-title">${escapeHtml(pkg.gate.name)} (${escapeHtml(pkg.gate.id)}) gate package</h2>
116
+ <dl class="package-facts" id="package-facts">${packageFacts(pkg)}</dl>
117
+ <p id="package-hash-warning" class="package-warning" role="alert" ${pkg.baseline.hashOk?"hidden":""}>The baseline content does not match its recorded hash.</p>
118
+ ${packageWaivers(pkg)}
119
+ <div id="package-approval" class="package-approval"></div>
120
+ <table class="signoff-table" id="package-signoff-table"><thead><tr><th scope="col">Role</th><th scope="col">Required</th><th scope="col">Recorded sign-offs</th><th scope="col">Recorded in this package, not yet imported</th></tr></thead><tbody id="package-signoffs"></tbody></table>
121
+ <form id="package-decision-form" class="decision-form" aria-label="Record decision">
122
+ <label>Name<input id="package-decision-user" maxlength="80" autocomplete="off" value="${escapeHtml(reviewerInitials())}"></label>
123
+ <label>Role<select id="package-decision-role">${pkg.roles.map(r=>`<option>${escapeHtml(r.role)}</option>`).join("")}</select></label>
124
+ <label>Decision<select id="package-decision-decision">${pkg.decisionOptions.map(o=>`<option>${escapeHtml(o)}</option>`).join("")}</select></label>
125
+ <label class="decision-note">Note (optional)<input id="package-decision-note" maxlength="500" autocomplete="off"></label>
126
+ <button type="submit" id="package-decision-submit" class="primary">Record decision</button>
127
+ <span id="package-decision-status" class="meta" role="status"></span></form>`;
128
+ packageCover.hidden=false;
129
+ $("#package-footer").textContent=packageFooterText(pkg);
130
+ const pageFooter=document.getElementById("package-page-footer")??document.head.appendChild(Object.assign(document.createElement("style"),{id:"package-page-footer"}));
131
+ pageFooter.textContent=`@media print{@page{size:landscape;margin:12mm 12mm 20mm;@bottom-center{content:${JSON.stringify(packageFooterText(pkg))};font:8pt ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;color:#000}}}`;
132
+ renderPackage();
133
+ $("#package-decision-user").addEventListener("focus",e=>{if(!e.target.value)e.target.value=reviewerInitials();});
134
+ $("#package-decision-form").addEventListener("submit",e=>{
135
+ e.preventDefault();
136
+ const field=id=>$("#package-decision-"+id),result=createDecision({role:field("role").value,user:field("user").value,decision:field("decision").value,note:field("note").value},new Date());
137
+ if(result.error){field("status").textContent=result.error;return;}
138
+ state.decisions.push(result.record);
139
+ field("note").value="";
140
+ field("status").textContent=`Recorded ${result.record.decision} for ${result.record.role}. Save a report copy to keep it.`;
141
+ updateDirty();
142
+ renderPackage();
143
+ });
144
+ packageCover.addEventListener("click",e=>{
145
+ const button=e.target.closest("[data-remove-decision]");
146
+ if(!button)return;
147
+ const record=state.decisions[Number(button.dataset.removeDecision)];
148
+ if(!record)return;
149
+ state.decisions=removeDecision(state.decisions,record);
150
+ $("#package-decision-status").textContent=`Removed ${record.decision} for ${record.role}.`;
151
+ updateDirty();
152
+ renderPackage();
153
+ });
154
+ }
155
+ function packageClearCopy(clone){
156
+ clone.querySelector("#package-cover")?.replaceChildren();
157
+ clone.querySelector("#package-cover")?.setAttribute("hidden","");
158
+ clone.querySelector("#package-footer")?.replaceChildren();
159
+ clone.querySelector("#package-page-footer")?.remove();
160
+ }
161
+ buildPackageCover();
162
+ """
163
+ )