diplodocus 0.15.0

Build coherent documentation websites for polyglot software projects.
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
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
use std::collections::{BTreeMap, BTreeSet};
use std::path::PathBuf;
use std::process::{Command, Stdio};

use rd_rds::lazyload::LazyLoadIndex;
use rd_rds::package::{MetadataField, NamespaceMetadata};

use crate::ir::{ParserProvenance, RGenericReference, RHelpTarget, RdrrRepository};

// Profiles and default package attachment are disabled so discovery evaluates
// only base metadata and cannot run a project's startup or package hooks.
const PROBE: &str = r#"
writeLines(paste("library", .libPaths(), sep = "\t"))
writeLines(paste("base", ls(baseenv(), all.names = TRUE), sep = "\t"))
writeLines(paste("generic", names(.knownS3Generics), .knownS3Generics, sep = "\t"))
writeLines(paste("version", getRversion(), sep = "\t"))
writeLines(paste("os", .Platform$OS.type, sep = "\t"))
"#;

#[derive(Clone)]
struct Discovery {
    paths: Vec<PathBuf>,
    base: BTreeSet<String>,
    generics: BTreeMap<String, String>,
    version: String,
    os_type: String,
}

pub(super) struct Libraries {
    discovery: Discovery,
    exports: BTreeMap<String, BTreeSet<String>>,
    help: BTreeMap<String, Option<HelpIndex>>,
}

struct HelpIndex {
    aliases: BTreeMap<String, String>,
    repository: RdrrRepository,
}

impl Libraries {
    pub(super) fn os_type(&self) -> &str {
        &self.discovery.os_type
    }

    pub(super) fn help_targets(
        &mut self,
        spelling: &str,
        dependencies: &BTreeSet<String>,
    ) -> Vec<RHelpTarget> {
        let (package, topic) = spelling
            .split_once("::")
            .map_or((None, spelling), |(package, topic)| (Some(package), topic));
        let packages: BTreeSet<String> = if let Some(package) = package {
            BTreeSet::from([package.to_owned()])
        } else {
            dependencies
                .iter()
                .cloned()
                .chain(
                    [
                        "base",
                        "compiler",
                        "datasets",
                        "grDevices",
                        "graphics",
                        "grid",
                        "methods",
                        "parallel",
                        "splines",
                        "stats",
                        "stats4",
                        "tcltk",
                        "tools",
                        "utils",
                    ]
                    .map(String::from),
                )
                .collect()
        };
        let mut targets = BTreeSet::new();
        for package in packages {
            if !valid_package_name(&package) {
                continue;
            }
            if !self.help.contains_key(&package) {
                let directory = self
                    .discovery
                    .paths
                    .iter()
                    .map(|library| library.join(&package))
                    .find(|directory| directory.join("DESCRIPTION").is_file());
                self.help.insert(
                    package.clone(),
                    directory.and_then(|directory| read_help_index(&directory).ok()),
                );
            }
            if let Some(index) = self.help[&package].as_ref()
                && let Some(topic) = index.aliases.get(topic)
            {
                targets.insert(RHelpTarget {
                    package,
                    topic: topic.clone(),
                    repository: index.repository,
                });
            }
        }
        targets.into_iter().collect()
    }

    pub(super) fn discover() -> Result<Self, String> {
        // A long-running preview can outlive a replacement of its prepared libraries.
        let discovery = probe()?;
        let mut libraries = Self {
            exports: BTreeMap::from([("base".into(), discovery.base.clone())]),
            discovery,
            help: BTreeMap::new(),
        };
        for package in [
            "stats",
            "graphics",
            "grDevices",
            "utils",
            "datasets",
            "methods",
        ] {
            libraries.exports(package)?;
        }
        Ok(libraries)
    }

    pub(super) fn exports(&mut self, package: &str) -> Result<&BTreeSet<String>, String> {
        if !self.exports.contains_key(package) {
            if !valid_package_name(package) {
                return Err(format!("Invalid installed R package name `{package}`."));
            }
            let directory = self
                .discovery
                .paths
                .iter()
                .map(|library| library.join(package))
                .find(|directory| directory.join("DESCRIPTION").is_file())
                .ok_or_else(|| {
                    format!("R package `{package}` is not installed in the discovered libraries.")
                })?;
            let exports = read_exports(&directory).map_err(|_| {
                format!(
                    "Cannot read complete installed namespace metadata for R package `{package}`."
                )
            })?;
            self.exports.insert(package.into(), exports);
        }
        Ok(&self.exports[package])
    }

    pub(super) fn default_generic(&self, name: &str) -> Option<RGenericReference> {
        // A registration establishes the generic role. Installed exports and
        // R's own known-generic map establish where that name is available.
        let package = self
            .discovery
            .generics
            .get(name)
            .map(String::as_str)
            .or_else(|| {
                [
                    "base",
                    "stats",
                    "graphics",
                    "grDevices",
                    "utils",
                    "datasets",
                    "methods",
                ]
                .into_iter()
                .find(|package| self.exports[*package].contains(name))
            })?;
        Some(RGenericReference::External {
            package: package.into(),
            name: name.into(),
        })
    }

    pub(super) fn provenance(&self) -> ParserProvenance {
        let mut settings = BTreeMap::from([("r-version".into(), self.discovery.version.clone())]);
        settings.insert("os-type".into(), self.discovery.os_type.clone());
        for (package, index) in &self.help {
            let bytes = serde_json::to_vec(
                &index
                    .as_ref()
                    .map(|index| (&index.aliases, index.repository)),
            )
            .expect("help indexes serialize");
            settings.insert(
                format!("help:{package}"),
                crate::provenance::fingerprint_bytes(&bytes).value,
            );
        }
        for (package, exports) in &self.exports {
            let bytes = serde_json::to_vec(exports).expect("string sets serialize");
            settings.insert(
                format!("exports:{package}"),
                crate::provenance::fingerprint_bytes(&bytes).value,
            );
        }
        let bytes = serde_json::to_vec(&self.discovery.generics).expect("string maps serialize");
        settings.insert(
            "base-known-s3-generics".into(),
            crate::provenance::fingerprint_bytes(&bytes).value,
        );
        ParserProvenance {
            version: "0.5.0".into(),
            role: "r-installed-namespace-metadata".into(),
            settings,
        }
    }
}

fn probe() -> Result<Discovery, String> {
    let output = Command::new("R")
        .args(["--vanilla", "--slave", "-e", PROBE])
        .env("R_DEFAULT_PACKAGES", "NULL")
        .stdin(Stdio::null())
        .output()
        .map_err(|_| {
            "R extraction requires an installed R executable on PATH to discover package libraries."
                .to_owned()
        })?;
    if !output.status.success() {
        return Err("R failed to report its installed package libraries and base metadata.".into());
    }
    let text = String::from_utf8(output.stdout)
        .map_err(|_| "R library discovery returned invalid UTF-8.".to_owned())?;
    let mut discovery = Discovery {
        paths: vec![],
        base: BTreeSet::new(),
        generics: BTreeMap::new(),
        version: String::new(),
        os_type: String::new(),
    };
    for line in text.lines() {
        let fields: Vec<_> = line.split('\t').collect();
        match fields.as_slice() {
            ["library", path] if !path.is_empty() => discovery.paths.push(PathBuf::from(path)),
            ["base", name] if !name.is_empty() => {
                discovery.base.insert((*name).into());
            }
            ["generic", name, package] if !name.is_empty() && valid_package_name(package) => {
                discovery.generics.insert((*name).into(), (*package).into());
            }
            ["version", version] if !version.is_empty() => {
                discovery.version = (*version).into();
            }
            ["os", os_type] if matches!(*os_type, "unix" | "windows") => {
                discovery.os_type = (*os_type).into()
            }
            _ => return Err("R library discovery returned malformed metadata.".into()),
        }
    }
    if discovery.paths.is_empty()
        || discovery.base.is_empty()
        || discovery.generics.is_empty()
        || discovery.version.is_empty()
        || discovery.os_type.is_empty()
    {
        return Err("R library discovery returned incomplete metadata.".into());
    }
    Ok(discovery)
}

fn valid_package_name(name: &str) -> bool {
    name.as_bytes().first().is_some_and(u8::is_ascii_alphabetic)
        && name
            .bytes()
            .all(|byte| byte.is_ascii_alphanumeric() || byte == b'.')
}

fn read_help_index(directory: &std::path::Path) -> Result<HelpIndex, ()> {
    let aliases = rd_rds::file::read(directory.join("help/aliases.rds")).map_err(|_| ())?;
    let rd_rds::RValue::Character(values) = aliases.value() else {
        return Err(());
    };
    let names = aliases.names().ok_or(())?;
    if names.len() != values.len() {
        return Err(());
    }
    let string = |value: &rd_rds::RStr| {
        value
            .as_str()
            .ok_or(())?
            .map(|value| value.into_owned())
            .map_err(|_| ())
    };
    let mut topics = BTreeMap::new();
    for (name, value) in names.iter().zip(values) {
        let name = string(name)?;
        let topic = string(value)?;
        if name.is_empty() || topic.is_empty() || topics.insert(name, topic).is_some() {
            return Err(());
        }
    }
    let description = std::fs::read_to_string(directory.join("DESCRIPTION")).map_err(|_| ())?;
    let parsed = arity_parser::dcf::parse(&description);
    if !parsed.diagnostics.is_empty() {
        return Err(());
    }
    let fields: BTreeMap<_, _> = parsed
        .document()
        .fields()
        .map(|field| (field.name().to_string(), field.folded_value()))
        .collect();
    let repository = if fields.get("Priority").is_some_and(|value| value == "base") {
        RdrrRepository::R
    } else if fields.contains_key("biocViews") {
        RdrrRepository::Bioc
    } else {
        RdrrRepository::Cran
    };
    Ok(HelpIndex {
        aliases: topics,
        repository,
    })
}

fn read_exports(directory: &std::path::Path) -> Result<BTreeSet<String>, ()> {
    let namespace = NamespaceMetadata::read_installed(directory).map_err(|_| ())?;
    let MetadataField::Present(declared) = namespace.declared_exports() else {
        return Err(());
    };
    let MetadataField::Present(patterns) = namespace.export_patterns() else {
        return Err(());
    };
    let mut exports: BTreeSet<_> = declared
        .iter()
        .map(|export| export.exported_name().to_owned())
        .collect();
    if !patterns.is_empty() {
        let package = directory
            .file_name()
            .and_then(|name| name.to_str())
            .ok_or(())?;
        let index = LazyLoadIndex::open(directory.join("R").join(format!("{package}.rdx")))
            .map_err(|_| ())?;
        for pattern in patterns {
            let pattern = regex::Regex::new(pattern).map_err(|_| ())?;
            exports.extend(
                index
                    .variables()
                    .iter()
                    .filter(|binding| pattern.is_match(binding.name()))
                    .map(|binding| binding.name().to_owned()),
            );
        }
    }
    Ok(exports)
}

#[cfg(test)]
mod tests {
    use super::*;

    fn fixture() -> PathBuf {
        PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/r-installed-library")
    }

    #[test]
    fn installed_exports_need_neither_code_records_nor_package_loading() {
        let root = fixture();
        assert_eq!(
            read_exports(&root.join("direct")).unwrap(),
            BTreeSet::from(["foreignGeneric".into()])
        );
        assert_eq!(
            read_exports(&root.join("patterns")).unwrap(),
            BTreeSet::from(["foreignGeneric".into(), "publicGeneric".into()])
        );
        assert!(read_exports(&root.join("malformed")).is_err());
        assert!(read_exports(&root.join("missing")).is_err());
    }

    #[test]
    fn library_precedence_and_failed_metadata_do_not_fall_back_to_other_installs() {
        let temp = tempfile::tempdir().unwrap();
        std::fs::create_dir(temp.path().join("direct")).unwrap();
        std::fs::write(temp.path().join("direct/DESCRIPTION"), "Package: direct\n").unwrap();
        let discovery = Discovery {
            paths: vec![temp.path().into(), fixture()],
            base: BTreeSet::new(),
            generics: BTreeMap::new(),
            version: "test".into(),
            os_type: "unix".into(),
        };
        let mut libraries = Libraries {
            discovery,
            help: BTreeMap::new(),
            exports: BTreeMap::new(),
        };
        assert!(libraries.exports("direct").is_err());
        assert!(libraries.exports("../direct").is_err());
        assert!(libraries.exports("notInstalled").is_err());
        assert!(
            libraries
                .exports("patterns")
                .unwrap()
                .contains("publicGeneric")
        );
    }
}