specfold-core 0.4.0

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
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
65
66
67
68
69
70

//! Stale: the code a document governs changed long after the document did, or, for a document
//! pinned with `verified_at: <commit>`, changed in any commit since the pin.

use super::super::types::{Item, Kind};
use super::days_between;
use crate::check::rules::support::quote;
use crate::corpus::Corpus;
use crate::workspace::vcs;

pub fn run(c: &Corpus, docs: &[usize], out: &mut Vec<Item>) {
    let limit = c.cfg.raw.audit.stale_days;
    for &i in docs {
        let d = &c.docs[i];
        if d.status().as_deref() != Some("active") {
            continue;
        }
        let governs = d.rel().remove("governs").unwrap_or_default();
        if governs.is_empty() {
            continue;
        }
        if let Some(pin) = d.str_field("verified_at") {
            // Commits to documents are not changes to the code they describe, and the pin's own
            // commit would otherwise always count.
            let docs = vec![format!("**/{}/**", c.cfg.spec_dir()), format!("{}/**", c.cfg.spec_dir())];
            let repin = format!("spec set {} verified_at=HEAD --write", crate::shell::word(&d.id));
            let (detail, next) = match vcs::commits_since(&c.cfg.root, &pin, &governs, &docs) {
                // No diff can start from a pin git does not know; re-pinning is the only step.
                None => (format!("verified_at {pin} is not a commit in this repository"), repin),
                Some(list) if list.is_empty() => continue,
                Some(list) => (
                    format!(
                        "governed code changed in {} commit(s) since verified_at {pin} (latest {})",
                        list.len(),
                        list[0]
                    ),
                    format!(
                        "git diff {pin}..HEAD -- {}  # then update the body and: {repin}",
                        governs.iter().map(|g| quote(g)).collect::<Vec<_>>().join(" ")
                    ),
                ),
            };
            out.push(Item {
                kind: Kind::Stale,
                subject: d.id.to_string(),
                path: d.path.clone(),
                line: 1,
                detail,
                next: Some(next),
            });
            continue;
        }
        let Some(updated) = d.str_field("updated") else { continue };
        let Some(code) = vcs::last_change(&c.cfg.root, &governs) else { continue };
        let Some(gap) = days_between(&updated, &code) else { continue };
        if gap > limit {
            out.push(Item {
                kind: Kind::Stale,
                subject: d.id.to_string(),
                path: d.path.clone(),
                line: 1,
                detail: format!("governed code changed {code}, {gap} days after the document ({updated})"),
                next: Some(format!(
                    "spec show {} && spec log {}",
                    crate::shell::word(&d.id),
                    crate::shell::word(&d.id)
                )),
            });
        }
    }
}