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
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

use std::fmt;

use gix::bstr::ByteSlice;
use serde::{Serialize, Serializer};
use thiserror::Error;

const NOTES_REF_PREFIX: &str = "refs/notes/vet";
pub(crate) const DEFAULT_REVIEW_CHANNEL: &str = "default";

/// A review channel whose notes ref has been validated as a Git ref name.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct ReviewChannel {
    name: String,
    notes_ref: NotesRef,
}

impl ReviewChannel {
    pub(crate) fn new(input: &str) -> Result<Self, ChannelError> {
        if input.is_empty() {
            return Err(ChannelError::Empty);
        }
        if input.contains('/') {
            return Err(ChannelError::ContainsSlash);
        }

        let notes_ref_name = format!("{NOTES_REF_PREFIX}/{input}");
        validate_notes_ref(&notes_ref_name)?;

        Ok(Self {
            name: input.to_owned(),
            notes_ref: NotesRef {
                name: notes_ref_name,
            },
        })
    }

    pub(crate) fn as_str(&self) -> &str {
        &self.name
    }

    pub(crate) const fn notes_ref(&self) -> &NotesRef {
        &self.notes_ref
    }
}

fn validate_notes_ref(notes_ref_name: &str) -> Result<(), ChannelError> {
    match gix::validate::reference::name(notes_ref_name.as_bytes().as_bstr()) {
        Ok(_) => Ok(()),
        Err(error) => Err(ChannelError::InvalidNotesRef {
            notes_ref: notes_ref_name.to_owned(),
            validation_error: error.to_string(),
        }),
    }
}

impl Serialize for ReviewChannel {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&self.name)
    }
}

impl fmt::Display for ReviewChannel {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.name.fmt(f)
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct NotesRef {
    name: String,
}

impl NotesRef {
    pub(crate) fn as_str(&self) -> &str {
        &self.name
    }
}

impl fmt::Display for NotesRef {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.name.fmt(f)
    }
}

#[derive(Clone, Debug, Eq, Error, PartialEq)]
pub(crate) enum ChannelError {
    #[error("channel name must not be empty")]
    Empty,
    #[error("channel name must not contain '/'")]
    ContainsSlash,
    #[error("notes ref {notes_ref:?} is not a valid Git ref name: {validation_error}")]
    InvalidNotesRef {
        notes_ref: String,
        validation_error: String,
    },
}