git-disjoint 0.11.8

A tool to batch commits by issue into GitHub PRs
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

use std::{error::Error, fmt::Display};

use git2::Commit;

use crate::issue::Issue;

#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub(crate) struct GitCommitSummary(pub String);

impl Display for GitCommitSummary {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

#[derive(Debug)]
#[non_exhaustive]
pub(crate) struct FromCommitError {
    commit: git2::Oid,
    kind: FromCommitErrorKind,
}

impl Display for FromCommitError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match &self.kind {
            FromCommitErrorKind::InvalidUtf8 => {
                write!(f, "summary for commit {:?} is not valid UTF-8", self.commit)
            }
        }
    }
}

impl Error for FromCommitError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match &self.kind {
            FromCommitErrorKind::InvalidUtf8 => None,
        }
    }
}

#[derive(Debug)]
pub(crate) enum FromCommitErrorKind {
    #[non_exhaustive]
    InvalidUtf8,
}

impl TryFrom<&Commit<'_>> for GitCommitSummary {
    type Error = FromCommitError;

    fn try_from(commit: &Commit) -> Result<Self, Self::Error> {
        Ok(Self(
            commit
                .summary()
                .ok_or(FromCommitError {
                    commit: commit.id(),
                    kind: FromCommitErrorKind::InvalidUtf8,
                })?
                .to_owned(),
        ))
    }
}

#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub(crate) enum IssueGroup {
    Issue(Issue),
    Commit(GitCommitSummary),
}

impl Display for IssueGroup {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            IssueGroup::Issue(issue) => write!(f, "{issue}"),
            IssueGroup::Commit(commit) => write!(f, "{commit}"),
        }
    }
}

impl From<GitCommitSummary> for IssueGroup {
    fn from(value: GitCommitSummary) -> Self {
        Self::Commit(value)
    }
}

impl From<Issue> for IssueGroup {
    fn from(value: Issue) -> Self {
        Self::Issue(value)
    }
}

#[cfg(test)]
mod test_display {
    use crate::{issue::Issue, issue_group::GitCommitSummary};

    use super::IssueGroup;

    fn check<I: Into<IssueGroup>>(issue_group: I, displays_as: &str) {
        assert_eq!(displays_as, format!("{}", issue_group.into()));
    }

    #[test]
    fn display_human_readable_issue() {
        check(Issue::Jira("COOL-123".to_string()), "Jira COOL-123");
    }

    #[test]
    fn display_human_readable_commit() {
        check(
            GitCommitSummary(String::from("this is a cool summary")),
            "this is a cool summary",
        );
    }
}