mdbook-journal 0.4.0

journal plugin for mdBook
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
85
86
87
88
89
90

use crate::prelude::*;

/// Supporting structures
mod private;

use private::*;

#[derive(Debug, Default)]
pub struct DirIndex {
    depth: usize,
    entries: Vec<Arc<Entry>>,
    indices: BTreeMap<String, DirIndex>,
}

impl DirIndex {
    pub fn for_topic(entries: &[Entry], topic: &Topic) -> Result<Self> {
        let mut index = Self::default();
        let parts = &mut TopicParts::new(topic);

        for entry in entries {
            let mut current = &mut index;
            parts.load(entry)?;
            let shared_entry = Arc::new(entry.clone());
            for (idx, segment) in parts.iter_mut().enumerate() {
                current.entries.push(shared_entry.clone());
                if !current.indices.contains_key(segment) {
                    let dir = DirIndex {
                        depth: idx + 1,
                        ..Default::default()
                    };
                    current.indices.insert(segment.clone(), dir);
                }
                current = current.indices.get_mut(segment).unwrap();
            }
            current.entries.push(shared_entry);
        }

        Ok(index)
    }

    pub fn is_leaf(&self) -> bool {
        self.indices.is_empty()
    }

    pub fn children(&self) -> impl Iterator<Item = (&String, &DirIndex)> {
        self.indices.iter()
    }

    pub fn entries(&self) -> impl Iterator<Item = &Entry> {
        self.entries.iter().map(|entry| entry.as_ref())
    }

    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }
}

impl std::ops::Index<&str> for DirIndex {
    type Output = Self;

    fn index(&self, index: &str) -> &Self::Output {
        self.indices.get(index).unwrap()
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::support::fixtures::*;
    use crate::support::prelude::*;

    #[rstest]
    fn builds_correctly(entries: Vec<Entry>, topic: Topic) -> Result<()> {
        let index = DirIndex::for_topic(&entries, &topic)?;

        assert_eq!(index["test"]["2024"]["July"].entries().count(), 1);
        assert_eq!(index["test"]["2024"]["July"].children().count(), 0);

        assert_eq!(index["test"]["2024"]["June"].entries().count(), 1);
        assert_eq!(index["test"]["2024"]["June"].children().count(), 0);

        assert_eq!(index["test"]["2024"].entries().count(), 2);
        assert_eq!(index["test"]["2024"].children().count(), 2);

        assert_eq!(index["test"].children().count(), 1);
        assert_eq!(index["test"].entries().count(), 2);

        Ok(())
    }
}