acton-service 0.23.0

Production-ready Rust backend framework with type-enforced API versioning
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

//! HTMX utility helpers.
//!
//! This module provides helper functions for common HTMX patterns.

use axum::{
    http::HeaderMap,
    response::{Html, IntoResponse, Response},
};

/// Check if the current request is an HTMX request based on headers.
///
/// Useful in middleware or where extractors aren't available.
///
/// # Example
///
/// ```rust,ignore
/// use acton_service::htmx::is_htmx_request;
///
/// fn check_request(headers: &HeaderMap) -> bool {
///     is_htmx_request(headers)
/// }
/// ```
#[must_use]
pub fn is_htmx_request(headers: &HeaderMap) -> bool {
    headers.contains_key("hx-request")
}

/// Check if the current request is an HTMX boosted request.
///
/// Boosted requests are made by HTMX when using `hx-boost="true"` on links
/// or forms. These requests should typically return full pages rather than
/// fragments.
///
/// # Example
///
/// ```rust,ignore
/// use acton_service::htmx::is_boosted_request;
///
/// fn check_boosted(headers: &HeaderMap) -> bool {
///     is_boosted_request(headers)
/// }
/// ```
#[must_use]
pub fn is_boosted_request(headers: &HeaderMap) -> bool {
    headers
        .get("hx-boosted")
        .and_then(|v| v.to_str().ok())
        .is_some_and(|s| s == "true")
}

/// Return different responses for HTMX vs full-page requests.
///
/// This is a helper for the common pattern of returning a fragment
/// for HTMX requests and a full page for regular requests.
///
/// # Example
///
/// ```rust,ignore
/// use acton_service::htmx::{HxRequest, fragment_or_full};
///
/// async fn items_list(HxRequest(is_htmx): HxRequest) -> impl IntoResponse {
///     let items_html = render_items();
///     fragment_or_full(
///         is_htmx,
///         items_html.clone(),
///         || render_full_page(&items_html),
///     )
/// }
/// ```
pub fn fragment_or_full<F>(is_htmx: bool, fragment: impl Into<String>, full_page_fn: F) -> Response
where
    F: FnOnce() -> String,
{
    if is_htmx {
        Html(fragment.into()).into_response()
    } else {
        Html(full_page_fn()).into_response()
    }
}

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

    #[test]
    fn test_is_htmx_request() {
        let mut headers = HeaderMap::new();
        assert!(!is_htmx_request(&headers));

        headers.insert("hx-request", HeaderValue::from_static("true"));
        assert!(is_htmx_request(&headers));
    }

    #[test]
    fn test_is_boosted_request() {
        let mut headers = HeaderMap::new();
        assert!(!is_boosted_request(&headers));

        headers.insert("hx-boosted", HeaderValue::from_static("true"));
        assert!(is_boosted_request(&headers));

        headers.insert("hx-boosted", HeaderValue::from_static("false"));
        assert!(!is_boosted_request(&headers));
    }

    #[test]
    fn test_fragment_or_full() {
        // HTMX request should return fragment
        let response = fragment_or_full(true, "<p>Fragment</p>", || {
            "<html><body><p>Full</p></body></html>".to_string()
        });
        assert_eq!(response.status(), axum::http::StatusCode::OK);

        // Non-HTMX request should return full page
        let response = fragment_or_full(false, "<p>Fragment</p>", || {
            "<html><body><p>Full</p></body></html>".to_string()
        });
        assert_eq!(response.status(), axum::http::StatusCode::OK);
    }
}