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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
use anyhow::{anyhow, Result};
use mdbook::{
    book::{Book, BookItem},
    errors::Result as MdbookResult,
    preprocess::{Preprocessor, PreprocessorContext},
};

use crate::{
    book_config::{admonish_config_from_context, Config, RenderMode},
    markdown::preprocess,
    types::RenderTextMode,
};

pub struct Admonish;

impl Preprocessor for Admonish {
    fn name(&self) -> &str {
        "admonish"
    }

    fn run(&self, ctx: &PreprocessorContext, mut book: Book) -> MdbookResult<Book> {
        let config = admonish_config_from_context(ctx)?;
        ensure_compatible_assets_version(&config)?;

        let on_failure = config.on_failure;
        let admonition_defaults = config.default;

        // Load what rendering we should do from config, falling back to a default
        let render_mode = config
            .renderer
            .get(&ctx.renderer)
            .and_then(|renderer| renderer.render_mode)
            .unwrap_or_else(|| {
                // By default only render html for the html renderer
                // For everything else, do nothing
                if &ctx.renderer == "html" {
                    RenderMode::Html
                } else {
                    RenderMode::Preserve
                }
            });
        let render_text_mode = match render_mode {
            RenderMode::Preserve => return Ok(book),
            RenderMode::Html => RenderTextMode::Html,
            RenderMode::Strip => RenderTextMode::Strip,
        };

        let mut res = None;
        book.for_each_mut(|item: &mut BookItem| {
            if let Some(Err(_)) = res {
                return;
            }

            if let BookItem::Chapter(ref mut chapter) = *item {
                res = Some(
                    preprocess(
                        &chapter.content,
                        on_failure,
                        &admonition_defaults,
                        render_text_mode,
                    )
                    .map(|md| {
                        chapter.content = md;
                    }),
                );
            }
        });

        res.unwrap_or(Ok(())).map(|_| book)
    }

    fn supports_renderer(&self, _renderer: &str) -> bool {
        // We support all renderers, but will only actually take action
        // if configured to do so - or, if it's the html renderer
        true
    }
}

fn ensure_compatible_assets_version(config: &Config) -> Result<()> {
    use semver::{Version, VersionReq};

    const REQUIRES_ASSETS_VERSION: &str = std::include_str!("./REQUIRED_ASSETS_VERSION");
    let requirement = VersionReq::parse(REQUIRES_ASSETS_VERSION.trim()).unwrap();

    const USER_ACTION: &str = "Please run `mdbook-admonish install` to update installed assets.";
    const DOCS_REFERENCE: &str = "For more information, see: https://github.com/tommilligan/mdbook-admonish#semantic-versioning";

    let version = match &config.assets_version {
        Some(version) => version,
        None => {
            return Err(anyhow!(
                r#"ERROR:
  Incompatible assets installed: required mdbook-admonish assets version '{requirement}', but did not find a version.
  {USER_ACTION}
  {DOCS_REFERENCE}"#
            ))
        }
    };

    let version = Version::parse(version).unwrap();

    if !requirement.matches(&version) {
        return Err(anyhow!(
            r#"ERROR:
  Incompatible assets installed: required mdbook-admonish assets version '{requirement}', but found '{version}'.
  {USER_ACTION}
  {DOCS_REFERENCE}"#
        ));
    };
    Ok(())
}

#[cfg(test)]
mod test {
    use super::*;
    use pretty_assertions::assert_eq;
    use serde_json::{json, Value};

    fn mock_book(content: &str) -> Book {
        serde_json::from_value(json!({
            "sections": [
                {
                    "Chapter": {
                        "name": "Chapter 1",
                        "content": content,
                        "number": [1],
                        "sub_items": [],
                        "path": "chapter_1.md",
                        "source_path": "chapter_1.md",
                        "parent_names": []
                    }
                }
            ],
            "__non_exhaustive": null
        }))
        .unwrap()
    }

    fn mock_context(admonish: &Value, renderer: &str) -> PreprocessorContext {
        let value = json!({
            "root": "/path/to/book",
            "config": {
                "book": {
                    "authors": ["AUTHOR"],
                    "language": "en",
                    "multilingual": false,
                    "src": "src",
                    "title": "TITLE"
                },
                "preprocessor": {
                    "admonish": admonish,
                }
            },
            "renderer": renderer,
            "mdbook_version": "0.4.21"
        });

        serde_json::from_value(value).unwrap()
    }

    #[test]
    fn run_html() {
        let content = r#"
````admonish title="Title"
```rust
let x = 10;
x = 20;
```
````
"#;
        let expected_content = r##"

<div id="admonition-title" class="admonition admonish-note">
<div class="admonition-title">

Title

<a class="admonition-anchor-link" href="#admonition-title"></a>
</div>
<div>

```rust
let x = 10;
x = 20;
```

</div>
</div>
"##;

        let ctx = mock_context(
            &json!({
                "assets_version": "3.0.0"
            }),
            "html",
        );
        let book = mock_book(content);
        let expected_book = mock_book(expected_content);

        assert_eq!(Admonish.run(&ctx, book).unwrap(), expected_book)
    }

    #[test]
    fn run_test_preserves_by_default() {
        let content = r#"
````admonish title="Title"
```rust
let x = 10;
x = 20;
```
````
"#;
        let ctx = mock_context(
            &json!({
                "assets_version": "3.0.0"
            }),
            "test",
        );
        let book = mock_book(content);
        let expected_book = book.clone();

        assert_eq!(Admonish.run(&ctx, book).unwrap(), expected_book)
    }

    #[test]
    fn run_test_can_strip() {
        let content = r#"
````admonish title="Title"
```rust
let x = 10;
x = 20;
```
````
"#;
        let expected_content = r#"

```rust
let x = 10;
x = 20;
```

"#;
        let ctx = mock_context(
            &json!({
                "assets_version": "3.0.0",
                "renderer": {
                    "test": {
                        "render_mode": "strip",
                    },
                },
            }),
            "test",
        );
        let book = mock_book(content);
        let expected_book = mock_book(expected_content);

        assert_eq!(Admonish.run(&ctx, book).unwrap(), expected_book)
    }
}