simple_dot 0.1.1

Simple API for creating GraphViz DOT files.
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

/*!
One-line description.

More detailed description, with

# Example

 */

use crate::{
    attributes::{EdgeAttributes, Styled},
    Identified, Identifier, Node,
};
use std::fmt::Display;

// ------------------------------------------------------------------------------------------------
// Public Macros
// ------------------------------------------------------------------------------------------------

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

#[derive(Clone, Debug)]
pub struct Edge {
    head: Identifier,
    tail: Identifier,
    directed: bool,
    attributes: Option<EdgeAttributes>,
}

// ------------------------------------------------------------------------------------------------
// Public Functions
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Private Types
// ------------------------------------------------------------------------------------------------

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

impl Display for Edge {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.to_string_no_attributes())?;
        if let Some(attributes) = self.attributes() {
            writeln!(f, " {}", attributes)
        } else {
            writeln!(f)
        }
    }
}

impl From<(Identifier, Identifier)> for Edge {
    fn from(pair: (Identifier, Identifier)) -> Self {
        Self::new(pair.0, pair.1)
    }
}

impl Styled<EdgeAttributes> for Edge {
    fn attributes(&self) -> Option<&EdgeAttributes> {
        self.attributes.as_ref()
    }

    fn set_attributes(self, attributes: EdgeAttributes) -> Self
    where
        Self: Sized,
    {
        let mut self_mut = self;
        self_mut.attributes = Some(attributes);
        self_mut
    }
}

impl Edge {
    pub fn new(head: Identifier, tail: Identifier) -> Self {
        Self {
            head,
            tail,
            attributes: Default::default(),
            directed: Default::default(),
        }
    }

    pub fn new_from(head: &Node, tail: &Node) -> Self {
        Self::new(head.id().clone(), tail.id().clone())
    }

    pub fn chain(nodes: &[Node]) -> Vec<Edge> {
        if nodes.len() < 2 {
            Vec::new()
        } else {
            nodes
                .windows(2)
                .map(|pair| Edge::new_from(&pair[0], &pair[1]))
                .collect()
        }
    }

    pub fn circular_chain(nodes: &[Node]) -> Vec<Edge> {
        if nodes.is_empty() {
            Vec::new()
        } else {
            let mut edges: Vec<Edge> = nodes
                .windows(2)
                .map(|pair| Edge::new_from(&pair[0], &pair[1]))
                .collect();
            edges.push(Edge::new_from(
                nodes.first().unwrap(),
                nodes.last().unwrap(),
            ));
            edges
        }
    }

    pub fn head(&self) -> &Identifier {
        &self.head
    }

    pub fn tail(&self) -> &Identifier {
        &self.tail
    }

    pub fn is_directed(&self) -> bool {
        self.directed
    }

    pub(crate) fn set_directed(self, directed: bool) -> Self {
        let mut self_mut = self;
        self_mut.directed = directed;
        self_mut
    }

    pub fn to_string_no_attributes(&self) -> String {
        format!(
            "{} {} {}",
            self.head(),
            if self.directed { "->" } else { "--" },
            self.tail()
        )
    }
}

// ------------------------------------------------------------------------------------------------
// Private Functions
// ------------------------------------------------------------------------------------------------

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

#[cfg(test)]
mod tests {
    use crate::{Edge, Identifier};

    #[test]
    fn test_undirected_edge_to_string() {
        let a = Identifier::new_unchecked("a");
        let b = Identifier::new_unchecked("b");

        assert_eq!(
            Edge::new(a.clone(), b.clone()).to_string(),
            String::from("a -- b\n")
        );
    }

    #[test]
    fn test_directed_edge_to_string() {
        let a = Identifier::new_unchecked("a");
        let b = Identifier::new_unchecked("b");

        assert_eq!(
            Edge::new(a.clone(), b.clone())
                .set_directed(true)
                .to_string(),
            String::from("a -> b\n")
        );
    }
}