adbook 0.1.0

Creates a book from AsciiDoc files
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Table of contents, list of items in a directory
//!
//! It's recursive and makes up a book file structure.

use {
    std::{
        fmt, fs, io,
        path::{Path, PathBuf},
    },
    thiserror::Error,
};

use crate::book::config::TocRon;

/// Error when loading `toc.ron`
#[derive(Debug, Error)]
pub enum TocLoadError {
    /// (relative_path_to_the_file, book_ron_directory_path)
    #[error("Unable to locate `{0}` in `{1}`")]
    FailedToLocateItem(PathBuf, PathBuf),
    #[error("Unexpected item with path: {0}")]
    FoundOddItem(PathBuf),
    #[error("Found directory without `toc.ron`: {0}")]
    FoundDirectoryWithoutTocRon(PathBuf),
    #[error("Failed to read toc.ron at: {0}. IO error: {1}")]
    FailedToReadTocRon(PathBuf, io::Error),
    #[error("Failed to parse toc.ron at: {0}")]
    FailedToParseTocRon(PathBuf, ron::Error),
    #[error("Errors in sub `toc.ron`: {0}")]
    FoundErrorsInSubToc(Box<SubTocLoadErrors>),
}

/// Errors when loading a sub `toc.ron`, a type just for printing
#[derive(Debug)]
pub struct SubTocLoadErrors {
    errors: Vec<TocLoadError>,
}

impl fmt::Display for SubTocLoadErrors {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for err in &self.errors {
            writeln!(f, "{}", err)?;
        }
        Ok(())
    }
}

/// The recursive book structure, corresponds to `mod.rs` in Rust
#[derive(Debug, Clone)]
pub struct Toc {
    /// Absolute path to the [`toc.ron`]
    pub path: PathBuf,
    pub items: Vec<TocItem>,
}

/// Item in `toc.ron`: `("name", "path")` where path is File | SubToc
///
/// Every path is canonicalized to an absolute path.
#[derive(Debug, Clone)]
pub struct TocItem {
    pub name: String,
    pub content: TocItemContent,
}

/// File | SubToc
#[derive(Debug, Clone)]
pub enum TocItemContent {
    /// Absolute path to the file
    File(PathBuf),
    SubToc(Box<Toc>),
}

impl Toc {
    /// Loads `toc.ron` recursively. Invalid items are excluded
    pub fn from_toc_ron_recursive(
        toc_ron: &TocRon,
        toc_ron_dir: &Path,
    ) -> (Self, Vec<TocLoadError>) {
        let mut errors = vec![];
        let mut items = vec![];

        trace!("parsing toc.ron at directory `{}`", toc_ron_dir.display());

        for (name, rel_path) in &toc_ron.items {
            let path = toc_ron_dir.join(rel_path);
            if !path.exists() {
                errors.push(TocLoadError::FailedToLocateItem(
                    rel_path.into(),
                    toc_ron_dir.to_path_buf(),
                ));
                continue;
            }

            let path = path.canonicalize().unwrap();

            // 3 cases:
            if path.is_file() {
                // case 1. File
                items.push(TocItem {
                    name: name.to_string(),
                    content: TocItemContent::File(path.clone()),
                });
            } else if path.is_dir() {
                // case 2. Directory with `toc.ron`
                let nested_toc_ron = path.join("toc.ron");
                if !nested_toc_ron.is_file() {
                    errors.push(TocLoadError::FoundDirectoryWithoutTocRon(path));
                    continue;
                }

                let toc_ron_str = match fs::read_to_string(&nested_toc_ron) {
                    Ok(s) => s,
                    Err(err) => {
                        errors.push(TocLoadError::FailedToReadTocRon(path, err));
                        continue;
                    }
                };

                let toc_ron: TocRon = match ron::from_str(&toc_ron_str) {
                    Ok(ron) => ron,
                    Err(err) => {
                        errors.push(TocLoadError::FailedToParseTocRon(path.clone(), err));
                        continue;
                    }
                };

                let (sub_toc, sub_errors) = Toc::from_toc_ron_recursive(&toc_ron, &path);
                if !sub_errors.is_empty() {
                    errors.push(TocLoadError::FoundErrorsInSubToc(Box::new(
                        SubTocLoadErrors { errors: sub_errors },
                    )));
                }

                items.push(TocItem {
                    name: name.to_string(),
                    content: TocItemContent::SubToc(Box::new(sub_toc)),
                });
            } else {
                // case 3. Unexpected item
                errors.push(TocLoadError::FoundOddItem(path));
            }
        }

        (
            Self {
                path: toc_ron_dir.to_path_buf(),
                items,
            },
            errors,
        )
    }
}