aphid 0.2.0

A static site generator for blogs and wikis, with wiki-links across both.
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
use std::fs;
use std::path::PathBuf;

use insta::assert_snapshot;
use tempfile::TempDir;

use aphid::testutil::write_file;

mod common;

/// Slice the `<main>...</main>` element out of a full HTML page so snapshots
/// don't include nav/header/footer boilerplate that's irrelevant to the
/// thing under test.
fn extract_main(html: &str) -> &str {
    let start = html.find("<main").expect("no <main> tag in output");
    let end = html.rfind("</main>").expect("no </main> tag in output");
    &html[start..end + "</main>".len()]
}

/// Build a site from the shared fixtures into a tempdir and return the
/// (tempdir, output_dir) so assertions can inspect the result.
async fn build_fixture_site() -> (TempDir, PathBuf) {
    let (dir, config_path) = common::setup_with_shared_fixtures_and_style();
    let output = dir.path().join("dist");

    aphid::build(&config_path, &output).await.unwrap();
    (dir, output)
}

#[tokio::test]
async fn blog_post_rendered_with_wiki_link() {
    let (_dir, output) = build_fixture_site().await;
    let html = fs::read_to_string(output.join("blog/first-post/index.html")).unwrap();

    assert!(html.contains("First Post"), "title missing from blog post");
    assert!(
        html.contains(r#"href="/wiki/glossary/""#),
        "expected resolved wiki-link href to glossary"
    );
}

#[tokio::test]
async fn wiki_page_has_backlinks() {
    let (_dir, output) = build_fixture_site().await;
    let html = fs::read_to_string(output.join("wiki/glossary/index.html")).unwrap();
    assert_snapshot!("wiki_glossary_main", extract_main(&html));
}

#[tokio::test]
async fn tag_pages_generated() {
    let (_dir, output) = build_fixture_site().await;

    let rust_tag = output.join("tags/rust/index.html");
    let html = fs::read_to_string(&rust_tag).expect("tag page for 'rust' missing");
    assert_snapshot!("tags_rust_main", extract_main(&html));

    assert!(
        output.join("tags/advanced/index.html").exists(),
        "tag page for 'advanced' missing"
    );

    let tags_index = output.join("tags/index.html");
    let html = fs::read_to_string(&tags_index).expect("tags index missing");
    assert!(html.contains("rust"));
}

#[tokio::test]
async fn blog_and_wiki_indexes_generated() {
    let (_dir, output) = build_fixture_site().await;

    assert!(
        output.join("index.html").exists(),
        "home page (root index.html) missing"
    );

    let blog_index = output.join("blog/index.html");
    let html = fs::read_to_string(&blog_index).expect("blog index missing");
    assert!(
        html.contains(r#"href="/blog/first-post/""#),
        "blog index should link to first-post"
    );

    let wiki_index = output.join("wiki/index.html");
    let html = fs::read_to_string(&wiki_index).expect("wiki index missing");
    assert!(
        html.contains(r#"href="/wiki/glossary/""#),
        "wiki index should link to glossary"
    );
}

#[tokio::test]
async fn standalone_page_rendered() {
    let (_dir, output) = build_fixture_site().await;
    let html = fs::read_to_string(output.join("about/index.html")).unwrap();
    assert!(html.contains("About"), "standalone page title missing");
}

#[tokio::test]
async fn static_files_copied() {
    let (_dir, output) = build_fixture_site().await;

    assert_eq!(
        fs::read_to_string(output.join("static/style.css")).unwrap(),
        "body { margin: 0; }",
        "user static file content mismatch"
    );
    assert!(
        output.join("static/css/theme.css").exists(),
        "embedded theme CSS missing"
    );
}

#[tokio::test]
async fn four_oh_four_page_generated() {
    let (_dir, output) = build_fixture_site().await;
    let html = fs::read_to_string(output.join("404.html")).unwrap();
    assert!(html.contains("Not Found") || html.contains("404"));
}

#[tokio::test]
async fn html_is_well_formed() {
    let (_dir, output) = build_fixture_site().await;

    for entry in walkdir::WalkDir::new(&output)
        .into_iter()
        .filter_map(|e| e.ok())
        .filter(|e| e.path().extension().is_some_and(|ext| ext == "html"))
    {
        let content = fs::read_to_string(entry.path()).unwrap();
        assert!(
            content.contains("<!DOCTYPE html>") || content.contains("<!doctype html>"),
            "{} missing DOCTYPE",
            entry.path().display()
        );
        assert!(
            content.contains("</html>"),
            "{} missing closing </html>",
            entry.path().display()
        );
    }
}

#[tokio::test]
async fn broken_wiki_link_fails_build() {
    let dir = TempDir::new().unwrap();
    let content_dir = dir.path().join("content");
    let config_path = common::write_fixture_config(dir.path(), &content_dir);

    write_file(
        &content_dir.join("blog/broken.md"),
        "\
---
title: Broken
slug: broken
author: Test
created: 2026-01-01
---
See [[nonexistent]] for details.",
    );

    let result = aphid::build(&config_path, &dir.path().join("dist")).await;
    let err = result.expect_err("build should fail on broken wiki-link");
    let msg = err.to_string();
    assert!(
        msg.contains("nonexistent"),
        "error should mention the broken target: {msg}"
    );
    assert!(
        msg.contains("broken"),
        "error should mention the source page: {msg}"
    );
}

#[tokio::test]
async fn broken_wiki_link_in_home_fails_build() {
    let dir = TempDir::new().unwrap();
    let content_dir = dir.path().join("content");
    let config_path = common::write_fixture_config(dir.path(), &content_dir);

    write_file(
        &content_dir.join("home.md"),
        "# Welcome\n\nSee [[missing-home-link]] for details.\n",
    );

    let result = aphid::build(&config_path, &dir.path().join("dist")).await;
    let err = result.expect_err("build should fail on broken home wiki-link");
    let msg = err.to_string();
    assert!(
        msg.contains("missing-home-link"),
        "error should mention the broken target: {msg}"
    );
    assert!(
        msg.contains("home.md"),
        "error should mention home.md as the source: {msg}"
    );
}

#[tokio::test]
async fn home_md_content_appears_in_home_html() {
    let dir = TempDir::new().unwrap();
    let content_dir = dir.path().join("content");
    let config_path = common::write_fixture_config(dir.path(), &content_dir);

    write_file(
        &content_dir.join("home.md"),
        "# Welcome\n\nThis page is from `home.md` — totally bespoke.\n",
    );

    let output = dir.path().join("dist");
    aphid::build(&config_path, &output).await.unwrap();

    let html = fs::read_to_string(output.join("index.html")).unwrap();
    assert!(
        html.contains("Welcome"),
        "index.html should include the heading from home.md: {html}"
    );
    assert!(
        html.contains("totally bespoke"),
        "index.html should include the body from home.md: {html}"
    );
}

#[tokio::test]
async fn not_found_md_content_appears_in_404_html() {
    let dir = TempDir::new().unwrap();
    let content_dir = dir.path().join("content");
    let config_path = common::write_fixture_config(dir.path(), &content_dir);

    write_file(
        &content_dir.join("404.md"),
        "# Custom 404\n\nThis page is from `404.md` — totally bespoke.\n",
    );

    let output = dir.path().join("dist");
    aphid::build(&config_path, &output).await.unwrap();

    let html = fs::read_to_string(output.join("404.html")).unwrap();
    assert!(
        html.contains("Custom 404"),
        "404.html should include the heading from 404.md: {html}"
    );
    assert!(
        html.contains("totally bespoke"),
        "404.html should include the body from 404.md: {html}"
    );
}

#[tokio::test]
async fn broken_wiki_link_in_not_found_fails_build() {
    let dir = TempDir::new().unwrap();
    let content_dir = dir.path().join("content");
    let config_path = common::write_fixture_config(dir.path(), &content_dir);

    write_file(
        &content_dir.join("404.md"),
        "# Gone\n\nTry [[missing-404-link]] instead.\n",
    );

    let result = aphid::build(&config_path, &dir.path().join("dist")).await;
    let err = result.expect_err("build should fail on broken 404 wiki-link");
    let msg = err.to_string();
    assert!(
        msg.contains("missing-404-link"),
        "error should mention the broken target: {msg}"
    );
    assert!(
        msg.contains("404.md"),
        "error should mention 404.md as the source: {msg}"
    );
}

#[tokio::test]
async fn build_output_does_not_contain_live_reload_script() {
    let (_dir, output) = build_fixture_site().await;

    // The live-reload script must never appear in build output — it is
    // a serve-mode-only transformation.
    for entry in walkdir::WalkDir::new(&output)
        .into_iter()
        .filter_map(|e| e.ok())
        .filter(|e| e.path().extension().is_some_and(|ext| ext == "html"))
    {
        let content = fs::read_to_string(entry.path()).unwrap();
        assert!(
            !content.contains("WebSocket"),
            "{} contains live-reload WebSocket script — must not appear in build output",
            entry.path().display()
        );
    }
}

// ── robots.txt & sitemap.xml ────────────────────────────────────────────

#[tokio::test]
async fn robots_txt_generated() {
    let (_dir, output) = build_fixture_site().await;
    let robots = fs::read_to_string(output.join("robots.txt")).unwrap();
    assert!(robots.contains("User-agent: *"));
    assert!(robots.contains("Allow: /"));
    assert!(robots.contains("Sitemap: https://example.com/sitemap.xml"));
}

#[tokio::test]
async fn sitemap_xml_generated() {
    let (_dir, output) = build_fixture_site().await;
    let sitemap = fs::read_to_string(output.join("sitemap.xml")).unwrap();

    assert!(sitemap.starts_with("<?xml"));
    assert!(sitemap.contains("<urlset"));
    // Home, blog index, wiki index should be present
    assert!(
        sitemap.contains("<loc>https://example.com/</loc>"),
        "sitemap should contain home URL"
    );
    assert!(
        sitemap.contains("<loc>https://example.com/blog/</loc>"),
        "sitemap should contain blog index URL"
    );
    assert!(
        sitemap.contains("<loc>https://example.com/wiki/</loc>"),
        "sitemap should contain wiki index URL"
    );
    // Blog posts should have lastmod
    assert!(
        sitemap.contains("<lastmod>"),
        "blog posts in sitemap should have lastmod"
    );
}

// ── Favicon ─────────────────────────────────────────────────────────────

/// Build with a test favicon and verify all generated files.
#[tokio::test]
async fn favicon_files_generated() {
    let dir = TempDir::new().unwrap();
    let config_path = common::write_fixture_config(dir.path(), &common::fixtures_dir());

    // Create a tiny 4×4 red PNG as the favicon source.
    let icon_path = dir.path().join("icon.png");
    write_tiny_png(&icon_path);

    // Add favicon to config
    append_config(
        &config_path,
        &format!("favicon = \"{}\"", icon_path.display()),
    );

    let output = dir.path().join("dist");
    write_file(&dir.path().join("static/empty"), "");
    aphid::build(&config_path, &output).await.unwrap();

    assert!(output.join("favicon.ico").exists(), "favicon.ico missing");
    assert!(
        output.join("apple-touch-icon.png").exists(),
        "apple-touch-icon.png missing"
    );
    assert!(
        output.join("android-chrome-192x192.png").exists(),
        "android-chrome-192x192.png missing"
    );
    assert!(
        output.join("android-chrome-512x512.png").exists(),
        "android-chrome-512x512.png missing"
    );
    assert!(
        output.join("site.webmanifest").exists(),
        "site.webmanifest missing"
    );
}

#[tokio::test]
async fn favicon_html_tags_injected() {
    let dir = TempDir::new().unwrap();
    let config_path = common::write_fixture_config(dir.path(), &common::fixtures_dir());

    let icon_path = dir.path().join("icon.png");
    write_tiny_png(&icon_path);
    append_config(
        &config_path,
        &format!("favicon = \"{}\"", icon_path.display()),
    );

    let output = dir.path().join("dist");
    write_file(&dir.path().join("static/empty"), "");
    aphid::build(&config_path, &output).await.unwrap();

    let html = fs::read_to_string(output.join("blog/first-post/index.html")).unwrap();
    assert!(
        html.contains(r#"href="/favicon.ico""#),
        "favicon.ico link missing from HTML head"
    );
    assert!(
        html.contains(r#"href="/apple-touch-icon.png""#),
        "apple-touch-icon link missing from HTML head"
    );
    assert!(
        html.contains(r#"href="/site.webmanifest""#),
        "webmanifest link missing from HTML head"
    );
}

#[tokio::test]
async fn no_favicon_when_not_configured() {
    let (_dir, output) = build_fixture_site().await;
    assert!(
        !output.join("favicon.ico").exists(),
        "favicon.ico should not exist when favicon is not configured"
    );
    assert!(
        !output.join("apple-touch-icon.png").exists(),
        "apple-touch-icon.png should not exist when favicon is not configured"
    );

    // robots.txt and sitemap.xml should still be present
    assert!(output.join("robots.txt").exists());
    assert!(output.join("sitemap.xml").exists());
}

/// Write a tiny 4×4 red PNG for test fixtures.
fn write_tiny_png(path: &std::path::Path) {
    use std::io::Cursor;
    let img = image::DynamicImage::ImageRgba8(image::RgbaImage::from_pixel(
        4,
        4,
        image::Rgba([255, 0, 0, 255]),
    ));
    let mut buf = Cursor::new(Vec::new());
    img.write_to(&mut buf, image::ImageFormat::Png).unwrap();
    fs::write(path, buf.into_inner()).unwrap();
}

fn append_config(config_path: &std::path::Path, extra: &str) {
    let mut content = fs::read_to_string(config_path).unwrap();
    content.push('\n');
    content.push_str(extra);
    content.push('\n');
    fs::write(config_path, content).unwrap();
}