modo-rs 0.8.0

Rust web framework for small monolithic apps
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

use axum::extract::FromRequestParts;
use http::request::Parts;

/// Axum extractor that detects HTMX requests.
///
/// Returns `HxRequest(true)` when the request contains `HX-Request: true`,
/// and `HxRequest(false)` otherwise. The extraction is infallible.
///
/// # Example
///
/// ```rust,no_run
/// use modo::template::HxRequest;
///
/// async fn handler(hx: HxRequest) {
///     if hx.is_htmx() {
///         // respond with a partial
///     }
/// }
/// ```
#[derive(Debug, Clone, Copy)]
pub struct HxRequest(bool);

impl HxRequest {
    /// Returns `true` if the request was issued by HTMX (`HX-Request: true`).
    pub fn is_htmx(&self) -> bool {
        self.0
    }
}

impl<S: Send + Sync> FromRequestParts<S> for HxRequest {
    type Rejection = std::convert::Infallible;

    async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
        let is_htmx = parts
            .headers
            .get("hx-request")
            .and_then(|v| v.to_str().ok())
            .is_some_and(|v| v == "true");
        Ok(HxRequest(is_htmx))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use axum::extract::FromRequestParts;
    use http::Request;

    #[tokio::test]
    async fn detects_htmx_request() {
        let req = Request::builder()
            .header("hx-request", "true")
            .body(())
            .unwrap();
        let (mut parts, _) = req.into_parts();
        let hx = HxRequest::from_request_parts(&mut parts, &())
            .await
            .unwrap();
        assert!(hx.is_htmx());
    }

    #[tokio::test]
    async fn detects_non_htmx_request() {
        let req = Request::builder().body(()).unwrap();
        let (mut parts, _) = req.into_parts();
        let hx = HxRequest::from_request_parts(&mut parts, &())
            .await
            .unwrap();
        assert!(!hx.is_htmx());
    }

    #[tokio::test]
    async fn hx_request_false_header_is_not_htmx() {
        let req = Request::builder()
            .header("hx-request", "false")
            .body(())
            .unwrap();
        let (mut parts, _) = req.into_parts();
        let hx = HxRequest::from_request_parts(&mut parts, &())
            .await
            .unwrap();
        assert!(!hx.is_htmx());
    }

    #[tokio::test]
    async fn hx_request_header_case_insensitive() {
        let req = Request::builder()
            .header("HX-Request", "true")
            .body(())
            .unwrap();
        let (mut parts, _) = req.into_parts();
        let hx = HxRequest::from_request_parts(&mut parts, &())
            .await
            .unwrap();
        assert!(hx.is_htmx());
    }
}