hyperlit-runtime 0.1.0

A software documentation tool documentation embedded in source files - runtime crate
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
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 hyperlit_base::result::HyperlitResult;
use hyperlit_database::Database;
use hyperlit_model::directive_evaluation::DirectiveEvaluation;
use hyperlit_model::directives::parse_directive;
use hyperlit_model::segment::segments_sort_by_title;

pub fn evaluate_directive<'a>(
    string: &str,
    database: &'a dyn Database,
) -> HyperlitResult<DirectiveEvaluation<'a>> {
    let string = string.trim();
    let prefix = "§{";
    Ok(if string.starts_with(prefix) && string.ends_with("}") {
        let directive = parse_directive(string)?;
        match directive {
            hyperlit_model::directives::Directive::IncludeByTag { tag } => {
                let mut segments = database.get_segments_by_tag(&tag)?;
                segments_sort_by_title(segments.as_mut_slice());
                DirectiveEvaluation::Segments { segments }
            }
            hyperlit_model::directives::Directive::IncludeRest => {
                let segments = database.get_all_segments()?;
                let mut rest_segments: Vec<_> =
                    segments.into_iter().filter(|s| !s.is_included).collect();
                segments_sort_by_title(rest_segments.as_mut_slice());
                DirectiveEvaluation::Segments {
                    segments: rest_segments,
                }
            }
        }
    } else {
        DirectiveEvaluation::NoDirective
    })
}

#[cfg(test)]
mod tests {
    use crate::evaluate_directive::evaluate_directive;
    use hyperlit_base::result::HyperlitResult;
    use hyperlit_database::Database;
    use hyperlit_database::in_memory_database::InMemoryDatabase;
    use hyperlit_model::directive_evaluation::DirectiveEvaluation;
    use hyperlit_model::location::Location;
    use hyperlit_model::segment::Segment;

    fn make_segments(how_many: usize) -> Vec<Segment> {
        vec![Segment::new(0, "title", vec![], "text", Location::new("path", 1)); how_many]
    }

    #[test]
    fn test_evaluate_include_rest_directive() -> HyperlitResult<()> {
        let mut database = InMemoryDatabase::new();
        database.add_segments(make_segments(3))?;
        database.set_segment_included(1)?;
        let evaluation = evaluate_directive("§{@include_rest}", &database)?;
        match evaluation {
            DirectiveEvaluation::Segments { segments } => {
                assert_eq!(
                    segments.iter().map(|s| s.id).collect::<Vec<_>>(),
                    vec![0, 2]
                );
            }
            _ => panic!("should be segments, instead got: {evaluation:?}"),
        }
        Ok(())
    }

    #[test]
    fn test_evaluate_include_by_tag() -> HyperlitResult<()> {
        let mut database = InMemoryDatabase::new();
        database.add_segments(make_segments(3))?;
        database.add_segments(vec![Segment::new(
            0,
            "title A",
            vec!["the_tag".to_string()],
            "text",
            Location::new("path", 1),
        )])?;
        database.add_segments(make_segments(3))?;
        database.add_segments(vec![Segment::new(
            0,
            "title B",
            vec!["the_tag".to_string()],
            "text",
            Location::new("path", 1),
        )])?;
        let evaluation = evaluate_directive("§{@include_by_tag:#the_tag}", &database)?;
        match evaluation {
            DirectiveEvaluation::Segments { segments } => {
                assert_eq!(
                    segments.iter().map(|s| s.id).collect::<Vec<_>>(),
                    vec![3, 7]
                );
            }
            _ => panic!("should be segments, instead got: {evaluation:?}"),
        }
        Ok(())
    }

    #[test]
    fn test_evaluate_no_directive() -> HyperlitResult<()> {
        fn evaluate(string: &str) -> HyperlitResult<()> {
            let database = InMemoryDatabase::new();
            let evaluation = evaluate_directive(string, &database)?;
            match evaluation {
                DirectiveEvaluation::NoDirective => {
                    // Ok
                }
                _ => panic!("should be no directive, instead got: {evaluation:?}"),
            }
            Ok(())
        }
        evaluate("")?;
        evaluate("    ")?;
        evaluate("§{    }x")?;
        evaluate("§{    x")?;
        evaluate("}")?;
        evaluate("§ {  }")?;
        Ok(())
    }
}