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

use std::path::Path;

use crate::repository::Remote;

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

/// Builder for `git ls-remote` command.
///
/// See `git ls-remote --help` for full documentation.
#[derive(Debug)]
pub struct LsRemote<'a> {
    repo_path: Option<&'a Path>,
    heads: bool,
    symref: bool,
    remote: Option<&'a Remote>,
    pattern: Option<&'a str>,
}

crate::impl_repo_path!(LsRemote);

impl<'a> LsRemote<'a> {
    #[must_use]
    fn new() -> Self {
        Self {
            repo_path: None,
            heads: false,
            symref: false,
            remote: None,
            pattern: None,
        }
    }

    crate::flag_methods! {
        /// Limit to refs/heads (branches only).
        ///
        /// Corresponds to `--heads`.
        pub fn heads / heads_if, heads, "Conditionally limit to refs/heads."
    }

    crate::flag_methods! {
        /// Show underlying ref in addition to the object.
        ///
        /// Corresponds to `--symref`. Useful for finding the default branch.
        pub fn symref / symref_if, symref, "Conditionally show underlying ref."
    }

    /// Set the remote repository to query.
    #[must_use]
    pub fn remote(mut self, remote: &'a Remote) -> Self {
        self.remote = Some(remote);
        self
    }

    /// Set the pattern to filter refs.
    #[must_use]
    pub fn pattern(mut self, pattern: &'a str) -> Self {
        self.pattern = Some(pattern);
        self
    }
}

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

impl crate::Build for LsRemote<'_> {
    fn build(self) -> cmd_proc::Command {
        crate::base_command(self.repo_path)
            .argument("ls-remote")
            .optional_flag(self.heads, "--heads")
            .optional_flag(self.symref, "--symref")
            .optional_argument(self.remote)
            .optional_argument(self.pattern)
    }
}

#[cfg(feature = "test-utils")]
impl LsRemote<'_> {
    /// Compare the built command with another command using debug representation.
    pub fn test_eq(&self, other: &cmd_proc::Command) {
        let command = crate::Build::build(Self {
            repo_path: self.repo_path,
            heads: self.heads,
            symref: self.symref,
            remote: self.remote,
            pattern: self.pattern,
        });
        command.test_eq(other);
    }
}