gitbox 2.1.3

Git toolbox to simplify adoption of conventional commits and semantic version, among other things.
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

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

use crate::domain::error::semantic_version_invariant_error::SemanticVersionInvariantError;

type RepositoryError = Box<dyn Error>;

#[derive(Debug)]
pub enum DescribeNewVersionError {
    StableRelease(DescribeStableReleaseError),
    Prerelease(DescribePrereleaseError),
    Metadata(DescribeMetadataError),
    SemanticVersionCreation(SemanticVersionInvariantError),
    Repository(RepositoryError),
}

impl Display for DescribeNewVersionError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "failed to describe new version: {}",
            self.source().expect("source error is always present")
        )
    }
}

impl Error for DescribeNewVersionError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::SemanticVersionCreation(err) => Some(err),
            Self::StableRelease(err) => Some(err),
            Self::Prerelease(err) => Some(err),
            Self::Metadata(err) => Some(err),
            Self::Repository(err) => Some(err.as_ref()),
        }
    }
}

impl From<DescribeStableReleaseError> for DescribeNewVersionError {
    fn from(value: DescribeStableReleaseError) -> Self {
        Self::StableRelease(value)
    }
}

impl From<DescribePrereleaseError> for DescribeNewVersionError {
    fn from(value: DescribePrereleaseError) -> Self {
        Self::Prerelease(value)
    }
}

impl From<DescribeMetadataError> for DescribeNewVersionError {
    fn from(value: DescribeMetadataError) -> Self {
        Self::Metadata(value)
    }
}

impl From<SemanticVersionInvariantError> for DescribeNewVersionError {
    fn from(value: SemanticVersionInvariantError) -> Self {
        Self::SemanticVersionCreation(value)
    }
}

impl From<RepositoryError> for DescribeNewVersionError {
    fn from(value: RepositoryError) -> Self {
        Self::Repository(value)
    }
}

#[derive(Debug)]
pub enum DescribeStableReleaseError {
    NoChanges(DescribeNoRelevantChangesError),
    RepositoryError(RepositoryError),
}

impl Display for DescribeStableReleaseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "failed to describe stable release: {}",
            self.source().expect("source error is always present")
        )
    }
}

impl Error for DescribeStableReleaseError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::NoChanges(err) => Some(err),
            Self::RepositoryError(err) => Some(err.as_ref()),
        }
    }
}

impl From<DescribeNoRelevantChangesError> for DescribeStableReleaseError {
    fn from(value: DescribeNoRelevantChangesError) -> Self {
        Self::NoChanges(value)
    }
}

impl From<Box<dyn Error>> for DescribeStableReleaseError {
    fn from(value: Box<dyn Error>) -> Self {
        Self::RepositoryError(value)
    }
}

#[derive(Debug)]
pub enum DescribePrereleaseError {
    NoChanges(DescribeNoRelevantChangesError),
    RepositoryError(RepositoryError),
}

impl Display for DescribePrereleaseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "failed to describe prerelease: {}",
            self.source().expect("source error is always present")
        )
    }
}

impl Error for DescribePrereleaseError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::NoChanges(err) => Some(err),
            Self::RepositoryError(err) => Some(err.as_ref()),
        }
    }
}

impl From<DescribeNoRelevantChangesError> for DescribePrereleaseError {
    fn from(value: DescribeNoRelevantChangesError) -> Self {
        Self::NoChanges(value)
    }
}

impl From<Box<dyn Error>> for DescribePrereleaseError {
    fn from(value: Box<dyn Error>) -> Self {
        Self::RepositoryError(value)
    }
}

#[derive(Debug)]
pub enum DescribeMetadataError {
    RepositoryError(RepositoryError),
}

impl Display for DescribeMetadataError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "failed to describe metadata: {}",
            self.source().expect("source error is always present")
        )
    }
}

impl Error for DescribeMetadataError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::RepositoryError(err) => Some(err.as_ref()),
        }
    }
}

impl From<Box<dyn Error>> for DescribeMetadataError {
    fn from(value: Box<dyn Error>) -> Self {
        Self::RepositoryError(value)
    }
}

/// The error may occur when the Describe usecase does not find relevant changes.
#[derive(Debug)]
pub struct DescribeNoRelevantChangesError {}

impl DescribeNoRelevantChangesError {
    pub fn new() -> DescribeNoRelevantChangesError {
        DescribeNoRelevantChangesError {}
    }
}

impl Display for DescribeNoRelevantChangesError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "There are no relevant changes from the last release. Use triggers if you want to proc a new version.")
    }
}

impl Error for DescribeNoRelevantChangesError {}