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

use crate::domain::CodeFact;
use std::path::{Path, PathBuf};

/// Everything an analyzer needs to answer questions about the project.
///
/// Owns parsed artifacts so each file is parsed at most once per run.
#[derive(Debug, Default)]
pub struct ProjectContext {
    pub root: PathBuf,
    pub rust_files: Vec<PathBuf>,
    pub markdown_files: Vec<PathBuf>,
    pub yaml_files: Vec<PathBuf>,
    pub makefile_files: Vec<PathBuf>,
    pub code_facts: Vec<CodeFact>,
}

impl ProjectContext {
    pub fn new(root: impl Into<PathBuf>) -> Self {
        Self {
            root: root.into(),
            ..Self::default()
        }
    }

    pub fn facts_named<'a>(&'a self, name: &'a str) -> impl Iterator<Item = &'a CodeFact> + 'a {
        self.code_facts.iter().filter(move |f| f.name == name)
    }

    pub fn rel<'a>(&self, path: &'a Path) -> &'a Path {
        path.strip_prefix(&self.root).unwrap_or(path)
    }
}