aw-spec-cli 0.1.13 → 0.1.15
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.
- package/assets/.appweaver/STACK-PROFILES.md +1 -1
- package/assets/.appweaver/orchestrator/orchestrator.py +5 -0
- package/assets/.appweaver/orchestrator/rev-templates/domain-rule-bindings.skeleton.md +10 -3
- package/assets/.appweaver/orchestrator/rev-templates/tech-rule-bindings.skeleton.md +38 -11
- package/assets/.appweaver/orchestrator/workflows/aw-spec-adopt.orch.yaml +2 -1
- package/assets/.appweaver/orchestrator/workflows/aw-spec-analyze-design.orch.yaml +607 -123
- package/assets/.appweaver/orchestrator/workflows/aw-spec-analyze-slice.orch.yaml +625 -66
- package/assets/.appweaver/orchestrator/workflows/aw-spec-implement-ui.orch.yaml +407 -134
- package/assets/.appweaver/orchestrator/workflows/aw-spec-implement.orch.yaml +452 -143
- package/assets/.appweaver/orchestrator/workflows/aw-spec-onboard.orch.yaml +78 -14
- package/assets/.appweaver/orchestrator/workflows/aw-spec-plan-ui.orch.yaml +597 -0
- package/assets/.appweaver/orchestrator/workflows/aw-spec-plan.orch.yaml +688 -0
- package/assets/.appweaver/orchestrator/workflows/aw-spec-select-feature.orch.yaml +3 -3
- package/assets/.appweaver/orchestrator/workflows/aw-spec-specify.orch.yaml +23 -23
- package/assets/.appweaver/orchestrator/workflows/aw-spec-story-plan.orch.yaml +945 -0
- package/assets/.appweaver/orchestrator/workflows/aw-spec-sync-stories.orch.yaml +1040 -0
- package/assets/.appweaver/scripts/bash/aw-spec-actions.sh +2069 -28
- package/assets/.appweaver/scripts/bash/aw-xref.sh +2 -1
- package/assets/.appweaver/scripts/powershell/aw-spec-actions.ps1 +1973 -13
- package/assets/.appweaver/scripts/powershell/aw-xref.ps1 +2 -1
- package/assets/.appweaver/scripts/python/aw-xref.py +246 -20
- package/assets/.appweaver/templates/design-template.md +88 -54
- package/assets/.appweaver/templates/spec-template.md +12 -10
- package/assets/.appweaver/templates/story-template.md +48 -8
- package/assets/.appweaver/templates/ui-design-template.md +71 -39
- package/assets/guardrails/projects/dotnet-default-project/domain-rule-bindings.md +19 -7
- package/assets/guardrails/projects/dotnet-default-project/tech-rule-bindings.md +35 -26
- package/package.json +1 -1
- package/assets/.appweaver/orchestrator/workflows/aw-spec-design-ui.orch.yaml +0 -386
- package/assets/.appweaver/orchestrator/workflows/aw-spec-design.orch.yaml +0 -382
|
@@ -49,15 +49,45 @@
|
|
|
49
49
|
# -> {feature, version, active_change, created, bootstrap_pending}
|
|
50
50
|
# (create active_version.json v1.0; --bootstrap marks a first draft in progress)
|
|
51
51
|
# spec-check [--feature-dir <path>] -> {ok, state, version, doc_version, body_changed, spec_sha256, error}
|
|
52
|
-
# (the ledger tripwire: clean | unstamped | ledgered_edit |
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
52
|
+
# (the ledger tripwire: clean | unstamped | ledgered_edit | header_behind |
|
|
53
|
+
# unrowed_edit | unledgered_edit | rollback | no_ledger | delta_open.
|
|
54
|
+
# A recorded edit is one with a version ROW above the recorded version — the
|
|
55
|
+
# **Version** header is a claim, not evidence. ok:false on an edit that skipped
|
|
56
|
+
# the Change History row, which is the ledger's only silent case)
|
|
57
|
+
# spec-stamp [--feature-dir <path>] -> {ok, state, version, spec_sha256, header_rewritten}
|
|
58
|
+
# (record spec.md's hash as the new baseline; used after a bootstrap authors it.
|
|
59
|
+
# The version recorded is the highest of the recorded one, the document header
|
|
60
|
+
# and the newest ledger row, and a header behind that is rewritten up to it)
|
|
56
61
|
# ledger-append [--feature-dir <path>] --ids <ids> [--summary <text>]
|
|
57
62
|
# -> {ok, version, previous, row, spec_sha256}
|
|
58
63
|
# (bump, append the Change History row, stamp the **Version** header and
|
|
59
64
|
# re-hash — ONE call, so a row can never exist without its hash)
|
|
60
65
|
# story-refs [--feature-dir <path>] [--ids <FR-001, BR-002>]
|
|
66
|
+
# slice-mode [--input <text>] -> {strategy, guidance, single, note}
|
|
67
|
+
# (the strategy word off the front of the launch line, and the guidance
|
|
68
|
+
# left behind it — `single-run` asks for one story over the work set)
|
|
69
|
+
# backlog-plan --groups <json> --work <csv> [--strategy single|auto] [--ceiling <n>]
|
|
70
|
+
# [--plan --approved <ids> --version <v>]
|
|
71
|
+
# story-stamp --story <id> [--ids <csv>] [--version <v>] [--follows <id>]
|
|
72
|
+
# [--depends-on <csv>] [--wave <n>]
|
|
73
|
+
# ledger-read [--feature-dir <path>] -> {rows, work_csv, work_source, gap, ...}
|
|
74
|
+
# story-plan-check [--story <id>] [--input <text>] [--feature-dir <p>]
|
|
75
|
+
# -> {resolved, needs_pick, open_ids, story, story_open, status_msg,
|
|
76
|
+
# exercises_csv, constraints_csv, stale_csv, stale_note,
|
|
77
|
+
# be_doc_path/fe_doc_path, be_doc_exists/fe_doc_exists,
|
|
78
|
+
# be_next_pass/fe_next_pass, be_last_pass/fe_last_pass,
|
|
79
|
+
# be_pass_tmp/fe_pass_tmp,
|
|
80
|
+
# be_doc_spec_version/fe_doc_spec_version, be_doc_stale/fe_doc_stale,
|
|
81
|
+
# legacy_doc, legacy_doc_exists, if_tmp, adr_path, if_path}
|
|
82
|
+
# (resolve WHICH story a story-plan run works on + everything its gates read)
|
|
83
|
+
# story-plan-doc --story <id> --pass-file <p> [--lane backend|frontend] [--spec-version <v>]
|
|
84
|
+
# -> {ok, doc, lane, pass, created}
|
|
85
|
+
# (the only writer of stories/<ID>/story-<lane>-plan.md: scaffold on first use, append
|
|
86
|
+
# the pass under a script-written '## Design pass N' header, stamp frontmatter)
|
|
87
|
+
# log-append --log adr|interfaces --entries-file <p> [--status <s>]
|
|
88
|
+
# -> {ok, appended, ids_csv, unknown_ids_csv, bad_supersedes_csv}
|
|
89
|
+
# (append-only feature logs; the script assigns ADR-nnn/IF-nnn ids, dates and
|
|
90
|
+
# status — entries arrive as '## IF-NEW — <title>' blocks, 'none' is a no-op)
|
|
61
91
|
# -> {covered_csv, affected[], affected_csv, story_csv,
|
|
62
92
|
# in_flight_csv, any, any_in_flight, story_count}
|
|
63
93
|
# (which requirements have OPEN stories against them; no --ids = all of them.
|
|
@@ -65,10 +95,27 @@
|
|
|
65
95
|
# spec-coverage [--feature-dir <path>] -> {written, requirements, stories, uncovered_csv, delivered_csv}
|
|
66
96
|
# (regenerate the spec's AW:COVERAGE block — every FR-/BR- and the stories
|
|
67
97
|
# delivering it. Fenced out of the hash and the diff, so writing it is not
|
|
68
|
-
# a spec edit. Called by specify, user-story and
|
|
98
|
+
# a spec edit. Called by specify, user-story and sync-stories alike)
|
|
69
99
|
# spec-preserve --disturbing <csv> --approved <csv> -> {preserve_csv, preserve_count, approved_csv}
|
|
70
100
|
# (the complement: which disturbed requirements were NOT approved for change)
|
|
71
|
-
# feature-paths -> {feature, feature_dir, spec_file, design_file, spec_exists, design_exists
|
|
101
|
+
# feature-paths -> {feature, feature_dir, spec_file, design_file, spec_exists, design_exists,
|
|
102
|
+
# backend_plan_file, frontend_plan_file, backend_plan_exists, frontend_plan_exists}
|
|
103
|
+
# plan-check --doc <path> [--feature-dir <p>] -> {state, derived_version, current_version, changed_csv, changed_summary, body_changed}
|
|
104
|
+
# (the plan doc's derivation record vs the spec ledger: fresh | untracked |
|
|
105
|
+
# clean | behind | edited | edited_behind; behind's changed_csv is the update's work list)
|
|
106
|
+
# plan-stamp --doc <path> [--feature-dir <p>] [--ids <csv>] [--note <text>] [--no-row]
|
|
107
|
+
# -> {ok, version, row, warnings[]}
|
|
108
|
+
# (the ONLY writer of a plan doc's version identity: **Version** header := the
|
|
109
|
+
# spec version derived from, a Change History row unless --no-row, and the body
|
|
110
|
+
# hash into the doc's own .aw-plan-track.<doc>.json — refuses, writing no baseline, when the doc has
|
|
111
|
+
# no Change History section left)
|
|
112
|
+
# gate-result --gate <name> --ok <true|false> [--feature-dir <p>] [--spec-version <v>]
|
|
113
|
+
# [--story <id>] [--report <path>] [--out <path>] [--gap-count <n>]
|
|
114
|
+
# [--gap-refs <csv>] [--note <text>] [--field k=v]...
|
|
115
|
+
# -> {ok, result_file, status, gap_count}
|
|
116
|
+
# (the machine-readable verdict every analyze gate writes beside its markdown
|
|
117
|
+
# report, so CI branches on a value instead of prose. `ok` means the file was
|
|
118
|
+
# WRITTEN; the verdict is `status`. Fixed core keys + gate-specific --field)
|
|
72
119
|
# checklist-read --file <path> -> {exists, total, checked, items[]}
|
|
73
120
|
# checklist-apply --file <path> --results <json>-> {exists, before_checked, after_checked, total, newly_passing[], regressions[]}
|
|
74
121
|
# detect-project -> {scaffolded, markers[]}
|
|
@@ -184,7 +231,8 @@ cmd_resolve_domain() {
|
|
|
184
231
|
# stack_mismatch when it is not a stack this repo declares, because a map pinned to the
|
|
185
232
|
# wrong corpus is how a Java project ends up being handed C# rules.
|
|
186
233
|
cmd_resolve_tech() {
|
|
187
|
-
local command_name="aw-spec-
|
|
234
|
+
local command_name="aw-spec-plan" # inert: every caller passes --command. Kept current
|
|
235
|
+
# so a hand-run defaults to a LIVE command, not a dead one.
|
|
188
236
|
while [ $# -gt 0 ]; do
|
|
189
237
|
case "$1" in
|
|
190
238
|
--command) command_name="$2"; shift 2 ;;
|
|
@@ -1087,7 +1135,7 @@ _version_cmd() { # $1 = op (read|init), then --feature-dir arg
|
|
|
1087
1135
|
# spec.md's `## Change History` is the sync anchor between the spec and its story
|
|
1088
1136
|
# backlog: each row names the requirement ids that version touched, and each story
|
|
1089
1137
|
# records the version it last synced at, so "is this story stale" is one integer
|
|
1090
|
-
# comparison rather than a diff.
|
|
1138
|
+
# comparison rather than a diff. sync-stories reads the rows; specify and
|
|
1091
1139
|
# update-spec append them.
|
|
1092
1140
|
#
|
|
1093
1141
|
# The ledger is hand-writable, which is the point — a spec can be edited by hand —
|
|
@@ -1165,6 +1213,14 @@ sep = (next((i for i in range(hi + 1, sec_end)
|
|
|
1165
1213
|
if re.match(r'^\|[\s\-:|]+\|$', lines[i].strip())), -1) if hi >= 0 else -1)
|
|
1166
1214
|
rows = [i for i in range(sep + 1, sec_end) if lines[i].lstrip().startswith("|")] if sep >= 0 else []
|
|
1167
1215
|
has_ledger = hi >= 0 and sep >= 0
|
|
1216
|
+
# THE VERSIONS THE TABLE ACTUALLY CARRIES, read from the rows located above rather than by
|
|
1217
|
+
# an unbounded scan, so a version-looking cell in another section's table cannot be counted
|
|
1218
|
+
# as history. This is the EVIDENCE that a change was recorded; the document's **Version**
|
|
1219
|
+
# header is only the CLAIM, and hand editing parts the two in both directions.
|
|
1220
|
+
row_versions = [m.group(1) for m in
|
|
1221
|
+
(re.match(r'^\|\s*(v\d+(?:\.\d+)?)\s*\|', lines[i].lstrip()) for i in rows)
|
|
1222
|
+
if m]
|
|
1223
|
+
newest_row = max(row_versions, key=vtuple) if row_versions else ""
|
|
1168
1224
|
|
|
1169
1225
|
def cell(s, limit=160):
|
|
1170
1226
|
"""One markdown table cell. A newline ENDS a row and a bare pipe STARTS a column, so
|
|
@@ -1194,7 +1250,7 @@ if dspec and os.path.isfile(dspec) and os.path.getsize(dspec) > 0:
|
|
|
1194
1250
|
out.update(open_change=cr, delta_authored=delta_authored)
|
|
1195
1251
|
out.update(version=recorded_ver, doc_version=doc_ver, spec_sha256=actual,
|
|
1196
1252
|
recorded_sha256=recorded_hash, body_changed=(recorded_hash != actual),
|
|
1197
|
-
has_ledger=has_ledger, ledger_rows=len(rows),
|
|
1253
|
+
has_ledger=has_ledger, ledger_rows=len(rows), newest_row=newest_row,
|
|
1198
1254
|
first_stamp=(not recorded_hash))
|
|
1199
1255
|
|
|
1200
1256
|
if op == "check":
|
|
@@ -1228,8 +1284,28 @@ if op == "check":
|
|
|
1228
1284
|
out["state"] = "unstamped" # pre-ledger spec; stamp adopts it
|
|
1229
1285
|
elif recorded_hash == actual:
|
|
1230
1286
|
out["state"] = "clean"
|
|
1287
|
+
# THE ROW IS THE EVIDENCE; THE HEADER IS ONLY THE CLAIM. The body has moved since the
|
|
1288
|
+
# kit last stamped, and what makes that edit legible downstream is a version ROW naming
|
|
1289
|
+
# the ids it touched: sync-stories reads rows, story-plan's staleness check reads rows,
|
|
1290
|
+
# and neither ever opens the **Version** header. Taking the header as proof accepted the
|
|
1291
|
+
# commonest hand-edit mistake there is — bump the number, forget the row — and that one
|
|
1292
|
+
# passed every tripwire in the kit, raised no work anywhere, and was then buried for good
|
|
1293
|
+
# by the next run's stamp adopting its hash. So the test is a row ABOVE the version the
|
|
1294
|
+
# kit last recorded, and the header is only asked whether it kept up.
|
|
1295
|
+
elif newest_row and vtuple(newest_row) > vtuple(recorded_ver):
|
|
1296
|
+
out["state"] = ("ledgered_edit" if vtuple(doc_ver) >= vtuple(newest_row)
|
|
1297
|
+
else "header_behind") # recorded; stamp reconciles the header
|
|
1231
1298
|
elif vtuple(doc_ver) > vtuple(recorded_ver):
|
|
1232
|
-
|
|
1299
|
+
# The header claims a version the table never recorded. Refused for the same reason
|
|
1300
|
+
# an unrowed edit is: without the row nothing can say WHICH requirements moved, so
|
|
1301
|
+
# every story citing one is stale with nothing able to detect it.
|
|
1302
|
+
out["state"] = "unrowed_edit"
|
|
1303
|
+
out.update(ok=False, error="spec.md's header reads %s but the Change History carries "
|
|
1304
|
+
"no row above %s — the version was bumped and what it changed was never "
|
|
1305
|
+
"recorded. The row is what a story reads to learn that a requirement it "
|
|
1306
|
+
"cites has moved; the header is read by nobody. Add a row naming the ids "
|
|
1307
|
+
"you changed (keep the header at %s), then re-run."
|
|
1308
|
+
% (doc_ver or "no version", recorded_ver, doc_ver))
|
|
1233
1309
|
elif vtuple(doc_ver) < vtuple(recorded_ver):
|
|
1234
1310
|
out["state"] = "rollback"
|
|
1235
1311
|
out.update(ok=False, error="spec.md reads %s but the kit last wrote %s — the "
|
|
@@ -1241,8 +1317,23 @@ if op == "check":
|
|
|
1241
1317
|
"stale. Add a row naming the ids you changed, then re-run."
|
|
1242
1318
|
% recorded_ver)
|
|
1243
1319
|
elif op == "stamp":
|
|
1320
|
+
# THE VERSION IS THE HIGHEST OF THE THREE PLACES ONE IS WRITTEN, and the document's
|
|
1321
|
+
# header is reconciled up to it. Taking the header alone let a hand edit that DID write
|
|
1322
|
+
# its row — without bumping the header — leave the kit recording a version below the
|
|
1323
|
+
# newest row; the next hand edit then read as a `rollback`, the document behind its own
|
|
1324
|
+
# ledger, when nothing had rolled back. Rewriting the header is the authority
|
|
1325
|
+
# ledger-append already exercises: the kit owns the number, the row is what it is
|
|
1326
|
+
# computed from, and re-hashing after the rewrite is what keeps the baseline honest.
|
|
1327
|
+
stamp_ver = max([recorded_ver or "v1.0", doc_ver or "v1.0"] +
|
|
1328
|
+
([newest_row] if newest_row else []), key=vtuple)
|
|
1329
|
+
if doc_ver and vtuple(doc_ver) < vtuple(stamp_ver):
|
|
1330
|
+
text = re.sub(r'^(\*\*Version\*\*:\s*)v[\d.]+', r'\g<1>' + stamp_ver,
|
|
1331
|
+
text, count=1, flags=re.M)
|
|
1332
|
+
open(spec, "w", encoding="utf-8").write(text)
|
|
1333
|
+
actual = hashlib.sha256(contract_of(text).encode("utf-8")).hexdigest()
|
|
1334
|
+
out.update(header_rewritten=True, doc_version=stamp_ver, spec_sha256=actual)
|
|
1244
1335
|
av.setdefault("feature", feature); av.setdefault("active_change", "")
|
|
1245
|
-
av["version"] =
|
|
1336
|
+
av["version"] = stamp_ver
|
|
1246
1337
|
av["spec_sha256"] = actual; av["updated"] = now()
|
|
1247
1338
|
open(avp, "w", encoding="utf-8").write(json.dumps(av, indent=2) + "\n")
|
|
1248
1339
|
out.update(version=av["version"], state="stamped")
|
|
@@ -1251,7 +1342,7 @@ elif op == "append":
|
|
|
1251
1342
|
# A version that names no ids is a bump nothing can reconcile against: every
|
|
1252
1343
|
# story keeps its old stamp and the gap compounds at the next real change.
|
|
1253
1344
|
bail("ledger-append: --ids is required — a version row that names no requirement "
|
|
1254
|
-
"ids leaves
|
|
1345
|
+
"ids leaves sync-stories nothing to act on", 2)
|
|
1255
1346
|
# The next number comes from the highest of all three places a version is written —
|
|
1256
1347
|
# what the kit last recorded, what the document's header claims, and the newest row
|
|
1257
1348
|
# actually in the table. A hand edit routinely moves one and not the others, and
|
|
@@ -1296,7 +1387,7 @@ elif op == "rowids":
|
|
|
1296
1387
|
# for the reason the header of this file gives: a row the model DECLARED can omit an id
|
|
1297
1388
|
# it moved, and an omitted id is silent. The v1.0 row was the one exception — written by
|
|
1298
1389
|
# the author from a template whose placeholder literally reads "FR-001…FR-00n", which
|
|
1299
|
-
#
|
|
1390
|
+
# sync-stories then has to be told not to trust. This op closes that gap: the caller
|
|
1300
1391
|
# diffs the finished document against nothing and hands the ids in, exactly as the
|
|
1301
1392
|
# extend path does, so the first row is observed like all the rest.
|
|
1302
1393
|
if not ids:
|
|
@@ -1352,7 +1443,7 @@ PY
|
|
|
1352
1443
|
# neither is disturbed by the contract moving (E4).
|
|
1353
1444
|
#
|
|
1354
1445
|
# in_flight is the narrower set: an open story that already has a stories/<ID>/ directory,
|
|
1355
|
-
# so someone has run story-
|
|
1446
|
+
# so someone has run story-plan and is working from a design of the requirement as it
|
|
1356
1447
|
# reads today. That is the same directory-existence predicate change-story-id uses for its
|
|
1357
1448
|
# legality boundary — one test, serving three workflows.
|
|
1358
1449
|
cmd_story_refs() {
|
|
@@ -1409,6 +1500,11 @@ if os.path.isdir(sdir):
|
|
|
1409
1500
|
status = (fm.get("status") or "open").strip().lower()
|
|
1410
1501
|
cites = [c.strip() for c in re.findall(r'[A-Z]{2}-\d+', fm.get("exercises", ""))]
|
|
1411
1502
|
stories.append({"id": sid, "status": status, "exercises": cites,
|
|
1503
|
+
"cites_csv": ", ".join(cites),
|
|
1504
|
+
"title": (fm.get("title") or "").strip().strip("[]"),
|
|
1505
|
+
"spec_version": (fm.get("spec_version") or "").strip(),
|
|
1506
|
+
"type": (fm.get("type") or "functional").strip().lower(),
|
|
1507
|
+
"follows": (fm.get("follows") or "").strip(),
|
|
1412
1508
|
"in_flight": os.path.isdir(os.path.join(sdir, sid))})
|
|
1413
1509
|
|
|
1414
1510
|
open_stories = [s for s in stories if s["status"] == "open"]
|
|
@@ -1430,11 +1526,30 @@ for rid in targets:
|
|
|
1430
1526
|
aff_stories += names; inflight += flying
|
|
1431
1527
|
affected.append({"id": rid, "stories": names, "in_flight": flying})
|
|
1432
1528
|
|
|
1529
|
+
# THE COMPLEMENT, NAMED. `affected` is "these ids have live work"; its complement is
|
|
1530
|
+
# "these ids have nobody on them", and that is the set sync-stories raises new stories for.
|
|
1531
|
+
# Derived here rather than in the caller because the orchestrator binds values and never
|
|
1532
|
+
# computes them, and a subtraction done in a prompt is a subtraction nothing can check.
|
|
1533
|
+
unlinked = [rid for rid in targets if rid not in aff_ids]
|
|
1534
|
+
|
|
1535
|
+
# One line per open story, for a prompt that has to ask about them. A story id on its own
|
|
1536
|
+
# is not something an author can answer about: what it cites and whether someone is already
|
|
1537
|
+
# implementing it are the whole basis of the decision.
|
|
1538
|
+
digest = "\n".join(
|
|
1539
|
+
" %-16s %-9s %-11s cites %s%s" % (
|
|
1540
|
+
s["id"], s["status"], "IN FLIGHT" if s["in_flight"] else "not started",
|
|
1541
|
+
s["cites_csv"] or "nothing",
|
|
1542
|
+
(" @ " + s["spec_version"]) if s["spec_version"] else "")
|
|
1543
|
+
for s in open_stories) or " (no open stories)"
|
|
1544
|
+
|
|
1433
1545
|
print(json.dumps({
|
|
1434
1546
|
"ok": True, "stories_dir": sdir, "stories_exist": os.path.isdir(sdir),
|
|
1435
1547
|
"story_count": len(stories), "open_count": len(open_stories),
|
|
1548
|
+
"stories": stories, "digest": digest,
|
|
1436
1549
|
"queried": queried, "covered": covered, "covered_csv": ", ".join(covered),
|
|
1437
1550
|
"affected": affected, "affected_ids": aff_ids, "affected_csv": ", ".join(aff_ids),
|
|
1551
|
+
"unlinked": unlinked, "unlinked_csv": ", ".join(unlinked),
|
|
1552
|
+
"unlinked_count": len(unlinked), "any_unlinked": bool(unlinked),
|
|
1438
1553
|
"story_csv": ", ".join(sorted(set(aff_stories))),
|
|
1439
1554
|
"in_flight_csv": ", ".join(sorted(set(inflight))),
|
|
1440
1555
|
"any": bool(aff_ids), "any_in_flight": bool(inflight),
|
|
@@ -1450,7 +1565,7 @@ PY
|
|
|
1450
1565
|
# discarded by design — the story is where delivery is declared.
|
|
1451
1566
|
#
|
|
1452
1567
|
# Every workflow that changes either side calls this: specify when the requirements move,
|
|
1453
|
-
# user-story and
|
|
1568
|
+
# user-story and sync-stories when the backlog does. It is deterministic and model-free,
|
|
1454
1569
|
# so calling it more often than necessary costs nothing and drift is not possible.
|
|
1455
1570
|
#
|
|
1456
1571
|
# Scoped to FR-/BR- — the ids a story cites. CN-/DC-/IC-/UX- are constraints the design
|
|
@@ -1543,6 +1658,1030 @@ print(json.dumps(out))
|
|
|
1543
1658
|
PY
|
|
1544
1659
|
}
|
|
1545
1660
|
|
|
1661
|
+
# ─────────────────────────────── ledger-read ───────────────────────────────
|
|
1662
|
+
# THE WORK SET: which requirements this sync has to account for. The ledger records what
|
|
1663
|
+
# each version touched and every story records the version it last synced at, so the
|
|
1664
|
+
# question "what has moved since the backlog was last in step" is answerable by reading
|
|
1665
|
+
# rows — no diffing, no hashing, no model.
|
|
1666
|
+
#
|
|
1667
|
+
# The set is the union of the ids named by every row ABOVE THE LOWEST spec_version across
|
|
1668
|
+
# the OPEN stories, not the ids of the newest row alone. Those are the same set whenever
|
|
1669
|
+
# the backlog is one version behind, which is the ordinary case; they diverge only when a
|
|
1670
|
+
# sync was skipped, and that is exactly the case worth getting right. Two specify runs
|
|
1671
|
+
# without a sync between them leave the middle version named by no row anyone reads, and
|
|
1672
|
+
# its requirements would get no story with nothing to say so — a silent gap, in the one
|
|
1673
|
+
# mechanism built to make gaps loud.
|
|
1674
|
+
#
|
|
1675
|
+
# THE v1.0 CASE (E42). At v1.0 nothing has moved yet: there is no "since" to read from. So
|
|
1676
|
+
# when no open story carries a readable spec version — an empty backlog, or stories written
|
|
1677
|
+
# before the field existed — the work set is every FR-/BR- the DOCUMENT declares, and the
|
|
1678
|
+
# per-id four-case table does the rest. A second run over the same spec then creates
|
|
1679
|
+
# nothing, because by then every id has a story.
|
|
1680
|
+
#
|
|
1681
|
+
# Scoped to FR-/BR- throughout, the same scoping spec-coverage applies: those are the only
|
|
1682
|
+
# classes a story's `exercises:` can name. CN-/DC-/IC-/UX- move the contract and belong in
|
|
1683
|
+
# the ledger row, but they are constraints a story CARRIES, not slices of work it delivers.
|
|
1684
|
+
cmd_ledger_read() {
|
|
1685
|
+
local fd_arg=""
|
|
1686
|
+
while [ $# -gt 0 ]; do
|
|
1687
|
+
case "$1" in
|
|
1688
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
1689
|
+
--help|-h) echo "ledger-read [--feature-dir <path>]"; return 0 ;;
|
|
1690
|
+
*) echo "ledger-read: unknown arg '$1'" >&2; return 1 ;;
|
|
1691
|
+
esac
|
|
1692
|
+
done
|
|
1693
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
1694
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "ledger-read: no feature set and no --feature-dir" >&2; return 1; }
|
|
1695
|
+
AW_FD="$fd" python3 - <<'PY'
|
|
1696
|
+
import json, os, re, sys
|
|
1697
|
+
fd = os.environ["AW_FD"]
|
|
1698
|
+
spec = os.path.join(fd, "spec.md"); sdir = os.path.join(fd, "stories")
|
|
1699
|
+
|
|
1700
|
+
def bail(msg, code=1):
|
|
1701
|
+
print(json.dumps({"ok": False, "error": msg}))
|
|
1702
|
+
sys.stderr.write(msg + "\n"); sys.exit(code)
|
|
1703
|
+
|
|
1704
|
+
if not os.path.isfile(spec): bail("no spec.md at %s" % fd)
|
|
1705
|
+
text = open(spec, encoding="utf-8", errors="replace").read()
|
|
1706
|
+
|
|
1707
|
+
COV = re.compile(r'<!--\s*AW:COVERAGE:BEGIN\s*-->.*?<!--\s*AW:COVERAGE:END\s*-->', re.S)
|
|
1708
|
+
|
|
1709
|
+
def vtuple(v):
|
|
1710
|
+
m = re.match(r'v?(\d+)(?:\.(\d+))?', (v or "").strip())
|
|
1711
|
+
return (int(m.group(1)), int(m.group(2) or 0)) if m else (0, 0)
|
|
1712
|
+
|
|
1713
|
+
def rids(s):
|
|
1714
|
+
"""FR-/BR- ids in order of appearance, deduped, then sorted by class and number so
|
|
1715
|
+
two callers reading the same row always produce the same csv."""
|
|
1716
|
+
seen, out = set(), []
|
|
1717
|
+
for t in re.findall(r'\b(?:FR|BR)-\d+', s or ""):
|
|
1718
|
+
if t not in seen: seen.add(t); out.append(t)
|
|
1719
|
+
return sorted(out, key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
1720
|
+
|
|
1721
|
+
def parse_fm(text):
|
|
1722
|
+
"""Frontmatter as a flat dict. A value may be inline (`exercises: [FR-001, BR-002]`) or
|
|
1723
|
+
a YAML block list under an empty key — both are valid YAML and a hand edit produces
|
|
1724
|
+
either, so a parser that read only the inline form saw a perfectly good story as citing
|
|
1725
|
+
nothing, and a story citing nothing is invisible to every gate that exists to protect
|
|
1726
|
+
it. Block items are folded into the inline shape so every caller stays regex-simple."""
|
|
1727
|
+
m = re.match(r'^---\s*\n(.*?)\n---\s*\n', text, re.S)
|
|
1728
|
+
if not m: return {}
|
|
1729
|
+
fm, key, block = {}, None, set()
|
|
1730
|
+
for line in m.group(1).split("\n"):
|
|
1731
|
+
km = re.match(r'^([A-Za-z_]+):\s*(.*)$', line)
|
|
1732
|
+
if km:
|
|
1733
|
+
key = km.group(1); fm[key] = km.group(2).strip(); continue
|
|
1734
|
+
im = re.match(r'^\s+-\s+(.*)$', line) if key else None
|
|
1735
|
+
if im and (key in block or not fm[key]):
|
|
1736
|
+
block.add(key)
|
|
1737
|
+
fm[key] = (fm[key] + ", " + im.group(1).strip()) if fm[key] else im.group(1).strip()
|
|
1738
|
+
return fm
|
|
1739
|
+
|
|
1740
|
+
# THE LEDGER TABLE, located the same way _spec_ledger locates it — heading, separator rule,
|
|
1741
|
+
# then the rows under it, bounded by the next `## `. Any other section carries its own
|
|
1742
|
+
# table (Story Coverage does), and an unbounded search would read one of those as history.
|
|
1743
|
+
lines = text.split("\n")
|
|
1744
|
+
hi = next((i for i, l in enumerate(lines)
|
|
1745
|
+
if re.match(r'^##\s+Change History\s*$', l.strip())), -1)
|
|
1746
|
+
sec_end = (next((i for i in range(hi + 1, len(lines)) if lines[i].startswith("## ")),
|
|
1747
|
+
len(lines)) if hi >= 0 else -1)
|
|
1748
|
+
sep = (next((i for i in range(hi + 1, sec_end)
|
|
1749
|
+
if re.match(r'^\|[\s\-:|]+\|$', lines[i].strip())), -1) if hi >= 0 else -1)
|
|
1750
|
+
row_lines = [i for i in range(sep + 1, sec_end) if lines[i].lstrip().startswith("|")] if sep >= 0 else []
|
|
1751
|
+
has_ledger = hi >= 0 and sep >= 0
|
|
1752
|
+
|
|
1753
|
+
def cells(line):
|
|
1754
|
+
parts = re.split(r'(?<!\\)\|', line)
|
|
1755
|
+
return [c.strip().replace("\\|", "|") for c in parts[1:-1]] if len(parts) >= 3 else []
|
|
1756
|
+
|
|
1757
|
+
rows = []
|
|
1758
|
+
for i in row_lines:
|
|
1759
|
+
c = cells(lines[i]); c += [""] * (5 - len(c))
|
|
1760
|
+
# A row whose first cell is not a version is the template's own placeholder line, or a
|
|
1761
|
+
# note somebody left in the table. It records no version, so it orders against nothing.
|
|
1762
|
+
if not re.match(r'^v\d', c[0]): continue
|
|
1763
|
+
rows.append({"version": c[0], "date": c[1], "change": c[2], "ids_cell": c[3],
|
|
1764
|
+
"stories": c[4], "requirements": rids(c[3])})
|
|
1765
|
+
rows.sort(key=lambda r: vtuple(r["version"]))
|
|
1766
|
+
|
|
1767
|
+
# WHAT THE DOCUMENT STILL DECLARES. Read from the requirement's DEFINING line — the bolded
|
|
1768
|
+
# id the template gives every requirement — and with the Change History cut away, so the
|
|
1769
|
+
# ids named in a row's own cell are never mistaken for requirements the spec carries.
|
|
1770
|
+
body = COV.sub("", text).split("\n## Change History")[0]
|
|
1771
|
+
declared = []
|
|
1772
|
+
for line in body.split("\n"):
|
|
1773
|
+
m = re.search(r'\*\*((?:FR|BR)-\d+)\*\*', line)
|
|
1774
|
+
if m and m.group(1) not in declared: declared.append(m.group(1))
|
|
1775
|
+
declared.sort(key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
1776
|
+
|
|
1777
|
+
stories = []
|
|
1778
|
+
if os.path.isdir(sdir):
|
|
1779
|
+
for name in sorted(os.listdir(sdir)):
|
|
1780
|
+
if not name.endswith(".md"): continue
|
|
1781
|
+
p = os.path.join(sdir, name)
|
|
1782
|
+
if not os.path.isfile(p): continue
|
|
1783
|
+
fm = parse_fm(open(p, encoding="utf-8", errors="replace").read())
|
|
1784
|
+
sid = fm.get("id") or name[:-3]
|
|
1785
|
+
stories.append({"id": sid, "status": (fm.get("status") or "open").strip().lower(),
|
|
1786
|
+
"spec_version": (fm.get("spec_version") or "").strip(),
|
|
1787
|
+
"follows": (fm.get("follows") or "").strip(),
|
|
1788
|
+
"in_flight": os.path.isdir(os.path.join(sdir, sid)),
|
|
1789
|
+
"cites": rids(fm.get("exercises", ""))})
|
|
1790
|
+
open_stories = [s for s in stories if s["status"] == "open"]
|
|
1791
|
+
|
|
1792
|
+
# THE FLOOR is the oldest version any open story is still sitting at, and everything above
|
|
1793
|
+
# it is unsynced. A story whose spec_version is missing or unreadable counts as v0.0 rather
|
|
1794
|
+
# than being skipped: it has demonstrably never synced, and putting the whole ledger above
|
|
1795
|
+
# it is the same answer enumerating from the document would give.
|
|
1796
|
+
floors = [vtuple(s["spec_version"]) for s in open_stories]
|
|
1797
|
+
readable = [s for s in open_stories if re.match(r'^v?\d', s["spec_version"] or "")]
|
|
1798
|
+
# A BACKLOG THAT IS ENTIRELY CLOSED IS NOT A BACKLOG THAT NEVER SYNCED. Reading the floor
|
|
1799
|
+
# from open stories alone made the last story closing look exactly like a feature nobody has
|
|
1800
|
+
# ever sliced: no floor took the enumerate-the-whole-document branch below, so one idle
|
|
1801
|
+
# re-run after finishing a feature raised a fresh story for every requirement in the spec —
|
|
1802
|
+
# each one reported as work the contract had moved on, when nothing had moved at all. A
|
|
1803
|
+
# CLOSED story carries a stamp too, and it records which version its work was measured
|
|
1804
|
+
# against. CANCELLED ones are excluded: abandoned work delivered nothing and settles nothing,
|
|
1805
|
+
# so it establishes no floor and leaves its requirements to be sliced again.
|
|
1806
|
+
closed_stories = [s for s in stories if s["status"] == "closed"]
|
|
1807
|
+
floor_source = "open" if floors else ("closed" if closed_stories else "none")
|
|
1808
|
+
floor = (min(floors) if floors
|
|
1809
|
+
else (min(vtuple(s["spec_version"]) for s in closed_stories) if closed_stories
|
|
1810
|
+
else None))
|
|
1811
|
+
|
|
1812
|
+
latest = rows[-1] if rows else None
|
|
1813
|
+
out = {"ok": True, "feature_dir": fd, "has_ledger": has_ledger,
|
|
1814
|
+
"row_count": len(rows), "ledger_empty": len(rows) == 0,
|
|
1815
|
+
"rows": rows,
|
|
1816
|
+
"latest_version": latest["version"] if latest else "",
|
|
1817
|
+
"latest_change": latest["change"] if latest else "",
|
|
1818
|
+
"latest_ids_csv": ", ".join(latest["requirements"]) if latest else "",
|
|
1819
|
+
"spec_ids_csv": ", ".join(declared), "spec_id_count": len(declared),
|
|
1820
|
+
"story_count": len(stories), "open_count": len(open_stories),
|
|
1821
|
+
"unversioned_open": len(open_stories) - len(readable)}
|
|
1822
|
+
|
|
1823
|
+
if not has_ledger:
|
|
1824
|
+
out.update(ok=False, error="spec.md has no '## Change History' table. That table is "
|
|
1825
|
+
"where a story learns a requirement it cites has moved, so a spec without "
|
|
1826
|
+
"one cannot be kept in step with its backlog.")
|
|
1827
|
+
print(json.dumps(out)); sys.stderr.write(out["error"] + "\n"); sys.exit(2)
|
|
1828
|
+
|
|
1829
|
+
if not rows:
|
|
1830
|
+
# An empty ledger is not corruption — it is a spec that has never been versioned, which
|
|
1831
|
+
# means specify has not finished with it. Reported, not raised: the caller warns and
|
|
1832
|
+
# stops, because there is no "since" to sync from and inventing one would raise a
|
|
1833
|
+
# backlog against a document nobody has committed to.
|
|
1834
|
+
out.update(work_csv="", work_count=0, work_source="none", span_versions_csv="",
|
|
1835
|
+
gap=False, removed_csv="",
|
|
1836
|
+
work_note="the Change History table carries no version row")
|
|
1837
|
+
print(json.dumps(out)); sys.exit(0)
|
|
1838
|
+
|
|
1839
|
+
if floor is None:
|
|
1840
|
+
# E42 — nothing has moved because nothing has synced. Enumerate from the document.
|
|
1841
|
+
source, span = "spec", []
|
|
1842
|
+
candidates = list(declared)
|
|
1843
|
+
note = ("nothing has synced against this spec yet — no open story records a version and "
|
|
1844
|
+
"nothing has closed against it — so there is no 'since' to read from: the work "
|
|
1845
|
+
"set is every requirement the document declares, and the per-id rules then "
|
|
1846
|
+
"create only what has no story")
|
|
1847
|
+
else:
|
|
1848
|
+
span = [r for r in rows if vtuple(r["version"]) > floor]
|
|
1849
|
+
seen, candidates = set(), []
|
|
1850
|
+
for r in span:
|
|
1851
|
+
for rid in r["requirements"]:
|
|
1852
|
+
if rid not in seen: seen.add(rid); candidates.append(rid)
|
|
1853
|
+
candidates.sort(key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
1854
|
+
source = "ledger"
|
|
1855
|
+
note = ("%d version row(s) above the oldest %s story's v%d.%d: %s"
|
|
1856
|
+
% (len(span), floor_source, floor[0], floor[1],
|
|
1857
|
+
", ".join(r["version"] for r in span) or "none"))
|
|
1858
|
+
|
|
1859
|
+
# THE SPAN IS A PREFILTER; STALENESS IS PER ID. The floor is the oldest version any open
|
|
1860
|
+
# story sits at, and a story whose requirements never move sits there forever — Order-001
|
|
1861
|
+
# holding v1.0 keeps v1.1 and v1.2 in the span long after everything they named has been
|
|
1862
|
+
# synced. Reading the span alone therefore re-offered the same requirements on every run,
|
|
1863
|
+
# and each re-offer is a model call rewriting a story that was already in step.
|
|
1864
|
+
#
|
|
1865
|
+
# So the span says which ids are WORTH CHECKING and this says which have actually moved
|
|
1866
|
+
# under someone: an id is stale when it has no open story at all, or when some open story
|
|
1867
|
+
# citing it is stamped BELOW the newest version that touched it. An id whose every open
|
|
1868
|
+
# story is at or above that version is in step, whatever the floor says.
|
|
1869
|
+
moved_at = {}
|
|
1870
|
+
for r in rows:
|
|
1871
|
+
for rid in r["requirements"]:
|
|
1872
|
+
v = vtuple(r["version"])
|
|
1873
|
+
if v > moved_at.get(rid, (0, 0)): moved_at[rid] = v
|
|
1874
|
+
|
|
1875
|
+
def carried_on(story_id, rid, at):
|
|
1876
|
+
"""Has a follow-on already taken this requirement off that story's hands, at or above
|
|
1877
|
+
the version that moved it. The `follows` link is the whole record of that hand-off."""
|
|
1878
|
+
return any(s["follows"] == story_id and rid in s["cites"]
|
|
1879
|
+
and vtuple(s["spec_version"]) >= at for s in open_stories)
|
|
1880
|
+
|
|
1881
|
+
work, in_step = [], []
|
|
1882
|
+
for rid in candidates:
|
|
1883
|
+
holders = [s for s in open_stories if rid in s["cites"]]
|
|
1884
|
+
at = moved_at.get(rid, (0, 0))
|
|
1885
|
+
behind = []
|
|
1886
|
+
for s in holders:
|
|
1887
|
+
if vtuple(s["spec_version"]) >= at: continue
|
|
1888
|
+
# AN IN-FLIGHT STORY CANNOT BE BROUGHT UP TO DATE, BY DESIGN. It is never rewritten
|
|
1889
|
+
# (§5.5), so its spec_version can never rise, so reading it as a staleness signal
|
|
1890
|
+
# gives a signal that never clears — and a sync that mints a fresh follow-on for the
|
|
1891
|
+
# same requirement on every run. What clears it is the follow-on itself: once one
|
|
1892
|
+
# exists carrying this id at or above the version that moved it, the hand-off has
|
|
1893
|
+
# happened and the original is history in progress, not unfinished business.
|
|
1894
|
+
if s["in_flight"] and carried_on(s["id"], rid, at): continue
|
|
1895
|
+
behind.append(s["id"])
|
|
1896
|
+
# A CLOSED STORY STAMPED AT OR ABOVE THE VERSION THAT LAST MOVED THIS REQUIREMENT
|
|
1897
|
+
# DELIVERED THE WORDING THE SPEC ASKS FOR TODAY, so the requirement is FINISHED rather
|
|
1898
|
+
# than unsliced. Reading "no open story cites it" as work on its own could not tell those
|
|
1899
|
+
# two apart, which is what let a fully delivered feature re-raise its entire backlog.
|
|
1900
|
+
# A closed story stamped BELOW that version is the other case and stays work: the
|
|
1901
|
+
# contract moved after it shipped, so what shipped is no longer what the spec asks for,
|
|
1902
|
+
# and backlog-plan names the closed story it is re-opening against.
|
|
1903
|
+
delivered = any(rid in s["cites"] and vtuple(s["spec_version"]) >= at
|
|
1904
|
+
for s in closed_stories)
|
|
1905
|
+
(in_step if ((holders and not behind) or (not holders and delivered))
|
|
1906
|
+
else work).append(rid)
|
|
1907
|
+
|
|
1908
|
+
# A row names what a version TOUCHED, and that includes ids it REMOVED. A removed
|
|
1909
|
+
# requirement has no wording left to write a story from, so it leaves the work set — but it
|
|
1910
|
+
# is reported, because every open story citing one is orphaned and that is a decision for a
|
|
1911
|
+
# person, not a default (E1).
|
|
1912
|
+
removed = [i for i in work if i not in declared]
|
|
1913
|
+
work = [i for i in work if i in declared]
|
|
1914
|
+
|
|
1915
|
+
out.update(work_csv=", ".join(work), work_count=len(work), work_source=source,
|
|
1916
|
+
work_note=note, work_any=bool(work),
|
|
1917
|
+
candidates_csv=", ".join(candidates), candidate_count=len(candidates),
|
|
1918
|
+
in_step_csv=", ".join(in_step), in_step_count=len(in_step),
|
|
1919
|
+
floor_source=floor_source,
|
|
1920
|
+
span_versions_csv=", ".join(r["version"] for r in span),
|
|
1921
|
+
span_count=len(span), gap=len(span) > 1,
|
|
1922
|
+
removed_csv=", ".join(removed), removed_count=len(removed),
|
|
1923
|
+
synced_floor=("v%d.%d" % floor) if floor else "")
|
|
1924
|
+
print(json.dumps(out))
|
|
1925
|
+
PY
|
|
1926
|
+
}
|
|
1927
|
+
|
|
1928
|
+
# ─────────────────────────────── slice-mode ────────────────────────────────
|
|
1929
|
+
# Which slicing strategy the launch line asked for, and what is left of the input once that
|
|
1930
|
+
# word is taken out of it. Its own op rather than a `condition:` in the workflow, because
|
|
1931
|
+
# the engine compares a whole rendered value: `{{USER_INPUT}} == single-run` only matches an
|
|
1932
|
+
# input carrying the strategy and no guidance at all, and `sync-stories single-run keep the
|
|
1933
|
+
# payment rules together` — the form the launch line documents — would silently slice by
|
|
1934
|
+
# default while looking as though it had been told not to.
|
|
1935
|
+
#
|
|
1936
|
+
# ONLY THE FIRST WORD IS A STRATEGY. Guidance is free prose, and "keep the single sign-on
|
|
1937
|
+
# requirements in one story" is a slicing instruction with the token sitting in the middle
|
|
1938
|
+
# of it. Reading the token anywhere in the string would turn that sentence into the opposite
|
|
1939
|
+
# of what it asks, with nothing to say so.
|
|
1940
|
+
cmd_slice_mode() {
|
|
1941
|
+
local input=""
|
|
1942
|
+
while [ $# -gt 0 ]; do
|
|
1943
|
+
case "$1" in
|
|
1944
|
+
--input) input="$2"; shift 2 ;;
|
|
1945
|
+
--help|-h) echo "slice-mode [--input <text>] -> {strategy, guidance, note}"; return 0 ;;
|
|
1946
|
+
*) echo "slice-mode: unknown arg '$1'" >&2; return 1 ;;
|
|
1947
|
+
esac
|
|
1948
|
+
done
|
|
1949
|
+
AW_INPUT="$input" python3 - <<'PY'
|
|
1950
|
+
import json, os, re
|
|
1951
|
+
raw = (os.environ.get("AW_INPUT", "") or "").strip()
|
|
1952
|
+
|
|
1953
|
+
# `single-run` is the spelling the launch line documents; the others are what people write
|
|
1954
|
+
# when they mean it. `auto` is the default and is accepted explicitly so a launch line can
|
|
1955
|
+
# say so — a strategy nobody can name is one nobody can turn off.
|
|
1956
|
+
TOKENS = {"single-run": "single", "single-story": "single", "single": "single",
|
|
1957
|
+
"one-story": "single", "auto": "auto", "per-slice": "auto", "default": "auto"}
|
|
1958
|
+
|
|
1959
|
+
strategy, guidance = "auto", raw
|
|
1960
|
+
m = re.match(r'^([A-Za-z][A-Za-z0-9_-]*)\s*[:,]?\s*(.*)$', raw, re.S)
|
|
1961
|
+
if m and m.group(1).lower() in TOKENS:
|
|
1962
|
+
strategy = TOKENS[m.group(1).lower()]
|
|
1963
|
+
guidance = m.group(2).strip()
|
|
1964
|
+
|
|
1965
|
+
if strategy == "single":
|
|
1966
|
+
note = ("one story was asked for (single-run): the whole work set goes into a single "
|
|
1967
|
+
"slice unless it is too heavy to be picked up as one piece of work, in which "
|
|
1968
|
+
"case it is split along its dependencies and the split is reported")
|
|
1969
|
+
else:
|
|
1970
|
+
note = "the slicing is decided from the requirements themselves"
|
|
1971
|
+
|
|
1972
|
+
print(json.dumps({"ok": True, "strategy": strategy, "guidance": guidance,
|
|
1973
|
+
"single": strategy == "single", "note": note,
|
|
1974
|
+
"raw": raw, "tokens": sorted(TOKENS)}))
|
|
1975
|
+
PY
|
|
1976
|
+
}
|
|
1977
|
+
|
|
1978
|
+
# ─────────────────────────────── backlog-plan ──────────────────────────────
|
|
1979
|
+
# The grouping is a judgment; everything that follows from it is arithmetic. This op does
|
|
1980
|
+
# the arithmetic, in two modes over the same inputs so the two passes cannot disagree about
|
|
1981
|
+
# what a group contains:
|
|
1982
|
+
#
|
|
1983
|
+
# scan which OPEN stories already stand in front of a group's requirements — the
|
|
1984
|
+
# candidates the author is asked about, and the wording of that question.
|
|
1985
|
+
# plan given the author's answer, the flat list of story files to write: one entry per
|
|
1986
|
+
# file, each already carrying its id, its path, and the ids it must end up citing.
|
|
1987
|
+
#
|
|
1988
|
+
# THE FOUR CASES (§5.4) resolve per group, not per requirement, because a group IS the story:
|
|
1989
|
+
#
|
|
1990
|
+
# no open story cites anything in the group -> create
|
|
1991
|
+
# an open story does, no stories/<ID>/ yet -> update in place (asked)
|
|
1992
|
+
# an open story does, a story plan already exists -> mint a follow-on (asked); the
|
|
1993
|
+
# original is never rewritten (§5.5)
|
|
1994
|
+
# the author declines -> that story is left alone AND the ids
|
|
1995
|
+
# it covers leave the group; whatever
|
|
1996
|
+
# remains becomes a new story
|
|
1997
|
+
#
|
|
1998
|
+
# The last line is the one worth reading twice. Declining does not abandon the group — it
|
|
1999
|
+
# withdraws the requirements that story is already carrying and creates a story for the
|
|
2000
|
+
# rest. A group of three where one id has a story the author will not touch still delivers
|
|
2001
|
+
# the other two.
|
|
2002
|
+
#
|
|
2003
|
+
# ONE GROUP, ONE ABSORBING STORY. Where the author approves two stories in the same group,
|
|
2004
|
+
# the first by id takes the group's unclaimed requirements and the others keep exactly the
|
|
2005
|
+
# ids they already cite. Two stories both claiming the same new requirement is not a state
|
|
2006
|
+
# the completeness rule can read.
|
|
2007
|
+
#
|
|
2008
|
+
# IN FLIGHT IS TESTED PER STORY, NOT ONLY ON THE FIRST. An approved story that already has
|
|
2009
|
+
# a story with a story plan is never rewritten wherever it sits in the group — it gets its own follow-on
|
|
2010
|
+
# carrying what it covers, exactly as it would if it were the only story there.
|
|
2011
|
+
#
|
|
2012
|
+
# AND THE ORDER. Plan mode also resolves the dependency edges the grouping declared between
|
|
2013
|
+
# slices, folds in the `depends_on:` an updated story already carries, breaks any cycle, and
|
|
2014
|
+
# lays the result out in WAVES: wave N holds the stories whose every dependency sits below N,
|
|
2015
|
+
# so one wave is a set with no ordering between its members — they may be picked up in
|
|
2016
|
+
# parallel. The plan comes back sorted by wave, which is also the order the stories are
|
|
2017
|
+
# written in, so meeting the cap costs the LAST wave rather than an arbitrary slice of the
|
|
2018
|
+
# backlog. See the block above the wave computation for why `follows:` is not an edge.
|
|
2019
|
+
cmd_backlog_plan() {
|
|
2020
|
+
local fd_arg="" groups="" approved="" work="" version="" mode="scan" cap="" strategy="" ceiling=""
|
|
2021
|
+
while [ $# -gt 0 ]; do
|
|
2022
|
+
case "$1" in
|
|
2023
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
2024
|
+
--groups) groups="$2"; shift 2 ;;
|
|
2025
|
+
--approved) approved="$2"; shift 2 ;;
|
|
2026
|
+
--work) work="$2"; shift 2 ;;
|
|
2027
|
+
--version) version="$2"; shift 2 ;;
|
|
2028
|
+
--cap) cap="$2"; shift 2 ;;
|
|
2029
|
+
--strategy) strategy="$2"; shift 2 ;;
|
|
2030
|
+
--ceiling) ceiling="$2"; shift 2 ;;
|
|
2031
|
+
--plan) mode="plan"; shift ;;
|
|
2032
|
+
--help|-h) echo "backlog-plan --groups <json> --work <csv> [--strategy single|auto] [--ceiling <n>] [--feature-dir <p>]"; echo "backlog-plan --plan --groups <json> --work <csv> --approved <story ids> --version <v> [--cap <n>] [--strategy single|auto] [--ceiling <n>]"; return 0 ;;
|
|
2033
|
+
*) echo "backlog-plan: unknown arg '$1'" >&2; return 1 ;;
|
|
2034
|
+
esac
|
|
2035
|
+
done
|
|
2036
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
2037
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "backlog-plan: no feature set and no --feature-dir" >&2; return 1; }
|
|
2038
|
+
AW_FD="$fd" AW_GROUPS="$groups" AW_OK="$approved" AW_WORK="$work" AW_VER="$version" AW_MODE="$mode" AW_CAP="$cap" AW_STRATEGY="$strategy" AW_CEILING="$ceiling" python3 - <<'PY'
|
|
2039
|
+
import json, os, re, sys
|
|
2040
|
+
fd = os.environ["AW_FD"]; mode = os.environ.get("AW_MODE", "scan")
|
|
2041
|
+
sdir = os.path.join(fd, "stories")
|
|
2042
|
+
feature = os.path.basename(fd.rstrip("/\\"))
|
|
2043
|
+
|
|
2044
|
+
def bail(msg, code=2):
|
|
2045
|
+
print(json.dumps({"ok": False, "error": msg}))
|
|
2046
|
+
sys.stderr.write(msg + "\n"); sys.exit(code)
|
|
2047
|
+
|
|
2048
|
+
def rids(s):
|
|
2049
|
+
seen, out = set(), []
|
|
2050
|
+
for t in re.findall(r'\b(?:FR|BR)-\d+', s or ""):
|
|
2051
|
+
if t not in seen: seen.add(t); out.append(t)
|
|
2052
|
+
return sorted(out, key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
2053
|
+
|
|
2054
|
+
def sids(s):
|
|
2055
|
+
"""Story ids out of a csv, a JSON list or a YAML inline list. A story id is a feature
|
|
2056
|
+
name and a number; a template placeholder (`[]`, `[STORY-ID]`) is neither, and must
|
|
2057
|
+
never become a dependency edge nobody can resolve."""
|
|
2058
|
+
seen, out = set(), []
|
|
2059
|
+
for t in re.split(r'[,\s\[\]"\']+', s or ""):
|
|
2060
|
+
t = t.strip()
|
|
2061
|
+
if re.match(r'^[A-Za-z][\w.]*-\d+$', t) and t not in seen:
|
|
2062
|
+
seen.add(t); out.append(t)
|
|
2063
|
+
return out
|
|
2064
|
+
|
|
2065
|
+
def wave_of(s):
|
|
2066
|
+
"""A story's declared wave. Absent — a story written before the field existed — reads
|
|
2067
|
+
as 1, the conservative floor: nothing is KNOWN to have to land before it."""
|
|
2068
|
+
m = re.match(r'^\s*(\d+)\s*$', (s or "").strip())
|
|
2069
|
+
return int(m.group(1)) if m else 1
|
|
2070
|
+
|
|
2071
|
+
def names(s):
|
|
2072
|
+
"""Story ids out of a csv or a JSON list. A multi-select answer arrives as the engine's
|
|
2073
|
+
JSON rendering of a list, so both spellings have to read the same."""
|
|
2074
|
+
seen, out = set(), []
|
|
2075
|
+
for t in re.split(r'[,\s\[\]"\']+', s or ""):
|
|
2076
|
+
t = t.strip()
|
|
2077
|
+
if t and t not in seen: seen.add(t); out.append(t)
|
|
2078
|
+
return out
|
|
2079
|
+
|
|
2080
|
+
def parse_fm(text):
|
|
2081
|
+
"""Frontmatter as a flat dict. A value may be inline (`exercises: [FR-001, BR-002]`) or
|
|
2082
|
+
a YAML block list under an empty key — both are valid YAML and a hand edit produces
|
|
2083
|
+
either, so a parser that read only the inline form saw a perfectly good story as citing
|
|
2084
|
+
nothing, and a story citing nothing is invisible to every gate that exists to protect
|
|
2085
|
+
it. Block items are folded into the inline shape so every caller stays regex-simple."""
|
|
2086
|
+
m = re.match(r'^---\s*\n(.*?)\n---\s*\n', text, re.S)
|
|
2087
|
+
if not m: return {}
|
|
2088
|
+
fm, key, block = {}, None, set()
|
|
2089
|
+
for line in m.group(1).split("\n"):
|
|
2090
|
+
km = re.match(r'^([A-Za-z_]+):\s*(.*)$', line)
|
|
2091
|
+
if km:
|
|
2092
|
+
key = km.group(1); fm[key] = km.group(2).strip(); continue
|
|
2093
|
+
im = re.match(r'^\s+-\s+(.*)$', line) if key else None
|
|
2094
|
+
if im and (key in block or not fm[key]):
|
|
2095
|
+
block.add(key)
|
|
2096
|
+
fm[key] = (fm[key] + ", " + im.group(1).strip()) if fm[key] else im.group(1).strip()
|
|
2097
|
+
return fm
|
|
2098
|
+
|
|
2099
|
+
# ---- the backlog -----------------------------------------------------------------
|
|
2100
|
+
stories, used_numbers = [], []
|
|
2101
|
+
if os.path.isdir(sdir):
|
|
2102
|
+
for name in sorted(os.listdir(sdir)):
|
|
2103
|
+
if not name.endswith(".md"): continue
|
|
2104
|
+
p = os.path.join(sdir, name)
|
|
2105
|
+
if not os.path.isfile(p): continue
|
|
2106
|
+
fm = parse_fm(open(p, encoding="utf-8", errors="replace").read())
|
|
2107
|
+
sid = fm.get("id") or name[:-3]
|
|
2108
|
+
# Numbers come from the FILENAME as well as the id, and from CLOSED and CANCELLED
|
|
2109
|
+
# stories as well as open ones. An id is permanent once minted: re-issuing the
|
|
2110
|
+
# number of a story that shipped re-points its execution artefacts at new work.
|
|
2111
|
+
for cand in (sid, name[:-3]):
|
|
2112
|
+
m = re.search(r'-(\d+)$', cand)
|
|
2113
|
+
if m: used_numbers.append(int(m.group(1)))
|
|
2114
|
+
stories.append({"id": sid, "status": (fm.get("status") or "open").strip().lower(),
|
|
2115
|
+
"title": (fm.get("title") or "").strip().strip("[]"),
|
|
2116
|
+
"spec_version": (fm.get("spec_version") or "").strip(),
|
|
2117
|
+
"cites": rids(fm.get("exercises", "")),
|
|
2118
|
+
"wave": wave_of(fm.get("wave", "")),
|
|
2119
|
+
"deps": sids(fm.get("depends_on", "")),
|
|
2120
|
+
"in_flight": os.path.isdir(os.path.join(sdir, sid)),
|
|
2121
|
+
"path": p})
|
|
2122
|
+
open_stories = [s for s in stories if s["status"] == "open"]
|
|
2123
|
+
# Closed and cancelled stories hold no requirement — completeness is "no OPEN stories" —
|
|
2124
|
+
# but they are the reason a create can look like duplicated work, so they are read in
|
|
2125
|
+
# order to say so. See the create branch below.
|
|
2126
|
+
done_stories = [s for s in stories if s["status"] != "open"]
|
|
2127
|
+
by_id = {s["id"]: s for s in stories}
|
|
2128
|
+
_next = [max(used_numbers) + 1 if used_numbers else 1]
|
|
2129
|
+
|
|
2130
|
+
def mint():
|
|
2131
|
+
n = _next[0]; _next[0] += 1
|
|
2132
|
+
return "%s-%03d" % (feature, n)
|
|
2133
|
+
|
|
2134
|
+
# ---- the groups ------------------------------------------------------------------
|
|
2135
|
+
raw = (os.environ.get("AW_GROUPS") or "").strip()
|
|
2136
|
+
try:
|
|
2137
|
+
parsed = json.loads(raw) if raw else []
|
|
2138
|
+
except Exception as e:
|
|
2139
|
+
bail("backlog-plan: --groups is not valid JSON (%s)" % e)
|
|
2140
|
+
if isinstance(parsed, dict): parsed = parsed.get("groups") or []
|
|
2141
|
+
if not isinstance(parsed, list):
|
|
2142
|
+
bail("backlog-plan: --groups must be a JSON list of groups")
|
|
2143
|
+
|
|
2144
|
+
# Ids are read from the group's OWN requirements field, never scraped from its prose. A
|
|
2145
|
+
# rationale that mentions FR-004 as the reason two others belong together would otherwise
|
|
2146
|
+
# pull a third requirement into the story, and nothing downstream would question it.
|
|
2147
|
+
work = rids(os.environ.get("AW_WORK", ""))
|
|
2148
|
+
groups, dropped = [], []
|
|
2149
|
+
for i, g in enumerate(parsed):
|
|
2150
|
+
if not isinstance(g, dict): continue
|
|
2151
|
+
src = g.get("requirements")
|
|
2152
|
+
if isinstance(src, list): src = ", ".join(str(x) for x in src)
|
|
2153
|
+
ids = rids(src if src is not None else g.get("requirements_csv", ""))
|
|
2154
|
+
if work:
|
|
2155
|
+
outside = [x for x in ids if x not in work]
|
|
2156
|
+
dropped += outside
|
|
2157
|
+
ids = [x for x in ids if x in work]
|
|
2158
|
+
if not ids: continue
|
|
2159
|
+
# `depends_on` names OTHER GROUPS by key, or open stories already in the backlog by
|
|
2160
|
+
# id. Kept as raw tokens: a group key only becomes a story id once the plan has minted
|
|
2161
|
+
# one, so resolving here would have to guess at a name that does not exist yet.
|
|
2162
|
+
dep_src = g.get("depends_on")
|
|
2163
|
+
if dep_src is None: dep_src = g.get("depends_on_csv")
|
|
2164
|
+
if isinstance(dep_src, list): dep_src = ", ".join(str(x) for x in dep_src)
|
|
2165
|
+
deps_raw = [x for x in re.split(r'[,\s\[\]"\']+', str(dep_src or "")) if x.strip()]
|
|
2166
|
+
groups.append({"key": g.get("id") or ("g%d" % (i + 1)),
|
|
2167
|
+
"title": (g.get("title") or "").strip(),
|
|
2168
|
+
"rationale": (g.get("rationale") or "").strip(),
|
|
2169
|
+
"complexity": (g.get("complexity") or "").strip().lower(),
|
|
2170
|
+
"deps_raw": deps_raw,
|
|
2171
|
+
"ids": ids, "ids_csv": ", ".join(ids)})
|
|
2172
|
+
|
|
2173
|
+
# Every work-set id must land in exactly one group. One the model left out gets no story
|
|
2174
|
+
# and nothing says so; one it repeated gets two, each claiming the same requirement.
|
|
2175
|
+
placed = [x for g in groups for x in g["ids"]]
|
|
2176
|
+
repeated = sorted({x for x in placed if placed.count(x) > 1})
|
|
2177
|
+
|
|
2178
|
+
# A REPEATED ID IS RESOLVED HERE, not merely reported. Two groups both claiming one
|
|
2179
|
+
# requirement become two stories both claiming it, and "does this requirement still have
|
|
2180
|
+
# open stories" — the completeness rule — then answers for work that was never really
|
|
2181
|
+
# duplicated. The grouping is a judgment; the arithmetic over it is not. So the id stays in
|
|
2182
|
+
# the FIRST group that claimed it and leaves the rest, which is deterministic (the same
|
|
2183
|
+
# grouping always yields the same slices) and loses no coverage, because the id still
|
|
2184
|
+
# reaches exactly one story. repeated_notice reports what that touched.
|
|
2185
|
+
if repeated:
|
|
2186
|
+
seen_ids = set()
|
|
2187
|
+
for g in groups:
|
|
2188
|
+
keep_ids = [x for x in g["ids"] if x not in seen_ids]
|
|
2189
|
+
seen_ids.update(keep_ids)
|
|
2190
|
+
g["ids"], g["ids_csv"] = keep_ids, ", ".join(keep_ids)
|
|
2191
|
+
groups = [g for g in groups if g["ids"]]
|
|
2192
|
+
placed = [x for g in groups for x in g["ids"]]
|
|
2193
|
+
|
|
2194
|
+
missed = [x for x in work if x not in placed]
|
|
2195
|
+
|
|
2196
|
+
def candidates_of(g):
|
|
2197
|
+
"""Open stories standing in front of this group, each with what it already covers OF
|
|
2198
|
+
THIS GROUP — the intersection, not its whole citation list, because that is what the
|
|
2199
|
+
author is being asked to move."""
|
|
2200
|
+
out = []
|
|
2201
|
+
for s in open_stories:
|
|
2202
|
+
shared = [x for x in g["ids"] if x in s["cites"]]
|
|
2203
|
+
if not shared: continue
|
|
2204
|
+
out.append({"story": s["id"], "title": s["title"], "in_flight": s["in_flight"],
|
|
2205
|
+
"spec_version": s["spec_version"], "cites_csv": ", ".join(s["cites"]),
|
|
2206
|
+
"shared_csv": ", ".join(shared), "shared": shared,
|
|
2207
|
+
"group": g["key"], "group_title": g["title"], "group_ids_csv": g["ids_csv"],
|
|
2208
|
+
"action": "followon" if s["in_flight"] else "update"})
|
|
2209
|
+
return sorted(out, key=lambda c: c["story"])
|
|
2210
|
+
|
|
2211
|
+
base = {"ok": True, "feature": feature, "feature_dir": fd, "stories_dir": sdir,
|
|
2212
|
+
"group_count": len(groups), "groups": groups,
|
|
2213
|
+
"work_csv": ", ".join(work),
|
|
2214
|
+
"unplaced_csv": ", ".join(missed), "unplaced_count": len(missed),
|
|
2215
|
+
"repeated_csv": ", ".join(repeated), "repeated_count": len(repeated),
|
|
2216
|
+
"dropped_csv": ", ".join(sorted(set(dropped))),
|
|
2217
|
+
"groups_digest": "\n".join(
|
|
2218
|
+
" [%s] %s\n requirements: %s%s%s"
|
|
2219
|
+
% (g["key"], g["title"] or "(untitled)", g["ids_csv"],
|
|
2220
|
+
("\n stands behind: " + ", ".join(g["deps_raw"])) if g["deps_raw"] else "",
|
|
2221
|
+
("\n " + g["rationale"]) if g["rationale"] else "")
|
|
2222
|
+
for g in groups) or " (no groups)"}
|
|
2223
|
+
|
|
2224
|
+
# THE STRATEGY IS THE AUTHOR'S; THE ARITHMETIC OVER IT IS NOT. `single` asked for one story
|
|
2225
|
+
# covering the whole work set, and the grouping may still have returned several — because a
|
|
2226
|
+
# slice nobody can pick up is not a story, and splitting it is the honest answer. So the
|
|
2227
|
+
# split is REPORTED rather than refused or hidden: quietly handing six stories to someone
|
|
2228
|
+
# who asked for one is the kind of silent disobedience that makes an option not worth having.
|
|
2229
|
+
strategy = (os.environ.get("AW_STRATEGY") or "").strip().lower() or "auto"
|
|
2230
|
+
try:
|
|
2231
|
+
ceiling = int((os.environ.get("AW_CEILING") or "").strip() or 8)
|
|
2232
|
+
except ValueError:
|
|
2233
|
+
ceiling = 8
|
|
2234
|
+
oversized = [g["key"] for g in groups if len(g["ids"]) > ceiling]
|
|
2235
|
+
split_note, split_count = "", 0
|
|
2236
|
+
if strategy == "single" and len(groups) > 1:
|
|
2237
|
+
split_count = len(groups)
|
|
2238
|
+
split_note = ("one story was asked for and the work set was too heavy for one: it is "
|
|
2239
|
+
"split into %d, in dependency order — %s" % (len(groups), "; ".join(
|
|
2240
|
+
"[%s] %s (%s)" % (g["key"], g["title"] or "untitled", g["ids_csv"])
|
|
2241
|
+
for g in groups)))
|
|
2242
|
+
elif strategy == "single" and len(groups) == 1:
|
|
2243
|
+
split_note = ("one story was asked for and one covers the whole work set: %s"
|
|
2244
|
+
% groups[0]["ids_csv"])
|
|
2245
|
+
base.update(strategy=strategy, ceiling=ceiling, split_count=split_count,
|
|
2246
|
+
split_note=split_note, oversized_csv=", ".join(oversized))
|
|
2247
|
+
|
|
2248
|
+
if mode == "scan":
|
|
2249
|
+
cands = [c for g in groups for c in candidates_of(g)]
|
|
2250
|
+
lines = []
|
|
2251
|
+
for c in cands:
|
|
2252
|
+
lines.append(
|
|
2253
|
+
" %s (%s)\n"
|
|
2254
|
+
" group [%s] %s covers %s\n"
|
|
2255
|
+
" this story already covers %s of it, and cites %s in total\n"
|
|
2256
|
+
" %s"
|
|
2257
|
+
% (c["story"], c["title"] or "untitled",
|
|
2258
|
+
c["group"], c["group_title"] or "", c["group_ids_csv"],
|
|
2259
|
+
c["shared_csv"], c["cites_csv"],
|
|
2260
|
+
("ALREADY IN FLIGHT (story plan exists) — picking it mints a FOLLOW-ON "
|
|
2261
|
+
"carrying the change; this story is never rewritten"
|
|
2262
|
+
if c["in_flight"] else
|
|
2263
|
+
"not started (no story plan yet) — picking it rewrites this story to "
|
|
2264
|
+
"cover the whole group")))
|
|
2265
|
+
base.update(candidates=cands, candidate_count=len(cands),
|
|
2266
|
+
candidate_ids=[c["story"] for c in cands],
|
|
2267
|
+
candidate_csv=", ".join(c["story"] for c in cands),
|
|
2268
|
+
any_candidates=bool(cands),
|
|
2269
|
+
ask_digest="\n".join(lines) or " (no existing story covers any of these)")
|
|
2270
|
+
print(json.dumps(base)); sys.exit(0)
|
|
2271
|
+
|
|
2272
|
+
# ---- plan ------------------------------------------------------------------------
|
|
2273
|
+
approved = set(names(os.environ.get("AW_OK", "")))
|
|
2274
|
+
version = (os.environ.get("AW_VER") or "").strip()
|
|
2275
|
+
plan, skipped, notes = [], [], []
|
|
2276
|
+
for g in groups:
|
|
2277
|
+
cands = candidates_of(g)
|
|
2278
|
+
declined = [c for c in cands if c["story"] not in approved]
|
|
2279
|
+
# A declined story keeps its requirements: the author said do not disturb it, and
|
|
2280
|
+
# raising a second story over the same ids disturbs it just as thoroughly.
|
|
2281
|
+
held = {x for c in declined for x in c["shared"]}
|
|
2282
|
+
skipped += [c["story"] for c in declined]
|
|
2283
|
+
remaining = [x for x in g["ids"] if x not in held]
|
|
2284
|
+
taken = [c for c in cands if c["story"] in approved]
|
|
2285
|
+
|
|
2286
|
+
if taken:
|
|
2287
|
+
# ONE APPROVED STORY ABSORBS THE GROUP'S UNCLAIMED REQUIREMENTS — the first by id.
|
|
2288
|
+
# Every OTHER approved story keeps exactly the ids it already cites, so those ids
|
|
2289
|
+
# are RESERVED out of what the carrier gains: two open stories both claiming one
|
|
2290
|
+
# requirement is not a state the completeness rule can read, and the run would have
|
|
2291
|
+
# created that state itself rather than merely reporting it.
|
|
2292
|
+
carrier = taken[0]; s = by_id[carrier["story"]]
|
|
2293
|
+
reserved = {x for c in taken[1:] for x in c["shared"]}
|
|
2294
|
+
gained = [x for x in remaining if x not in reserved]
|
|
2295
|
+
if carrier["in_flight"]:
|
|
2296
|
+
# §5.5 — the original stays open and unchanged, and closes having delivered
|
|
2297
|
+
# what it was written to deliver. The follow-on carries the remainder.
|
|
2298
|
+
carry = [x for x in g["ids"] if x in s["cites"] or x in gained]
|
|
2299
|
+
carry = [x for x in carry if x not in held]
|
|
2300
|
+
sid = mint()
|
|
2301
|
+
plan.append({"action": "followon", "story": sid, "follows": carrier["story"],
|
|
2302
|
+
"path": os.path.join(sdir, sid + ".md"),
|
|
2303
|
+
"requirements_csv": ", ".join(carry), "existing_csv": "",
|
|
2304
|
+
"prior_csv": ", ".join(s["cites"]), "prior_title": s["title"],
|
|
2305
|
+
"prior_path": s["path"],
|
|
2306
|
+
"group": g["key"], "group_title": g["title"],
|
|
2307
|
+
"group_ids_csv": g["ids_csv"], "complexity": g["complexity"],
|
|
2308
|
+
"rationale": g["rationale"], "spec_version": version})
|
|
2309
|
+
else:
|
|
2310
|
+
keep = sorted(set(s["cites"]) | set(gained),
|
|
2311
|
+
key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
2312
|
+
plan.append({"action": "update", "story": s["id"], "follows": "",
|
|
2313
|
+
"path": s["path"],
|
|
2314
|
+
"requirements_csv": ", ".join(keep),
|
|
2315
|
+
"existing_csv": ", ".join(s["cites"]),
|
|
2316
|
+
"prior_csv": ", ".join(s["cites"]), "prior_title": s["title"],
|
|
2317
|
+
"prior_path": s["path"],
|
|
2318
|
+
"group": g["key"], "group_title": g["title"],
|
|
2319
|
+
"group_ids_csv": g["ids_csv"], "complexity": g["complexity"],
|
|
2320
|
+
"rationale": g["rationale"], "spec_version": version})
|
|
2321
|
+
carrier_sid = plan[-1]["story"]
|
|
2322
|
+
for c in taken[1:]:
|
|
2323
|
+
s2 = by_id[c["story"]]
|
|
2324
|
+
if c["in_flight"]:
|
|
2325
|
+
# AN IN-FLIGHT STORY IS NEVER REWRITTEN, whatever position it holds in the
|
|
2326
|
+
# group. Its story plan was derived from this body, and
|
|
2327
|
+
# rewriting the body leaves the three disagreeing with nothing to say so —
|
|
2328
|
+
# which is the whole reason §5.5 exists. Being second in a group is not a
|
|
2329
|
+
# different situation from being first, so it gets the same answer: its own
|
|
2330
|
+
# follow-on, carrying the ids it already covers of this group.
|
|
2331
|
+
#
|
|
2332
|
+
# That link is also what clears its staleness. ledger-read discounts an
|
|
2333
|
+
# in-flight story once an open story whose `follows` names it cites the same
|
|
2334
|
+
# id; skipping it instead would leave it stale forever and re-offered on
|
|
2335
|
+
# every run.
|
|
2336
|
+
carry2 = [x for x in c["shared"] if x not in held]
|
|
2337
|
+
if not carry2:
|
|
2338
|
+
notes.append("%s was approved and is in flight, but every requirement "
|
|
2339
|
+
"it covers of group [%s] is held by a story left "
|
|
2340
|
+
"untouched; nothing to carry" % (c["story"], g["key"]))
|
|
2341
|
+
continue
|
|
2342
|
+
sid2 = mint()
|
|
2343
|
+
notes.append("%s was approved and is IN FLIGHT, so it is not rewritten; "
|
|
2344
|
+
"%s carries %s forward from it, while %s takes the group's "
|
|
2345
|
+
"unclaimed requirements"
|
|
2346
|
+
% (c["story"], sid2, ", ".join(carry2), carrier_sid))
|
|
2347
|
+
plan.append({"action": "followon", "story": sid2, "follows": c["story"],
|
|
2348
|
+
"path": os.path.join(sdir, sid2 + ".md"),
|
|
2349
|
+
"requirements_csv": ", ".join(carry2), "existing_csv": "",
|
|
2350
|
+
"prior_csv": ", ".join(s2["cites"]), "prior_title": s2["title"],
|
|
2351
|
+
"prior_path": s2["path"],
|
|
2352
|
+
"group": g["key"], "group_title": g["title"],
|
|
2353
|
+
"group_ids_csv": g["ids_csv"], "complexity": g["complexity"],
|
|
2354
|
+
"rationale": g["rationale"], "spec_version": version})
|
|
2355
|
+
continue
|
|
2356
|
+
notes.append("%s was approved but %s takes the group's unclaimed requirements; "
|
|
2357
|
+
"%s is refreshed against the current spec without gaining ids"
|
|
2358
|
+
% (c["story"], carrier_sid, c["story"]))
|
|
2359
|
+
plan.append({"action": "update", "story": s2["id"], "follows": "",
|
|
2360
|
+
"path": s2["path"],
|
|
2361
|
+
"requirements_csv": ", ".join(s2["cites"]),
|
|
2362
|
+
"existing_csv": ", ".join(s2["cites"]),
|
|
2363
|
+
"prior_csv": ", ".join(s2["cites"]), "prior_title": s2["title"],
|
|
2364
|
+
"prior_path": s2["path"],
|
|
2365
|
+
"group": g["key"], "group_title": g["title"],
|
|
2366
|
+
"group_ids_csv": g["ids_csv"], "complexity": g["complexity"],
|
|
2367
|
+
"rationale": g["rationale"], "spec_version": version})
|
|
2368
|
+
elif remaining:
|
|
2369
|
+
sid = mint()
|
|
2370
|
+
# A REQUIREMENT WHOSE ONLY STORIES ARE CLOSED RE-ENTERS THE WORK SET, and that is
|
|
2371
|
+
# right: a version row above the closed story's stamp means the contract moved
|
|
2372
|
+
# AFTER it shipped, so what shipped is no longer what the spec asks for. It reads
|
|
2373
|
+
# as duplicated work to anyone who remembers delivering it, so the run names the
|
|
2374
|
+
# story it is re-opening against rather than leaving them to find it.
|
|
2375
|
+
shipped = ["%s (%s)" % (d["id"], ", ".join(x for x in remaining if x in d["cites"]))
|
|
2376
|
+
for d in done_stories if any(x in d["cites"] for x in remaining)]
|
|
2377
|
+
if shipped:
|
|
2378
|
+
notes.append("%s covers requirements already delivered by %s — the spec moved "
|
|
2379
|
+
"after those closed, so this is the change, not a repeat"
|
|
2380
|
+
% (sid, "; ".join(shipped)))
|
|
2381
|
+
plan.append({"action": "create", "story": sid, "follows": "",
|
|
2382
|
+
"path": os.path.join(sdir, sid + ".md"),
|
|
2383
|
+
"requirements_csv": ", ".join(remaining), "existing_csv": "",
|
|
2384
|
+
"prior_csv": "", "prior_title": "", "prior_path": "",
|
|
2385
|
+
"group": g["key"], "group_title": g["title"],
|
|
2386
|
+
"group_ids_csv": g["ids_csv"], "complexity": g["complexity"],
|
|
2387
|
+
"rationale": g["rationale"], "spec_version": version})
|
|
2388
|
+
else:
|
|
2389
|
+
notes.append("group [%s] (%s) is entirely covered by stories left untouched; "
|
|
2390
|
+
"nothing to write" % (g["key"], g["ids_csv"]))
|
|
2391
|
+
|
|
2392
|
+
# ---- waves: the order these stories can actually be picked up in -------------------
|
|
2393
|
+
# The grouping declared which slices stand behind which; turning that into an order is
|
|
2394
|
+
# arithmetic, so it happens here and not in the prompt — the same grouping always yields
|
|
2395
|
+
# the same waves.
|
|
2396
|
+
#
|
|
2397
|
+
# A WAVE IS AN ELIGIBILITY LEVEL, NOT A SCHEDULE. Wave N means every story this one depends
|
|
2398
|
+
# on sits in a wave below N. Two stories in the SAME wave therefore have no dependency
|
|
2399
|
+
# between them and may be picked up in parallel; it does not say they start together, and
|
|
2400
|
+
# nothing waits for a whole wave to finish. That is also why the number is not a priority:
|
|
2401
|
+
# wave 1 is "nothing blocks this", not "do this first".
|
|
2402
|
+
#
|
|
2403
|
+
# THE EDGE SET IS A UNION of what the grouping declared and what an updated story already
|
|
2404
|
+
# carries in `depends_on:`. The sync sees one feature's spec; an edge someone added by hand
|
|
2405
|
+
# may name work it has no view of, and dropping it would silently un-order real work. Both
|
|
2406
|
+
# are claims about CODE ordering, and the union is exactly what the story ends up citing —
|
|
2407
|
+
# so the wave and the frontmatter cannot disagree about what stands in front of what.
|
|
2408
|
+
#
|
|
2409
|
+
# `follows:` is NOT an edge. A follow-on carries the remainder of a story in flight, and the
|
|
2410
|
+
# remainder is often buildable alongside it — §5.5 asks the author to say in Notes which
|
|
2411
|
+
# half has to land first. Making it an implicit edge would put an ordering in the waves that
|
|
2412
|
+
# no frontmatter field explains.
|
|
2413
|
+
entries_of, by_story = {}, {}
|
|
2414
|
+
for e in plan:
|
|
2415
|
+
entries_of.setdefault(e["group"], []).append(e["story"]); by_story[e["story"]] = e
|
|
2416
|
+
preds = {e["story"]: set() for e in plan}
|
|
2417
|
+
external, unresolved = {}, [] # stories outside this run, at the wave they declare
|
|
2418
|
+
|
|
2419
|
+
for g in groups:
|
|
2420
|
+
tgt = entries_of.get(g["key"], [])
|
|
2421
|
+
if not tgt: continue # the group wrote nothing; its edges order nothing
|
|
2422
|
+
for tok in g["deps_raw"]:
|
|
2423
|
+
tok = tok.strip()
|
|
2424
|
+
if not tok or tok == g["key"]: continue
|
|
2425
|
+
if tok in entries_of:
|
|
2426
|
+
src = entries_of[tok]
|
|
2427
|
+
elif tok in by_id and by_id[tok]["status"] == "open":
|
|
2428
|
+
external[tok] = by_id[tok]["wave"]; src = [tok]
|
|
2429
|
+
else:
|
|
2430
|
+
unresolved.append("%s (named by group [%s])" % (tok, g["key"])); continue
|
|
2431
|
+
for x in tgt: preds[x].update(s for s in src if s != x)
|
|
2432
|
+
|
|
2433
|
+
for e in plan:
|
|
2434
|
+
if e["action"] != "update": continue
|
|
2435
|
+
for d in by_id.get(e["story"], {}).get("deps", []):
|
|
2436
|
+
if d == e["story"] or d in preds[e["story"]]: continue
|
|
2437
|
+
if d not in preds: external[d] = by_id[d]["wave"] if d in by_id else 1
|
|
2438
|
+
preds[e["story"]].add(d)
|
|
2439
|
+
|
|
2440
|
+
# A CYCLE IS REJECTED AT AUTHORING TIME (§6.1), and this is where it would be authored.
|
|
2441
|
+
# Depth-first over a sorted node order, dropping the one edge that closes each cycle: only
|
|
2442
|
+
# edges that actually close one are lost, and the choice is deterministic — the same
|
|
2443
|
+
# grouping always breaks the same edge. Reported, because a dropped edge was a real claim
|
|
2444
|
+
# about ordering and the cycle it sat in is a fact about the slicing, not a glitch.
|
|
2445
|
+
cycles, state = [], {}
|
|
2446
|
+
def walk(node):
|
|
2447
|
+
state[node] = 1
|
|
2448
|
+
for m in sorted(preds.get(node, ())):
|
|
2449
|
+
if state.get(m) == 1:
|
|
2450
|
+
preds[node].discard(m); cycles.append("%s -> %s" % (node, m)); continue
|
|
2451
|
+
if state.get(m) != 2 and m in preds: walk(m)
|
|
2452
|
+
state[node] = 2
|
|
2453
|
+
for node in sorted(preds):
|
|
2454
|
+
if state.get(node) != 2: walk(node)
|
|
2455
|
+
|
|
2456
|
+
# Longest path from a root, relaxed to a fixed point. A story with no dependency is wave 1,
|
|
2457
|
+
# which is what puts every independent story in the same wave.
|
|
2458
|
+
wave = dict(external)
|
|
2459
|
+
for _ in range(len(preds) + 1):
|
|
2460
|
+
moved = False
|
|
2461
|
+
for node in sorted(preds):
|
|
2462
|
+
w = 1 + max([wave.get(m, 1) for m in preds[node]] or [0])
|
|
2463
|
+
if wave.get(node) != w: wave[node] = w; moved = True
|
|
2464
|
+
if not moved: break
|
|
2465
|
+
for e in plan:
|
|
2466
|
+
e["wave"] = wave.get(e["story"], 1)
|
|
2467
|
+
e["depends_on_csv"] = ", ".join(sorted(preds.get(e["story"], ())))
|
|
2468
|
+
|
|
2469
|
+
# Written in wave order, so a run that meets the cap writes the stories that can be STARTED
|
|
2470
|
+
# rather than an arbitrary prefix of them. The story id is not the order — the wave is.
|
|
2471
|
+
plan.sort(key=lambda e: (e["wave"], e["story"]))
|
|
2472
|
+
for i, e in enumerate(plan): e["seq"] = i + 1
|
|
2473
|
+
|
|
2474
|
+
waves = {}
|
|
2475
|
+
for e in plan: waves.setdefault(e["wave"], []).append(e["story"])
|
|
2476
|
+
wave_digest = "\n".join(" wave %d: %s" % (w, ", ".join(waves[w]))
|
|
2477
|
+
for w in sorted(waves)) or " (nothing to write)"
|
|
2478
|
+
if unresolved:
|
|
2479
|
+
notes.append("the grouping named dependencies matching no slice and no open story, so "
|
|
2480
|
+
"they set no order: %s" % "; ".join(sorted(set(unresolved))))
|
|
2481
|
+
if cycles:
|
|
2482
|
+
notes.append("slices were declared to depend on each other in a cycle; the edge closing "
|
|
2483
|
+
"each one is dropped, because a backlog with no order at all is worse than "
|
|
2484
|
+
"one missing an edge someone can re-add: %s" % ", ".join(cycles))
|
|
2485
|
+
|
|
2486
|
+
# THE WRITE LOOP HAS A CEILING AND THE ENGINE DOES NOT SAY WHEN IT HITS IT — `over:` stops
|
|
2487
|
+
# at max_iterations with no message, so plan entries past it are simply never written and
|
|
2488
|
+
# the run reports success. The caller passes its own ceiling here so the overflow is named
|
|
2489
|
+
# while the story ids still exist to name. Nothing is dropped from the plan: the ids are
|
|
2490
|
+
# reported and the entries stay, so raising the cap and re-running writes them.
|
|
2491
|
+
try:
|
|
2492
|
+
cap = int((os.environ.get("AW_CAP") or "").strip() or 0)
|
|
2493
|
+
except ValueError:
|
|
2494
|
+
cap = 0
|
|
2495
|
+
overflow = [e["story"] for e in plan[cap:]] if cap > 0 else []
|
|
2496
|
+
|
|
2497
|
+
counts = {a: sum(1 for e in plan if e["action"] == a) for a in ("create", "update", "followon")}
|
|
2498
|
+
base.update(plan=plan, plan_count=len(plan), any_plan=bool(plan),
|
|
2499
|
+
cap=cap, overflow_csv=", ".join(overflow), overflow_count=len(overflow),
|
|
2500
|
+
create_count=counts["create"], update_count=counts["update"],
|
|
2501
|
+
followon_count=counts["followon"],
|
|
2502
|
+
skipped_csv=", ".join(sorted(set(skipped))),
|
|
2503
|
+
stories_csv=", ".join(e["story"] for e in plan),
|
|
2504
|
+
wave_digest=wave_digest, wave_count=len(waves),
|
|
2505
|
+
max_wave=(max(waves) if waves else 0),
|
|
2506
|
+
cycle_csv=", ".join(cycles),
|
|
2507
|
+
unresolved_deps_csv=", ".join(sorted(set(unresolved))),
|
|
2508
|
+
notes=notes, notes_text="\n".join(" - " + n for n in notes),
|
|
2509
|
+
plan_digest="\n".join(
|
|
2510
|
+
" w%-3d %-9s %-16s %s%s%s"
|
|
2511
|
+
% (e["wave"], e["action"], e["story"], e["requirements_csv"],
|
|
2512
|
+
(" (follows %s)" % e["follows"]) if e["follows"] else "",
|
|
2513
|
+
(" [after %s]" % e["depends_on_csv"]) if e["depends_on_csv"] else "")
|
|
2514
|
+
for e in plan) or " (nothing to write)")
|
|
2515
|
+
print(json.dumps(base))
|
|
2516
|
+
PY
|
|
2517
|
+
}
|
|
2518
|
+
|
|
2519
|
+
# ─────────────────────────────── story-stamp ───────────────────────────────
|
|
2520
|
+
# The story's frontmatter is the gate surface — `exercises:`, `spec_version:`, `status:`
|
|
2521
|
+
# and `follows:` are what spec-coverage, check-stories, analyze-slice and close-story read,
|
|
2522
|
+
# and none of them opens the body. So those fields are OBSERVED and written by the kit, not
|
|
2523
|
+
# declared by the model that wrote the prose, for the same reason the Change History row is
|
|
2524
|
+
# computed rather than announced: a model that drops one id from `exercises:` produces a
|
|
2525
|
+
# story that reads perfectly and is invisible to every gate built to protect it. Silent,
|
|
2526
|
+
# and in the one field where silence costs the most.
|
|
2527
|
+
#
|
|
2528
|
+
# Everything else in the block is left exactly as the author wrote it, and a key the file
|
|
2529
|
+
# is missing is appended in template order rather than the block being rebuilt — a story
|
|
2530
|
+
# carrying a work_item or a depends_on must not lose it to a stamp.
|
|
2531
|
+
cmd_story_stamp() {
|
|
2532
|
+
local fd_arg="" story="" ids="" version="" follows="" ids_given="" title="" deps="" wave=""
|
|
2533
|
+
while [ $# -gt 0 ]; do
|
|
2534
|
+
case "$1" in
|
|
2535
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
2536
|
+
--story) story="$2"; shift 2 ;;
|
|
2537
|
+
--ids) ids="$2"; ids_given=1; shift 2 ;;
|
|
2538
|
+
--version) version="$2"; shift 2 ;;
|
|
2539
|
+
--follows) follows="$2"; shift 2 ;;
|
|
2540
|
+
--title) title="$2"; shift 2 ;;
|
|
2541
|
+
--depends-on) deps="$2"; shift 2 ;;
|
|
2542
|
+
--wave) wave="$2"; shift 2 ;;
|
|
2543
|
+
--help|-h) echo "story-stamp --story <id> [--ids <csv>] [--version <v>] [--follows <id>] [--title <t>] [--depends-on <csv>] [--wave <n>] [--feature-dir <p>]"; return 0 ;;
|
|
2544
|
+
*) echo "story-stamp: unknown arg '$1'" >&2; return 1 ;;
|
|
2545
|
+
esac
|
|
2546
|
+
done
|
|
2547
|
+
[ -n "$story" ] || { echo "story-stamp: --story is required" >&2; return 1; }
|
|
2548
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
2549
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "story-stamp: no feature set and no --feature-dir" >&2; return 1; }
|
|
2550
|
+
AW_FD="$fd" AW_STORY="$story" AW_IDS="$ids" AW_IDS_GIVEN="$ids_given" \
|
|
2551
|
+
AW_VER="$version" AW_FOLLOWS="$follows" AW_TITLE="$title" \
|
|
2552
|
+
AW_DEPS="$deps" AW_WAVE="$wave" python3 - <<'PY'
|
|
2553
|
+
import json, os, re, sys, datetime
|
|
2554
|
+
fd = os.environ["AW_FD"]; story = os.environ["AW_STORY"].strip()
|
|
2555
|
+
path = os.path.join(fd, "stories", story + ".md")
|
|
2556
|
+
|
|
2557
|
+
def bail(msg, code=2):
|
|
2558
|
+
print(json.dumps({"ok": False, "story": story, "path": path, "error": msg}))
|
|
2559
|
+
sys.stderr.write(msg + "\n"); sys.exit(code)
|
|
2560
|
+
|
|
2561
|
+
if not os.path.isfile(path):
|
|
2562
|
+
bail("story-stamp: no story file at %s — the authoring step did not write it" % path)
|
|
2563
|
+
|
|
2564
|
+
def rids(s):
|
|
2565
|
+
seen, out = set(), []
|
|
2566
|
+
for t in re.findall(r'\b(?:FR|BR)-\d+', s or ""):
|
|
2567
|
+
if t not in seen: seen.add(t); out.append(t)
|
|
2568
|
+
return sorted(out, key=lambda r: (r.split("-")[0], int(r.split("-")[1])))
|
|
2569
|
+
|
|
2570
|
+
def sids(s):
|
|
2571
|
+
"""Story ids out of a csv or an inline list. A story id is a feature name and a number;
|
|
2572
|
+
the template's placeholders are neither, and must not become a dependency edge."""
|
|
2573
|
+
seen, out = set(), []
|
|
2574
|
+
for t in re.split(r'[,\s\[\]"\']+', s or ""):
|
|
2575
|
+
t = t.strip()
|
|
2576
|
+
if re.match(r'^[A-Za-z][\w.]*-\d+$', t) and t not in seen:
|
|
2577
|
+
seen.add(t); out.append(t)
|
|
2578
|
+
return out
|
|
2579
|
+
|
|
2580
|
+
text = open(path, encoding="utf-8", errors="replace").read()
|
|
2581
|
+
m = re.match(r'^---\s*\n(.*?)\n---\s*\n', text, re.S)
|
|
2582
|
+
if m:
|
|
2583
|
+
block, body = m.group(1), text[m.end():]
|
|
2584
|
+
else:
|
|
2585
|
+
# A model that returned the prose and no frontmatter leaves a story every gate skips.
|
|
2586
|
+
# Synthesised rather than refused: the body is the expensive half and it is already on
|
|
2587
|
+
# disk, and the fields below are exactly the ones this op is authoritative for.
|
|
2588
|
+
block, body = "", text.lstrip("\n")
|
|
2589
|
+
|
|
2590
|
+
# The block as an ordered list of (key, rendered line), so an unrecognised key and its
|
|
2591
|
+
# continuation lines survive untouched.
|
|
2592
|
+
lines = block.split("\n") if block else []
|
|
2593
|
+
order, seen_key = [], None
|
|
2594
|
+
for line in lines:
|
|
2595
|
+
km = re.match(r'^([A-Za-z_]+):\s*(.*)$', line)
|
|
2596
|
+
if km:
|
|
2597
|
+
seen_key = km.group(1); order.append([seen_key, [line]])
|
|
2598
|
+
elif order and (line.startswith(" ") or line.startswith("\t")):
|
|
2599
|
+
order[-1][1].append(line) # a block-list item under the key above
|
|
2600
|
+
elif line.strip():
|
|
2601
|
+
order.append([None, [line]])
|
|
2602
|
+
|
|
2603
|
+
def put(key, value):
|
|
2604
|
+
"""Set a key to a single-line value, collapsing a block list into the inline form."""
|
|
2605
|
+
line = ("%s: %s" % (key, value)) if value != "" else ("%s:" % key)
|
|
2606
|
+
for entry in order:
|
|
2607
|
+
if entry[0] == key:
|
|
2608
|
+
entry[1] = [line]
|
|
2609
|
+
return "set"
|
|
2610
|
+
order.append([key, [line]])
|
|
2611
|
+
return "added"
|
|
2612
|
+
|
|
2613
|
+
TEMPLATE_ORDER = ["id", "type", "status", "title", "exercises", "spec_version",
|
|
2614
|
+
"depends_on", "wave", "follows", "work_item", "created"]
|
|
2615
|
+
def get(key):
|
|
2616
|
+
for entry in order:
|
|
2617
|
+
if entry[0] == key: return entry[1][0].split(":", 1)[1].strip()
|
|
2618
|
+
return ""
|
|
2619
|
+
|
|
2620
|
+
changed = {}
|
|
2621
|
+
changed["id"] = put("id", story)
|
|
2622
|
+
|
|
2623
|
+
if os.environ.get("AW_IDS_GIVEN"):
|
|
2624
|
+
ids = rids(os.environ.get("AW_IDS", ""))
|
|
2625
|
+
changed["exercises"] = put("exercises", "[" + ", ".join(ids) + "]")
|
|
2626
|
+
else:
|
|
2627
|
+
ids = rids(get("exercises"))
|
|
2628
|
+
|
|
2629
|
+
ver = (os.environ.get("AW_VER") or "").strip()
|
|
2630
|
+
if ver: changed["spec_version"] = put("spec_version", ver)
|
|
2631
|
+
|
|
2632
|
+
fol = (os.environ.get("AW_FOLLOWS") or "").strip()
|
|
2633
|
+
if fol: changed["follows"] = put("follows", fol)
|
|
2634
|
+
|
|
2635
|
+
ttl = (os.environ.get("AW_TITLE") or "").strip()
|
|
2636
|
+
if ttl and (not get("title") or get("title").startswith("[")):
|
|
2637
|
+
changed["title"] = put("title", ttl)
|
|
2638
|
+
|
|
2639
|
+
# Placeholders the template ships. Left alone once a real value is in them, so a story
|
|
2640
|
+
# CLOSED between the plan and the write is not quietly re-opened by a stamp.
|
|
2641
|
+
if not get("type") or get("type").startswith("["):
|
|
2642
|
+
changed["type"] = put("type", "functional" if ids else "technical")
|
|
2643
|
+
if not get("status") or get("status").startswith("["):
|
|
2644
|
+
changed["status"] = put("status", "open")
|
|
2645
|
+
# ORDERING IS A UNION, NEVER A REPLACEMENT. The edges passed in are what this run's slicing
|
|
2646
|
+
# declared; the ones already in the file may name work outside this feature, which the sync
|
|
2647
|
+
# cannot see. Dropping either loses a real claim about what has to land first, and a lost
|
|
2648
|
+
# edge is silent — no later stage re-derives it.
|
|
2649
|
+
deps = sorted(set(sids(get("depends_on")) + sids(os.environ.get("AW_DEPS", ""))) - {story})
|
|
2650
|
+
if deps or not get("depends_on") or get("depends_on").startswith("["):
|
|
2651
|
+
changed["depends_on"] = put("depends_on", "[" + ", ".join(deps) + "]")
|
|
2652
|
+
|
|
2653
|
+
# THE WAVE IS AN ELIGIBILITY LEVEL, NOT A PRIORITY: every story this one depends on sits in
|
|
2654
|
+
# a lower one, so stories sharing a wave have no ordering between them and may be picked up
|
|
2655
|
+
# in parallel. Computed by backlog-plan from `depends_on`, and written here for the same
|
|
2656
|
+
# reason `exercises:` is — a field the gates and the listings read is observed, not declared.
|
|
2657
|
+
# A story stamped without one floors at 1: nothing is KNOWN to have to land before it.
|
|
2658
|
+
wv = (os.environ.get("AW_WAVE") or "").strip()
|
|
2659
|
+
if wv.isdigit():
|
|
2660
|
+
changed["wave"] = put("wave", wv)
|
|
2661
|
+
elif not get("wave").isdigit():
|
|
2662
|
+
changed["wave"] = put("wave", "1")
|
|
2663
|
+
if not get("created") or get("created").startswith("["):
|
|
2664
|
+
changed["created"] = put("created", datetime.date.today().isoformat())
|
|
2665
|
+
for k in ("title", "follows", "work_item"):
|
|
2666
|
+
if not any(e[0] == k for e in order): put(k, "")
|
|
2667
|
+
|
|
2668
|
+
# Rendered back in template order, with anything unrecognised kept after it in the order it
|
|
2669
|
+
# was written. A story is read by people as well as by gates.
|
|
2670
|
+
rank = {k: i for i, k in enumerate(TEMPLATE_ORDER)}
|
|
2671
|
+
order.sort(key=lambda e: rank.get(e[0], len(TEMPLATE_ORDER)))
|
|
2672
|
+
out_block = "\n".join(l for e in order for l in e[1])
|
|
2673
|
+
open(path, "w", encoding="utf-8").write("---\n" + out_block + "\n---\n\n" + body.lstrip("\n"))
|
|
2674
|
+
|
|
2675
|
+
print(json.dumps({"ok": True, "story": story, "path": path,
|
|
2676
|
+
"exercises": ids, "exercises_csv": ", ".join(ids),
|
|
2677
|
+
"spec_version": get("spec_version"), "status": get("status"),
|
|
2678
|
+
"depends_on": get("depends_on"), "wave": get("wave"),
|
|
2679
|
+
"follows": get("follows"), "title": get("title"),
|
|
2680
|
+
"type": get("type"), "had_frontmatter": bool(m),
|
|
2681
|
+
"fields": sorted(changed)}))
|
|
2682
|
+
PY
|
|
2683
|
+
}
|
|
2684
|
+
|
|
1546
2685
|
# ────────────────────────────── spec-preserve ──────────────────────────────
|
|
1547
2686
|
# Set subtraction with a purpose: of the requirements this run disturbed, which ones was
|
|
1548
2687
|
# it NOT given permission to change. The approved list comes from a multi-select ask, so
|
|
@@ -1624,7 +2763,7 @@ PY
|
|
|
1624
2763
|
#
|
|
1625
2764
|
# Deriving the row this way is what makes it trustworthy. A row the model declares can
|
|
1626
2765
|
# omit a requirement the converge loop rewrote on its way past — and an omitted id is
|
|
1627
|
-
# the silent case the whole ledger exists to prevent, since
|
|
2766
|
+
# the silent case the whole ledger exists to prevent, since sync-stories would never
|
|
1628
2767
|
# learn that requirement moved. A row computed from the diff cannot omit one.
|
|
1629
2768
|
#
|
|
1630
2769
|
# Ids are read in both shapes the template uses: the bold form of the list sections
|
|
@@ -1772,7 +2911,7 @@ reissued = sorted(set(added) & spent(snap))
|
|
|
1772
2911
|
# THE STORY-FACING SUBSET. A story cites FR- and BR- ids and nothing else, so those are the
|
|
1773
2912
|
# only classes the backlog can act on — the same scoping spec-coverage applies, for the same
|
|
1774
2913
|
# reason. The scan is deliberately class-blind (CN-/DC-/IC-/UX-/SC- all move the contract and
|
|
1775
|
-
# all belong in the ledger row), but handing that whole set to
|
|
2914
|
+
# all belong in the ledger row), but handing that whole set to sync-stories as "the
|
|
1776
2915
|
# requirements this run touched" asks it to raise a story for a success criterion.
|
|
1777
2916
|
STORY_CLASS = ("FR-", "BR-")
|
|
1778
2917
|
story_ids = [c for c in changed if c.startswith(STORY_CLASS)]
|
|
@@ -1795,7 +2934,7 @@ print(json.dumps({
|
|
|
1795
2934
|
# spec on disk that the next run's entry check would refuse too.
|
|
1796
2935
|
"reissued": reissued, "reissued_csv": ", ".join(reissued),
|
|
1797
2936
|
"reissued_any": bool(reissued),
|
|
1798
|
-
# changed, narrowed to the classes a story can cite — what
|
|
2937
|
+
# changed, narrowed to the classes a story can cite — what sync-stories works from.
|
|
1799
2938
|
"story_ids": story_ids, "story_ids_csv": ", ".join(story_ids),
|
|
1800
2939
|
"story_id_count": len(story_ids),
|
|
1801
2940
|
}))
|
|
@@ -1857,6 +2996,7 @@ cmd_feature_paths() {
|
|
|
1857
2996
|
# design.ui.md (adopt today) enrolls the feature in the UI half of the delta loop
|
|
1858
2997
|
# by the act of writing the file.
|
|
1859
2998
|
local spec="$fd/spec.md" design="$fd/design.md" ui_design="$fd/design.ui.md"
|
|
2999
|
+
local backend_plan="$fd/backend-plan.md" frontend_plan="$fd/frontend-plan.md"
|
|
1860
3000
|
# needs_bootstrap, not spec_exists, is what picks specify's branch. A crashed first run
|
|
1861
3001
|
# leaves spec.md on disk with the marker still up, and branching on the file alone read
|
|
1862
3002
|
# that as a spec to EXTEND — re-applying the same input over an unfinished v1.0.
|
|
@@ -1865,12 +3005,15 @@ cmd_feature_paths() {
|
|
|
1865
3005
|
local spec_exists=false; [ -f "$spec" ] && spec_exists=true
|
|
1866
3006
|
local design_exists=false; [ -f "$design" ] && design_exists=true
|
|
1867
3007
|
local ui_design_exists=false; [ -f "$ui_design" ] && ui_design_exists=true
|
|
3008
|
+
local backend_plan_exists=false; [ -f "$backend_plan" ] && backend_plan_exists=true
|
|
3009
|
+
local frontend_plan_exists=false; [ -f "$frontend_plan" ] && frontend_plan_exists=true
|
|
1868
3010
|
local needs_bootstrap=false
|
|
1869
3011
|
[ "$spec_exists" = false ] && needs_bootstrap=true
|
|
1870
3012
|
[ "$bootstrap_pending" = true ] && needs_bootstrap=true
|
|
1871
|
-
printf '{"feature":"%s","feature_dir":"%s","spec_file":"%s","design_file":"%s","ui_design_file":"%s","spec_exists":%s,"design_exists":%s,"ui_design_exists":%s,"bootstrap_pending":%s,"needs_bootstrap":%s}\n' \
|
|
3013
|
+
printf '{"feature":"%s","feature_dir":"%s","spec_file":"%s","design_file":"%s","ui_design_file":"%s","backend_plan_file":"%s","frontend_plan_file":"%s","spec_exists":%s,"design_exists":%s,"ui_design_exists":%s,"backend_plan_exists":%s,"frontend_plan_exists":%s,"bootstrap_pending":%s,"needs_bootstrap":%s}\n' \
|
|
1872
3014
|
"$(json_escape "$feature")" "$(json_escape "$fd")" "$(json_escape "$spec")" "$(json_escape "$design")" \
|
|
1873
|
-
"$(json_escape "$ui_design")" "$
|
|
3015
|
+
"$(json_escape "$ui_design")" "$(json_escape "$backend_plan")" "$(json_escape "$frontend_plan")" \
|
|
3016
|
+
"$spec_exists" "$design_exists" "$ui_design_exists" "$backend_plan_exists" "$frontend_plan_exists" \
|
|
1874
3017
|
"$bootstrap_pending" "$needs_bootstrap"
|
|
1875
3018
|
}
|
|
1876
3019
|
|
|
@@ -2920,15 +4063,21 @@ cmd_design_scaffold() {
|
|
|
2920
4063
|
# Priority-1), so the defaults already yield the as-built structure for
|
|
2921
4064
|
# forward `design` and adopt alike, and this is rarely needed.
|
|
2922
4065
|
--template) template_arg="$2"; shift 2 ;;
|
|
2923
|
-
--help|-h) echo "design-scaffold --feature-dir <path> [--lane service|ui] [--template <name>]"; return 0 ;;
|
|
4066
|
+
--help|-h) echo "design-scaffold --feature-dir <path> [--lane service|ui|backend|frontend] [--template <name>]"; return 0 ;;
|
|
2924
4067
|
*) echo "design-scaffold: unknown arg '$1'" >&2; return 1 ;;
|
|
2925
4068
|
esac
|
|
2926
4069
|
done
|
|
2927
|
-
|
|
4070
|
+
# backend/frontend are the PLAN-phase pairs: the same templates, the plan document
|
|
4071
|
+
# names, and a MIGRATION — a legacy design.md / design.ui.md is RENAMED into the
|
|
4072
|
+
# plan name so a feature never carries both spellings of the same master.
|
|
4073
|
+
# service/ui stay byte-identical for their existing callers (adopt, the delta chain).
|
|
4074
|
+
local doc_name legacy_name=""
|
|
2928
4075
|
case "$lane_arg" in
|
|
2929
|
-
service)
|
|
2930
|
-
ui)
|
|
2931
|
-
|
|
4076
|
+
service) doc_name="design.md"; [ -n "$template_arg" ] || template_arg="design-template" ;;
|
|
4077
|
+
ui) doc_name="design.ui.md"; [ -n "$template_arg" ] || template_arg="ui-design-template" ;;
|
|
4078
|
+
backend) doc_name="backend-plan.md"; legacy_name="design.md"; [ -n "$template_arg" ] || template_arg="design-template" ;;
|
|
4079
|
+
frontend) doc_name="frontend-plan.md"; legacy_name="design.ui.md"; [ -n "$template_arg" ] || template_arg="ui-design-template" ;;
|
|
4080
|
+
*) echo "design-scaffold: unknown --lane '$lane_arg' (service|ui|backend|frontend)" >&2; return 1 ;;
|
|
2932
4081
|
esac
|
|
2933
4082
|
local repo_root; repo_root=$(get_repo_root)
|
|
2934
4083
|
local fd="$feature_dir_arg"
|
|
@@ -2937,7 +4086,10 @@ cmd_design_scaffold() {
|
|
|
2937
4086
|
[[ "$fd" != /* ]] && fd="$repo_root/$fd"
|
|
2938
4087
|
mkdir -p "$fd"
|
|
2939
4088
|
|
|
2940
|
-
local target="$fd/$doc_name" created="false" tpl
|
|
4089
|
+
local target="$fd/$doc_name" created="false" tpl migrated="false"
|
|
4090
|
+
if [ ! -f "$target" ] && [ -n "$legacy_name" ] && [ -f "$fd/$legacy_name" ]; then
|
|
4091
|
+
mv "$fd/$legacy_name" "$target"; migrated="true"
|
|
4092
|
+
fi
|
|
2941
4093
|
if [ -f "$target" ]; then
|
|
2942
4094
|
created="false"
|
|
2943
4095
|
else
|
|
@@ -2954,8 +4106,8 @@ cmd_design_scaffold() {
|
|
|
2954
4106
|
local override_active="false"
|
|
2955
4107
|
[ -f "$repo_root/.appweaver/templates/overrides/${template_arg}.md" ] && override_active="true"
|
|
2956
4108
|
local template_source; template_source=$(resolve_template "$template_arg" "$repo_root") || true
|
|
2957
|
-
printf '{"feature_dir":"%s","design_doc":"%s","lane":"%s","created":%s,"override_active":%s,"template":"%s","template_source":"%s"}\n' \
|
|
2958
|
-
"$(json_escape "$fd")" "$(json_escape "$target")" "$(json_escape "$lane_arg")" "$created" "$override_active" \
|
|
4109
|
+
printf '{"feature_dir":"%s","design_doc":"%s","lane":"%s","created":%s,"migrated":%s,"override_active":%s,"template":"%s","template_source":"%s"}\n' \
|
|
4110
|
+
"$(json_escape "$fd")" "$(json_escape "$target")" "$(json_escape "$lane_arg")" "$created" "$migrated" "$override_active" \
|
|
2959
4111
|
"$(json_escape "$template_arg")" "$(json_escape "${template_source:-}")"
|
|
2960
4112
|
}
|
|
2961
4113
|
|
|
@@ -3137,6 +4289,189 @@ print(json.dumps({
|
|
|
3137
4289
|
"$scoped" "$matched" "$fence_green" "$(json_escape "$cmd")" "$(json_escape "$t")"
|
|
3138
4290
|
}
|
|
3139
4291
|
|
|
4292
|
+
# ─────────────────────────────── test-diff ─────────────────────────────────
|
|
4293
|
+
# The TECHNICAL-STORY ORACLE. A technical story delivers no requirement, so there is no
|
|
4294
|
+
# FR- to trace it to and the existing test suite is the only thing that can say whether
|
|
4295
|
+
# it changed behaviour: a test that HAD to be edited means behaviour moved, and the work
|
|
4296
|
+
# was a functional story citing a requirement. This reports the suite's diff against a
|
|
4297
|
+
# baseline and lets the caller decide — it never judges.
|
|
4298
|
+
#
|
|
4299
|
+
# Read-only, always exits 0, and reports `checked` so an unreadable oracle (no git) is
|
|
4300
|
+
# distinguishable from a clean one. A gate that treats "could not look" as "nothing
|
|
4301
|
+
# found" is the exact false green the kit refuses everywhere else.
|
|
4302
|
+
cmd_test_diff() {
|
|
4303
|
+
local fd_arg="" base=""
|
|
4304
|
+
while [ $# -gt 0 ]; do
|
|
4305
|
+
case "$1" in
|
|
4306
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
4307
|
+
--base) base="$2"; shift 2 ;;
|
|
4308
|
+
--help|-h) echo "test-diff [--feature-dir <path>] [--base <git ref>]"; return 0 ;;
|
|
4309
|
+
*) echo "test-diff: unknown arg '$1'" >&2; return 1 ;;
|
|
4310
|
+
esac
|
|
4311
|
+
done
|
|
4312
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
4313
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || fd=""
|
|
4314
|
+
AW_ROOT="$repo_root" AW_FD="$fd" AW_BASE="$base" python3 - <<'PY'
|
|
4315
|
+
import json, os, re, subprocess
|
|
4316
|
+
root = os.environ.get("AW_ROOT") or "."
|
|
4317
|
+
fd = os.environ.get("AW_FD", "")
|
|
4318
|
+
want = (os.environ.get("AW_BASE") or "").strip()
|
|
4319
|
+
agg = os.path.basename(fd.rstrip("/\\"))
|
|
4320
|
+
|
|
4321
|
+
def git(*a):
|
|
4322
|
+
"""A git read that never raises. A working copy this command cannot interrogate is a
|
|
4323
|
+
FACT TO REPORT — the caller decides what an unreadable oracle means — never a crash
|
|
4324
|
+
that takes the gate down with it."""
|
|
4325
|
+
try:
|
|
4326
|
+
p = subprocess.run(["git", "-C", root] + list(a), capture_output=True, text=True)
|
|
4327
|
+
except Exception:
|
|
4328
|
+
return 1, ""
|
|
4329
|
+
return p.returncode, (p.stdout or "").strip()
|
|
4330
|
+
|
|
4331
|
+
DIR_RE = re.compile(r'(^|/)(tests?|specs?|__tests__|testing|test-suite)(/|$)', re.I)
|
|
4332
|
+
|
|
4333
|
+
# The kit's OWN trees, which hold documents and configuration and never tests. The spec
|
|
4334
|
+
# tree is derived rather than assumed: `specs/` matches the RSpec directory convention
|
|
4335
|
+
# exactly, so without this every requirement document — and this gate's own verdict file,
|
|
4336
|
+
# written before the diff is taken — counted as a modified test.
|
|
4337
|
+
SKIP = [".appweaver/"]
|
|
4338
|
+
if fd:
|
|
4339
|
+
_rel = os.path.relpath(fd, root).replace("\\", "/")
|
|
4340
|
+
SKIP.append((_rel.rsplit("/", 1)[0] if "/" in _rel else _rel).rstrip("/") + "/")
|
|
4341
|
+
|
|
4342
|
+
def is_test(path):
|
|
4343
|
+
"""A path is a TEST when a directory on it says so, or its own filename does — the
|
|
4344
|
+
four conventions every shipped stack uses between them: a tests/ directory, a
|
|
4345
|
+
Name.Tests.cs / NameTest.java suffix, a test_name.py / name_test.go affix, and a
|
|
4346
|
+
name.test.ts / name.spec.ts infix. Deliberately GENEROUS: over-calling a file a test
|
|
4347
|
+
costs a louder message, under-calling one costs a technical story that changed
|
|
4348
|
+
behaviour and passed its own oracle."""
|
|
4349
|
+
p = path.replace("\\", "/")
|
|
4350
|
+
if any(p.startswith(s) for s in SKIP):
|
|
4351
|
+
return False
|
|
4352
|
+
stem, ext = os.path.splitext(os.path.basename(p))
|
|
4353
|
+
# Prose is never a test, wherever it sits. A tests/ directory holds its own README
|
|
4354
|
+
# and a docs tree holds files named for testing; counting either would fail a
|
|
4355
|
+
# technical story over a paragraph.
|
|
4356
|
+
if ext.lower() in (".md", ".markdown", ".txt", ".rst", ".adoc"):
|
|
4357
|
+
return False
|
|
4358
|
+
if DIR_RE.search(os.path.dirname(p)):
|
|
4359
|
+
return True
|
|
4360
|
+
stem = stem.lower()
|
|
4361
|
+
if stem.startswith(("test", "spec")) or stem.endswith(("test", "tests", "spec", "specs")):
|
|
4362
|
+
return True
|
|
4363
|
+
return any(k in stem for k in (".test", ".spec", "_test", "_spec", "-test", "-spec"))
|
|
4364
|
+
|
|
4365
|
+
out = {"ok": True, "aggregate": agg, "git": False, "checked": False,
|
|
4366
|
+
"base": "", "base_ref": "", "base_kind": "none", "files_changed": 0,
|
|
4367
|
+
"tests_changed": [], "tests_changed_csv": "", "tests_changed_count": 0,
|
|
4368
|
+
"tests_deleted": [], "tests_deleted_csv": "",
|
|
4369
|
+
"tests_added": [], "tests_added_csv": "", "tests_added_count": 0,
|
|
4370
|
+
"slice_tests_changed": [], "slice_tests_changed_csv": "", "slice_tests_changed_count": 0,
|
|
4371
|
+
"any_test_changed": False, "clean": True, "oracle": "clean",
|
|
4372
|
+
"note": "", "digest": ""}
|
|
4373
|
+
|
|
4374
|
+
if git("rev-parse", "--is-inside-work-tree")[1] != "true":
|
|
4375
|
+
out["oracle"] = "unverified"
|
|
4376
|
+
out["note"] = ("Not a git working copy, so the test suite's history cannot be read. The "
|
|
4377
|
+
"unchanged-suite oracle is UNVERIFIED for this run — not passed.")
|
|
4378
|
+
out["digest"] = out["note"]
|
|
4379
|
+
print(json.dumps(out)); raise SystemExit(0)
|
|
4380
|
+
out["git"] = out["checked"] = True
|
|
4381
|
+
|
|
4382
|
+
# WHICH BASELINE. An explicit --base wins. Otherwise the fork point from the integration
|
|
4383
|
+
# branch, which is what a story's work sits on top of; falling back to HEAD, which sees
|
|
4384
|
+
# the working tree alone. The kind is reported because it changes what the answer MEANS:
|
|
4385
|
+
# a `head` baseline cannot see a test modified in a commit this branch already made.
|
|
4386
|
+
head = git("rev-parse", "HEAD")[1]
|
|
4387
|
+
if want and git("rev-parse", "--verify", want + "^{commit}")[0] == 0:
|
|
4388
|
+
out["base"], out["base_ref"], out["base_kind"] = git("rev-parse", want)[1], want, "given"
|
|
4389
|
+
if not out["base"]:
|
|
4390
|
+
cands = []
|
|
4391
|
+
rc, ref = git("symbolic-ref", "--quiet", "refs/remotes/origin/HEAD")
|
|
4392
|
+
if rc == 0 and ref:
|
|
4393
|
+
cands.append(ref.split("refs/remotes/", 1)[-1])
|
|
4394
|
+
cands += ["origin/main", "origin/master", "main", "master"]
|
|
4395
|
+
seen = set()
|
|
4396
|
+
for c in cands:
|
|
4397
|
+
if c in seen:
|
|
4398
|
+
continue
|
|
4399
|
+
seen.add(c)
|
|
4400
|
+
if git("rev-parse", "--verify", c + "^{commit}")[0] != 0:
|
|
4401
|
+
continue
|
|
4402
|
+
rc, mb = git("merge-base", "HEAD", c)
|
|
4403
|
+
if rc != 0 or not mb:
|
|
4404
|
+
continue
|
|
4405
|
+
out["base"], out["base_ref"] = mb, c
|
|
4406
|
+
out["base_kind"] = "head" if mb == head else "merge-base"
|
|
4407
|
+
break
|
|
4408
|
+
if not out["base"]:
|
|
4409
|
+
out["base"], out["base_kind"] = head or "HEAD", "head"
|
|
4410
|
+
|
|
4411
|
+
rc, diff = git("diff", "--name-status", "--find-renames", out["base"])
|
|
4412
|
+
changed, added, deleted, files = [], [], [], 0
|
|
4413
|
+
for line in diff.splitlines():
|
|
4414
|
+
parts = line.split("\t")
|
|
4415
|
+
if len(parts) < 2:
|
|
4416
|
+
continue
|
|
4417
|
+
code, paths = parts[0].strip(), parts[1:]
|
|
4418
|
+
files += 1
|
|
4419
|
+
hits = [p for p in paths if is_test(p)]
|
|
4420
|
+
if not hits:
|
|
4421
|
+
continue
|
|
4422
|
+
p = hits[-1]
|
|
4423
|
+
if code.startswith("A") or code.startswith("C"):
|
|
4424
|
+
# A NEW test is not a changed one. A refactor that adds characterisation tests is
|
|
4425
|
+
# exactly the work a technical story exists to do.
|
|
4426
|
+
added.append(p)
|
|
4427
|
+
elif code.startswith("R"):
|
|
4428
|
+
# A pure rename moves a test without changing what it asserts; anything less than
|
|
4429
|
+
# a 100% match carries an edit inside it.
|
|
4430
|
+
(added if code == "R100" else changed).append(p)
|
|
4431
|
+
elif code.startswith("D"):
|
|
4432
|
+
deleted.append(p); changed.append(p)
|
|
4433
|
+
else:
|
|
4434
|
+
changed.append(p)
|
|
4435
|
+
|
|
4436
|
+
# Untracked files are ADDITIONS the diff cannot see — reported as such so a new test
|
|
4437
|
+
# written in the working tree is not mistaken for a missing one.
|
|
4438
|
+
for p in git("ls-files", "--others", "--exclude-standard")[1].splitlines():
|
|
4439
|
+
p = p.strip()
|
|
4440
|
+
if p and is_test(p) and p not in added:
|
|
4441
|
+
added.append(p); files += 1
|
|
4442
|
+
|
|
4443
|
+
changed = sorted(set(changed)); added = sorted(set(added)); deleted = sorted(set(deleted))
|
|
4444
|
+
low = agg.lower()
|
|
4445
|
+
slice_changed = [p for p in changed if low and low in p.lower()]
|
|
4446
|
+
out.update(files_changed=files,
|
|
4447
|
+
tests_changed=changed, tests_changed_csv=", ".join(changed),
|
|
4448
|
+
tests_changed_count=len(changed),
|
|
4449
|
+
tests_deleted=deleted, tests_deleted_csv=", ".join(deleted),
|
|
4450
|
+
tests_added=added, tests_added_csv=", ".join(added), tests_added_count=len(added),
|
|
4451
|
+
slice_tests_changed=slice_changed, slice_tests_changed_csv=", ".join(slice_changed),
|
|
4452
|
+
slice_tests_changed_count=len(slice_changed),
|
|
4453
|
+
any_test_changed=bool(changed), clean=not changed,
|
|
4454
|
+
# The DIFF's state in one word — clean | changed | unverified — so a caller can
|
|
4455
|
+
# branch on it without recombining a boolean with a "could I even look" flag.
|
|
4456
|
+
# It says what the suite did, never what that means for a story.
|
|
4457
|
+
oracle="changed" if changed else "clean")
|
|
4458
|
+
|
|
4459
|
+
kindnote = {"given": "the ref given on the command line",
|
|
4460
|
+
"merge-base": "the fork point from %s — every commit this branch added is in view" % out["base_ref"],
|
|
4461
|
+
"head": "HEAD — only uncommitted work is in view, so a test modified in a commit "
|
|
4462
|
+
"already made on this branch is NOT counted"}[out["base_kind"]]
|
|
4463
|
+
lines = ["Test-suite diff against %s (%s): %s" % (out["base"][:12], out["base_kind"], kindnote),
|
|
4464
|
+
" files changed: %d" % files,
|
|
4465
|
+
" tests MODIFIED or DELETED (%d): %s" % (len(changed), ", ".join(changed) or "none"),
|
|
4466
|
+
" tests ADDED (%d): %s" % (len(added), ", ".join(added) or "none")]
|
|
4467
|
+
if slice_changed:
|
|
4468
|
+
lines.append(" of those, on this aggregate (%s): %s" % (agg, ", ".join(slice_changed)))
|
|
4469
|
+
out["note"] = kindnote
|
|
4470
|
+
out["digest"] = "\n".join(lines)
|
|
4471
|
+
print(json.dumps(out))
|
|
4472
|
+
PY
|
|
4473
|
+
}
|
|
4474
|
+
|
|
3140
4475
|
cmd_run_migrate() {
|
|
3141
4476
|
while [ $# -gt 0 ]; do
|
|
3142
4477
|
case "$1" in
|
|
@@ -3374,6 +4709,701 @@ print(json.dumps({"ok": True, "version": ver, "stamped": stamped,
|
|
|
3374
4709
|
PY
|
|
3375
4710
|
}
|
|
3376
4711
|
|
|
4712
|
+
|
|
4713
|
+
# ─────────────────────────── plan-check / plan-stamp ────────────────────────
|
|
4714
|
+
# The plan documents' derivation tracking. Each plan doc (backend-plan.md /
|
|
4715
|
+
# frontend-plan.md) derives from ONE spec version and carries its OWN track file
|
|
4716
|
+
# beside the spec — .aw-plan-track.backend-plan.json / .aw-plan-track.frontend-plan.json
|
|
4717
|
+
# — recording {spec_version, sha256}, so the two lanes' stamps never share a write.
|
|
4718
|
+
# plan-check reads the record back against the spec's Change History ledger;
|
|
4719
|
+
# plan-stamp is the only writer.
|
|
4720
|
+
# Both always exit 0 with an ok/state field — the workflow's verify_context owns
|
|
4721
|
+
# the stop (the lane-verify convention).
|
|
4722
|
+
cmd_plan_check() {
|
|
4723
|
+
local fd_arg="" doc=""
|
|
4724
|
+
while [ $# -gt 0 ]; do
|
|
4725
|
+
case "$1" in
|
|
4726
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
4727
|
+
--doc) doc="$2"; shift 2 ;;
|
|
4728
|
+
--help|-h) echo "plan-check --doc <path> [--feature-dir <path>]"; return 0 ;;
|
|
4729
|
+
*) echo "plan-check: unknown arg '$1'" >&2; return 1 ;;
|
|
4730
|
+
esac
|
|
4731
|
+
done
|
|
4732
|
+
[ -n "$doc" ] || { echo "plan-check: --doc required" >&2; return 1; }
|
|
4733
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
4734
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "plan-check: no feature set and no --feature-dir" >&2; return 1; }
|
|
4735
|
+
AW_DOC="$doc" AW_FD="$fd" python3 - <<'PY'
|
|
4736
|
+
import json, os, re, sys, hashlib
|
|
4737
|
+
doc = os.environ["AW_DOC"]; fd = os.environ["AW_FD"]
|
|
4738
|
+
spec = os.path.join(fd, "spec.md")
|
|
4739
|
+
# One track file per plan document (.aw-plan-track.backend-plan.json /
|
|
4740
|
+
# .aw-plan-track.frontend-plan.json) — parallel lane stamps never contend on a shared file.
|
|
4741
|
+
stem = os.path.splitext(os.path.basename(doc))[0]
|
|
4742
|
+
track_path = os.path.join(fd, ".aw-plan-track.%s.json" % stem)
|
|
4743
|
+
def vtuple(v):
|
|
4744
|
+
try: return tuple(int(x) for x in v.lstrip("vV").split("."))
|
|
4745
|
+
except Exception: return (0,)
|
|
4746
|
+
out = {"doc": doc, "doc_exists": os.path.isfile(doc), "state": "", "derived_version": "",
|
|
4747
|
+
"current_version": "", "changed_csv": "", "changed_summary": "", "body_changed": False}
|
|
4748
|
+
# Current version = the widest of the ledger's rows and the **Version** header — the
|
|
4749
|
+
# same widest-wins rule ledger-append uses, so a hand-moved header cannot hide a row.
|
|
4750
|
+
rows = []; cur = ""; idcol = -1
|
|
4751
|
+
if os.path.isfile(spec):
|
|
4752
|
+
text = open(spec, encoding="utf-8", errors="replace").read()
|
|
4753
|
+
m = re.search(r'^##\s+Change History\s*$', text, re.M)
|
|
4754
|
+
if m:
|
|
4755
|
+
for line in text[m.end():].splitlines():
|
|
4756
|
+
if idcol < 0 and line.lstrip().startswith("|") and "requirements changed" in line.lower():
|
|
4757
|
+
hdr = [c.strip().lower() for c in line.strip().strip("|").split("|")]
|
|
4758
|
+
idcol = next((i for i, c in enumerate(hdr) if "requirements changed" in c), -1)
|
|
4759
|
+
rm = re.match(r'^\|\s*(v\d+(?:\.\d+)?)\s*\|', line)
|
|
4760
|
+
if rm: rows.append((rm.group(1), line))
|
|
4761
|
+
hv = re.search(r'^\*\*Version\*\*:\s*(v[\d.]+)', text, re.M)
|
|
4762
|
+
cands = [r[0] for r in rows] + ([hv.group(1)] if hv else [])
|
|
4763
|
+
if cands: cur = max(cands, key=vtuple)
|
|
4764
|
+
out["current_version"] = cur
|
|
4765
|
+
if not out["doc_exists"]:
|
|
4766
|
+
out["state"] = "fresh"; print(json.dumps(out)); sys.exit(0)
|
|
4767
|
+
try: track = json.load(open(track_path, encoding="utf-8"))
|
|
4768
|
+
except Exception: track = {}
|
|
4769
|
+
entry = track.get(os.path.basename(doc))
|
|
4770
|
+
if not entry:
|
|
4771
|
+
# A document with no derivation record — a migrated legacy master, or a baseline
|
|
4772
|
+
# lost by hand. There is no stamp to diff against, so the caller reconciles the
|
|
4773
|
+
# WHOLE document once and plan-stamp baselines it.
|
|
4774
|
+
out["state"] = "untracked"; print(json.dumps(out)); sys.exit(0)
|
|
4775
|
+
derived = entry.get("spec_version", "")
|
|
4776
|
+
out["derived_version"] = derived
|
|
4777
|
+
body = open(doc, encoding="utf-8", errors="replace").read()
|
|
4778
|
+
out["body_changed"] = hashlib.sha256(body.encode("utf-8")).hexdigest() != entry.get("sha256", "")
|
|
4779
|
+
moved = [r for r in rows if vtuple(r[0]) > vtuple(derived)]
|
|
4780
|
+
# Scrape ONLY the ledger's "Requirements changed" cell when it names one. The
|
|
4781
|
+
# Stories cell holds ids of the form <Aggregate>-nnn, which read as requirement ids
|
|
4782
|
+
# whenever the aggregate is spelled in caps (EDI-001, HR-002) — those would arrive
|
|
4783
|
+
# as requirements for the plan to conform, and there is no such requirement.
|
|
4784
|
+
def _scope(line):
|
|
4785
|
+
if idcol >= 0:
|
|
4786
|
+
cells = [c.strip() for c in line.strip().strip("|").split("|")]
|
|
4787
|
+
if idcol < len(cells): return cells[idcol]
|
|
4788
|
+
return line
|
|
4789
|
+
ids = sorted({i for _v, line in moved for i in re.findall(r'[A-Z]{2}-\d+', _scope(line))})
|
|
4790
|
+
out["changed_csv"] = ", ".join(ids)
|
|
4791
|
+
out["changed_summary"] = " // ".join(line.strip() for _v, line in moved)
|
|
4792
|
+
behind = bool(moved) or bool(cur and vtuple(cur) > vtuple(derived))
|
|
4793
|
+
if out["body_changed"] and behind: out["state"] = "edited_behind"
|
|
4794
|
+
elif out["body_changed"]: out["state"] = "edited"
|
|
4795
|
+
elif behind: out["state"] = "behind"
|
|
4796
|
+
else: out["state"] = "clean"
|
|
4797
|
+
print(json.dumps(out))
|
|
4798
|
+
PY
|
|
4799
|
+
}
|
|
4800
|
+
|
|
4801
|
+
cmd_plan_stamp() {
|
|
4802
|
+
local fd_arg="" doc="" ids="" note="" no_row="false"
|
|
4803
|
+
while [ $# -gt 0 ]; do
|
|
4804
|
+
case "$1" in
|
|
4805
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
4806
|
+
--doc) doc="$2"; shift 2 ;;
|
|
4807
|
+
--ids) ids="$2"; shift 2 ;;
|
|
4808
|
+
--note) note="$2"; shift 2 ;;
|
|
4809
|
+
--no-row) no_row="true"; shift ;;
|
|
4810
|
+
--help|-h) echo "plan-stamp --doc <path> [--feature-dir <path>] [--ids <csv>] [--note <text>] [--no-row]"; return 0 ;;
|
|
4811
|
+
*) echo "plan-stamp: unknown arg '$1'" >&2; return 1 ;;
|
|
4812
|
+
esac
|
|
4813
|
+
done
|
|
4814
|
+
[ -n "$doc" ] || { echo "plan-stamp: --doc required" >&2; return 1; }
|
|
4815
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
4816
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "plan-stamp: no feature set and no --feature-dir" >&2; return 1; }
|
|
4817
|
+
AW_DOC="$doc" AW_FD="$fd" AW_IDS="$ids" AW_NOTE="$note" AW_NOROW="$no_row" python3 - <<'PY'
|
|
4818
|
+
import json, os, re, sys, hashlib, datetime
|
|
4819
|
+
doc = os.environ["AW_DOC"]; fd = os.environ["AW_FD"]
|
|
4820
|
+
ids = os.environ.get("AW_IDS", "").strip(); note = os.environ.get("AW_NOTE", "").strip()
|
|
4821
|
+
no_row = os.environ.get("AW_NOROW", "false") == "true"
|
|
4822
|
+
spec = os.path.join(fd, "spec.md")
|
|
4823
|
+
# One track file per plan document (.aw-plan-track.backend-plan.json /
|
|
4824
|
+
# .aw-plan-track.frontend-plan.json) — parallel lane stamps never contend on a shared file.
|
|
4825
|
+
stem = os.path.splitext(os.path.basename(doc))[0]
|
|
4826
|
+
track_path = os.path.join(fd, ".aw-plan-track.%s.json" % stem)
|
|
4827
|
+
def vtuple(v):
|
|
4828
|
+
try: return tuple(int(x) for x in v.lstrip("vV").split("."))
|
|
4829
|
+
except Exception: return (0,)
|
|
4830
|
+
if not os.path.isfile(doc):
|
|
4831
|
+
print(json.dumps({"ok": False, "error": "plan document %s does not exist" % doc, "version": ""})); sys.exit(0)
|
|
4832
|
+
cur = ""
|
|
4833
|
+
if os.path.isfile(spec):
|
|
4834
|
+
st = open(spec, encoding="utf-8", errors="replace").read()
|
|
4835
|
+
m = re.search(r'^##\s+Change History\s*$', st, re.M)
|
|
4836
|
+
rows = re.findall(r'^\|\s*(v\d+(?:\.\d+)?)\s*\|', st[m.end():] if m else "", re.M)
|
|
4837
|
+
hv = re.search(r'^\*\*Version\*\*:\s*(v[\d.]+)', st, re.M)
|
|
4838
|
+
cands = rows + ([hv.group(1)] if hv else [])
|
|
4839
|
+
if cands: cur = max(cands, key=vtuple)
|
|
4840
|
+
text = open(doc, encoding="utf-8", errors="replace").read()
|
|
4841
|
+
# The ledger-survival fence: a plan whose update dropped the Change History section is
|
|
4842
|
+
# NOT baselined — a lost ledger silently baselined over could never be noticed again.
|
|
4843
|
+
hist = re.search(r'^##+\s*(?:\d+\.\s*)?Change History\s*$', text, re.M)
|
|
4844
|
+
if not hist:
|
|
4845
|
+
print(json.dumps({"ok": False, "version": cur,
|
|
4846
|
+
"error": "the plan document has no 'Change History' section — the write dropped the ledger; nothing was baselined"}))
|
|
4847
|
+
sys.exit(0)
|
|
4848
|
+
warnings = []
|
|
4849
|
+
if not re.search(r'^##+.*Assumptions', text, re.M):
|
|
4850
|
+
warnings.append("no 'Assumptions' section found")
|
|
4851
|
+
if not re.search(r'^##+.*(Workarounds|Deviations)', text, re.M):
|
|
4852
|
+
warnings.append("no 'Workarounds/Deviations' section found")
|
|
4853
|
+
row_txt = ""
|
|
4854
|
+
if not no_row:
|
|
4855
|
+
# Bounded to the Change History section; the row's cell count follows the section's
|
|
4856
|
+
# own table so the append fits the greenfield, UI and onboard-generated shapes alike.
|
|
4857
|
+
lines = text.split("\n")
|
|
4858
|
+
hline = text[:hist.start()].count("\n")
|
|
4859
|
+
end = len(lines)
|
|
4860
|
+
for i in range(hline + 1, len(lines)):
|
|
4861
|
+
if re.match(r'^##', lines[i]): end = i; break
|
|
4862
|
+
tbl = [i for i in range(hline + 1, end) if lines[i].lstrip().startswith("|")]
|
|
4863
|
+
ncells = 5
|
|
4864
|
+
if tbl: ncells = max(3, lines[tbl[0]].strip().strip("|").count("|") + 1)
|
|
4865
|
+
change = note or ("Conformed to spec %s" % (cur or "(unversioned)"))
|
|
4866
|
+
if ids: change = "%s — %s" % (change, ids)
|
|
4867
|
+
change = change.replace("|", "/").replace("\n", " ")
|
|
4868
|
+
cells = [cur or "v?", datetime.date.today().isoformat(), change] + ["—"] * (ncells - 3)
|
|
4869
|
+
row_txt = "| " + " | ".join(cells[:ncells]) + " |"
|
|
4870
|
+
lines.insert((tbl[-1] + 1) if tbl else end, row_txt)
|
|
4871
|
+
text = "\n".join(lines)
|
|
4872
|
+
if cur:
|
|
4873
|
+
text = re.sub(r'^(\*\*Version\*\*:\s*)v[\d.]+', r'\g<1>' + cur, text, count=1, flags=re.M)
|
|
4874
|
+
open(doc, "w", encoding="utf-8").write(text)
|
|
4875
|
+
try: track = json.load(open(track_path, encoding="utf-8"))
|
|
4876
|
+
except Exception: track = {}
|
|
4877
|
+
track[os.path.basename(doc)] = {
|
|
4878
|
+
"spec_version": cur,
|
|
4879
|
+
"sha256": hashlib.sha256(text.encode("utf-8")).hexdigest(),
|
|
4880
|
+
"updated": datetime.datetime.now().isoformat(timespec="seconds")}
|
|
4881
|
+
open(track_path, "w", encoding="utf-8").write(json.dumps(track, indent=2) + "\n")
|
|
4882
|
+
print(json.dumps({"ok": True, "version": cur, "row": row_txt, "warnings": warnings}))
|
|
4883
|
+
PY
|
|
4884
|
+
}
|
|
4885
|
+
|
|
4886
|
+
|
|
4887
|
+
# ───────────────────────────────── gate-result ──────────────────────────────
|
|
4888
|
+
# The machine-readable verdict every analyze gate writes beside its markdown
|
|
4889
|
+
# report. CI cannot branch on prose, and a verdict is exactly the kind of dated,
|
|
4890
|
+
# derived record the model must never write — so the script writes it.
|
|
4891
|
+
#
|
|
4892
|
+
# Shared by design: analyze-design writes one per feature, and analyze-slice /
|
|
4893
|
+
# analyze-code will write one per story and per run. The CORE keys are fixed
|
|
4894
|
+
# (gate, status, feature, spec_version, story, gap_count, gap_refs, report,
|
|
4895
|
+
# generated_at) so a pipeline can read any gate's result with one expression;
|
|
4896
|
+
# everything gate-specific arrives through repeatable --field k=v and lands under
|
|
4897
|
+
# "fields", where it cannot destabilise that core.
|
|
4898
|
+
#
|
|
4899
|
+
# NOTE the returned `ok` means THE FILE WAS WRITTEN. The pass/fail verdict is
|
|
4900
|
+
# `status` — binding a workflow gate to `ok` would pass on every run.
|
|
4901
|
+
cmd_gate_result() {
|
|
4902
|
+
local fd_arg="" gate="" ok="" version="" story="" report="" out="" gaps="" refs="" note="" fields=""
|
|
4903
|
+
while [ $# -gt 0 ]; do
|
|
4904
|
+
case "$1" in
|
|
4905
|
+
--gate) gate="$2"; shift 2 ;;
|
|
4906
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
4907
|
+
--ok) ok="$2"; shift 2 ;;
|
|
4908
|
+
--spec-version) version="$2"; shift 2 ;;
|
|
4909
|
+
--story) story="$2"; shift 2 ;;
|
|
4910
|
+
--report) report="$2"; shift 2 ;;
|
|
4911
|
+
--out) out="$2"; shift 2 ;;
|
|
4912
|
+
--gap-count) gaps="$2"; shift 2 ;;
|
|
4913
|
+
--gap-refs) refs="$2"; shift 2 ;;
|
|
4914
|
+
--note) note="$2"; shift 2 ;;
|
|
4915
|
+
--field) fields="${fields}$2"$'\n'; shift 2 ;;
|
|
4916
|
+
--help|-h) echo "gate-result --gate <name> --ok <true|false> [--feature-dir <p>] [--spec-version <v>] [--story <id>] [--report <path>] [--out <path>] [--gap-count <n>] [--gap-refs <csv>] [--note <text>] [--field k=v]..."; return 0 ;;
|
|
4917
|
+
*) echo "gate-result: unknown arg '$1'" >&2; return 1 ;;
|
|
4918
|
+
esac
|
|
4919
|
+
done
|
|
4920
|
+
[ -n "$gate" ] || { echo "gate-result: --gate required" >&2; return 1; }
|
|
4921
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
4922
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "gate-result: no feature set and no --feature-dir" >&2; return 1; }
|
|
4923
|
+
AW_GATE="$gate" AW_FD="$fd" AW_OK="$ok" AW_VERSION="$version" AW_STORY="$story" \
|
|
4924
|
+
AW_REPORT="$report" AW_OUT="$out" AW_GAPS="$gaps" AW_REFS="$refs" AW_NOTE="$note" \
|
|
4925
|
+
AW_FIELDS="$fields" python3 - <<'PY'
|
|
4926
|
+
import json, os, sys, datetime
|
|
4927
|
+
gate = (os.environ.get("AW_GATE", "") or "").strip() or "gate"
|
|
4928
|
+
fd = os.environ.get("AW_FD", "")
|
|
4929
|
+
report = (os.environ.get("AW_REPORT", "") or "").strip()
|
|
4930
|
+
out = (os.environ.get("AW_OUT", "") or "").strip()
|
|
4931
|
+
# "pass" only on an explicit affirmative. An absent or unreadable verdict is a FAIL,
|
|
4932
|
+
# because a result that defaults green turns every broken run into a passing one.
|
|
4933
|
+
ok = (os.environ.get("AW_OK", "") or "").strip().lower() in ("true", "1", "yes", "pass", "ok")
|
|
4934
|
+
# Written BESIDE the markdown report and named after it, so a job holding either path
|
|
4935
|
+
# holds the other. --out overrides; with no report named at all it falls back to a
|
|
4936
|
+
# dotfile in the feature directory under the gate's own name.
|
|
4937
|
+
if not out:
|
|
4938
|
+
out = (os.path.splitext(report)[0] + ".json") if report else os.path.join(fd, ".aw-gate-%s.json" % gate)
|
|
4939
|
+
try: gap_count = int((os.environ.get("AW_GAPS", "") or "").strip() or 0)
|
|
4940
|
+
except ValueError: gap_count = 0
|
|
4941
|
+
refs = [r.strip() for r in (os.environ.get("AW_REFS", "") or "").replace(";", ",").split(",") if r.strip()]
|
|
4942
|
+
# A fail reporting zero findings reads as green to anything that sums the number
|
|
4943
|
+
# rather than reading the status, so a red verdict always carries at least one.
|
|
4944
|
+
if not ok and gap_count < 1: gap_count = max(1, len(refs))
|
|
4945
|
+
# --field k=v, repeatable, arriving newline-separated. Keeps the CORE schema below
|
|
4946
|
+
# fixed for every gate while each one carries its own detail underneath.
|
|
4947
|
+
fields = {}
|
|
4948
|
+
for line in (os.environ.get("AW_FIELDS", "") or "").splitlines():
|
|
4949
|
+
k, sep, v = line.partition("=")
|
|
4950
|
+
if sep and k.strip(): fields[k.strip()] = v.strip()
|
|
4951
|
+
res = {"gate": gate,
|
|
4952
|
+
"status": "pass" if ok else "fail",
|
|
4953
|
+
"feature": os.path.basename(fd.rstrip("/\\")),
|
|
4954
|
+
"feature_dir": fd,
|
|
4955
|
+
"spec_version": (os.environ.get("AW_VERSION", "") or "").strip(),
|
|
4956
|
+
"story": (os.environ.get("AW_STORY", "") or "").strip(),
|
|
4957
|
+
"gap_count": gap_count,
|
|
4958
|
+
"gap_refs": refs,
|
|
4959
|
+
"report": report,
|
|
4960
|
+
"note": (os.environ.get("AW_NOTE", "") or "").strip(),
|
|
4961
|
+
"fields": fields,
|
|
4962
|
+
"generated_at": datetime.datetime.now().isoformat(timespec="seconds")}
|
|
4963
|
+
d = os.path.dirname(out)
|
|
4964
|
+
if d and not os.path.isdir(d): os.makedirs(d, exist_ok=True)
|
|
4965
|
+
open(out, "w", encoding="utf-8").write(json.dumps(res, indent=2) + "\n")
|
|
4966
|
+
print(json.dumps({"ok": True, "result_file": out, "status": res["status"], "gap_count": gap_count}))
|
|
4967
|
+
PY
|
|
4968
|
+
}
|
|
4969
|
+
|
|
4970
|
+
# ─────────────── story-plan-check / story-plan-doc / log-append ───────────────
|
|
4971
|
+
# The per-story execution design ("story design") — SHORT-LIVED scaffolding, ONE
|
|
4972
|
+
# DOCUMENT PER LANE beside the story: stories/<ID>/story-backend-plan.md and
|
|
4973
|
+
# stories/<ID>/story-frontend-plan.md. Every /appweaver story-plan run
|
|
4974
|
+
# APPENDS a dated "## Design pass N" section; the LATEST pass wins and nothing is
|
|
4975
|
+
# edited in place, so a manual edit to an earlier pass survives a re-run. The
|
|
4976
|
+
# document's identity is positional (its directory): no story id appears in its
|
|
4977
|
+
# text. Writing into stories/<ID>/ is what flips the story IN-FLIGHT for
|
|
4978
|
+
# sync-stories' follow-on rule — the same isdir test story-spec's projection used
|
|
4979
|
+
# to trip.
|
|
4980
|
+
#
|
|
4981
|
+
# story-plan-check resolves WHICH story (an explicit --story, an id found in the
|
|
4982
|
+
# free-text input, or the open backlog for an ask), and reports everything the
|
|
4983
|
+
# workflow gates on: status, cited ids, the Constraints section's bound ids, ledger
|
|
4984
|
+
# rows above the story's stamp (staleness), doc/pass state and the feature's
|
|
4985
|
+
# append-only log paths. Always exits 0 with ok/flag fields — the workflow's
|
|
4986
|
+
# verify_context owns every stop (the lane-verify convention).
|
|
4987
|
+
#
|
|
4988
|
+
# story-plan-doc is the ONLY writer of either lane's design: --lane picks the file,
|
|
4989
|
+
# and it scaffolds the shell (frontmatter + contract comment) on first use, appends
|
|
4990
|
+
# the authored pass under a SCRIPT-written header (the model writes no pass number,
|
|
4991
|
+
# date or version), stamps the frontmatter and removes the temp pass file. Pass
|
|
4992
|
+
# numbers are per lane. A pre-split story-plan.md is reported by story-plan-check as
|
|
4993
|
+
# legacy_doc and touched by nothing.
|
|
4994
|
+
#
|
|
4995
|
+
# log-append owns the feature's two append-only logs: interfaces.md (IF-nnn — the
|
|
4996
|
+
# FE/BE contract anchor; BE design appends status:proposed, story close verifies
|
|
4997
|
+
# against the as-built and flips to live) and adr.md (ADR-nnn — ratified decisions).
|
|
4998
|
+
# The script assigns ids, dates and status; entries are never edited afterwards,
|
|
4999
|
+
# only superseded by later entries naming `supersedes:`.
|
|
5000
|
+
cmd_story_plan_check() {
|
|
5001
|
+
local fd_arg="" input="" story=""
|
|
5002
|
+
while [ $# -gt 0 ]; do
|
|
5003
|
+
case "$1" in
|
|
5004
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
5005
|
+
--input) input="$2"; shift 2 ;;
|
|
5006
|
+
--story) story="$2"; shift 2 ;;
|
|
5007
|
+
--help|-h) echo "story-plan-check [--story <id>] [--input <free text>] [--feature-dir <path>]"; return 0 ;;
|
|
5008
|
+
*) echo "story-plan-check: unknown arg '$1'" >&2; return 1 ;;
|
|
5009
|
+
esac
|
|
5010
|
+
done
|
|
5011
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
5012
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "story-plan-check: no feature set and no --feature-dir" >&2; return 1; }
|
|
5013
|
+
AW_FD="$fd" AW_INPUT="$input" AW_STORY="$story" python3 - <<'PY'
|
|
5014
|
+
import json, os, re, sys
|
|
5015
|
+
fd = os.environ["AW_FD"]
|
|
5016
|
+
sdir = os.path.join(fd, "stories")
|
|
5017
|
+
spec = os.path.join(fd, "spec.md")
|
|
5018
|
+
|
|
5019
|
+
def parse_fm(text):
|
|
5020
|
+
"""Frontmatter as a flat dict — inline and block-list values both fold to the
|
|
5021
|
+
inline shape (same reader story-refs uses, for the same reason)."""
|
|
5022
|
+
m = re.match(r'^---\s*\n(.*?)\n---\s*\n', text, re.S)
|
|
5023
|
+
if not m: return {}
|
|
5024
|
+
fm, key, block = {}, None, set()
|
|
5025
|
+
for line in m.group(1).split("\n"):
|
|
5026
|
+
km = re.match(r'^([A-Za-z_]+):\s*(.*)$', line)
|
|
5027
|
+
if km:
|
|
5028
|
+
key = km.group(1); fm[key] = km.group(2).strip(); continue
|
|
5029
|
+
im = re.match(r'^\s+-\s+(.*)$', line) if key else None
|
|
5030
|
+
if im and (key in block or not fm[key]):
|
|
5031
|
+
block.add(key)
|
|
5032
|
+
fm[key] = (fm[key] + ", " + im.group(1).strip()) if fm[key] else im.group(1).strip()
|
|
5033
|
+
return fm
|
|
5034
|
+
|
|
5035
|
+
def vtuple(v):
|
|
5036
|
+
try: return tuple(int(x) for x in v.lstrip("vV").split("."))
|
|
5037
|
+
except Exception: return (0,)
|
|
5038
|
+
|
|
5039
|
+
# ---- the backlog ------------------------------------------------------------
|
|
5040
|
+
stories = []
|
|
5041
|
+
if os.path.isdir(sdir):
|
|
5042
|
+
for name in sorted(os.listdir(sdir)):
|
|
5043
|
+
# stories.md is the GENERATED index beside the stories, not a story
|
|
5044
|
+
if not name.endswith(".md") or name == "stories.md": continue
|
|
5045
|
+
p = os.path.join(sdir, name)
|
|
5046
|
+
if not os.path.isfile(p): continue
|
|
5047
|
+
text = open(p, encoding="utf-8", errors="replace").read()
|
|
5048
|
+
fm = parse_fm(text)
|
|
5049
|
+
sid = fm.get("id") or name[:-3]
|
|
5050
|
+
stories.append({"id": sid, "file_id": name[:-3],
|
|
5051
|
+
"status": (fm.get("status") or "open").strip().lower(),
|
|
5052
|
+
"type": (fm.get("type") or "functional").strip().lower(),
|
|
5053
|
+
"title": (fm.get("title") or "").strip().strip("[]"),
|
|
5054
|
+
"spec_version": (fm.get("spec_version") or "").strip(),
|
|
5055
|
+
"cites": re.findall(r'\b(?:FR|BR)-\d+', fm.get("exercises", "")),
|
|
5056
|
+
"path": p, "text": text})
|
|
5057
|
+
open_stories = [s for s in stories if s["status"] == "open"]
|
|
5058
|
+
open_ids = [s["id"] for s in open_stories]
|
|
5059
|
+
digest = "\n".join(" %-16s %s%s" % (s["id"], s["title"] or "(untitled)",
|
|
5060
|
+
(" cites " + ", ".join(s["cites"])) if s["cites"] else "")
|
|
5061
|
+
for s in open_stories) or " (no open stories)"
|
|
5062
|
+
|
|
5063
|
+
# ---- which story ------------------------------------------------------------
|
|
5064
|
+
want = (os.environ.get("AW_STORY") or "").strip()
|
|
5065
|
+
free = os.environ.get("AW_INPUT") or ""
|
|
5066
|
+
target, reason = None, ""
|
|
5067
|
+
if want:
|
|
5068
|
+
hit = [s for s in stories if s["id"] == want or s["file_id"] == want]
|
|
5069
|
+
target = hit[0] if hit else None
|
|
5070
|
+
if not target: reason = "not-found"
|
|
5071
|
+
else:
|
|
5072
|
+
# every known story id appearing as a whole token in the free text; one match
|
|
5073
|
+
# resolves, several is a question, none is a question
|
|
5074
|
+
named = [s for s in stories
|
|
5075
|
+
if re.search(r'(?<![\w-])' + re.escape(s["id"]) + r'(?![\w-])', free)]
|
|
5076
|
+
if len(named) == 1: target = named[0]
|
|
5077
|
+
else: reason = "ambiguous" if named else "none-given"
|
|
5078
|
+
|
|
5079
|
+
out = {"ok": True, "stories_dir": sdir, "stories_exist": os.path.isdir(sdir),
|
|
5080
|
+
"open_count": len(open_stories), "any_open": bool(open_stories),
|
|
5081
|
+
"open_ids": open_ids, "open_ids_csv": ", ".join(open_ids), "digest": digest,
|
|
5082
|
+
"resolved": bool(target), "needs_pick": not target, "pick_reason": reason,
|
|
5083
|
+
"story": "", "story_path": "", "story_status": "", "story_open": False,
|
|
5084
|
+
"story_type": "", "is_technical": False,
|
|
5085
|
+
"status_msg": "", "story_title": "", "exercises_csv": "", "constraints_csv": "",
|
|
5086
|
+
"story_spec_version": "", "current_version": "", "stale_csv": "", "stale_note": "",
|
|
5087
|
+
"story_dir": "", "if_tmp": "", "legacy_doc": "", "legacy_doc_exists": False,
|
|
5088
|
+
"be_doc_path": "", "be_doc_exists": False, "be_next_pass": 1, "be_pass_tmp": "",
|
|
5089
|
+
"be_last_pass": 0, "be_doc_spec_version": "", "be_doc_stale": False,
|
|
5090
|
+
"fe_doc_path": "", "fe_doc_exists": False, "fe_next_pass": 1, "fe_pass_tmp": "",
|
|
5091
|
+
"fe_last_pass": 0, "fe_doc_spec_version": "", "fe_doc_stale": False,
|
|
5092
|
+
"adr_path": os.path.join(fd, "adr.md"), "adr_exists": os.path.isfile(os.path.join(fd, "adr.md")),
|
|
5093
|
+
"if_path": os.path.join(fd, "interfaces.md"), "if_exists": os.path.isfile(os.path.join(fd, "interfaces.md")),
|
|
5094
|
+
"spec_exists": os.path.isfile(spec)}
|
|
5095
|
+
|
|
5096
|
+
# ---- the ledger (widest-wins current version, same rule ledger-append uses) --
|
|
5097
|
+
rows, cur = [], ""
|
|
5098
|
+
if os.path.isfile(spec):
|
|
5099
|
+
stext = open(spec, encoding="utf-8", errors="replace").read()
|
|
5100
|
+
m = re.search(r'^##\s+Change History\s*$', stext, re.M)
|
|
5101
|
+
if m:
|
|
5102
|
+
for line in stext[m.end():].splitlines():
|
|
5103
|
+
rm = re.match(r'^\|\s*(v\d+(?:\.\d+)?)\s*\|', line)
|
|
5104
|
+
if rm: rows.append((rm.group(1), line))
|
|
5105
|
+
hv = re.search(r'^\*\*Version\*\*:\s*(v[\d.]+)', stext, re.M)
|
|
5106
|
+
cands = [r[0] for r in rows] + ([hv.group(1)] if hv else [])
|
|
5107
|
+
if cands: cur = max(cands, key=vtuple)
|
|
5108
|
+
out["current_version"] = cur
|
|
5109
|
+
|
|
5110
|
+
if not target:
|
|
5111
|
+
print(json.dumps(out)); sys.exit(0)
|
|
5112
|
+
|
|
5113
|
+
# ---- the resolved story -----------------------------------------------------
|
|
5114
|
+
status = target["status"]
|
|
5115
|
+
out.update(story=target["id"], story_path=target["path"], story_status=status,
|
|
5116
|
+
story_open=(status == "open"), story_title=target["title"],
|
|
5117
|
+
story_type=target["type"], is_technical=(target["type"] == "technical"),
|
|
5118
|
+
exercises_csv=", ".join(target["cites"]),
|
|
5119
|
+
story_spec_version=target["spec_version"])
|
|
5120
|
+
if status != "open":
|
|
5121
|
+
verb = {"closed": "was closed — its plan is history. Remaining work needs its own story "
|
|
5122
|
+
"(sync-stories mints a follow-on when the spec moves)",
|
|
5123
|
+
"cancelled": "was cancelled — cancelled work is not planned; open a new story if the need returns",
|
|
5124
|
+
"draft": "is a draft proposal — run /appweaver sync-spec to merge it into the contract first; "
|
|
5125
|
+
"story-plan designs only against merged requirements"}
|
|
5126
|
+
out["status_msg"] = "Story %s %s." % (
|
|
5127
|
+
target["id"], verb.get(status, "has status '%s', not open" % status))
|
|
5128
|
+
|
|
5129
|
+
# bound constraint ids come from the story BODY's ## Constraints section (they are
|
|
5130
|
+
# barred from exercises: by design — met, not delivered)
|
|
5131
|
+
cm = re.search(r'^##\s+Constraints\s*$(.*?)(?=^##\s|\Z)', target["text"], re.M | re.S)
|
|
5132
|
+
cons = sorted(set(re.findall(r'\b(?:CN|DC|IC|UX)-\d+', cm.group(1)))) if cm else []
|
|
5133
|
+
out["constraints_csv"] = ", ".join(cons)
|
|
5134
|
+
|
|
5135
|
+
# staleness: ledger rows ABOVE the story's stamp naming an id the story carries —
|
|
5136
|
+
# exercises: AND the Constraints section, so a moved bound is announced too
|
|
5137
|
+
sv = target["spec_version"]
|
|
5138
|
+
if sv:
|
|
5139
|
+
carried = set(target["cites"]) | set(cons)
|
|
5140
|
+
moved = [r for r in rows if vtuple(r[0]) > vtuple(sv)]
|
|
5141
|
+
stale = sorted({i for _v, l in moved for i in re.findall(r'[A-Z]{2}-\d+', l) if i in carried})
|
|
5142
|
+
out["stale_csv"] = ", ".join(stale)
|
|
5143
|
+
if stale:
|
|
5144
|
+
out["stale_note"] = (
|
|
5145
|
+
"CAUTION: the spec moved above this story's stamp (%s -> %s) on ids this story "
|
|
5146
|
+
"carries: %s. Design against the CURRENT spec text, record the divergence under "
|
|
5147
|
+
"Risks, and consider /appweaver sync-stories to bring the backlog back in step."
|
|
5148
|
+
% (sv, cur or "?", ", ".join(stale)))
|
|
5149
|
+
|
|
5150
|
+
# doc / pass state + the temp paths the workflow writes through. ONE DOCUMENT PER
|
|
5151
|
+
# LANE: the service design and the UI design are authored by different steps, under
|
|
5152
|
+
# different rule sets, from different code, and are read by different implement
|
|
5153
|
+
# commands — folded into one file, every one of those becomes a section boundary the
|
|
5154
|
+
# next reader has to trust. Pass numbers are per file, so a run that designs only the
|
|
5155
|
+
# backend leaves the frontend's count exactly where it was.
|
|
5156
|
+
#
|
|
5157
|
+
# legacy_doc is the pre-split story-plan.md. It is REPORTED, never read and never
|
|
5158
|
+
# written: a design nobody consumes must not sit silently beside two that are.
|
|
5159
|
+
stdir = os.path.join(sdir, target["id"])
|
|
5160
|
+
legacy = os.path.join(stdir, "story-plan.md")
|
|
5161
|
+
out.update(story_dir=stdir, if_tmp=os.path.join(stdir, ".if-entries.tmp.md"),
|
|
5162
|
+
legacy_doc=legacy, legacy_doc_exists=os.path.isfile(legacy))
|
|
5163
|
+
for lane, stem in (("be", "backend"), ("fe", "frontend")):
|
|
5164
|
+
doc = os.path.join(stdir, "story-%s-plan.md" % stem)
|
|
5165
|
+
out[lane + "_doc_path"] = doc
|
|
5166
|
+
out[lane + "_doc_exists"] = os.path.isfile(doc)
|
|
5167
|
+
out[lane + "_pass_tmp"] = os.path.join(stdir, ".%s-pass.tmp.md" % stem)
|
|
5168
|
+
if out[lane + "_doc_exists"]:
|
|
5169
|
+
d = open(doc, encoding="utf-8", errors="replace").read()
|
|
5170
|
+
nums = [int(n) for n in re.findall(r'^##\s+Design pass\s+(\d+)', d, re.M)]
|
|
5171
|
+
out[lane + "_next_pass"] = (max(nums) + 1) if nums else 1
|
|
5172
|
+
# What implement needs on top of the path: WHICH pass it builds from (the last
|
|
5173
|
+
# one — earlier passes are superseded history) and the spec version that pass was
|
|
5174
|
+
# designed against. A design behind the current spec is ANNOUNCED at implement,
|
|
5175
|
+
# never refused: the story is legitimately in flight, and the spec may well have
|
|
5176
|
+
# moved on ids this story does not carry. stale_csv is the sharper signal and it
|
|
5177
|
+
# is already computed above.
|
|
5178
|
+
out[lane + "_last_pass"] = max(nums) if nums else 0
|
|
5179
|
+
dv = (parse_fm(d).get("spec_version") or "").strip().strip('"')
|
|
5180
|
+
out[lane + "_doc_spec_version"] = dv
|
|
5181
|
+
out[lane + "_doc_stale"] = bool(dv and cur and vtuple(dv) < vtuple(cur))
|
|
5182
|
+
print(json.dumps(out))
|
|
5183
|
+
PY
|
|
5184
|
+
}
|
|
5185
|
+
|
|
5186
|
+
cmd_story_plan_doc() {
|
|
5187
|
+
local fd_arg="" story="" pass_file="" spec_version="" lane="backend"
|
|
5188
|
+
while [ $# -gt 0 ]; do
|
|
5189
|
+
case "$1" in
|
|
5190
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
5191
|
+
--story) story="$2"; shift 2 ;;
|
|
5192
|
+
--lane) lane="$2"; shift 2 ;;
|
|
5193
|
+
--pass-file) pass_file="$2"; shift 2 ;;
|
|
5194
|
+
--spec-version) spec_version="$2"; shift 2 ;;
|
|
5195
|
+
--help|-h) echo "story-plan-doc --story <id> --pass-file <path> [--lane backend|frontend] [--spec-version <v>] [--feature-dir <path>]"; return 0 ;;
|
|
5196
|
+
*) echo "story-plan-doc: unknown arg '$1'" >&2; return 1 ;;
|
|
5197
|
+
esac
|
|
5198
|
+
done
|
|
5199
|
+
[ -n "$story" ] || { echo "story-plan-doc: --story is required" >&2; return 1; }
|
|
5200
|
+
[ -n "$pass_file" ] || { echo "story-plan-doc: --pass-file is required" >&2; return 1; }
|
|
5201
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
5202
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "story-plan-doc: no feature set and no --feature-dir" >&2; return 1; }
|
|
5203
|
+
AW_FD="$fd" AW_STORY="$story" AW_LANE="$lane" AW_PASS="$pass_file" AW_VER="$spec_version" python3 - <<'PY'
|
|
5204
|
+
import json, os, re, sys, datetime
|
|
5205
|
+
fd = os.environ["AW_FD"]; story = os.environ["AW_STORY"].strip()
|
|
5206
|
+
pf = os.environ["AW_PASS"]; ver = (os.environ.get("AW_VER") or "").strip()
|
|
5207
|
+
lane = (os.environ.get("AW_LANE") or "backend").strip().lower()
|
|
5208
|
+
sdir = os.path.join(fd, "stories", story)
|
|
5209
|
+
doc = os.path.join(sdir, "story-%s-plan.md" % lane)
|
|
5210
|
+
|
|
5211
|
+
def bail(msg, code=2):
|
|
5212
|
+
print(json.dumps({"ok": False, "doc": doc, "error": msg}))
|
|
5213
|
+
sys.stderr.write(msg + "\n"); sys.exit(code)
|
|
5214
|
+
|
|
5215
|
+
if lane not in ("backend", "frontend"):
|
|
5216
|
+
bail("story-plan-doc: --lane must be backend or frontend, not '%s'" % lane)
|
|
5217
|
+
if not os.path.isfile(os.path.join(fd, "stories", story + ".md")):
|
|
5218
|
+
bail("story-plan-doc: no story file for '%s' — the plan lives beside a story that exists" % story)
|
|
5219
|
+
if not os.path.isfile(pf):
|
|
5220
|
+
bail("story-plan-doc: pass file missing at %s — the authoring step wrote nothing" % pf)
|
|
5221
|
+
content = open(pf, encoding="utf-8", errors="replace").read().strip()
|
|
5222
|
+
if not content:
|
|
5223
|
+
bail("story-plan-doc: the authored pass is empty — nothing appended")
|
|
5224
|
+
# the pass header is SCRIPT-written; strip one the model wrote anyway rather than
|
|
5225
|
+
# letting the doc double-number
|
|
5226
|
+
content = re.sub(r'^##\s+Design pass\b[^\n]*\n+', '', content, count=1)
|
|
5227
|
+
|
|
5228
|
+
LANE_WORD = "SERVICE" if lane == "backend" else "UI"
|
|
5229
|
+
LANE_READER = "/appweaver implement" if lane == "backend" else "/appweaver implement-ui"
|
|
5230
|
+
os.makedirs(sdir, exist_ok=True)
|
|
5231
|
+
today = datetime.date.today().isoformat()
|
|
5232
|
+
created = not os.path.isfile(doc)
|
|
5233
|
+
if created:
|
|
5234
|
+
open(doc, "w", encoding="utf-8").write("""---
|
|
5235
|
+
created: %s
|
|
5236
|
+
updated: %s
|
|
5237
|
+
passes: 0
|
|
5238
|
+
spec_version: ""
|
|
5239
|
+
---
|
|
5240
|
+
|
|
5241
|
+
<!--
|
|
5242
|
+
STORY DESIGN (%s LANE) — the ephemeral execution design for ONE story, read by
|
|
5243
|
+
%s.
|
|
5244
|
+
|
|
5245
|
+
Identity is positional: the file lives in the story's directory and carries no
|
|
5246
|
+
story id in its text. Every /appweaver story-plan run APPENDS a "## Design pass N"
|
|
5247
|
+
section to THIS lane's file — nothing is edited in place, so a manual edit to an
|
|
5248
|
+
earlier pass survives a re-run. THE LATEST PASS WINS; earlier passes are the
|
|
5249
|
+
iteration history.
|
|
5250
|
+
|
|
5251
|
+
EDIT IT BEFORE YOU IMPLEMENT. This is the document a design is corrected in by
|
|
5252
|
+
hand: change the latest pass and implement builds what you changed. Re-running
|
|
5253
|
+
story-plan instead appends a fresh pass that supersedes it, so hand-edit to
|
|
5254
|
+
adjust, re-run to redesign.
|
|
5255
|
+
|
|
5256
|
+
It is scaffolding for confirming the implementation strategy — archived with the
|
|
5257
|
+
story at close, never maintained afterwards. Durable decisions do not live here:
|
|
5258
|
+
the latest pass PROPOSES ADRs (ratified into the feature's adr.md at close), and
|
|
5259
|
+
published-surface changes are appended to the feature's interfaces.md as proposed
|
|
5260
|
+
entries at design time. spec_version below is the spec the LATEST pass was
|
|
5261
|
+
designed against. The other lane's design, where the project has one, sits beside
|
|
5262
|
+
this file — the two are written apart on purpose and neither restates the other.
|
|
5263
|
+
-->
|
|
5264
|
+
""" % (today, today, LANE_WORD, LANE_READER))
|
|
5265
|
+
text = open(doc, encoding="utf-8", errors="replace").read()
|
|
5266
|
+
nums = [int(n) for n in re.findall(r'^##\s+Design pass\s+(\d+)', text, re.M)]
|
|
5267
|
+
n = (max(nums) + 1) if nums else 1
|
|
5268
|
+
header = "## Design pass %d — %s%s" % (n, today, (" (spec %s)" % ver) if ver else "")
|
|
5269
|
+
text = text.rstrip("\n") + "\n\n" + header + "\n\n" + content + "\n"
|
|
5270
|
+
# frontmatter stamps — first match only, which is the frontmatter by position
|
|
5271
|
+
text = re.sub(r'^(updated:).*$', r'\g<1> ' + today, text, count=1, flags=re.M)
|
|
5272
|
+
text = re.sub(r'^(passes:).*$', r'\g<1> %d' % n, text, count=1, flags=re.M)
|
|
5273
|
+
if ver:
|
|
5274
|
+
text = re.sub(r'^(spec_version:).*$', r'\g<1> %s' % ver, text, count=1, flags=re.M)
|
|
5275
|
+
open(doc, "w", encoding="utf-8").write(text)
|
|
5276
|
+
os.remove(pf)
|
|
5277
|
+
print(json.dumps({"ok": True, "doc": doc, "lane": lane, "pass": n, "created": created,
|
|
5278
|
+
"spec_version": ver, "story_dir": sdir}))
|
|
5279
|
+
PY
|
|
5280
|
+
}
|
|
5281
|
+
|
|
5282
|
+
cmd_log_append() {
|
|
5283
|
+
local fd_arg="" log="" entries_file="" status=""
|
|
5284
|
+
while [ $# -gt 0 ]; do
|
|
5285
|
+
case "$1" in
|
|
5286
|
+
--feature-dir) fd_arg="$2"; shift 2 ;;
|
|
5287
|
+
--log) log="$2"; shift 2 ;;
|
|
5288
|
+
--entries-file) entries_file="$2"; shift 2 ;;
|
|
5289
|
+
--status) status="$2"; shift 2 ;;
|
|
5290
|
+
--help|-h) echo "log-append --log adr|interfaces --entries-file <path> [--status <s>] [--feature-dir <path>]"; return 0 ;;
|
|
5291
|
+
*) echo "log-append: unknown arg '$1'" >&2; return 1 ;;
|
|
5292
|
+
esac
|
|
5293
|
+
done
|
|
5294
|
+
case "$log" in adr|interfaces) ;; *) echo "log-append: --log must be adr or interfaces" >&2; return 1 ;; esac
|
|
5295
|
+
[ -n "$entries_file" ] || { echo "log-append: --entries-file is required" >&2; return 1; }
|
|
5296
|
+
local repo_root; repo_root=$(get_repo_root)
|
|
5297
|
+
local fd; fd=$(_resolve_feature_dir "$fd_arg" "$repo_root") || { echo "log-append: no feature set and no --feature-dir" >&2; return 1; }
|
|
5298
|
+
AW_FD="$fd" AW_LOG="$log" AW_ENTRIES="$entries_file" AW_STATUS="$status" python3 - <<'PY'
|
|
5299
|
+
import json, os, re, sys, datetime
|
|
5300
|
+
fd = os.environ["AW_FD"]; log = os.environ["AW_LOG"]
|
|
5301
|
+
ef = os.environ["AW_ENTRIES"]; status = (os.environ.get("AW_STATUS") or "").strip()
|
|
5302
|
+
fname, prefix, default_status, title = {
|
|
5303
|
+
"interfaces": ("interfaces.md", "IF", "proposed", "Interface Log"),
|
|
5304
|
+
"adr": ("adr.md", "ADR", "accepted", "Architecture Decision Log")}[log]
|
|
5305
|
+
status = status or default_status
|
|
5306
|
+
path = os.path.join(fd, fname)
|
|
5307
|
+
|
|
5308
|
+
def bail(msg, code=2):
|
|
5309
|
+
print(json.dumps({"ok": False, "log": path, "error": msg}))
|
|
5310
|
+
sys.stderr.write(msg + "\n"); sys.exit(code)
|
|
5311
|
+
|
|
5312
|
+
if not os.path.isfile(ef):
|
|
5313
|
+
bail("log-append: entries file missing at %s — the authoring step wrote nothing" % ef)
|
|
5314
|
+
raw = open(ef, encoding="utf-8", errors="replace").read().strip()
|
|
5315
|
+
if not raw or raw.lower().rstrip(".") == "none":
|
|
5316
|
+
os.remove(ef)
|
|
5317
|
+
print(json.dumps({"ok": True, "log": path, "appended": 0, "ids_csv": "",
|
|
5318
|
+
"unknown_ids_csv": "", "bad_supersedes_csv": "", "none": True}))
|
|
5319
|
+
sys.exit(0)
|
|
5320
|
+
|
|
5321
|
+
# every entry must arrive as '## <PREFIX>-NEW — <title>': the script is the only id
|
|
5322
|
+
# authority, so a model-numbered entry is refused rather than trusted
|
|
5323
|
+
blocks = [b.strip() for b in re.split(r'(?=^##\s)', raw, flags=re.M) if b.strip()]
|
|
5324
|
+
bad = [b.splitlines()[0] for b in blocks
|
|
5325
|
+
if not re.match(r'^##\s+%s-NEW\s+[—-]+\s+\S' % prefix, b)]
|
|
5326
|
+
if bad:
|
|
5327
|
+
bail("log-append: every entry must start '## %s-NEW — <title>' (the script assigns "
|
|
5328
|
+
"ids); got: %s" % (prefix, " | ".join(bad[:3])))
|
|
5329
|
+
|
|
5330
|
+
SCAFFOLD = {
|
|
5331
|
+
"interfaces": """<!--
|
|
5332
|
+
INTERFACE LOG — this feature's published-surface contract. APPEND-ONLY.
|
|
5333
|
+
|
|
5334
|
+
WHO WRITES: /appweaver plan publishes this feature's surface whenever it authors or
|
|
5335
|
+
conforms backend-plan.md; a BE story plan appends an entry only where its slice
|
|
5336
|
+
changes that surface. Both land as status: proposed, and story close verifies each
|
|
5337
|
+
against the as-built and flips it to live.
|
|
5338
|
+
WHO READS: /appweaver plan-ui and the FE story designs — this log is the BE-to-FE
|
|
5339
|
+
contract anchor, and the plan documents CITE these ids rather than restating them.
|
|
5340
|
+
The current surface per interface is the LATEST entry — one that names an earlier
|
|
5341
|
+
id in `supersedes:` replaces it. Never edit an existing entry; publish a
|
|
5342
|
+
superseding one. status: proposed -> live -> superseded | retired.
|
|
5343
|
+
`serves:` cites the FR-/BR- ids the interface exists for, so a spec change to
|
|
5344
|
+
those ids flags the contract for review.
|
|
5345
|
+
-->
|
|
5346
|
+
|
|
5347
|
+
# Interface Log
|
|
5348
|
+
""",
|
|
5349
|
+
"adr": """<!--
|
|
5350
|
+
ADR LOG — this feature's durable decisions. APPEND-ONLY.
|
|
5351
|
+
|
|
5352
|
+
A story plan PROPOSES ADRs in its latest design pass; they are ratified into this
|
|
5353
|
+
log at story close, or the architect appends directly. Never rewrite an entry —
|
|
5354
|
+
supersede it with a new one naming `supersedes:`. An ADR records ONLY what neither
|
|
5355
|
+
the code nor the rules can say: a deliberate choice among rule-compliant
|
|
5356
|
+
alternatives, a rejected alternative and why, or a trade-off with its revisit
|
|
5357
|
+
trigger. It never restates what code shows or a rule mandates.
|
|
5358
|
+
-->
|
|
5359
|
+
|
|
5360
|
+
# Architecture Decision Log
|
|
5361
|
+
"""}
|
|
5362
|
+
created = not os.path.isfile(path)
|
|
5363
|
+
if created:
|
|
5364
|
+
open(path, "w", encoding="utf-8").write(SCAFFOLD[log])
|
|
5365
|
+
text = open(path, encoding="utf-8", errors="replace").read()
|
|
5366
|
+
existing = set(re.findall(r'^##\s+(%s-\d+)' % prefix, text, re.M))
|
|
5367
|
+
nums = [int(i.split("-")[1]) for i in existing]
|
|
5368
|
+
nxt = (max(nums) + 1) if nums else 1
|
|
5369
|
+
today = datetime.date.today().isoformat()
|
|
5370
|
+
|
|
5371
|
+
spec = os.path.join(fd, "spec.md")
|
|
5372
|
+
known = set(re.findall(r'\b[A-Z]{2}-\d+\b',
|
|
5373
|
+
open(spec, encoding="utf-8", errors="replace").read())) \
|
|
5374
|
+
if os.path.isfile(spec) else set()
|
|
5375
|
+
|
|
5376
|
+
assigned, unknown, badsup, out_blocks = [], [], [], []
|
|
5377
|
+
for b in blocks:
|
|
5378
|
+
bid = "%s-%03d" % (prefix, nxt); nxt += 1
|
|
5379
|
+
lines = b.splitlines()
|
|
5380
|
+
lines[0] = lines[0].replace("%s-NEW" % prefix, bid, 1)
|
|
5381
|
+
body = "\n".join(lines[1:]).strip("\n")
|
|
5382
|
+
# status and date are script-stamped, whatever the model wrote
|
|
5383
|
+
body = re.sub(r'^status:.*\n?', '', body, flags=re.M)
|
|
5384
|
+
body = re.sub(r'^date:.*\n?', '', body, flags=re.M)
|
|
5385
|
+
body = ("status: %s\ndate: %s" % (status, today)) + ("\n" + body if body else "")
|
|
5386
|
+
for line in body.splitlines():
|
|
5387
|
+
if line.startswith("serves:"):
|
|
5388
|
+
unknown += [i for i in re.findall(r'\b[A-Z]{2}-\d+\b', line)
|
|
5389
|
+
if known and i not in known]
|
|
5390
|
+
if line.startswith("supersedes:"):
|
|
5391
|
+
badsup += [i for i in re.findall(r'\b%s-\d+\b' % prefix, line)
|
|
5392
|
+
if i not in existing]
|
|
5393
|
+
out_blocks.append(lines[0] + "\n\n" + body)
|
|
5394
|
+
assigned.append(bid)
|
|
5395
|
+
|
|
5396
|
+
text = text.rstrip("\n") + "\n\n" + "\n\n".join(out_blocks) + "\n"
|
|
5397
|
+
open(path, "w", encoding="utf-8").write(text)
|
|
5398
|
+
os.remove(ef)
|
|
5399
|
+
print(json.dumps({"ok": True, "log": path, "appended": len(assigned),
|
|
5400
|
+
"ids_csv": ", ".join(assigned),
|
|
5401
|
+
"unknown_ids_csv": ", ".join(sorted(set(unknown))),
|
|
5402
|
+
"bad_supersedes_csv": ", ".join(sorted(set(badsup))),
|
|
5403
|
+
"none": False, "created_log": created}))
|
|
5404
|
+
PY
|
|
5405
|
+
}
|
|
5406
|
+
|
|
3377
5407
|
case "$sub" in
|
|
3378
5408
|
resolve-domain) cmd_resolve_domain "$@" ;;
|
|
3379
5409
|
resolve-tech) cmd_resolve_tech "$@" ;;
|
|
@@ -3399,13 +5429,24 @@ case "$sub" in
|
|
|
3399
5429
|
spec-snapshot) cmd_spec_snapshot "$@" ;;
|
|
3400
5430
|
spec-diff) cmd_spec_diff "$@" ;;
|
|
3401
5431
|
story-refs) cmd_story_refs "$@" ;;
|
|
5432
|
+
slice-mode) cmd_slice_mode "$@" ;;
|
|
5433
|
+
backlog-plan) cmd_backlog_plan "$@" ;;
|
|
5434
|
+
story-stamp) cmd_story_stamp "$@" ;;
|
|
5435
|
+
story-plan-check) cmd_story_plan_check "$@" ;;
|
|
5436
|
+
story-plan-doc) cmd_story_plan_doc "$@" ;;
|
|
5437
|
+
log-append) cmd_log_append "$@" ;;
|
|
5438
|
+
ledger-read) cmd_ledger_read "$@" ;;
|
|
3402
5439
|
spec-coverage) cmd_spec_coverage "$@" ;;
|
|
3403
5440
|
spec-preserve) cmd_spec_preserve "$@" ;;
|
|
3404
5441
|
spec-markers) cmd_spec_markers "$@" ;;
|
|
3405
5442
|
feature-paths) cmd_feature_paths "$@" ;;
|
|
3406
5443
|
design-scaffold) cmd_design_scaffold "$@" ;;
|
|
5444
|
+
plan-check) cmd_plan_check "$@" ;;
|
|
5445
|
+
plan-stamp) cmd_plan_stamp "$@" ;;
|
|
5446
|
+
gate-result) cmd_gate_result "$@" ;;
|
|
3407
5447
|
build-compile) cmd_build_compile "$@" ;;
|
|
3408
5448
|
test-run) cmd_test_run "$@" ;;
|
|
5449
|
+
test-diff) cmd_test_diff "$@" ;;
|
|
3409
5450
|
run-migrate) cmd_run_migrate "$@" ;;
|
|
3410
5451
|
deploy-dispatch) cmd_deploy_dispatch "$@" ;;
|
|
3411
5452
|
cr-setup) cmd_cr_setup "$@" ;;
|