italic 0.2.4

A static site generator for your digital garden
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

//! Tera adapter for the whole corpus. `all()` returns every doc in the frozen
//! [`DocIndex`] shared across the template phase, in the default listing order
//! (`id_path` — the `BTreeMap`'s natural order, stable across runs and machines).
//! It is the zero-config escape hatch for "list everything" that needs no
//! `collections:` entry in `config.yaml`.
//!
//! It takes no arguments by design: ordering, limiting, and filtering are what
//! collections are for (`collection(name=...)` with an `order_by`/`sort`/`omit`
//! definition), or what the array filters do at render time (`omit_docs`,
//! `dirtree`, `filter_in_dir`, `slice`). So any kwarg is rejected up front — a
//! typo'd `all(limt=5)` fails loudly rather than silently ignoring the cap.

use crate::doc_index::DocIndex;
use std::collections::HashMap;
use std::sync::Arc;
use tera::{Tera, Value};

pub fn register(env: &mut Tera, index: Arc<DocIndex>) {
    env.register_function(
        "all",
        move |args: &HashMap<String, Value>| -> tera::Result<Value> {
            check_no_args(args)?;
            let docs: Vec<&crate::doc::Doc> = index.docs().collect();
            tera::to_value(docs).map_err(tera::Error::from)
        },
    );
}

/// `all()` takes no arguments. Reject any kwarg so an attempt at a
/// `limit=`/`order_by=`/`omit=` (which `all` deliberately does not support)
/// fails loudly rather than being silently dropped — define a `collection`, or
/// pipe the result through array filters, instead.
fn check_no_args(args: &HashMap<String, Value>) -> tera::Result<()> {
    if let Some(key) = args.keys().next() {
        return Err(tera::Error::msg(format!(
            "all: unexpected argument `{}` (all() takes no arguments — define a \
             collection to order/limit/filter, or pipe through filters like \
             omit_docs, dirtree, or slice)",
            key
        )));
    }
    Ok(())
}

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

    #[test]
    fn check_no_args_accepts_empty() {
        assert!(check_no_args(&HashMap::new()).is_ok());
    }

    #[test]
    fn check_no_args_rejects_any_kwarg() {
        let mut args = HashMap::new();
        args.insert("limit".to_string(), Value::from(5u64));
        assert!(check_no_args(&args).is_err());
    }
}