gobby-wiki 0.8.0

Gobby wiki CLI shell
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

use std::collections::BTreeSet;
use std::path::Path;

use crate::frontmatter::WikiLifecycle;
use crate::support::scope::scope_includes_page;
use crate::{CommandOutcome, ScopeSelection, WikiError, audit, lint};

pub(crate) fn execute(selection: ScopeSelection) -> Result<CommandOutcome, WikiError> {
    super::run_analysis_command(
        "audit",
        selection,
        "serialize audit report",
        |root, output_scope| {
            let report =
                audit::run_with_options(root, output_scope, audit::AuditOptions::from_env())?;
            promote_verified_lifecycle(root, &report)?;
            Ok(report)
        },
        audit::render_text,
    )
}

/// An audit citation pass promotes `reviewed` pages with zero unsupported
/// claims to `verified`. Only the `gwiki audit` command mutates; trust and
/// librarian call `audit::run_with_options` directly and stay read-only.
/// Legacy pages without a lifecycle field are never touched, and `draft`
/// pages must earn `reviewed` from the librarian first.
fn promote_verified_lifecycle(
    vault_root: &Path,
    report: &audit::AuditReport,
) -> Result<(), WikiError> {
    let unsupported: BTreeSet<&Path> = report
        .unsupported_claims
        .iter()
        .map(|claim| claim.path.as_path())
        .collect();
    for page in lint::collect_pages(vault_root)? {
        if !scope_includes_page(&report.scope, &page.relative_path) {
            continue;
        }
        if page.parsed.frontmatter.lifecycle != Some(WikiLifecycle::Reviewed) {
            continue;
        }
        if unsupported.contains(page.relative_path.as_path()) {
            continue;
        }
        crate::lifecycle::apply_lifecycle_transition(
            vault_root,
            &report.scope,
            &page.relative_path,
            WikiLifecycle::Verified,
            "audit: citation pass with no unsupported claims",
        )?;
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use super::*;
    use crate::ScopeIdentity;
    use crate::frontmatter::parse_frontmatter;

    fn write_page(root: &Path, relative: &str, markdown: &str) {
        let path = root.join(relative);
        std::fs::create_dir_all(path.parent().expect("page parent")).expect("create parent");
        std::fs::write(path, markdown).expect("write page");
    }

    fn report_with_unsupported(root: &Path, unsupported_paths: &[&str]) -> audit::AuditReport {
        let source_context = Arc::new(Vec::new());
        audit::AuditReport {
            command: "audit",
            scope: ScopeIdentity::project("proj"),
            root: root.to_path_buf(),
            claims: Vec::new(),
            unsupported_claims: unsupported_paths
                .iter()
                .map(|path| audit::UnsupportedClaim {
                    path: (*path).into(),
                    line: 1,
                    heading: None,
                    claim: "claim".to_string(),
                    reason: "no citation".to_string(),
                    source_context: Arc::clone(&source_context),
                })
                .collect(),
            source_context,
        }
    }

    #[test]
    fn citation_pass_promotes_reviewed_pages_to_verified() {
        let temp = tempfile::tempdir().expect("tempdir");
        write_page(
            temp.path(),
            "knowledge/concepts/supported.md",
            "---\ntitle: Supported\nlifecycle: reviewed\n---\n\nBody.\n",
        );
        write_page(
            temp.path(),
            "knowledge/concepts/unsupported.md",
            "---\ntitle: Unsupported\nlifecycle: reviewed\n---\n\nBody.\n",
        );
        write_page(
            temp.path(),
            "knowledge/concepts/draft.md",
            "---\ntitle: Draft\nlifecycle: draft\n---\n\nBody.\n",
        );
        let report = report_with_unsupported(temp.path(), &["knowledge/concepts/unsupported.md"]);

        promote_verified_lifecycle(temp.path(), &report).expect("promotion pass");

        let lifecycle_of = |relative: &str| {
            let markdown = std::fs::read_to_string(temp.path().join(relative)).expect("read page");
            parse_frontmatter(&markdown)
                .expect("parse")
                .metadata
                .lifecycle
        };
        assert_eq!(
            lifecycle_of("knowledge/concepts/supported.md"),
            Some(WikiLifecycle::Verified)
        );
        assert_eq!(
            lifecycle_of("knowledge/concepts/unsupported.md"),
            Some(WikiLifecycle::Reviewed)
        );
        assert_eq!(
            lifecycle_of("knowledge/concepts/draft.md"),
            Some(WikiLifecycle::Draft)
        );

        let log = std::fs::read_to_string(temp.path().join("log.md")).expect("read log");
        assert_eq!(log.matches("lifecycle_transition:").count(), 1, "{log}");
        assert!(log.contains("reviewed -> verified"), "{log}");
    }
}