gn-core 0.1.11

git-notes core engine — reads/writes git note objects
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

use serde::{Deserialize, Serialize};
use std::fmt;

/// The three built-in note namespaces. Extensible via `Custom`.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Namespace {
    Comments,
    Review,
    Todos,
    Custom(String),
}

impl Namespace {
    /// Returns the full ref path for this namespace.
    pub fn ref_path(&self) -> String {
        match self {
            Namespace::Comments => "refs/notes/comments".to_string(),
            Namespace::Review => "refs/notes/review".to_string(),
            Namespace::Todos => "refs/notes/todos".to_string(),
            Namespace::Custom(name) => format!("refs/notes/{}", name),
        }
    }

    /// Parses a string into a Namespace. Will match built-in names if possible.
    #[allow(clippy::should_implement_trait)]
    pub fn from_str(s: &str) -> Self {
        // Strip the standard prefix if provided
        let stripped = s.strip_prefix("refs/notes/").unwrap_or(s);
        match stripped {
            "comments" => Namespace::Comments,
            "review" => Namespace::Review,
            "todos" => Namespace::Todos,
            other => Namespace::Custom(other.to_string()),
        }
    }
}

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

    #[test]
    fn test_from_str_builtin_without_prefix() {
        assert_eq!(Namespace::from_str("comments"), Namespace::Comments);
        assert_eq!(Namespace::from_str("review"), Namespace::Review);
        assert_eq!(Namespace::from_str("todos"), Namespace::Todos);
    }

    #[test]
    fn test_from_str_builtin_with_prefix() {
        assert_eq!(Namespace::from_str("refs/notes/comments"), Namespace::Comments);
        assert_eq!(Namespace::from_str("refs/notes/review"), Namespace::Review);
        assert_eq!(Namespace::from_str("refs/notes/todos"), Namespace::Todos);
    }

    #[test]
    fn test_from_str_custom() {
        assert_eq!(
            Namespace::from_str("bugs"),
            Namespace::Custom("bugs".to_string())
        );
        assert_eq!(
            Namespace::from_str("refs/notes/bugs"),
            Namespace::Custom("bugs".to_string())
        );
    }

    #[test]
    fn test_ref_path_and_display() {
        let cases = vec![
            (Namespace::Comments, "refs/notes/comments", "comments"),
            (Namespace::Review, "refs/notes/review", "review"),
            (Namespace::Todos, "refs/notes/todos", "todos"),
            (Namespace::Custom("my-notes".to_string()), "refs/notes/my-notes", "my-notes"),
        ];

        for (ns, expected_ref, expected_display) in cases {
            assert_eq!(ns.ref_path(), expected_ref);
            assert_eq!(ns.to_string(), expected_display);
            assert_eq!(Namespace::from_str(expected_ref), ns);
            assert_eq!(Namespace::from_str(expected_display), ns);
        }
    }
}

impl fmt::Display for Namespace {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Namespace::Comments => write!(f, "comments"),
            Namespace::Review => write!(f, "review"),
            Namespace::Todos => write!(f, "todos"),
            Namespace::Custom(name) => write!(f, "{}", name),
        }
    }
}