bookyard-core 0.1.0

Core configuration and catalog model for Bookyard.
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

use std::path::Path;

use serde::{Deserialize, Serialize};

use crate::{BookyardError, Result, load_config, save_config};

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BookyardConfig {
    pub workspace: WorkspaceConfig,
    #[serde(default)]
    pub build: BuildConfig,
    #[serde(default)]
    pub books: Vec<BookConfig>,
}

impl BookyardConfig {
    pub fn new(title: impl Into<String>) -> Self {
        Self {
            workspace: WorkspaceConfig {
                title: title.into(),
                output: "bookyard".into(),
            },
            build: BuildConfig::default(),
            books: Vec::new(),
        }
    }

    pub fn load_from(path: impl AsRef<Path>) -> Result<Self> {
        load_config(path.as_ref())
    }

    pub fn save_to(&self, path: impl AsRef<Path>) -> Result<()> {
        save_config(path.as_ref(), self)
    }

    pub fn validate(&self) -> Result<()> {
        for book in &self.books {
            if book.engine != BookEngine::MdBook {
                return Err(BookyardError::UnsupportedBookEngine(
                    book.engine.to_string(),
                ));
            }
        }
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WorkspaceConfig {
    pub title: String,
    #[serde(default = "default_output")]
    pub output: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BuildConfig {
    #[serde(default = "default_jobs")]
    pub jobs: usize,
    #[serde(default)]
    pub fail_fast: bool,
}

impl Default for BuildConfig {
    fn default() -> Self {
        Self {
            jobs: default_jobs(),
            fail_fast: false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BookConfig {
    pub id: String,
    pub title: String,
    pub source: String,
    #[serde(default)]
    pub engine: BookEngine,
    #[serde(default)]
    pub folders: Vec<String>,
    #[serde(default)]
    pub tags: Vec<String>,
    #[serde(default)]
    pub order: i32,
}

impl BookConfig {
    pub fn new_mdbook(
        id: impl Into<String>,
        title: impl Into<String>,
        source: impl Into<String>,
        folders: Vec<impl Into<String>>,
    ) -> Self {
        Self {
            id: id.into(),
            title: title.into(),
            source: source.into(),
            engine: BookEngine::MdBook,
            folders: folders.into_iter().map(Into::into).collect(),
            tags: Vec::new(),
            order: 0,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum BookEngine {
    #[serde(rename = "mdbook")]
    MdBook,
}

impl Default for BookEngine {
    fn default() -> Self {
        Self::MdBook
    }
}

impl std::fmt::Display for BookEngine {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            BookEngine::MdBook => f.write_str("mdbook"),
        }
    }
}

fn default_output() -> String {
    "bookyard".into()
}

fn default_jobs() -> usize {
    4
}