semver-common 1.2.3

Common library to use for semantic release core and plugins.
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

use crate::Commit;
use derive_getters::Getters;
use serde::{Deserialize, Serialize};
use std::fmt::Display;

/// A container for a kind of change pattern that represents a commit that matches said pattern,
/// as well as a vector of Commit objects that match the pattern for that kind of change.
#[derive(Serialize, Deserialize, Debug, Getters, Clone)]
pub struct CommitBucket {
    priority: u32,
    kind: String,
    commits: Vec<Commit>,
}

impl Ord for CommitBucket {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        if self.priority > other.priority {
            return std::cmp::Ordering::Greater;
        } else if self.priority < other.priority {
            return std::cmp::Ordering::Less;
        }
        std::cmp::Ordering::Equal
    }
}

impl Eq for CommitBucket {}

impl PartialOrd for CommitBucket {
    fn ge(&self, other: &Self) -> bool {
        self.priority >= other.priority
    }

    fn gt(&self, other: &Self) -> bool {
        self.priority > other.priority
    }

    fn le(&self, other: &Self) -> bool {
        self.priority <= other.priority
    }

    fn lt(&self, other: &Self) -> bool {
        self.priority < other.priority
    }

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

impl PartialEq for CommitBucket {
    fn eq(&self, other: &Self) -> bool {
        if self.commits.len() != other.commits.len() || self.kind != other.kind {
            return false;
        }
        for i in 0..self.commits.len() {
            if self.commits[i] != other.commits[i] {
                return false;
            }
        }
        true
    }
}

impl Display for CommitBucket {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        writeln!(f, "## {}\n", self.kind)?;
        let mut commits = self.commits.clone();
        commits.sort();
        for commit in commits.iter() {
            write!(f, "- {}", commit)?;
        }
        Ok(())
    }
}

impl CommitBucket {
    pub fn new(kind: &str, priority: u32) -> Self {
        CommitBucket {
            priority,
            kind: String::from(kind),
            commits: vec![],
        }
    }

    pub fn add(&mut self, commit: Commit) {
        self.commits.push(commit);
    }
}

#[cfg(test)]
mod test {
    use crate::mock;

    use super::*;

    #[test]
    fn test_commitbucket_add() {
        let mut bucket = CommitBucket::new("Feature", 1);
        let commit_one = mock::commit::create("feat: this is a test one");
        let commit_two = mock::commit::create("feat: this is a test two");
        bucket.add(commit_one);
        bucket.add(commit_two);

        assert_eq!(bucket.kind(), "Feature");
        assert_eq!(bucket.commits()[0].message(), "feat: this is a test one");
        assert_eq!(bucket.commits()[1].message(), "feat: this is a test two");
    }

    #[test]
    fn test_commitbucket_fmt() {
        let mut bucket = CommitBucket::new("Feature", 1);
        let commit_one = mock::commit::create("feat: this is a test one");
        let commit_two = mock::commit::create("feat: this is a test two");
        bucket.add(commit_one);
        bucket.add(commit_two);

        let displayed = format!("{}", bucket);
        assert_eq!(
            &displayed,
            "## Feature\n\n- feat: this is a test one\n- feat: this is a test two\n"
        );
    }
}