doteur 0.3.3

Tool to automate the visualisation of UML dependencies from a SQL file
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

use std::fmt;

use super::dot_table::{DotTable};

/// A DotFile object is used to render the compiled schema in argument.
pub struct DotFile {
    /// The header of the dot file
    header : String,
    /// The tables to include in the file
    dot_tables: Vec<DotTable>,
    /// The relations to include in the file
    relations: Vec<String>,
    /// The footer of the file
    footer : String,
    /// Define if the graph has to be in dark mode
    dark_mode: bool
}

impl fmt::Display for DotFile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{0}\n{1}\n{2}\n\n{3}",
            self.header,
            self.dot_tables.iter().map(|s| s.to_string()).collect::<Vec<String>>().join("\n"),
            self.relations.join("\n"),
            self.footer
        )
    }
}

impl DotFile {

    /// Creates a new dotfile with the given name
    ///
    /// # Arguments
    ///
    /// * `filename` - This will be set as the graph's filename
    /// * `dark_mode` - Set if the file has to be in dark mode
    pub fn new(filename : &str, dark_mode : bool) -> DotFile {

        DotFile {
            header : init_dot(filename, dark_mode),
            dot_tables: Vec::new(),
            relations: Vec::new(),
            footer: String::from("}"),
            dark_mode
        }
    }

    /// Adds a table to the DotFile
    ///
    /// # Arguments
    ///
    /// * `table` - The table to add to the file
    pub fn add_table(&mut self, table : DotTable) {
        self.dot_tables.push(table);
    }

    /// Add a relation to the DotFile
    ///
    /// # Arguments
    ///
    /// * `table_name` - The table where the relation begins
    /// * `table_end` - The table where the relation ends
    /// * `key` - The key of the begin table
    /// * `refered` - The key of the end table
    pub fn add_relation(&mut self, table_name: &str, table_end: &str, key: &str, refered: &str){
        self.relations.push(generate_relation(table_name, table_end, key, refered, self.dark_mode))
    }
}

/// Creates the dot file header
///
/// # Arguments
///
/// * `filename` - The name of the input file
/// * `dark_mode` - Changes the color of rendering
fn init_dot(filename: &str, dark_mode: bool) -> String {
    let bg_color : &str = match dark_mode {
            true => "bgcolor= black;",
            false => "",
    };
    format!("//This file has been generated with doteur, enjoy!
digraph {0} {{\n

    {1}

    node [\n
        shape = \"plaintext\"
    ]\n\n", filename, bg_color)
}

/// Generate a dot relation with the given arguments
///
/// # Arguments
///
/// * `table_name` - The table where the relation begins
/// * `table_end` - The table where the relation ends
/// * `key` - The key of the begin table
/// * `refered` - The key of the end table
fn generate_relation(table_name: &str, table_end: &str, key: &str, refered: &str, dark_mode: bool) -> String {
    let color_scheme : &str = match dark_mode {
        true => "fontcolor=white, color=white",
        false => ""
    };
    let refer : &str = match cfg!(unix) {
        true => "\u{27A1}",
        _ => "refers"
    };
    format!("\t{0} -> {1} [label=<<I>{2} {3} {4}</I>>, arrowhead = \"dot\", fontsize=\"12.0\", {5}]", table_name, table_end, key, refer, refered, color_scheme)
}