snipdoc 0.1.12

Code Documentation Made Simple
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! This module defines the `Code` database, which get list collected snippets
//! from live code and converts them to a common structure for use with
//! `snipdoc`.
use std::{collections::BTreeMap, path::PathBuf};

use super::{DBData, Db, Result, Snippet};
use crate::parser::{collector::CollectSnippet, SnippetKind};

pub struct Code {
    pub snippets: BTreeMap<PathBuf, Vec<CollectSnippet>>,
}

impl Code {
    #[must_use]
    pub fn new(snippets: BTreeMap<PathBuf, Vec<CollectSnippet>>) -> Self {
        Self { snippets }
    }
}

impl Db for Code {
    fn load(&self) -> Result<'_, DBData> {
        let mut data = DBData::default();

        for (path, snippets) in &self.snippets {
            for snippet in snippets {
                // when loading snippets from the code, we should get only snippets and not
                // placeholder that we should inject
                if snippet.inject_from.is_none() {
                    data.snippets.insert(
                        snippet.id.clone(),
                        Snippet {
                            id: snippet.id.clone(),
                            content: snippet.snippet.join(crate::LINE_ENDING),
                            kind: SnippetKind::Code,
                            path: path.clone(),
                        },
                    );
                }
            }
        }

        tracing::debug!(count = data.snippets.len(), "collected code snippets");
        Ok(data)
    }
}

#[cfg(test)]
mod tests {
    use insta::{assert_debug_snapshot, with_settings};

    use super::*;
    use crate::tests_cfg;

    #[test]
    fn can_load() {
        let code = Code {
            snippets: BTreeMap::from([(
                PathBuf::from("README.md"),
                tests_cfg::get_collect_snippets(),
            )]),
        };

        with_settings!({filters => tests_cfg::redact::all()}, {
        assert_debug_snapshot!(code.load());
        });
    }

    #[test]
    fn can_save() {
        let code = Code {
            snippets: BTreeMap::new(),
        };

        let save_snippets = CollectSnippet {
            id: "description".to_string(),
            snippet: vec!["test".to_string(), "snipdoc".to_string()],
            inject_from: None,
            tag_open: "<snip id=\"description\">".to_string(),
            tag_close: "<!-- </snip> -->\n".to_string(),
        };

        assert!(code.save(&[&save_snippets], &BTreeMap::new()).is_err());
    }
}