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
|
use lazy_static::lazy_static;
use regex::Regex;
use serde::Deserialize;
use serde_yaml::Value;
use std::collections::{BTreeMap, HashMap};
use std::path::{Path, PathBuf};
lazy_static! {
// Pattern that recognises a YAML block at the beginning of a file.
static ref LEADING_YAML_PATTERN: Regex = Regex::new(r"^(?:\S*\n)*(?P<yaml>-{3,}\n([^.].*\n)*\.{3,}\n)(?P<text>(.*\n)*)$").unwrap();
// Pattern that recognises a YAML block at the end of a file.
static ref TRAILING_YAML_PATTERN: Regex = Regex::new(r"(?P<text>(.*\n)*)\n*(?P<yaml>-{3,}\n([^.].*\n)*\.{3,}\n)(?:\S*\n)*$").unwrap();
}
/// Errors from Markdown parsing.
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error(transparent)]
Regex(#[from] regex::Error),
#[error("Markdown doesn't contain a YAML block for document metadata")]
NoMetadata,
#[error(transparent)]
Yaml(#[from] serde_yaml::Error),
}
/// Document metadata.
///
/// This is expressed in the Markdown input file as an embedded YAML
/// block.
///
/// Note that this structure needs to be able to capture any metadata
/// block we can work with, in any input file. By being strict here we
/// make it easier to tell the user when a metadata block has, say, a
/// misspelled field.
#[derive(Debug, Default, Clone, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct YamlMetadata {
title: String,
subtitle: Option<String>,
authors: Option<Vec<String>>,
date: Option<String>,
classes: Option<Vec<String>>,
bibliography: Option<Vec<PathBuf>>,
markdowns: Vec<PathBuf>,
bindings: Option<Vec<PathBuf>>,
documentclass: Option<String>,
#[serde(default)]
impls: BTreeMap<String, Vec<PathBuf>>,
pandoc: Option<HashMap<String, Value>>,
}
impl YamlMetadata {
#[cfg(test)]
fn new(yaml_text: &str) -> Result<Self, Error> {
let meta: Self = serde_yaml::from_str(yaml_text)?;
Ok(meta)
}
/// Name of file with the Markdown for the subplot document.
pub fn markdown(&self) -> &Path {
&self.markdowns[0]
}
/// Title.
pub fn title(&self) -> &str {
&self.title
}
/// Subtitle.
pub fn subtitle(&self) -> Option<&str> {
self.subtitle.as_deref()
}
/// Date.
pub fn date(&self) -> Option<&str> {
self.date.as_deref()
}
/// Authors.
pub fn authors(&self) -> Option<&[String]> {
self.authors.as_deref()
}
/// Names of bindings files.
pub fn bindings_filenames(&self) -> Option<&[PathBuf]> {
self.bindings.as_deref()
}
/// Impls section.
pub fn impls(&self) -> &BTreeMap<String, Vec<PathBuf>> {
&self.impls
}
/// Bibliographies.
pub fn bibliographies(&self) -> Option<&[PathBuf]> {
self.bibliography.as_deref()
}
/// Classes..
pub fn classes(&self) -> Option<&[String]> {
self.classes.as_deref()
}
/// Documentclass.
pub fn documentclass(&self) -> Option<&str> {
self.documentclass.as_deref()
}
/// Pandoc metadata.
pub fn pandoc(&self) -> Option<&HashMap<String, Value>> {
if let Some(x) = &self.pandoc {
Some(x)
} else {
None
}
}
}
#[cfg(test)]
mod test {
use super::YamlMetadata;
use std::path::{Path, PathBuf};
#[test]
fn full_meta() {
let meta = YamlMetadata::new(
"\
title: Foo Bar
date: today
classes: [json, text]
impls:
python:
- foo.py
- bar.py
bibliography:
- foo.bib
- bar.bib
markdowns:
- test.md
bindings:
- foo.yaml
- bar.yaml
",
)
.unwrap();
assert_eq!(meta.title, "Foo Bar");
assert_eq!(meta.date.unwrap(), "today");
assert_eq!(meta.classes.unwrap(), &["json", "text"]);
assert_eq!(
meta.bibliography.unwrap(),
&[path("foo.bib"), path("bar.bib")]
);
assert_eq!(meta.markdowns, vec![Path::new("test.md")]);
assert_eq!(
meta.bindings.unwrap(),
&[path("foo.yaml"), path("bar.yaml")]
);
assert!(!meta.impls.is_empty());
for (k, v) in meta.impls.iter() {
assert_eq!(k, "python");
assert_eq!(v, &[path("foo.py"), path("bar.py")]);
}
}
fn path(s: &str) -> PathBuf {
PathBuf::from(s)
}
}
|
