releasaurus-core 0.19.0

A comprehensive release automation tool that streamlines the software release process across multiple programming languages and forge platforms
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
//! Version strategy trait and implementations for calculating next versions.
//!
//! This module provides a trait-based approach to version calculation,
//! allowing different strategies for stable releases, versioned prereleases,
//! and static prereleases.

use next_version::VersionUpdater;
use semver::Version;

use crate::{
    analyzer::helpers,
    config::prerelease::{PrereleaseConfig, PrereleaseStrategy},
    forge::request::Tag,
    result::Result,
};

/// Context for version calculation containing all necessary information.
#[derive(Debug, Clone)]
pub struct VersionContext<'a> {
    /// Current version tag (None for first release)
    pub current_tag: Option<&'a Tag>,
    /// Commit messages to analyze
    pub commits: &'a [String],
    /// Whether breaking changes should always increment major version
    pub breaking_always_increment_major: bool,
    /// Whether features should always increment minor version
    pub features_always_increment_minor: bool,
    /// Custom regex for major version increments
    pub custom_major_increment_regex: Option<&'a str>,
    /// Custom regex for minor version increments
    pub custom_minor_increment_regex: Option<&'a str>,
}

impl<'a> VersionContext<'a> {
    /// Create a VersionUpdater configured with the context's settings.
    pub fn create_version_updater(&self) -> Result<VersionUpdater> {
        let mut version_updater = VersionUpdater::new()
            .with_breaking_always_increment_major(
                self.breaking_always_increment_major,
            )
            .with_features_always_increment_minor(
                self.features_always_increment_minor,
            );

        if let Some(regex) = self.custom_major_increment_regex {
            version_updater =
                version_updater.with_custom_major_increment_regex(regex)?;
        }

        if let Some(regex) = self.custom_minor_increment_regex {
            version_updater =
                version_updater.with_custom_minor_increment_regex(regex)?;
        }

        Ok(version_updater)
    }
}

/// Trait for calculating the next version based on commits and current state.
pub trait VersionStrategy {
    /// Calculate the next version given the current context.
    fn calculate_next_version(
        &self,
        context: &VersionContext,
    ) -> Result<Version>;
}

/// Strategy for stable (non-prerelease) versions.
#[derive(Default)]
pub struct StableVersionStrategy;

impl VersionStrategy for StableVersionStrategy {
    fn calculate_next_version(
        &self,
        context: &VersionContext,
    ) -> Result<Version> {
        if let Some(current) = context.current_tag {
            if current.semver.pre.is_empty() {
                // Normal stable version bump
                log::debug!(
                    "stable version strategy: performing standard version update"
                );
                let version_updater = context.create_version_updater()?;
                Ok(version_updater
                    .increment(&current.semver, context.commits.to_vec()))
            } else {
                // Graduate from prerelease to stable
                log::info!(
                    "stable version strategy: graduating prerelease {} to stable",
                    current.semver
                );
                Ok(helpers::graduate_prerelease(&current.semver))
            }
        } else {
            // First release
            log::debug!("stable version strategy: first release");
            Ok(Version::parse("0.1.0")?)
        }
    }
}

/// Strategy for versioned prerelease versions (e.g., alpha.1, alpha.2).
pub struct VersionedPrereleaseStrategy {
    identifier: String,
}

impl VersionedPrereleaseStrategy {
    /// Create a new versioned prerelease strategy with the given identifier.
    pub fn new(identifier: String) -> Self {
        Self { identifier }
    }
}

impl VersionStrategy for VersionedPrereleaseStrategy {
    fn calculate_next_version(
        &self,
        context: &VersionContext,
    ) -> Result<Version> {
        if let Some(current) = context.current_tag {
            if current.semver.pre.is_empty() {
                // Starting new prerelease from stable
                log::info!(
                    "versioned prerelease strategy: starting new prerelease from stable {}",
                    current.semver
                );
                let version_updater = context.create_version_updater()?;
                let next_stable = version_updater
                    .increment(&current.semver, context.commits.to_vec());
                helpers::add_prerelease(
                    next_stable,
                    &self.identifier,
                    PrereleaseStrategy::Versioned,
                )
            } else {
                // Currently in a prerelease
                let current_pre_id =
                    current.semver.pre.as_str().split('.').next().unwrap_or("");

                if current_pre_id == self.identifier {
                    // Same prerelease identifier - increment it
                    log::info!(
                        "versioned prerelease strategy: incrementing prerelease {}",
                        current.semver
                    );
                    let version_updater = context.create_version_updater()?;
                    Ok(version_updater
                        .increment(&current.semver, context.commits.to_vec()))
                } else {
                    // Different prerelease identifier - switch to new one
                    log::info!(
                        "versioned prerelease strategy: switching from {} to {}",
                        current_pre_id,
                        self.identifier
                    );
                    let stable_current =
                        helpers::graduate_prerelease(&current.semver);
                    let version_updater = context.create_version_updater()?;
                    let stable_next = version_updater
                        .increment(&stable_current, context.commits.to_vec());
                    helpers::add_prerelease(
                        stable_next,
                        &self.identifier,
                        PrereleaseStrategy::Versioned,
                    )
                }
            }
        } else {
            // First release as prerelease
            log::info!(
                "versioned prerelease strategy: first release as prerelease"
            );
            let version = Version::parse("0.1.0")?;
            helpers::add_prerelease(
                version,
                &self.identifier,
                PrereleaseStrategy::Versioned,
            )
        }
    }
}

/// Strategy for static prerelease versions (e.g., SNAPSHOT, dev).
pub struct StaticPrereleaseStrategy {
    identifier: String,
}

impl StaticPrereleaseStrategy {
    /// Create a new static prerelease strategy with the given identifier.
    pub fn new(identifier: String) -> Self {
        Self { identifier }
    }
}

impl VersionStrategy for StaticPrereleaseStrategy {
    fn calculate_next_version(
        &self,
        context: &VersionContext,
    ) -> Result<Version> {
        if let Some(current) = context.current_tag {
            if current.semver.pre.is_empty() {
                // Starting new prerelease from stable
                log::info!(
                    "static prerelease strategy: starting new prerelease from stable {}",
                    current.semver
                );
                let version_updater = context.create_version_updater()?;
                let next_stable = version_updater
                    .increment(&current.semver, context.commits.to_vec());
                helpers::add_prerelease(
                    next_stable,
                    &self.identifier,
                    PrereleaseStrategy::Static,
                )
            } else {
                // Currently in a prerelease
                let current_pre_id =
                    current.semver.pre.as_str().split('.').next().unwrap_or("");

                if current_pre_id == self.identifier {
                    // Same static identifier - increment version and re-add suffix
                    log::info!(
                        "static prerelease strategy: incrementing prerelease {}",
                        current.semver
                    );
                    let mut version =
                        helpers::graduate_prerelease(&current.semver);
                    let version_updater = context.create_version_updater()?;
                    version = version_updater
                        .increment(&version, context.commits.to_vec());
                    helpers::add_prerelease(
                        version,
                        &self.identifier,
                        PrereleaseStrategy::Static,
                    )
                } else {
                    // Different prerelease identifier - switch to new one
                    log::info!(
                        "static prerelease strategy: switching from {} to {}",
                        current_pre_id,
                        self.identifier
                    );
                    let stable_current =
                        helpers::graduate_prerelease(&current.semver);
                    let version_updater = context.create_version_updater()?;
                    let stable_next = version_updater
                        .increment(&stable_current, context.commits.to_vec());
                    helpers::add_prerelease(
                        stable_next,
                        &self.identifier,
                        PrereleaseStrategy::Static,
                    )
                }
            }
        } else {
            // First release as prerelease
            log::info!(
                "static prerelease strategy: first release as prerelease"
            );
            let version = Version::parse("0.1.0")?;
            helpers::add_prerelease(
                version,
                &self.identifier,
                PrereleaseStrategy::Static,
            )
        }
    }
}

/// Factory for creating version strategies based on configuration.
pub struct VersionStrategyFactory;

impl VersionStrategyFactory {
    /// Create a version strategy based on the provided prerelease configuration.
    pub fn create(
        prerelease: Option<&PrereleaseConfig>,
    ) -> Result<Box<dyn VersionStrategy>> {
        if let Some(config) = prerelease {
            let identifier = config.suffix()?.to_string();

            match config.strategy {
                PrereleaseStrategy::Versioned => {
                    Ok(Box::new(VersionedPrereleaseStrategy::new(identifier)))
                }
                PrereleaseStrategy::Static => {
                    Ok(Box::new(StaticPrereleaseStrategy::new(identifier)))
                }
            }
        } else {
            Ok(Box::new(StableVersionStrategy))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn create_test_tag(version: &str) -> Tag {
        Tag {
            name: version.to_string(),
            semver: Version::parse(version).unwrap(),
            sha: "abc123".to_string(),
            timestamp: None,
        }
    }

    fn create_basic_context<'a>(
        current_tag: Option<&'a Tag>,
        commits: &'a [String],
    ) -> VersionContext<'a> {
        VersionContext {
            current_tag,
            commits,
            breaking_always_increment_major: true,
            features_always_increment_minor: true,
            custom_major_increment_regex: None,
            custom_minor_increment_regex: None,
        }
    }

    #[test]
    fn test_stable_strategy_first_release() {
        let strategy = StableVersionStrategy;
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0").unwrap());
    }

    #[test]
    fn test_stable_strategy_increment_patch() {
        let strategy = StableVersionStrategy;
        let tag = create_test_tag("1.0.0");
        let commits = vec!["fix: bug fix".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.0.1").unwrap());
    }

    #[test]
    fn test_stable_strategy_graduate_prerelease() {
        let strategy = StableVersionStrategy;
        let tag = create_test_tag("1.0.0-alpha.1");
        let commits = vec![];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.0.0").unwrap());
    }

    #[test]
    fn test_versioned_prerelease_first_release() {
        let strategy = VersionedPrereleaseStrategy::new("alpha".to_string());
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0-alpha.1").unwrap());
    }

    #[test]
    fn test_versioned_prerelease_from_stable() {
        let strategy = VersionedPrereleaseStrategy::new("alpha".to_string());
        let tag = create_test_tag("1.0.0");
        let commits = vec!["feat: new feature".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.1.0-alpha.1").unwrap());
    }

    #[test]
    fn test_versioned_prerelease_increment() {
        let strategy = VersionedPrereleaseStrategy::new("alpha".to_string());
        let tag = create_test_tag("1.0.0-alpha.1");
        let commits = vec!["fix: bug fix".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.0.0-alpha.2").unwrap());
    }

    #[test]
    fn test_versioned_prerelease_switch_identifier() {
        let strategy = VersionedPrereleaseStrategy::new("beta".to_string());
        let tag = create_test_tag("1.0.0-alpha.3");
        let commits = vec!["feat: new feature".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.1.0-beta.1").unwrap());
    }

    #[test]
    fn test_static_prerelease_first_release() {
        let strategy = StaticPrereleaseStrategy::new("SNAPSHOT".to_string());
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0-SNAPSHOT").unwrap());
    }

    #[test]
    fn test_static_prerelease_from_stable() {
        let strategy = StaticPrereleaseStrategy::new("dev".to_string());
        let tag = create_test_tag("1.0.0");
        let commits = vec!["feat: new feature".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.1.0-dev").unwrap());
    }

    #[test]
    fn test_static_prerelease_increment() {
        let strategy = StaticPrereleaseStrategy::new("SNAPSHOT".to_string());
        let tag = create_test_tag("1.0.0-SNAPSHOT");
        let commits = vec!["fix: bug fix".to_string()];
        let context = create_basic_context(Some(&tag), &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("1.0.1-SNAPSHOT").unwrap());
    }

    #[test]
    fn test_factory_creates_stable_strategy() {
        let strategy = VersionStrategyFactory::create(None).unwrap();
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0").unwrap());
    }

    #[test]
    fn test_factory_creates_versioned_prerelease_strategy() {
        let config = PrereleaseConfig {
            suffix: Some("alpha".to_string()),
            strategy: PrereleaseStrategy::Versioned,
        };
        let strategy = VersionStrategyFactory::create(Some(&config)).unwrap();
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0-alpha.1").unwrap());
    }

    #[test]
    fn test_factory_creates_static_prerelease_strategy() {
        let config = PrereleaseConfig {
            suffix: Some("SNAPSHOT".to_string()),
            strategy: PrereleaseStrategy::Static,
        };
        let strategy = VersionStrategyFactory::create(Some(&config)).unwrap();
        let commits = vec![];
        let context = create_basic_context(None, &commits);

        let result = strategy.calculate_next_version(&context).unwrap();
        assert_eq!(result, Version::parse("0.1.0-SNAPSHOT").unwrap());
    }
}