arcature 0.1.2

Arcature: an opinionated full-stack Rust web framework. One package, batteries included.
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

//! [`ContractArtifact`]: the machine-readable page-contract registry that
//! `arc typegen` and `arc build` consume.

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

use super::page_schema::PageSchema;

/// A machine-readable representation of an Inertia page-contract registry.
///
/// Produced by [`PageContracts::artifact`](super::PageContracts::artifact).
/// Pages are stored in a `BTreeMap`, so the JSON is byte-for-byte
/// deterministic across runs -- two builds of an unchanged application
/// produce identical bytes, so a diff means the contracts really changed.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ContractArtifact {
    format: String,
    pages: BTreeMap<String, PageSchema>,
}

impl ContractArtifact {
    /// The stable artifact format identifier.
    pub const FORMAT: &'static str = "arcature.page-contract.v1";

    /// Build an artifact from the registry's pages.
    #[must_use]
    pub fn new(pages: BTreeMap<String, PageSchema>) -> Self {
        Self {
            format: Self::FORMAT.to_owned(),
            pages,
        }
    }

    /// The artifact format identifier this artifact was written with.
    #[must_use]
    pub fn format(&self) -> &str {
        &self.format
    }

    /// The registered pages, ordered by stable page identity.
    #[must_use]
    pub fn pages(&self) -> &BTreeMap<String, PageSchema> {
        &self.pages
    }

    /// Serialize this artifact deterministically as pretty JSON.
    ///
    /// # Errors
    ///
    /// Returns the `serde_json` error if serialization fails.
    pub fn to_json(&self) -> Result<Vec<u8>, serde_json::Error> {
        serde_json::to_vec_pretty(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::inertia::contracts::{ContractType, PropsSchema};

    fn artifact() -> ContractArtifact {
        let mut pages = BTreeMap::new();
        pages.insert(
            "Home".to_owned(),
            PageSchema::new(PropsSchema::new().required("name", ContractType::string())),
        );
        ContractArtifact::new(pages)
    }

    #[test]
    fn carries_the_stable_format_identifier() {
        assert_eq!(artifact().format(), ContractArtifact::FORMAT);
    }

    #[test]
    fn json_is_deterministic() {
        assert_eq!(artifact().to_json().unwrap(), artifact().to_json().unwrap());
    }

    #[test]
    fn round_trips_through_json() {
        let json = artifact().to_json().unwrap();
        let parsed: ContractArtifact = serde_json::from_slice(&json).unwrap();
        assert_eq!(parsed, artifact());
    }
}