mdbook-core 0.5.2

The base support library for mdbook, intended for internal use only
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
122
123

use super::*;

#[test]
fn section_number_has_correct_dotted_representation() {
    let inputs = vec![
        (vec![0], "0."),
        (vec![1, 3], "1.3."),
        (vec![1, 2, 3], "1.2.3."),
    ];

    for (input, should_be) in inputs {
        let section_number = SectionNumber(input).to_string();
        assert_eq!(section_number, should_be);
    }
}

#[test]
fn book_iter_iterates_over_sequential_items() {
    let items = vec![
        BookItem::Chapter(Chapter {
            name: String::from("Chapter 1"),
            content: String::from("# Chapter 1"),
            ..Default::default()
        }),
        BookItem::Separator,
    ];
    let book = Book::new_with_items(items);

    let should_be: Vec<_> = book.items.iter().collect();

    let got: Vec<_> = book.iter().collect();

    assert_eq!(got, should_be);
}

#[test]
fn for_each_mut_visits_all_items() {
    let items = vec![
        BookItem::Chapter(Chapter {
            name: String::from("Chapter 1"),
            content: String::from("# Chapter 1"),
            number: None,
            path: Some(PathBuf::from("Chapter_1/index.md")),
            source_path: Some(PathBuf::from("Chapter_1/index.md")),
            parent_names: Vec::new(),
            sub_items: vec![
                BookItem::Chapter(Chapter::new(
                    "Hello World",
                    String::new(),
                    "Chapter_1/hello.md",
                    Vec::new(),
                )),
                BookItem::Separator,
                BookItem::Chapter(Chapter::new(
                    "Goodbye World",
                    String::new(),
                    "Chapter_1/goodbye.md",
                    Vec::new(),
                )),
            ],
        }),
        BookItem::Separator,
    ];
    let mut book = Book::new_with_items(items);

    let num_items = book.iter().count();
    let mut visited = 0;

    book.for_each_mut(|_| visited += 1);

    assert_eq!(visited, num_items);
}

#[test]
fn iterate_over_nested_book_items() {
    let items = vec![
        BookItem::Chapter(Chapter {
            name: String::from("Chapter 1"),
            content: String::from("# Chapter 1"),
            number: None,
            path: Some(PathBuf::from("Chapter_1/index.md")),
            source_path: Some(PathBuf::from("Chapter_1/index.md")),
            parent_names: Vec::new(),
            sub_items: vec![
                BookItem::Chapter(Chapter::new(
                    "Hello World",
                    String::new(),
                    "Chapter_1/hello.md",
                    Vec::new(),
                )),
                BookItem::Separator,
                BookItem::Chapter(Chapter::new(
                    "Goodbye World",
                    String::new(),
                    "Chapter_1/goodbye.md",
                    Vec::new(),
                )),
            ],
        }),
        BookItem::Separator,
    ];
    let book = Book::new_with_items(items);

    let got: Vec<_> = book.iter().collect();

    assert_eq!(got.len(), 5);

    // checking the chapter names are in the order should be sufficient here...
    let chapter_names: Vec<String> = got
        .into_iter()
        .filter_map(|i| match *i {
            BookItem::Chapter(ref ch) => Some(ch.name.clone()),
            _ => None,
        })
        .collect();
    let should_be: Vec<_> = vec![
        String::from("Chapter 1"),
        String::from("Hello World"),
        String::from("Goodbye World"),
    ];

    assert_eq!(chapter_names, should_be);
}