srcmetrics 0.2.0

Language-independent source code metrics (size, complexity, nesting, Halstead, duplication, dependencies, documentation) for C, C++, Go, Java, JavaScript, Python, Rust and TypeScript
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Documentation Metrics (ADR-0013).
//!
//! Comment LOC and Comment Ratio are provided by the Size calculator (`size.comment_loc`,
//! `size.comment_ratio`).

use super::{Calculator, MetricSpec, MetricValue, Metrics, ProgramMetrics, Scope::*, per_file};
use crate::ir::{File, Program};

pub struct DocumentationCalculator;

static SPECS: &[MetricSpec] = &[
    MetricSpec {
        id: "documentation.doc_loc",
        scopes: &[Function],
    },
    MetricSpec {
        id: "documentation.documented_function_count",
        scopes: &[File, Project],
    },
    MetricSpec {
        id: "documentation.documentation_ratio",
        scopes: &[File, Project],
    },
];

impl Calculator for DocumentationCalculator {
    fn specs(&self) -> &'static [MetricSpec] {
        SPECS
    }

    fn compute(&self, program: &Program) -> ProgramMetrics {
        let mut result = per_file(
            program,
            |_| (),
            |file, _| totals(&[file]),
            |_, _, function| {
                let lines = function.doc.map_or(0, |d| d.line_count());
                Metrics::from([("documentation.doc_loc", lines.into())])
            },
        );
        result.project = totals(&program.files.iter().collect::<Vec<_>>());
        result
    }
}

fn totals(files: &[&File]) -> Metrics {
    let functions = files.iter().flat_map(|f| &f.functions);
    let total = functions.clone().count();
    let documented = functions.filter(|f| f.doc.is_some()).count();
    Metrics::from([
        ("documentation.documented_function_count", documented.into()),
        (
            "documentation.documentation_ratio",
            MetricValue::ratio(documented as f64, total as f64),
        ),
    ])
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ir::builder::*;
    use crate::metrics::{Calculator, MetricValue};

    fn v(x: f64) -> MetricValue {
        MetricValue::Available(x)
    }

    fn sample() -> Program {
        let mut b = FileBuilder::new("");
        let root = b.root();
        b.function(root, "f", 0, lines(3, 5));
        b.function(root, "g", 0, lines(6, 7));
        let mut file = b.build();
        file.functions[0].doc = Some(lines(1, 2));
        Program { files: vec![file] }
    }

    #[test]
    fn function_doc_loc() {
        let r = DocumentationCalculator.compute(&sample());
        assert_eq!(r.files[0].functions[0]["documentation.doc_loc"], v(2.0));
        assert_eq!(r.files[0].functions[1]["documentation.doc_loc"], v(0.0));
    }

    #[test]
    fn file_and_project_counts_and_ratio() {
        let mut program = sample();
        program.files.push(FileBuilder::new("").build());
        let r = DocumentationCalculator.compute(&program);
        assert_eq!(
            r.files[0].metrics["documentation.documented_function_count"],
            v(1.0)
        );
        assert_eq!(
            r.files[0].metrics["documentation.documentation_ratio"],
            v(0.5)
        );
        assert_eq!(
            r.files[1].metrics["documentation.documentation_ratio"],
            MetricValue::NotApplicable
        );
        assert_eq!(r.project["documentation.documentation_ratio"], v(0.5));
    }
}