mermaid-builder 0.1.2

A Rust library for generating Mermaid diagrams using the builder pattern.
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
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Submodule providing a builder struct for the configuration of flowchart
//! diagrams in Mermaid syntax.

use alloc::string::ToString;

use crate::{
    diagrams::flowchart::{configuration::FlowchartConfiguration, curve_styles::CurveStyle},
    errors::ConfigError,
    shared::generic_configuration::GenericConfigurationBuilder,
    traits::ConfigurationBuilder,
};

#[derive(Default, Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// Builder for creating flowchart configurations with various properties.
pub struct FlowchartConfigurationBuilder {
    /// Generic configuration options which apply to all Mermaid diagrams.
    generic: GenericConfigurationBuilder,
    /// Whether to enable html labels in the flowchart.
    html_labels: bool,
    /// Whether to automatically wrap markdown labels.
    markdown_auto_wrap: bool,
    /// The curve style used for edges in the flowchart.
    curve_style: CurveStyle,
}

impl FlowchartConfigurationBuilder {
    #[must_use]
    /// Sets whether to enable html labels in the flowchart.
    pub fn html_labels(mut self, enable: bool) -> Self {
        self.html_labels = enable;
        self
    }

    #[must_use]
    /// Sets whether to automatically wrap markdown labels.
    pub fn markdown_auto_wrap(mut self, auto_wrap: bool) -> Self {
        self.markdown_auto_wrap = auto_wrap;
        self
    }

    #[must_use]
    /// Sets the curve style for edges in the flowchart.
    pub fn curve_style(mut self, style: CurveStyle) -> Self {
        self.curve_style = style;
        self
    }

    /// Sets the theme to use for the diagram.
    #[must_use]
    pub fn theme(mut self, theme: crate::shared::generic_configuration::Theme) -> Self {
        self.generic = self.generic.theme(theme);
        self
    }

    /// Sets the look to use for the diagram.
    #[must_use]
    pub fn look(mut self, look: crate::shared::generic_configuration::Look) -> Self {
        self.generic = self.generic.look(look);
        self
    }
}

impl TryFrom<FlowchartConfigurationBuilder> for FlowchartConfiguration {
    type Error = ConfigError;

    fn try_from(builder: FlowchartConfigurationBuilder) -> Result<Self, Self::Error> {
        Ok(FlowchartConfiguration {
            generic: builder.generic.try_into()?,
            markdown_auto_wrap: builder.markdown_auto_wrap,
            html_labels: builder.html_labels,
            curve_style: builder.curve_style,
        })
    }
}

impl ConfigurationBuilder for FlowchartConfigurationBuilder {
    type Configuration = FlowchartConfiguration;
    type Error = ConfigError;

    fn build(self) -> Result<Self::Configuration, Self::Error> {
        self.try_into()
    }

    fn title<S: ToString>(mut self, title: S) -> Result<Self, Self::Error> {
        self.generic = self.generic.title(title)?;
        Ok(self)
    }

    fn direction(mut self, direction: crate::shared::generic_configuration::Direction) -> Self {
        self.generic = self.generic.direction(direction);
        self
    }

    fn renderer(mut self, renderer: crate::shared::generic_configuration::Renderer) -> Self {
        self.generic = self.generic.renderer(renderer);
        self
    }
}

#[cfg(test)]
mod tests {
    use alloc::boxed::Box;

    use super::*;
    use crate::{
        shared::generic_configuration::{Direction, Look, Renderer, Theme},
        traits::Configuration,
    };

    #[test]
    fn test_flowchart_configuration_builder() -> Result<(), Box<dyn core::error::Error>> {
        let config = FlowchartConfigurationBuilder::default()
            .title("My Flowchart")?
            .direction(Direction::TopToBottom)
            .renderer(Renderer::EclipseLayoutKernel)
            .theme(Theme::Forest)
            .look(Look::HandDrawn)
            .html_labels(true)
            .markdown_auto_wrap(false)
            .curve_style(CurveStyle::Basis)
            .build()?;

        assert!(config.html_labels);
        assert!(!config.markdown_auto_wrap);
        assert_eq!(config.curve_style, CurveStyle::Basis);
        assert_eq!(config.title(), Some("My Flowchart"));
        assert_eq!(config.direction(), Direction::TopToBottom);
        assert_eq!(config.renderer(), Renderer::EclipseLayoutKernel);
        assert_eq!(config.theme(), Theme::Forest);
        assert_eq!(config.look(), Look::HandDrawn);
        Ok(())
    }
}