debtmap 0.16.5

Code complexity and technical debt analyzer
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

//! Database Framework Pattern Detection

use super::detector::{FileContext, FunctionAst};

/// Detect Diesel query (Rust)
pub fn is_diesel_query(function: &FunctionAst, file_context: &FileContext) -> bool {
    let has_diesel_import = file_context.imports.iter().any(|i| i.contains("diesel"));

    let has_diesel_calls = function.calls.iter().any(|call| {
        call.name.contains("execute")
            || call.name.contains("load")
            || call.name.contains("get_result")
            || call.name.contains("get_results")
    });

    let has_diesel_derives = function
        .derives
        .iter()
        .any(|d| d == "Queryable" || d == "Insertable");

    has_diesel_import && (has_diesel_calls || has_diesel_derives)
}

/// Detect SQLAlchemy model (Python)
pub fn is_sqlalchemy_model(function: &FunctionAst, file_context: &FileContext) -> bool {
    let has_sqlalchemy_import = file_context
        .imports
        .iter()
        .any(|i| i.contains("sqlalchemy") || i.contains("SQLAlchemy"));

    let has_sqlalchemy_decorators = function.decorators.iter().any(|d| {
        d.name.contains("validates")
            || d.name.contains("hybrid_property")
            || d.name.contains("event.listens_for")
    });

    has_sqlalchemy_import && has_sqlalchemy_decorators
}

#[cfg(test)]
mod tests {
    use super::super::detector::{Decorator, FileContext, FunctionAst, FunctionCall};
    use super::super::patterns::Language;
    use super::*;

    #[test]
    fn test_diesel_query_detection() {
        let mut function = FunctionAst::new("get_users".to_string());
        function.calls.push(FunctionCall {
            name: "load".to_string(),
        });

        let mut file_context = FileContext::new(Language::Rust, "models.rs".into());
        file_context.add_import("use diesel::prelude::*;".to_string());

        assert!(is_diesel_query(&function, &file_context));
    }

    #[test]
    fn test_sqlalchemy_model_detection() {
        let mut function = FunctionAst::new("validate_email".to_string());
        function.decorators.push(Decorator {
            name: "@validates('email')".to_string(),
        });

        let mut file_context = FileContext::new(Language::Python, "models.py".into());
        file_context.add_import("from sqlalchemy import validates".to_string());

        assert!(is_sqlalchemy_model(&function, &file_context));
    }
}