easement 0.3.0

Architecture quality gate for polyglot codebases
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

use std::collections::BTreeSet;

use anyhow::{Result, bail};
use globset::{Glob, GlobSet, GlobSetBuilder};

use crate::components::ComponentMap;
use crate::config::Config;

/// What a run reports on: the whole project, or the files of some components
/// and/or paths. The whole project is still read, because cycles, limits and
/// every edge need all of it; the scope narrows the report and its counters.
#[derive(Default)]
pub struct Scope {
    components: BTreeSet<String>,
    paths: Option<GlobSet>,
}

impl Scope {
    pub fn new(config: &Config, components: &[String], paths: &[String]) -> Result<Self> {
        for name in components {
            if !config.components.contains_key(name) {
                bail!("--component names unknown component `{name}`");
            }
        }
        let paths = if paths.is_empty() {
            None
        } else {
            let mut builder = GlobSetBuilder::new();
            for path in paths {
                let path = path.trim_start_matches("./").trim_end_matches('/');
                for glob in [path.to_string(), format!("{path}/**")] {
                    builder.add(Glob::new(&glob)?);
                }
            }
            Some(builder.build()?)
        };
        Ok(Self {
            components: components.iter().cloned().collect(),
            paths,
        })
    }

    /// Whether `file` is reported on: it matches every restriction that was given.
    pub fn contains(&self, map: &ComponentMap, file: &str) -> bool {
        (self.components.is_empty()
            || map
                .component_of(file)
                .is_some_and(|c| self.components.contains(c)))
            && self.paths.as_ref().is_none_or(|p| p.is_match(file))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn restricts_by_component_and_path() {
        let config: Config = serde_norway::from_str(
            "version: 1
components:
  web: { in: web }
  api: { in: api }
",
        )
        .unwrap();
        let map = ComponentMap::new(&config).unwrap();
        let all = Scope::default();
        assert!(all.contains(&map, "anything/x.ts"));

        let web = Scope::new(&config, &["web".into()], &[]).unwrap();
        assert!(web.contains(&map, "web/a.ts"));
        assert!(!web.contains(&map, "api/a.ts"));
        assert!(!web.contains(&map, "other/a.ts"));

        let path = Scope::new(&config, &[], &["web/pages".into()]).unwrap();
        assert!(path.contains(&map, "web/pages/a.ts"));
        assert!(!path.contains(&map, "web/other/a.ts"));

        let both = Scope::new(&config, &["web".into()], &["api".into()]).unwrap();
        assert!(!both.contains(&map, "web/a.ts"));

        let err = Scope::new(&config, &["ghost".into()], &[]).err().unwrap();
        assert!(err.to_string().contains("ghost"));
    }
}