armdb 0.4.1

sharded bitcask key-value storage optimized for NVMe
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

use std::fmt::Write;

use armour_core::{Fields, PathSeg, RelationKind, SchemaGraph, Typ};

/// Text formatter for a schema graph. Model → formatter architecture:
/// DOT can be added as a second implementation without changing the model.
pub trait SchemaFormatter {
    fn format(&self, graph: &SchemaGraph) -> String;
}

pub struct MermaidEr;

fn typ_label(t: &Typ) -> String {
    match t {
        Typ::Scalar(s) => format!("{s:?}"),
        Typ::Array(n, inner) => format!("Array{}_{}", n, typ_label(inner)),
        Typ::Vec(inner) => format!("Vec_{}", typ_label(inner)),
        Typ::Optional(inner) => format!("Opt_{}", typ_label(inner)),
        Typ::SimpleEnum(e) => e.name.to_string(),
        Typ::Struct(s) if !s.name.is_empty() => s.name.to_string(),
        Typ::Struct(_) => "tuple".to_string(),
        Typ::Enum(e) => e.name.to_string(),
        Typ::Custom(name, _) => (*name).to_string(),
    }
}

fn seg_label(seg: &PathSeg) -> String {
    match seg {
        PathSeg::Field(n) | PathSeg::Variant(n) => (*n).to_string(),
        PathSeg::Index(i) => i.to_string(),
        PathSeg::Elem => "[]".to_string(),
    }
}

/// Mermaid identifier: anything outside `[A-Za-z0-9_]` breaks erDiagram
/// parsing, so non-identifier characters are replaced with `_`.
fn ident(name: &str) -> String {
    name.chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || c == '_' {
                c
            } else {
                '_'
            }
        })
        .collect()
}

impl SchemaFormatter for MermaidEr {
    fn format(&self, graph: &SchemaGraph) -> String {
        let mut out = String::from("erDiagram\n");
        for c in &graph.collections {
            let _ = writeln!(out, "    {} {{", ident(&c.name));
            if let Typ::Struct(s) = &c.ty
                && let Fields::Named(fields) = &s.fields
            {
                for (fname, fty) in fields.iter() {
                    let _ = writeln!(out, "        {} {}", ident(&typ_label(fty)), ident(fname));
                }
            }
            out.push_str("    }\n");
        }
        for r in &graph.relations {
            let (arrow, label) = match &r.kind {
                RelationKind::Fk {
                    brand, field_path, ..
                } => {
                    let field = field_path
                        .iter()
                        .map(seg_label)
                        .collect::<Vec<_>>()
                        .join(".");
                    ("}o--||", format!("fk {field} ({brand})"))
                }
                RelationKind::Index => ("||--o{", "index".to_string()),
                RelationKind::Denorm => ("||--||", "denorm".to_string()),
                RelationKind::Counter { field } => ("||--o{", format!("counter {field}")),
            };
            let _ = writeln!(
                out,
                "    {} {arrow} {} : \"{label}\"",
                ident(&r.from),
                ident(&r.to)
            );
        }
        out
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use armour_core::{CollectionKind, CollectionNode, ScalarTyp, SchemaGraph};

    #[test]
    fn schema_mermaid_sanitizes_identifiers() {
        let g = SchemaGraph {
            collections: vec![CollectionNode {
                name: "my coll!".into(),
                kind: CollectionKind::Standalone,
                ty: Typ::Scalar(ScalarTyp::U64),
                self_brand: None,
                storage: None,
            }],
            relations: vec![],
        };
        let out = MermaidEr.format(&g);
        assert!(out.contains("my_coll_ {"), "{out}");
    }
}