hauchiwa 0.7.0

Incredibly flexible static site generator library with incremental rebuilds and cached image optimization
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

use std::fs;

use camino::{Utf8Path, Utf8PathBuf};

use crate::{
    BuildError, Hash32,
    loader::{Loader, generic::LoaderGeneric},
};

/// Represents a hashed, losslessly compressed WebP image ready for use in templates.
///
/// The `path` points to the output location under the `/hash/img/` virtual namespace,
/// suitable for use in `src` attributes or manifest generation. Images are
/// content-addressed, allowing caching, deduplication, and incremental builds.
///
/// Created by `glob_images` from any raster input (e.g., PNG, JPEG, etc.).
pub struct Image {
    /// Relative path to the optimized WebP image, rooted at `/hash/img/`.
    pub path: Utf8PathBuf,
}

/// Constructs a loader that ingests raster images and emits lossless WebP variants.
///
/// Matches files using a glob pattern relative to `path_base`, reads each file,
/// and re-encodes it as WebP using the [`image`] crate's lossless encoder. The
/// resulting output is hashed and cached, then emitted into `dist`. The final
/// [`Image`] contains a path pointing to the output asset.
///
/// ### Parameters
/// - `path_base`: Base directory for relative glob resolution.
/// - `path_glob`: Glob pattern matching source image files (e.g. `"**/*.png"`).
///
/// ### Returns
/// A [`Loader`] that emits [`Image`] objects keyed by file content.
///
/// ### Example
/// ```rust
/// use hauchiwa::{Context, TaskResult, Page, loader::{Image, glob_images}};
///
/// // loader
/// let loader = glob_images("assets/images", "**/*.png");
///
/// // task
/// fn task(ctx: Context) -> TaskResult<Vec<Page>> {
///     let Image { path } = ctx.get::<Image>("image.png")?;
///
///     Ok(vec![
///         Page::text("index.html".into(), format!("<img src='{path}'>"))
///     ])
/// }
/// ```
///
/// ### Notes
/// - Only lossless WebP encoding is currently supported.
/// - All outputs are content-addressed: the same input will always yield
///   the same output path.
/// - Image decoding/encoding is synchronous; performance may vary with size and volume.
pub fn glob_images(path_base: &'static str, path_glob: &'static str) -> Loader {
    Loader::with(move |_| {
        LoaderGeneric::new(
            path_base,
            path_glob,
            |path| {
                let hash = Hash32::hash_file(path)?;

                Ok((hash, (hash, path.to_owned())))
            },
            |_, (hash, path)| {
                let path = build_image(hash, &path)?;
                Ok(Image { path })
            },
        )
    })
}

fn process_image(buffer: &[u8]) -> image::ImageResult<Vec<u8>> {
    let img = image::load_from_memory(buffer)?;
    let w = img.width();
    let h = img.height();

    let mut out = Vec::new();
    let encoder = image::codecs::webp::WebPEncoder::new_lossless(&mut out);

    encoder.encode(&img.to_rgba8(), w, h, image::ExtendedColorType::Rgba8)?;

    Ok(out)
}

fn build_image(hash: Hash32, file: &Utf8Path) -> Result<Utf8PathBuf, BuildError> {
    let hash = hash.to_hex();
    let path_root = Utf8Path::new("/hash/img/")
        .join(&hash)
        .with_extension("webp");
    let path_hash = Utf8Path::new(".cache/hash/img/")
        .join(&hash)
        .with_extension("webp");
    let path_dist = Utf8Path::new("dist/hash/img/")
        .join(&hash)
        .with_extension("webp");

    // If this hash exists it means the work is already done.
    if !path_hash.exists() {
        let buffer = fs::read(file)?;
        let buffer = process_image(&buffer) //
            .map_err(|err| BuildError::Other(err.into()))?;

        fs::create_dir_all(".cache/hash/img/")?;
        fs::write(&path_hash, buffer)?;
    }

    let dir = path_dist.parent().unwrap_or(&path_dist);
    fs::create_dir_all(dir)?;
    fs::copy(&path_hash, &path_dist)?;

    Ok(path_root)
}