1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// SPDX-License-Identifier: GPL-3.0-only
//! `plan` — the authored implementation-plan read model.
//!
//! An engine-tier leaf: `Plan`/`PlanPhase` and the pure `Plan::parse`
//! validator, lifted out of `crate::slice` (SL-016) so the runtime `state`
//! layer can depend on a neutral home instead of reaching *up* into the
//! slice-CLI module. Pure — no clock, disk, or git here; disk IO
//! (`read_plan`) stays in the slice shell and calls `Plan::parse`.
use serde::Deserialize;
use anyhow::{Context, bail};
/// The authored implementation plan, read from `plan.toml`. Only the ordered
/// phase list is consumed in v1 (phase materialisation, slice-004 §5.2); the
/// specs/requirements link tables exist in the file but are empty (no registry
/// yet) and are not modelled. The first relational *read* model — no shared
/// `Meta` (slice-003 Non-Goal).
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct Plan {
#[serde(default)]
pub phases: Vec<PlanPhase>,
}
/// One authored phase row. `id` is the canonical `PHASE-NN` join key; `name`
/// and `objective` seed the disposable phase sheet. The entrance/exit/verification
/// criteria are lifted into the model (SL-170 PHASE-01) so the VT existence/shape
/// gate (PHASE-03 `vtgate`) and downstream IDE-008 can read them; every added
/// field is `#[serde(default)]`, so legacy plans without them round-trip to
/// defaulted empties (the behaviour-preservation gate, design §3).
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct PlanPhase {
pub id: String,
#[serde(default)]
pub name: String,
#[serde(default)]
pub objective: String,
#[serde(default)]
pub entrance_criteria: Vec<Criterion>,
#[serde(default)]
pub exit_criteria: Vec<Criterion>,
#[serde(default)]
pub verification: Vec<VerificationCriterion>,
}
/// An authored entrance (`EN-`) or exit (`EX-`) criterion. `id` is the immutable
/// doc-local handle; `text` is the prose body (defaulted empty if omitted).
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct Criterion {
pub id: String,
#[serde(default)]
pub text: String,
}
/// An authored verification criterion. Mode (VT test / VA agent / VH human) stays
/// encoded in the `id` prefix — there is no separate mode field. `expects` is the
/// free-text expectation (untouched, heterogeneous by design); the P2 structured
/// fields (`test_file` / `keywords` / `patterns`) are the machine-checkable mandate
/// the PHASE-03 gate reads, and `waived` / `waived_reason` are the recorded escape
/// valve. All but `id` default, so legacy `{ id, expects }` rows parse unchanged.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct VerificationCriterion {
pub id: String,
#[serde(default)]
pub expects: String,
#[serde(default)]
pub test_file: Option<String>,
#[serde(default)]
pub keywords: Vec<String>,
#[serde(default)]
pub patterns: Vec<String>,
#[serde(default)]
pub waived: bool,
#[serde(default)]
pub waived_reason: Option<String>,
}
impl Plan {
/// Parse and validate a `plan.toml` body. Rejects a plan whose phase ids
/// are not unique — a duplicate would alias two phases onto one tracking
/// file (finding 6). Per-id well-formedness (`PHASE-<digits>`) is enforced
/// at the filesystem boundary by `state::phase_stem` (slice-004 §9), where
/// an id becomes a filename.
pub(crate) fn parse(text: &str) -> anyhow::Result<Plan> {
// serde renames the TOML `[[phase]]` array to the `phases` field.
#[derive(Deserialize)]
struct Raw {
#[serde(default)]
phase: Vec<PlanPhase>,
}
let raw: Raw = toml::from_str(text).context("Failed to parse plan.toml")?;
let mut seen = std::collections::BTreeSet::new();
for ph in &raw.phase {
if !seen.insert(ph.id.as_str()) {
bail!("Duplicate phase id {} in plan", ph.id);
}
}
Ok(Plan { phases: raw.phase })
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_support::SCHEMA_PLAN_OVERVIEW;
#[test]
fn plan_parse_reads_ordered_phases() {
let text = format!(
r#"
schema = "{SCHEMA_PLAN_OVERVIEW}"
version = 1
slice = "SL-004"
[[phase]]
id = "PHASE-01"
name = "First"
objective = "do a"
[[phase]]
id = "PHASE-02"
name = "Second"
"#
);
let plan = Plan::parse(&text).unwrap();
let ids: Vec<&str> = plan.phases.iter().map(|p| p.id.as_str()).collect();
assert_eq!(ids, vec!["PHASE-01", "PHASE-02"]);
assert_eq!(plan.phases[0].objective, "do a");
// an absent objective defaults to empty, not an error
assert_eq!(plan.phases[1].objective, "");
}
#[test]
fn plan_parse_lifts_criteria_and_p2_fields() {
let text = format!(
r#"
schema = "{SCHEMA_PLAN_OVERVIEW}"
version = 1
slice = "SL-170"
[[phase]]
id = "PHASE-01"
name = "Lift"
objective = "do it"
entrance_criteria = [
{{ id = "EN-1", text = "design locked" }},
]
exit_criteria = [
{{ id = "EX-1", text = "fields parse" }},
]
verification = [
{{ id = "VT-1", expects = "round-trip", test_file = "src/plan.rs", keywords = ["entrance_criteria", "verification"], patterns = ["^\\s*pub"], waived = false }},
{{ id = "VT-2", expects = "behaviour-preserved", waived = true, waived_reason = "covered by existing suite" }},
]
"#
);
let plan = Plan::parse(&text).unwrap();
let ph = &plan.phases[0];
assert_eq!(ph.entrance_criteria.len(), 1);
assert_eq!(ph.entrance_criteria[0].id, "EN-1");
assert_eq!(ph.entrance_criteria[0].text, "design locked");
assert_eq!(ph.exit_criteria[0].id, "EX-1");
assert_eq!(ph.exit_criteria[0].text, "fields parse");
assert_eq!(ph.verification.len(), 2);
let vt1 = &ph.verification[0];
assert_eq!(vt1.id, "VT-1");
assert_eq!(vt1.expects, "round-trip");
assert_eq!(vt1.test_file.as_deref(), Some("src/plan.rs"));
assert_eq!(vt1.keywords, vec!["entrance_criteria", "verification"]);
assert_eq!(vt1.patterns, vec!["^\\s*pub"]);
assert!(!vt1.waived);
assert_eq!(vt1.waived_reason, None);
let vt2 = &ph.verification[1];
assert!(vt2.waived);
assert_eq!(
vt2.waived_reason.as_deref(),
Some("covered by existing suite")
);
}
#[test]
fn plan_parse_defaults_structured_fields_on_legacy_rows() {
let text = format!(
r#"
schema = "{SCHEMA_PLAN_OVERVIEW}"
version = 1
slice = "SL-016"
[[phase]]
id = "PHASE-01"
name = "Legacy"
verification = [
{{ id = "VT-1", expects = "full suite green" }},
]
"#
);
let plan = Plan::parse(&text).unwrap();
let ph = &plan.phases[0];
assert!(ph.entrance_criteria.is_empty());
assert!(ph.exit_criteria.is_empty());
let vt = &ph.verification[0];
assert_eq!(vt.expects, "full suite green");
assert_eq!(vt.test_file, None);
assert!(vt.keywords.is_empty());
assert!(vt.patterns.is_empty());
assert!(!vt.waived);
assert_eq!(vt.waived_reason, None);
}
#[test]
fn plan_parse_rejects_duplicate_phase_ids() {
let text = r#"
[[phase]]
id = "PHASE-01"
[[phase]]
id = "PHASE-01"
"#;
let err = Plan::parse(text).unwrap_err();
assert!(err.to_string().contains("Duplicate phase id PHASE-01"));
}
}