archaven 1.0.0

A small Rust dependency rule checker for modular architectures.
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
181
182

use std::fmt;

use crate::{Dependency, Location, ModulePath};

/// One dependency rule violation.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Violation {
    rule_name: String,
    reason: String,
    source: ModulePath,
    target: ModulePath,
    location: Location,
}

impl Violation {
    pub(crate) fn new(rule_name: &str, reason: String, dependency: &Dependency) -> Self {
        Self {
            rule_name: rule_name.to_owned(),
            reason,
            source: dependency.source().clone(),
            target: dependency.target().clone(),
            location: dependency.location().clone(),
        }
    }

    pub(crate) fn for_file(
        rule_name: &str,
        reason: String,
        module: ModulePath,
        location: Location,
    ) -> Self {
        Self {
            rule_name: rule_name.to_owned(),
            reason,
            source: module,
            target: ModulePath::from_segments(Vec::new()),
            location,
        }
    }

    /// Returns the rule name.
    #[must_use]
    pub fn rule_name(&self) -> &str {
        &self.rule_name
    }

    /// Returns the violation reason.
    #[must_use]
    pub fn reason(&self) -> &str {
        &self.reason
    }

    /// Returns the dependency source.
    #[must_use]
    pub fn source(&self) -> &ModulePath {
        &self.source
    }

    /// Returns the dependency target.
    #[must_use]
    pub fn target(&self) -> &ModulePath {
        &self.target
    }

    /// Returns the source location.
    #[must_use]
    pub fn location(&self) -> &Location {
        &self.location
    }
}

/// Collection of dependency rule violations.
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct Violations {
    items: Vec<Violation>,
}

impl Violations {
    /// Creates an empty violation list.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    pub(crate) fn push(&mut self, violation: Violation) {
        self.items.push(violation);
    }

    /// Appends another violation list.
    pub fn extend(&mut self, other: Self) {
        self.items.extend(other.items);
    }

    /// Returns `true` when there are no violations.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.items.is_empty()
    }

    /// Returns the number of violations.
    #[must_use]
    pub fn len(&self) -> usize {
        self.items.len()
    }

    /// Iterates over violations.
    pub fn iter(&self) -> impl Iterator<Item = &Violation> {
        self.items.iter()
    }

    /// Converts this collection into a vector.
    #[must_use]
    pub fn into_vec(self) -> Vec<Violation> {
        self.items
    }

    /// Panics when any violation exists.
    ///
    /// # Panics
    ///
    /// Panics with the formatted violation list when the collection is not empty.
    #[track_caller]
    pub fn assert_empty(&self) {
        assert!(self.is_empty(), "{self}");
    }
}

impl IntoIterator for Violations {
    type IntoIter = std::vec::IntoIter<Self::Item>;
    type Item = Violation;

    fn into_iter(self) -> Self::IntoIter {
        self.items.into_iter()
    }
}

impl<'a> IntoIterator for &'a Violations {
    type IntoIter = std::slice::Iter<'a, Violation>;
    type Item = &'a Violation;

    fn into_iter(self) -> Self::IntoIter {
        self.items.iter()
    }
}

impl fmt::Display for Violations {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.is_empty() {
            return write!(formatter, "No dependency violations found.");
        }

        writeln!(
            formatter,
            "Dependency violations found: {}",
            self.items.len()
        )?;

        for violation in &self.items {
            writeln!(formatter)?;
            writeln!(formatter, "[{}]", violation.rule_name)?;
            write!(formatter, "{}", violation.location.file().display())?;
            if let Some(line) = violation.location.line() {
                write!(formatter, ":{line}")?;
                if let Some(column) = violation.location.column() {
                    write!(formatter, ":{column}")?;
                }
            }
            writeln!(formatter)?;
            writeln!(formatter)?;
            if violation.target.is_empty() {
                writeln!(formatter, "{} violates this rule", violation.source)?;
            } else {
                writeln!(formatter, "{} depends on", violation.source)?;
                writeln!(formatter, "{}", violation.target)?;
            }
            writeln!(formatter)?;
            writeln!(formatter, "{}", violation.reason)?;
        }

        Ok(())
    }
}