spec-drift 0.1.0

Semantic coherence analysis between specification and implementation for Rust projects.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use crate::domain::{CodeFact, FactKind, Location};
use crate::error::SpecDriftError;
use std::path::Path;
use syn::spanned::Spanned;

pub struct RustParser;

impl RustParser {
    /// Parse `path` as a Rust file and extract every top-level (and nested)
    /// item as a [`CodeFact`]. Free functions inside `impl` blocks are included
    /// so method references like `Client::new` can be resolved.
    pub fn parse(path: &Path) -> Result<Vec<CodeFact>, SpecDriftError> {
        let source = std::fs::read_to_string(path).map_err(|e| SpecDriftError::Io {
            path: path.to_path_buf(),
            source: e,
        })?;

        let file = syn::parse_file(&source).map_err(|e| SpecDriftError::RustParse {
            path: path.to_path_buf(),
            source: e,
        })?;

        let mut facts = Vec::new();
        collect_items(&file.items, path, &mut facts);
        Ok(facts)
    }
}

fn collect_items(items: &[syn::Item], path: &Path, facts: &mut Vec<CodeFact>) {
    for item in items {
        match item {
            syn::Item::Fn(f) => {
                push(
                    facts,
                    path,
                    FactKind::Function,
                    f.sig.ident.to_string(),
                    f.span(),
                );
            }
            syn::Item::Struct(s) => {
                push(facts, path, FactKind::Struct, s.ident.to_string(), s.span());
            }
            syn::Item::Enum(e) => {
                push(facts, path, FactKind::Enum, e.ident.to_string(), e.span());
            }
            syn::Item::Trait(t) => {
                push(facts, path, FactKind::Trait, t.ident.to_string(), t.span());
            }
            syn::Item::Type(t) => {
                push(
                    facts,
                    path,
                    FactKind::TypeAlias,
                    t.ident.to_string(),
                    t.span(),
                );
            }
            syn::Item::Const(c) => {
                push(
                    facts,
                    path,
                    FactKind::Constant,
                    c.ident.to_string(),
                    c.span(),
                );
            }
            syn::Item::Static(s) => {
                push(
                    facts,
                    path,
                    FactKind::Constant,
                    s.ident.to_string(),
                    s.span(),
                );
            }
            syn::Item::Macro(m) => {
                if let Some(ident) = m.ident.as_ref() {
                    push(facts, path, FactKind::Macro, ident.to_string(), m.span());
                }
            }
            syn::Item::Mod(m) => {
                push(facts, path, FactKind::Module, m.ident.to_string(), m.span());
                if let Some((_, items)) = &m.content {
                    collect_items(items, path, facts);
                }
            }
            syn::Item::Impl(i) => {
                for impl_item in &i.items {
                    if let syn::ImplItem::Fn(f) = impl_item {
                        push(
                            facts,
                            path,
                            FactKind::Function,
                            f.sig.ident.to_string(),
                            f.span(),
                        );
                    }
                }
            }
            _ => {}
        }
    }
}

fn push(
    facts: &mut Vec<CodeFact>,
    path: &Path,
    kind: FactKind,
    name: String,
    span: proc_macro2::Span,
) {
    facts.push(CodeFact {
        location: Location::new(path, span.start().line as u32),
        kind,
        name,
    });
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn extracts_fn_struct_enum_trait_impl_methods() {
        let tmp = tempfile::tempdir().unwrap();
        let path = tmp.path().join("lib.rs");
        std::fs::write(
            &path,
            r#"
                pub fn hello() {}
                pub struct Widget;
                pub enum Color { Red, Blue }
                pub trait Sing { fn sing(&self); }
                impl Widget { pub fn make() {} }
            "#,
        )
        .unwrap();

        let facts = RustParser::parse(&path).unwrap();
        let names: Vec<_> = facts.iter().map(|f| f.name.as_str()).collect();
        assert!(names.contains(&"hello"));
        assert!(names.contains(&"Widget"));
        assert!(names.contains(&"Color"));
        assert!(names.contains(&"Sing"));
        assert!(names.contains(&"make"));
    }
}