aphid 0.2.1

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

use tokio::sync::{Notify, RwLock, broadcast};

use crate::render::BuiltSite;

/// Shared state for the axum application: the current rendered site,
/// the live-reload broadcast channel, and the shutdown notifier.
///
/// Everything cross-rebuild is owned by `Rebuilder` (see `rebuilder.rs`);
/// `AppState` carries only what HTTP handlers and the WebSocket
/// live-reload need to read.
#[doc(hidden)]
pub struct AppState {
    pub(crate) site: RwLock<BuiltSite>,
    /// Broadcast channel for signalling browsers to reload.
    pub reload_tx: broadcast::Sender<()>,
    /// Notified on shutdown so WebSocket handlers and the file watcher can
    /// break out of their loops and let axum drain.
    pub(crate) shutdown: Notify,
}

impl AppState {
    /// Wrap a freshly rendered site with the broadcast and shutdown channels.
    pub(super) fn new(rendered: BuiltSite) -> Self {
        let (reload_tx, _) = broadcast::channel(16);
        Self {
            site: RwLock::new(rendered),
            reload_tx,
            shutdown: Notify::new(),
        }
    }

    /// Atomically replace the rendered site and notify connected browsers
    /// to reload. The render itself happens elsewhere — this is the
    /// state-mutation half of a rebuild.
    pub(crate) async fn swap(&self, rendered: BuiltSite) {
        *self.site.write().await = rendered;
        let _ = self.reload_tx.send(());
    }
}

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

    fn empty_rendered() -> BuiltSite {
        BuiltSite {
            pages: HashMap::new(),
            not_found_html: String::new(),
            root_files: Vec::new(),
            diagnostics: Default::default(),
        }
    }

    fn rendered_with_page(url: &str, html: &str) -> BuiltSite {
        let mut pages = HashMap::new();
        pages.insert(url.to_string(), html.to_string());
        BuiltSite {
            pages,
            not_found_html: String::new(),
            root_files: Vec::new(),
            diagnostics: Default::default(),
        }
    }

    #[tokio::test]
    async fn swap_replaces_site() {
        let state = AppState::new(empty_rendered());
        assert!(state.site.read().await.lookup("/blog/post/").is_none());

        state
            .swap(rendered_with_page("/blog/post/", "<p>hi</p>"))
            .await;

        assert_eq!(
            state.site.read().await.lookup("/blog/post/"),
            Some("<p>hi</p>")
        );
    }

    #[tokio::test]
    async fn swap_broadcasts_reload() {
        let state = AppState::new(empty_rendered());
        let mut rx = state.reload_tx.subscribe();

        state.swap(empty_rendered()).await;

        // A subscriber registered before swap sees exactly one reload tick.
        assert!(rx.try_recv().is_ok());
    }
}