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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

use std::ffi::OsStr;
use std::path::Path;

use crate::CommandError;

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

/// Builder for `git commit` command.
///
/// See `git commit --help` for full documentation.
#[derive(Debug)]
pub struct Commit<'a> {
    repo_path: Option<&'a Path>,
    message: Option<&'a str>,
    author: Option<&'a str>,
    date: Option<&'a str>,
    allow_empty: bool,
    allow_empty_message: bool,
    porcelain: bool,
    env_vars: Vec<(cmd_proc::EnvVariableName<'a>, &'a OsStr)>,
}

crate::impl_repo_path!(Commit);
crate::impl_porcelain!(Commit);

impl<'a> Commit<'a> {
    #[must_use]
    fn new() -> Self {
        Self {
            repo_path: None,
            message: None,
            author: None,
            date: None,
            allow_empty: false,
            allow_empty_message: false,
            porcelain: false,
            env_vars: Vec::new(),
        }
    }

    /// Set the commit message.
    ///
    /// Corresponds to `--message` or `-m`.
    #[must_use]
    pub fn message(mut self, message: &'a str) -> Self {
        self.message = Some(message);
        self
    }

    /// Set the commit author.
    ///
    /// Corresponds to `--author`. Format: `Name <email>`.
    #[must_use]
    pub fn author(mut self, author: &'a str) -> Self {
        self.author = Some(author);
        self
    }

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

    crate::flag_methods! {
        /// Allow creating a commit with no changes.
        ///
        /// Corresponds to `--allow-empty`.
        pub fn allow_empty / allow_empty_if, allow_empty, "Conditionally allow creating a commit with no changes."
    }

    crate::flag_methods! {
        /// Allow creating a commit with an empty message.
        ///
        /// Corresponds to `--allow-empty-message`.
        pub fn allow_empty_message / allow_empty_message_if, allow_empty_message, "Conditionally allow creating a commit with an empty message."
    }

    /// Set an environment variable for the command.
    #[must_use]
    pub fn env(mut self, key: cmd_proc::EnvVariableName<'a>, value: &'a OsStr) -> Self {
        self.env_vars.push((key, value));
        self
    }

    /// Execute the command and return the exit status.
    pub async fn status(self) -> Result<(), CommandError> {
        crate::Build::build(self).status().await
    }
}

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

impl crate::Build for Commit<'_> {
    fn build(self) -> cmd_proc::Command {
        crate::base_command(self.repo_path)
            .argument("commit")
            .optional_option("--message", self.message)
            .optional_option("--author", self.author)
            .optional_option("--date", self.date)
            .optional_flag(self.allow_empty, "--allow-empty")
            .optional_flag(self.allow_empty_message, "--allow-empty-message")
            .optional_flag(self.porcelain, "--porcelain")
            .envs(self.env_vars)
    }
}

#[cfg(feature = "test-utils")]
impl Commit<'_> {
    /// 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,
            message: self.message,
            author: self.author,
            date: self.date,
            allow_empty: self.allow_empty,
            allow_empty_message: self.allow_empty_message,
            porcelain: self.porcelain,
            env_vars: self.env_vars.clone(),
        });
        command.test_eq(other);
    }
}