sdml-generate 0.3.2

Simple Domain Modeling Language (SDML) generated Artifacts
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

/*!
This module provides the generators for *concept*, *entity-relationship*, and *UML class* diagrams. It also provides a
common [`OutputFormat`] type that describes the image format.

- `concepts` -- A simple diagram showing only the entities and their relationships.
- `erd` -- An Entity-Relationship diagram.
- `uml` -- A detailed UML Class diagram.
*/

use crate::exec::CommandArg;

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

///
/// The format for image output.
///
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub enum OutputFormat {
    Source,
    ImageJpeg,
    ImagePng,
    #[default]
    ImageSvg,
}

/// Name of the command-line tool for GraphViz generation.
pub const DOT_PROGRAM: &str = "dot";

/// Name of the command-line tool for PlantUML generation.
pub const UML_PROGRAM: &str = "plantuml";

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl From<OutputFormat> for CommandArg {
    fn from(value: OutputFormat) -> Self {
        CommandArg::new_option(
            "-T",
            match value {
                OutputFormat::ImageJpeg => "jpg",
                OutputFormat::ImagePng => "png",
                OutputFormat::ImageSvg => "svg",
                _ => unreachable!(),
            },
        )
    }
}

// ------------------------------------------------------------------------------------------------
// Modules
// ------------------------------------------------------------------------------------------------

pub mod concepts;

pub mod erd;

pub mod uml;

pub mod filter;