spec-driven-docs 0.8.1

Spec-driven documentation: current specs, immutable decision records, and executable gates kept coherent for people and coding agents.
Documentation 
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

//! Gate: a known-issue record carries one filing state.
//!
//! The filing state says where the case stands upstream, which the state
//! axis never answers: a masked workaround says nothing about whether the
//! evidence behind it is ticket-ready. With the field judged, a grep for
//! `filing: ready` answers which cases someone can file today, and
//! `filing: filed` is what binds a record to its report body.

use crate::domain::rule_id::RuleId;
use crate::gates::ki_record::{FILINGS, judge};
use crate::gates::{GateCtx, GateResult};

/// The rules this gate can cite.
pub const CITES: &[RuleId] = &[RuleId::RecordCarriesOneFilingState];

/// Judge every known-issue record under the resolved roots.
///
/// # Errors
///
/// [`crate::gates::GateError::Io`] when a record cannot be read.
pub fn run(ctx: &GateCtx, args: &[String]) -> GateResult {
    judge(
        ctx,
        args,
        "filing",
        &FILINGS,
        RuleId::RecordCarriesOneFilingState,
    )
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::gates::tests_support::ki_fixture_filing;

    fn run_on(filing: &str) -> Vec<String> {
        let dir = ki_fixture_filing(
            filing,
            "https://example.invalid/issues/1234",
            "# V\n## Report\nT\n",
        );
        let ctx = GateCtx::new(dir.path().to_str().unwrap());
        run(&ctx, &[])
            .unwrap()
            .iter()
            .map(ToString::to_string)
            .collect()
    }

    #[test]
    fn accepts_every_filing_state_the_method_defines() {
        for filing in FILINGS {
            assert!(run_on(filing).is_empty(), "{filing} was rejected");
        }
    }

    #[test]
    fn rejects_a_filing_state_the_method_does_not_define() {
        let out = run_on("open");
        assert_eq!(out.len(), 1);
        assert!(out[0].starts_with("FAIL known-issues:a-record-carries-one-filing-state "));
        assert!(out[0].ends_with(": filing: open is not one of gathering, ready, filed, deferred"));
    }
}