cha-core 0.6.4

Core analysis engine for Cha — pluggable code smell detection
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

use crate::{AnalysisContext, Finding, Location, Plugin, Severity, SmellCategory};

/// Detect imports that violate configured layer boundaries.
/// Layers are defined as path prefixes with a numeric order.
/// Lower layers must not import from higher layers.
///
/// Configure via .cha.toml:
/// ```toml
/// [plugins.layer_violation.options]
/// layers = "domain:0,service:1,controller:2,ui:3"
/// ```
#[derive(Default)]
pub struct LayerViolationAnalyzer {
    /// Ordered layers: (prefix, level). Lower level = lower layer.
    pub layers: Vec<(String, u32)>,
}

impl Plugin for LayerViolationAnalyzer {
    fn name(&self) -> &str {
        "layer_violation"
    }

    fn analyze(&self, ctx: &AnalysisContext) -> Vec<Finding> {
        if self.layers.is_empty() {
            return vec![];
        }

        let file_path = ctx.file.path.to_string_lossy();
        let file_layer = self.layer_of(&file_path);

        ctx.model
            .imports
            .iter()
            .filter_map(|imp| self.check_import(ctx, &file_layer, imp))
            .collect()
    }
}

impl LayerViolationAnalyzer {
    /// Check a single import against the file's layer boundary.
    fn check_import(
        &self,
        ctx: &AnalysisContext,
        file_layer: &Option<(String, u32)>,
        imp: &crate::ImportInfo,
    ) -> Option<Finding> {
        let import_layer = self.layer_of(&imp.source);
        let (_, file_level) = file_layer.as_ref()?;
        let (imp_name, imp_level) = import_layer.as_ref()?;
        if file_level >= imp_level {
            return None;
        }
        Some(Finding {
            smell_name: "layer_violation".into(),
            category: SmellCategory::Couplers,
            severity: Severity::Error,
            location: Location {
                path: ctx.file.path.clone(),
                start_line: imp.line,
                end_line: imp.line,
                name: None,
            },
            message: format!(
                "Import `{}` violates layer boundary (importing from layer `{}` into lower layer)",
                imp.source, imp_name
            ),
            suggested_refactorings: vec!["Move Method".into(), "Extract Interface".into()],
        })
    }

    fn layer_of(&self, path: &str) -> Option<(String, u32)> {
        self.layers
            .iter()
            .find(|(prefix, _)| path.contains(prefix.as_str()))
            .map(|(name, level)| (name.clone(), *level))
    }

    /// Parse layers from config string: "domain:0,service:1,controller:2"
    pub fn from_config_str(s: &str) -> Self {
        let layers = s
            .split(',')
            .filter_map(|part| {
                let mut parts = part.trim().splitn(2, ':');
                let name = parts.next()?.trim().to_string();
                let level = parts.next()?.trim().parse().ok()?;
                Some((name, level))
            })
            .collect();
        Self { layers }
    }
}