overcast 0.1.3

Strongly typed changelogs for projects as changeable as the weather
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

use crate::release::Release;
use std::collections::BTreeMap;

/// Contains the entire changelog structure
#[derive(Debug, Clone, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Changelog {
    pub(crate) title: String,
    pub(crate) description: Option<String>,
    releases: BTreeMap<Option<semver::Version>, Release>,
    pub(crate) keep_a_changelog_message: bool,
    pub(crate) semantic_versioning_message: bool,
}

impl Changelog {
    /// Create a new changelog with specified title
    pub fn new(title: impl ToString) -> Self {
        Self {
            title: title.to_string(),
            description: None,
            releases: Default::default(),
            keep_a_changelog_message: false,
            semantic_versioning_message: false,
        }
    }

    /// Set the changelog's description field
    pub fn with_description(self, description: impl ToString) -> Self {
        Self {
            description: Some(description.to_string()),
            ..self
        }
    }

    /// Add to the changelog's releases field
    pub fn add_release(self, release: Release) -> Self {
        let mut releases = self.releases;
        releases.insert(release.version.clone(), release);

        Self { releases, ..self }
    }

    /// Add the keep a changelog message to the top of human oriented renderings
    pub fn add_keep_a_changelog_message(self) -> Self {
        Self {
            keep_a_changelog_message: true,
            ..self
        }
    }

    /// Add the keep a semantic versioning message to the top of human oriented renderings
    pub fn add_semantic_versioning_message(self) -> Self {
        Self {
            semantic_versioning_message: true,
            ..self
        }
    }

    /// Return an iterator of all releases in the changelog sorted by their `version` field
    pub fn releases(&self) -> impl Iterator<Item = &Release> {
        self.releases.values()
    }

    /// Return a sorted iterator of all version numbers in the changelog. This doesn't include
    /// unreleased as a version number
    pub fn versions(&self) -> impl Iterator<Item = &semver::Version> {
        self.releases.keys().filter_map(|v| v.as_ref())
    }
}

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

    #[test]
    fn ensure_releases_are_sorted_by_version_number() {
        let changelog = Changelog::new("")
            .add_release(Release::new(0, 2, 0))
            .add_release(Release::new(0, 1, 0))
            .add_release(Release::new(0, 1, 1))
            .add_release(Release::unreleased())
            .add_release(Release::new(0, 2, 1))
            .add_release(Release::new(0, 1, 2));

        assert_eq!(
            changelog
                .releases()
                .map(|v| v.version.clone())
                .collect::<Vec<_>>(),
            vec![
                None,
                Some(semver::Version::new(0, 1, 0)),
                Some(semver::Version::new(0, 1, 1)),
                Some(semver::Version::new(0, 1, 2)),
                Some(semver::Version::new(0, 2, 0)),
                Some(semver::Version::new(0, 2, 1)),
            ]
        );

        assert_eq!(
            changelog.versions().cloned().collect::<Vec<_>>(),
            vec![
                semver::Version::new(0, 1, 0),
                semver::Version::new(0, 1, 1),
                semver::Version::new(0, 1, 2),
                semver::Version::new(0, 2, 0),
                semver::Version::new(0, 2, 1),
            ]
        );
    }
}