cha-core 0.6.5

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

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

/// Detect classes with very few methods and lines (nearly empty wrappers).
pub struct LazyClassAnalyzer {
    pub max_methods: usize,
    pub max_lines: usize,
}

impl Default for LazyClassAnalyzer {
    fn default() -> Self {
        Self {
            max_methods: 1,
            max_lines: 10,
        }
    }
}

impl Plugin for LazyClassAnalyzer {
    fn name(&self) -> &str {
        "lazy_class"
    }

    fn description(&self) -> &str {
        "Class too small to justify its existence"
    }

    fn analyze(&self, ctx: &AnalysisContext) -> Vec<Finding> {
        ctx.model
            .classes
            .iter()
            .filter_map(|c| {
                if c.is_interface
                    || c.method_count > self.max_methods
                    || c.line_count > self.max_lines
                {
                    return None;
                }
                Some(Finding {
                    smell_name: "lazy_class".into(),
                    category: SmellCategory::Dispensables,
                    severity: Severity::Hint,
                    location: Location {
                        path: ctx.file.path.clone(),
                        start_line: c.start_line,
                        end_line: c.end_line,
                        name: Some(c.name.clone()),
                    },
                    message: format!(
                        "Class `{}` has only {} method(s) and {} lines, consider Inline Class",
                        c.name, c.method_count, c.line_count
                    ),
                    suggested_refactorings: vec!["Inline Class".into()],
                })
            })
            .collect()
    }
}