nextsv 0.19.30

Next semantic version calculator
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

use crate::version::Semantic;

use super::bump::Bump;
#[allow(unused_imports)]
use super::CalculatorConfig; // import used by documentation
use clap::{Parser, ValueEnum};
use std::{cmp, fmt};

/// This enum is used by [`CalculatorConfig::set_force_bump`] to override the bump
/// that would be calculated from conventional commits.
///
/// ## Variants
///
/// Variants are valid depending on the current version type.
///
/// |  Variant  | Non Prod. |  Pre Rel. |  Prod. |          Description             |
/// | ----------|-----------|-----------|--------|----------------------------------|
/// | `Major`   |     X     |           |    X   | Bump the major component         |
/// | `Minor`   |     X     |           |    X   | Bump the minor component         |
/// | `Patch`   |     X     |           |    X   | Bump the patch component         |
/// | `First`   |     X     |           |        | Set the version 1.0.0            |
/// | `Release` |           |     X     |        | Remove the pre-release           |
/// | `Rc`      |     X     |     X     |    X   | Bump or create rc pre-release    |
/// | `Beta`    |     X     |     X     |    X   | Bump or create beta pre-release  |
/// | `Alpha`   |     X     |     X     |    X   | Bump or create alpha pre-release |
///
///  Where it is not valid the bump is forced to [`None`].
#[derive(Debug, PartialEq, Eq, Clone, ValueEnum, Parser)]
pub enum ForceBump {
    /// Bump the major version component.
    Major,
    /// Bump the major version component.
    Minor,
    /// Bump the major version component.
    Patch,
    /// Release first production (1.0.0) version.
    First,
    /// Remove the pre-release version component if present.
    Release,
    /// Bump or create the rc pre-release version component.
    Rc,
    /// Bump or create the beta pre-release version component.
    Beta,
    /// Bump or create the alpha pre-release version component.
    Alpha,
}

use crate::version::VersionType;

impl ForceBump {
    /// Returns the bump type that should be used to calculate the next version.
    pub(crate) fn to_bump(&self, version_number: &Semantic) -> Bump {
        log::debug!(
            "ForceBump::to_bump({:?}) with version `{:?}`",
            self,
            version_number.version_type()
        );
        match version_number.version_type() {
            VersionType::NonProduction => match self {
                ForceBump::Major => Bump::Major,
                ForceBump::Minor => Bump::Minor,
                ForceBump::Patch => Bump::Patch,
                ForceBump::First => Bump::First,
                ForceBump::Release => Bump::None,
                ForceBump::Rc => Bump::Rc,
                ForceBump::Beta => Bump::Beta,
                ForceBump::Alpha => Bump::Alpha,
            },
            VersionType::PreRelease => match self {
                ForceBump::Major => Bump::None,
                ForceBump::Minor => Bump::None,
                ForceBump::Patch => Bump::None,
                ForceBump::First => {
                    if version_number.is_production_version() {
                        Bump::None
                    } else {
                        Bump::First
                    }
                }
                ForceBump::Release => Bump::Release,
                ForceBump::Rc => Bump::Rc,
                ForceBump::Beta => Bump::Beta,
                ForceBump::Alpha => Bump::Alpha,
            },
            VersionType::Production => match self {
                ForceBump::Major => Bump::Major,
                ForceBump::Minor => Bump::Minor,
                ForceBump::Patch => Bump::Patch,
                ForceBump::First => Bump::None,
                ForceBump::Release => Bump::None,
                ForceBump::Rc => Bump::Rc,
                ForceBump::Beta => Bump::Beta,
                ForceBump::Alpha => Bump::Alpha,
            },
        }
    }
}

impl fmt::Display for ForceBump {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ForceBump::Major => write!(f, "major"),
            ForceBump::Minor => write!(f, "minor"),
            ForceBump::Patch => write!(f, "patch"),
            ForceBump::First => write!(f, "1.0.0"),
            ForceBump::Alpha => write!(f, "alpha"),
            ForceBump::Beta => write!(f, "beta"),
            ForceBump::Rc => write!(f, "rc"),
            ForceBump::Release => write!(f, "release"),
        }
    }
}

impl Ord for ForceBump {
    fn cmp(&self, other: &Self) -> cmp::Ordering {
        match (self, other) {
            (ForceBump::Major, ForceBump::Major)
            | (ForceBump::Minor, ForceBump::Minor)
            | (ForceBump::Patch, ForceBump::Patch)
            | (ForceBump::First, ForceBump::First)
            | (ForceBump::Release, ForceBump::Release)
            | (ForceBump::Rc, ForceBump::Rc)
            | (ForceBump::Beta, ForceBump::Beta)
            | (ForceBump::Alpha, ForceBump::Alpha) => cmp::Ordering::Equal,
            (ForceBump::Major, _) => cmp::Ordering::Greater,
            (ForceBump::Alpha, _) => cmp::Ordering::Less,
            (ForceBump::Minor, ForceBump::Major) => cmp::Ordering::Less,
            (ForceBump::Minor, ForceBump::Patch)
            | (ForceBump::Minor, ForceBump::First)
            | (ForceBump::Minor, ForceBump::Release)
            | (ForceBump::Minor, ForceBump::Rc)
            | (ForceBump::Minor, ForceBump::Beta)
            | (ForceBump::Minor, ForceBump::Alpha) => cmp::Ordering::Greater,
            (ForceBump::Patch, ForceBump::Major) | (ForceBump::Patch, ForceBump::Minor) => {
                cmp::Ordering::Less
            }
            (ForceBump::Patch, ForceBump::First)
            | (ForceBump::Patch, ForceBump::Release)
            | (ForceBump::Patch, ForceBump::Rc)
            | (ForceBump::Patch, ForceBump::Beta)
            | (ForceBump::Patch, ForceBump::Alpha) => cmp::Ordering::Greater,
            (ForceBump::First, ForceBump::Major)
            | (ForceBump::First, ForceBump::Minor)
            | (ForceBump::First, ForceBump::Patch) => cmp::Ordering::Less,
            (ForceBump::First, ForceBump::Release)
            | (ForceBump::First, ForceBump::Rc)
            | (ForceBump::First, ForceBump::Beta)
            | (ForceBump::First, ForceBump::Alpha) => cmp::Ordering::Greater,
            (ForceBump::Release, ForceBump::Major)
            | (ForceBump::Release, ForceBump::Minor)
            | (ForceBump::Release, ForceBump::Patch)
            | (ForceBump::Release, ForceBump::First) => cmp::Ordering::Less,
            (ForceBump::Release, ForceBump::Rc)
            | (ForceBump::Release, ForceBump::Beta)
            | (ForceBump::Release, ForceBump::Alpha) => cmp::Ordering::Greater,
            (ForceBump::Rc, ForceBump::Major)
            | (ForceBump::Rc, ForceBump::Minor)
            | (ForceBump::Rc, ForceBump::Patch)
            | (ForceBump::Rc, ForceBump::First)
            | (ForceBump::Rc, ForceBump::Release) => cmp::Ordering::Less,
            (ForceBump::Rc, ForceBump::Beta) | (ForceBump::Rc, ForceBump::Alpha) => {
                cmp::Ordering::Greater
            }
            (ForceBump::Beta, ForceBump::Major)
            | (ForceBump::Beta, ForceBump::Minor)
            | (ForceBump::Beta, ForceBump::Patch)
            | (ForceBump::Beta, ForceBump::First)
            | (ForceBump::Beta, ForceBump::Release) => cmp::Ordering::Less,
            (ForceBump::Beta, ForceBump::Rc) => cmp::Ordering::Less,
            (ForceBump::Beta, ForceBump::Alpha) => cmp::Ordering::Greater,
        }
    }
}

impl PartialOrd for ForceBump {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        Some(self.cmp(other))
    }
}

#[cfg(test)]
mod test {

    use std::cmp;

    use super::ForceBump;
    use rstest::rstest;

    #[rstest]
    #[case::patch(ForceBump::Patch, "patch")]
    #[case::minor(ForceBump::Minor, "minor")]
    #[case::major(ForceBump::Major, "major")]
    #[case::release(ForceBump::Release, "release")]
    #[case::alpha(ForceBump::Alpha, "alpha")]
    #[case::beta(ForceBump::Beta, "beta")]
    #[case::rc(ForceBump::Rc, "rc")]
    #[case::first(ForceBump::First, "1.0.0")]
    fn display_value(#[case] test: ForceBump, #[case] expected: &str) {
        assert_eq!(expected, test.to_string().as_str());
    }

    #[rstest]
    #[case::major(ForceBump::Major, ForceBump::Major, cmp::Ordering::Equal)]
    #[case::minor(ForceBump::Minor, ForceBump::Minor, cmp::Ordering::Equal)]
    #[case::patch(ForceBump::Patch, ForceBump::Patch, cmp::Ordering::Equal)]
    #[case::first(ForceBump::First, ForceBump::First, cmp::Ordering::Equal)]
    #[case::release(ForceBump::Release, ForceBump::Release, cmp::Ordering::Equal)]
    #[case::rc(ForceBump::Rc, ForceBump::Rc, cmp::Ordering::Equal)]
    #[case::beta(ForceBump::Beta, ForceBump::Beta, cmp::Ordering::Equal)]
    #[case::alpha(ForceBump::Alpha, ForceBump::Alpha, cmp::Ordering::Equal)]
    #[case::major_minor(ForceBump::Major, ForceBump::Minor, cmp::Ordering::Greater)]
    #[case::minor_major(ForceBump::Minor, ForceBump::Major, cmp::Ordering::Less)]
    #[case::minor_patch(ForceBump::Minor, ForceBump::Patch, cmp::Ordering::Greater)]
    #[case::minor_first(ForceBump::Minor, ForceBump::First, cmp::Ordering::Greater)]
    #[case::minor_release(ForceBump::Minor, ForceBump::Release, cmp::Ordering::Greater)]
    #[case::minor_rc(ForceBump::Minor, ForceBump::Rc, cmp::Ordering::Greater)]
    #[case::minor_beta(ForceBump::Minor, ForceBump::Beta, cmp::Ordering::Greater)]
    #[case::minor_alpha(ForceBump::Minor, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::patch_major(ForceBump::Patch, ForceBump::Major, cmp::Ordering::Less)]
    #[case::patch_minor(ForceBump::Patch, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::patch_first(ForceBump::Patch, ForceBump::First, cmp::Ordering::Greater)]
    #[case::patch_release(ForceBump::Patch, ForceBump::Release, cmp::Ordering::Greater)]
    #[case::patch_rc(ForceBump::Patch, ForceBump::Rc, cmp::Ordering::Greater)]
    #[case::patch_beta(ForceBump::Patch, ForceBump::Beta, cmp::Ordering::Greater)]
    #[case::patch_alpha(ForceBump::Patch, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::first_major(ForceBump::First, ForceBump::Major, cmp::Ordering::Less)]
    #[case::first_minor(ForceBump::First, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::first_patch(ForceBump::First, ForceBump::Patch, cmp::Ordering::Less)]
    #[case::first_release(ForceBump::First, ForceBump::Release, cmp::Ordering::Greater)]
    #[case::first_rc(ForceBump::First, ForceBump::Rc, cmp::Ordering::Greater)]
    #[case::first_beta(ForceBump::First, ForceBump::Beta, cmp::Ordering::Greater)]
    #[case::first_alpha(ForceBump::First, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::release_major(ForceBump::Release, ForceBump::Major, cmp::Ordering::Less)]
    #[case::release_minor(ForceBump::Release, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::release_patch(ForceBump::Release, ForceBump::Patch, cmp::Ordering::Less)]
    #[case::release_first(ForceBump::Release, ForceBump::First, cmp::Ordering::Less)]
    #[case::release_rc(ForceBump::Release, ForceBump::Rc, cmp::Ordering::Greater)]
    #[case::release_beta(ForceBump::Release, ForceBump::Beta, cmp::Ordering::Greater)]
    #[case::release_alpha(ForceBump::Release, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::rc_major(ForceBump::Rc, ForceBump::Major, cmp::Ordering::Less)]
    #[case::rc_minor(ForceBump::Rc, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::rc_patch(ForceBump::Rc, ForceBump::Patch, cmp::Ordering::Less)]
    #[case::rc_first(ForceBump::Rc, ForceBump::First, cmp::Ordering::Less)]
    #[case::rc_release(ForceBump::Rc, ForceBump::Release, cmp::Ordering::Less)]
    #[case::rc_beta(ForceBump::Rc, ForceBump::Beta, cmp::Ordering::Greater)]
    #[case::rc_alpha(ForceBump::Rc, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::beta_major(ForceBump::Beta, ForceBump::Major, cmp::Ordering::Less)]
    #[case::beta_minor(ForceBump::Beta, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::beta_patch(ForceBump::Beta, ForceBump::Patch, cmp::Ordering::Less)]
    #[case::beta_first(ForceBump::Beta, ForceBump::First, cmp::Ordering::Less)]
    #[case::beta_release(ForceBump::Beta, ForceBump::Release, cmp::Ordering::Less)]
    #[case::beta_rc(ForceBump::Beta, ForceBump::Rc, cmp::Ordering::Less)]
    #[case::beta_alpha(ForceBump::Beta, ForceBump::Alpha, cmp::Ordering::Greater)]
    #[case::alpha_major(ForceBump::Alpha, ForceBump::Major, cmp::Ordering::Less)]
    #[case::alpha_minor(ForceBump::Alpha, ForceBump::Minor, cmp::Ordering::Less)]
    #[case::alpha_patch(ForceBump::Alpha, ForceBump::Patch, cmp::Ordering::Less)]
    #[case::alpha_first(ForceBump::Alpha, ForceBump::First, cmp::Ordering::Less)]
    #[case::alpha_release(ForceBump::Alpha, ForceBump::Release, cmp::Ordering::Less)]
    #[case::alpha_rc(ForceBump::Alpha, ForceBump::Rc, cmp::Ordering::Less)]
    #[case::alpha_beta(ForceBump::Alpha, ForceBump::Beta, cmp::Ordering::Less)]
    fn test_cmp(#[case] a: ForceBump, #[case] b: ForceBump, #[case] expected: cmp::Ordering) {
        assert_eq!(expected, a.cmp(&b));
    }
}