git-vet 0.2.0

Git-based review gate for tracked file contents
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

use std::path::{Path, PathBuf};

use ignore::gitignore::{Gitignore, GitignoreBuilder};

use crate::channel::ReviewChannel;
use crate::error::AppError;
use crate::path::RepoPath;

#[derive(Debug)]
pub(crate) struct Vetignore {
    matcher: Gitignore,
}

impl Vetignore {
    pub(crate) fn load(root: &Path, channel: &ReviewChannel) -> Result<Self, AppError> {
        let mut builder = GitignoreBuilder::new(root);
        add_existing_ignore_file(&mut builder, &root.join(".vetignore"))?;
        add_channel_ignore_file_if_present(&mut builder, &channel_ignore_path(root, channel))?;
        let matcher = builder
            .build()
            .map_err(|error| AppError::Vetignore(error.to_string()))?;
        Ok(Self { matcher })
    }

    pub(crate) fn is_ignored(&self, path: &RepoPath) -> bool {
        self.matcher
            .matched_path_or_any_parents(path.to_os_path_buf(), false)
            .is_ignore()
    }
}

fn add_existing_ignore_file(builder: &mut GitignoreBuilder, path: &Path) -> Result<(), AppError> {
    if let Some(error) = path.exists().then(|| builder.add(path)).flatten() {
        return Err(AppError::Vetignore(error.to_string()));
    }
    Ok(())
}

fn add_channel_ignore_file_if_present(
    builder: &mut GitignoreBuilder,
    path: &Path,
) -> Result<(), AppError> {
    if let Some(error) = path.is_file().then(|| builder.add(path)).flatten() {
        return Err(AppError::Vetignore(error.to_string()));
    }
    Ok(())
}

fn channel_ignore_path(root: &Path, channel: &ReviewChannel) -> PathBuf {
    root.join(format!(".vetignore.{}", channel.as_str()))
}