git-proc 0.4.0

Process-based git CLI wrapper with rich types
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::path::Path;

/// Create a new `git rev-parse` command builder.
#[must_use]
pub fn new() -> RevParse<'static> {
    RevParse::new()
}

/// Builder for `git rev-parse` command.
///
/// See `git rev-parse --help` for full documentation.
#[derive(Debug)]
pub struct RevParse<'a> {
    repo_path: Option<&'a Path>,
    abbrev_ref: bool,
    symbolic_full_name: bool,
    rev: Option<&'a str>,
}

crate::impl_repo_path!(RevParse);

impl<'a> RevParse<'a> {
    #[must_use]
    fn new() -> Self {
        Self {
            repo_path: None,
            abbrev_ref: false,
            symbolic_full_name: false,
            rev: None,
        }
    }

    crate::flag_methods! {
        /// Output short ref name (e.g., `main` instead of `refs/heads/main`).
        ///
        /// Corresponds to `--abbrev-ref`.
        pub fn abbrev_ref / abbrev_ref_if, abbrev_ref, "Conditionally output short ref name."
    }

    crate::flag_methods! {
        /// Output full symbolic ref name.
        ///
        /// Corresponds to `--symbolic-full-name`.
        pub fn symbolic_full_name / symbolic_full_name_if, symbolic_full_name, "Conditionally output full symbolic ref name."
    }

    /// Set the revision to parse (e.g., `HEAD`, `@{u}`).
    #[must_use]
    pub fn rev(mut self, rev: &'a str) -> Self {
        self.rev = Some(rev);
        self
    }
}

impl Default for RevParse<'_> {
    fn default() -> Self {
        Self::new()
    }
}

impl crate::Build for RevParse<'_> {
    fn build(self) -> cmd_proc::Command {
        crate::base_command(self.repo_path)
            .argument("rev-parse")
            .optional_flag(self.abbrev_ref, "--abbrev-ref")
            .optional_flag(self.symbolic_full_name, "--symbolic-full-name")
            .optional_argument(self.rev)
    }
}

#[cfg(feature = "test-utils")]
impl RevParse<'_> {
    /// Compare the built command with another command using debug representation.
    ///
    /// This is useful for testing command construction without executing.
    pub fn test_eq(&self, other: &cmd_proc::Command) {
        let command = crate::Build::build(Self {
            repo_path: self.repo_path,
            abbrev_ref: self.abbrev_ref,
            symbolic_full_name: self.symbolic_full_name,
            rev: self.rev,
        });
        command.test_eq(other);
    }
}

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

    #[tokio::test]
    async fn test_rev_parse_head() {
        let output = RevParse::new()
            .rev("HEAD")
            .build()
            .stdout_capture()
            .string()
            .await
            .unwrap();
        assert!(!output.trim().is_empty());
    }

    #[tokio::test]
    async fn test_rev_parse_abbrev_ref() {
        let output = RevParse::new()
            .abbrev_ref()
            .rev("HEAD")
            .build()
            .stdout_capture()
            .string()
            .await
            .unwrap();
        assert!(!output.trim().is_empty());
    }
}