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;

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

/// Builder for `git rev-list` command.
///
/// See `git rev-list --help` for full documentation.
#[derive(Debug)]
pub struct RevList<'a> {
    repo_path: Option<&'a Path>,
    topo_order: bool,
    reverse: bool,
    max_count: Option<usize>,
    commits: Vec<&'a str>,
}

crate::impl_repo_path!(RevList);

impl<'a> RevList<'a> {
    #[must_use]
    fn new() -> Self {
        Self {
            repo_path: None,
            topo_order: false,
            reverse: false,
            max_count: None,
            commits: Vec::new(),
        }
    }

    crate::flag_methods! {
        /// Show commits in topological order.
        ///
        /// Corresponds to `--topo-order`.
        pub fn topo_order / topo_order_if, topo_order, "Conditionally show commits in topological order."
    }

    crate::flag_methods! {
        /// Output commits in reverse order.
        ///
        /// Corresponds to `--reverse`.
        pub fn reverse / reverse_if, reverse, "Conditionally output commits in reverse order."
    }

    /// Limit the number of commits to output.
    ///
    /// Corresponds to `--max-count` or `-n`.
    #[must_use]
    pub fn max_count(mut self, count: usize) -> Self {
        self.max_count = Some(count);
        self
    }

    /// Add a commit or range to list.
    #[must_use]
    pub fn commit(mut self, commit: &'a str) -> Self {
        self.commits.push(commit);
        self
    }
}

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

impl crate::Build for RevList<'_> {
    fn build(self) -> cmd_proc::Command {
        crate::base_command(self.repo_path)
            .argument("rev-list")
            .optional_flag(self.topo_order, "--topo-order")
            .optional_flag(self.reverse, "--reverse")
            .optional_option("--max-count", self.max_count.map(|c| c.to_string()))
            .arguments(self.commits)
    }
}

#[cfg(feature = "test-utils")]
impl RevList<'_> {
    /// 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,
            topo_order: self.topo_order,
            reverse: self.reverse,
            max_count: self.max_count,
            commits: self.commits.clone(),
        });
        command.test_eq(other);
    }
}