episteme 0.3.0

Knowledge graph for software engineering — design patterns, refactorings, and laws for AI agents
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use serde::{Deserialize, Serialize};

/// Whether a parsed item is a function or a class/struct/impl block.
#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum ItemType {
    #[default]
    Function,
    Class,
}

/// Code metrics for a function or class.
///
/// Ported from `episteme.parsers.base.CodeMetrics`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CodeMetrics {
    pub loc: usize,
    pub cyclomatic_complexity: usize,
    pub nesting_depth: usize,
    pub parameter_count: usize,
    pub local_variables: usize,
    pub return_statements: usize,
    #[serde(default)]
    pub method_count: usize,
    #[serde(default)]
    pub field_count: usize,
    #[serde(default)]
    pub external_calls: usize,
    #[serde(default)]
    pub primitive_params: usize,
    #[serde(default)]
    pub branch_count: usize,
    #[serde(default)]
    pub method_call_chains: usize,
    #[serde(default)]
    pub delegation_methods: usize,
    #[serde(default)]
    pub ast_hash: String,
    /// Number of comment lines in the function/class body.
    #[serde(default)]
    pub comment_count: usize,
    /// Number of methods that override parent methods with empty or trivial bodies.
    #[serde(default)]
    pub override_count: usize,
    /// Whether this item is a function or class/struct/impl block.
    #[serde(default)]
    pub item_type: ItemType,
}

impl Default for CodeMetrics {
    fn default() -> Self {
        Self {
            loc: 0,
            cyclomatic_complexity: 1, // base complexity
            nesting_depth: 0,
            parameter_count: 0,
            local_variables: 0,
            return_statements: 0,
            method_count: 0,
            field_count: 0,
            external_calls: 0,
            primitive_params: 0,
            branch_count: 0,
            method_call_chains: 0,
            delegation_methods: 0,
            ast_hash: String::new(),
            comment_count: 0,
            override_count: 0,
            item_type: ItemType::Function,
        }
    }
}

/// A detected code smell with confidence score and location.
///
/// Ported from `episteme.parsers.base.SmellDetection`.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SmellDetection {
    pub smell_id: String,
    pub smell_name: String,
    pub confidence: f64,
    pub location: String,
    pub function_name: String,
    pub metrics: CodeMetrics,
    pub reasons: Vec<String>,
}