gitr 0.4.0

Async typed git CLI wrapper for agents and automation.
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

use crate::types::GitStatus;
use std::sync::Arc;
use tokio::sync::RwLock;

/// Simple in-memory cache for frequently accessed git state.
///
/// The cache is scoped to a single `Repository` handle and is *not*
/// synchronized across clones. Call [`Cache::invalidate`] after any
/// mutating operation to keep subsequent reads consistent.
#[derive(Debug, Clone, Default)]
pub struct Cache {
    status: Arc<RwLock<Option<GitStatus>>>,
}

impl Cache {
    /// Create a new empty cache.
    pub fn new() -> Self {
        Self::default()
    }

    /// Get cached status if available.
    pub async fn get_status(&self) -> Option<GitStatus> {
        self.status.read().await.clone()
    }

    /// Store status in the cache.
    pub async fn set_status(&self, status: GitStatus) {
        *self.status.write().await = Some(status);
    }

    /// Clear all cached entries.
    pub async fn invalidate(&self) {
        *self.status.write().await = None;
    }
}

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

    #[tokio::test]
    async fn test_cache_new_empty() {
        let cache = Cache::new();
        assert!(cache.get_status().await.is_none());
    }

    #[tokio::test]
    async fn test_cache_set_and_get() {
        let cache = Cache::new();
        let status = GitStatus {
            staged: vec!["a.txt".to_string()],
            unstaged: vec![],
            untracked: vec![],
        };
        cache.set_status(status.clone()).await;
        let got = cache.get_status().await.unwrap();
        assert_eq!(got.staged, status.staged);
        assert!(got.unstaged.is_empty());
        assert!(got.untracked.is_empty());
    }

    #[tokio::test]
    async fn test_cache_invalidate() {
        let cache = Cache::new();
        let status = GitStatus {
            staged: vec!["a.txt".to_string()],
            unstaged: vec![],
            untracked: vec![],
        };
        cache.set_status(status).await;
        cache.invalidate().await;
        assert!(cache.get_status().await.is_none());
    }

    #[tokio::test]
    async fn test_cache_clone_shares_state() {
        let cache = Cache::new();
        let status = GitStatus {
            staged: vec!["b.txt".to_string()],
            unstaged: vec![],
            untracked: vec![],
        };
        cache.set_status(status.clone()).await;
        let cache2 = cache.clone();
        assert_eq!(cache2.get_status().await.unwrap().staged, status.staged);
        cache2.invalidate().await;
        assert!(cache.get_status().await.is_none());
    }
}