archunit/layers/fluentapi/
layer_definition_builder.rs

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
use crate::common::{PatternError, RegexFactory};

use super::LayeredArchitecture;

/// Immutable stage defining which files belong to one named layer.
#[derive(Debug, Clone)]
#[must_use = "a layer definition has no effect until it receives a selector"]
pub struct LayerDefinitionBuilder {
    architecture: LayeredArchitecture,
    layer_name: String,
}

impl LayerDefinitionBuilder {
    pub(super) fn new(architecture: LayeredArchitecture, layer_name: String) -> Self {
        Self {
            architecture,
            layer_name,
        }
    }

    /// Assigns files whose complete normalized path matches `pattern` to this layer.
    pub fn defined_by(self, pattern: impl Into<crate::common::PatternSpec>) -> LayeredArchitecture {
        let filter = RegexFactory::default().path_matcher(pattern);
        self.add_filter(filter, "path")
    }

    /// Assigns files whose containing directory matches `pattern` to this layer.
    pub fn defined_by_folder(
        self,
        pattern: impl Into<crate::common::PatternSpec>,
    ) -> LayeredArchitecture {
        let filter = RegexFactory::default().folder_matcher(pattern);
        self.add_filter(filter, "folder")
    }

    /// Returns the architecture accumulated before this definition stage.
    pub const fn architecture(&self) -> &LayeredArchitecture {
        &self.architecture
    }

    /// Returns the name of the layer being defined.
    #[must_use]
    pub fn layer_name(&self) -> &str {
        &self.layer_name
    }

    fn add_filter(
        self,
        filter: Result<crate::common::Filter, PatternError>,
        selector_kind: &'static str,
    ) -> LayeredArchitecture {
        self.architecture
            .with_layer_filter(self.layer_name, filter, selector_kind)
    }
}