scraps 3.5.0

Scraps is a portable CLI knowledge hub for managing interconnected Markdown documentation with Wiki-link notation.
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

use std::collections::HashSet;

use scraps_libs::markdown::query::WikiRef;
use scraps_libs::model::{key::ScrapKey, scrap::Scrap};

use super::schema::{EdgeKind, KeyJson, LinkEdge};

/// Resolve every link and embed occurrence against the scraps that exist.
/// This is the link step: the objects say what each scrap references, the
/// table says whether each reference lands.
pub fn link_edges(scraps: &[Scrap]) -> Vec<LinkEdge> {
    let keys: HashSet<ScrapKey> = scraps.iter().map(Scrap::self_key).collect();
    let keys = &keys;

    scraps
        .iter()
        .flat_map(|scrap| {
            let from = KeyJson::from(&scrap.self_key());
            scrap.refs().iter().filter_map(move |r| {
                let (to, kind, heading, line) = match r {
                    WikiRef::Link(l) => {
                        (ScrapKey::from(l), EdgeKind::Link, l.heading.clone(), l.line)
                    }
                    WikiRef::Embed(e) => (
                        ScrapKey::from_path_str(&embed_path(&e.ctx_path, &e.title)),
                        EdgeKind::Embed,
                        e.heading.clone(),
                        e.line,
                    ),
                    // A path out of the wiki root names no scrap, so no edge.
                    WikiRef::MdLink(m) => {
                        (m.resolve(scrap.ctx())?, EdgeKind::Link, m.heading(), m.line)
                    }
                    WikiRef::Tag(_) => return None,
                };
                Some(LinkEdge {
                    from: from.clone(),
                    resolved: keys.contains(&to),
                    to: KeyJson::from(&to),
                    kind,
                    heading,
                    line,
                })
            })
        })
        .collect()
}

fn embed_path(ctx_path: &[String], title: &str) -> String {
    if ctx_path.is_empty() {
        title.to_string()
    } else {
        format!("{}/{}", ctx_path.join("/"), title)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_resolves_links_and_embeds_and_skips_tags() {
        let scraps = vec![
            Scrap::new(
                "a",
                &None,
                "line one\n[[b#Sec]] #[[tag]]\n![[Ctx/c]] [[missing]]",
            ),
            Scrap::new("b", &None, "## Sec"),
            Scrap::new("c", &Some("Ctx".into()), ""),
        ];

        let edges = link_edges(&scraps);

        assert_eq!(edges.len(), 3);
        assert_eq!(edges[0].to.stem, "b");
        assert_eq!(edges[0].kind, EdgeKind::Link);
        assert_eq!(edges[0].heading.as_deref(), Some("Sec"));
        assert_eq!(edges[0].line, 2);
        assert!(edges[0].resolved);
        assert_eq!(edges[1].kind, EdgeKind::Embed);
        assert_eq!(edges[1].to.ctx.as_deref(), Some("Ctx"));
        assert!(edges[1].resolved);
        assert_eq!(edges[2].to.stem, "missing");
        assert!(!edges[2].resolved);
        assert!(edges.iter().all(|e| e.from.stem == "a"));
    }

    #[test]
    fn it_resolves_markdown_links_from_the_linking_scrap() {
        let scraps = vec![
            Scrap::new(
                "orders",
                &Some("tables".into()),
                "[c](/tables/customers.md) [r](../metrics/revenue.md#definition)\n[g](./gone.md) [out](../../out.md)",
            ),
            Scrap::new("customers", &Some("tables".into()), ""),
            Scrap::new("revenue", &Some("metrics".into()), "# Definition"),
        ];

        let edges = link_edges(&scraps);

        assert_eq!(edges.len(), 3);
        assert!(edges.iter().all(|e| e.kind == EdgeKind::Link));
        assert_eq!(edges[0].to.stem, "customers");
        assert_eq!(edges[0].to.ctx.as_deref(), Some("tables"));
        assert!(edges[0].resolved);
        assert_eq!(edges[1].to.ctx.as_deref(), Some("metrics"));
        assert_eq!(edges[1].heading.as_deref(), Some("definition"));
        assert!(edges[1].resolved);
        assert_eq!(edges[2].to.stem, "gone");
        assert_eq!(edges[2].line, 2);
        assert!(!edges[2].resolved);
    }

    #[test]
    fn it_keeps_duplicate_occurrences() {
        let scraps = vec![Scrap::new("a", &None, "[[a]] [[a]]")];
        assert_eq!(link_edges(&scraps).len(), 2);
    }
}