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
|
use crate::{Bindings, SubplotError, TemplateSpec, YamlMetadata};
use log::trace;
use std::collections::HashMap;
use std::fmt::Debug;
use std::ops::Deref;
use std::path::{Path, PathBuf};
/// Metadata of a document, as needed by Subplot.
#[derive(Debug)]
pub struct Metadata {
basedir: PathBuf,
title: String,
date: Option<String>,
markdown_filename: PathBuf,
bindings_filenames: Vec<PathBuf>,
bindings: Bindings,
impls: HashMap<String, DocumentImpl>,
bibliographies: Vec<PathBuf>,
/// Extra class names which should be considered 'correct' for this document
classes: Vec<String>,
}
#[derive(Debug)]
pub struct DocumentImpl {
spec: TemplateSpec,
functions: Vec<PathBuf>,
}
impl Metadata {
/// Create from YamlMetadata.
pub fn from_yaml_metadata<P>(
basedir: P,
yaml: &YamlMetadata,
template: Option<&str>,
) -> Result<Self, SubplotError>
where
P: AsRef<Path> + Debug,
{
let mut bindings = Bindings::new();
let bindings_filenames = if let Some(filenames) = yaml.bindings_filenames() {
get_bindings(filenames, &mut bindings, template)?;
filenames.iter().map(|p| p.to_path_buf()).collect()
} else {
vec![]
};
let mut impls = HashMap::new();
for (impl_name, functions_filenames) in yaml.impls().iter() {
let template_spec = load_template_spec(impl_name)?;
let filenames = pathbufs("", functions_filenames);
let docimpl = DocumentImpl::new(template_spec, filenames);
impls.insert(impl_name.to_string(), docimpl);
}
let bibliographies = if let Some(v) = yaml.bibliographies() {
v.iter().map(|s| s.to_path_buf()).collect()
} else {
vec![]
};
let classes = if let Some(v) = yaml.classes() {
v.iter().map(|s| s.to_string()).collect()
} else {
vec![]
};
let meta = Self {
basedir: basedir.as_ref().to_path_buf(),
title: yaml.title().into(),
date: yaml.date().map(|s| s.into()),
markdown_filename: yaml.markdown().into(),
bindings_filenames,
bindings,
impls,
bibliographies,
classes,
};
trace!("metadata: {:#?}", meta);
Ok(meta)
}
/// Return title of document.
pub fn title(&self) -> &str {
&self.title
}
/// Return date of document, if any.
pub fn date(&self) -> Option<&str> {
self.date.as_deref()
}
/// Return base dir for all relative filenames.
pub fn basedir(&self) -> &Path {
&self.basedir
}
/// Return filename of the markdown file.
pub fn markdown_filename(&self) -> &Path {
&self.markdown_filename
}
/// Return filename where bindings are specified.
pub fn bindings_filenames(&self) -> Vec<&Path> {
self.bindings_filenames.iter().map(|f| f.as_ref()).collect()
}
/// Return the document implementation (filenames, spec, etc) for the given template name
pub fn document_impl(&self, template: &str) -> Option<&DocumentImpl> {
self.impls.get(template)
}
/// Return the templates the document expects to implement
pub fn templates(&self) -> impl Iterator<Item = &str> {
self.impls.keys().map(String::as_str)
}
/// Return the bindings.
pub fn bindings(&self) -> &Bindings {
&self.bindings
}
/// Return the bibliographies.
pub fn bibliographies(&self) -> Vec<&Path> {
self.bibliographies.iter().map(|x| x.as_path()).collect()
}
/// The classes which this document also claims are valid
pub fn classes(&self) -> impl Iterator<Item = &str> {
self.classes.iter().map(Deref::deref)
}
}
impl DocumentImpl {
fn new(spec: TemplateSpec, functions: Vec<PathBuf>) -> Self {
Self { spec, functions }
}
pub fn functions_filenames(&self) -> impl Iterator<Item = &Path> {
self.functions.iter().map(PathBuf::as_path)
}
pub fn spec(&self) -> &TemplateSpec {
&self.spec
}
}
fn load_template_spec(template: &str) -> Result<TemplateSpec, SubplotError> {
let mut spec_path = PathBuf::from(template);
spec_path.push("template");
spec_path.push("template.yaml");
TemplateSpec::from_file(&spec_path)
}
fn pathbufs<P>(basedir: P, v: &[PathBuf]) -> Vec<PathBuf>
where
P: AsRef<Path>,
{
let basedir = basedir.as_ref();
v.iter().map(|p| basedir.join(p)).collect()
}
fn get_bindings<P>(
filenames: &[P],
bindings: &mut Bindings,
template: Option<&str>,
) -> Result<(), SubplotError>
where
P: AsRef<Path> + Debug,
{
for filename in filenames {
bindings.add_from_file(filename, template)?;
}
Ok(())
}
|
