pyrls 0.1.0

A single-binary release automation tool for Python projects
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

use std::str::FromStr;

use thiserror::Error;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ConventionalCommit {
    pub commit_type: String,
    pub description: String,
    pub breaking: bool,
}

impl FromStr for ConventionalCommit {
    type Err = ConventionalCommitError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        let (head, description) = value
            .split_once(':')
            .ok_or(ConventionalCommitError::Delimiter)?;
        let description = description.trim();
        if description.is_empty() {
            return Err(ConventionalCommitError::Description);
        }

        let breaking = head.ends_with('!');
        let commit_type = head
            .trim_end_matches('!')
            .split_once('(')
            .map(|(ty, _)| ty)
            .unwrap_or(head.trim_end_matches('!'))
            .trim();
        if commit_type.is_empty() {
            return Err(ConventionalCommitError::Type);
        }

        Ok(Self {
            commit_type: commit_type.to_string(),
            description: description.to_string(),
            breaking,
        })
    }
}

impl ConventionalCommit {
    pub fn parse_message(message: &str) -> Result<Self, ConventionalCommitError> {
        let mut lines = message.lines();
        let subject = lines
            .next()
            .map(str::trim)
            .filter(|line| !line.is_empty())
            .ok_or(ConventionalCommitError::Description)?;
        let mut commit = Self::from_str(subject)?;

        for line in lines {
            let line = line.trim();
            if line.starts_with("BREAKING CHANGE:") || line.starts_with("BREAKING-CHANGE:") {
                commit.breaking = true;
                break;
            }
        }

        Ok(commit)
    }
}

#[derive(Debug, Error)]
pub enum ConventionalCommitError {
    #[error("commit message must contain ':' delimiter")]
    Delimiter,
    #[error("commit type is missing")]
    Type,
    #[error("commit description is missing")]
    Description,
}

#[cfg(test)]
mod tests {
    use std::str::FromStr;

    use super::ConventionalCommit;

    #[test]
    fn parses_breaking_commit() {
        let commit = ConventionalCommit::from_str("feat!: break api").expect("should parse");
        assert_eq!(commit.commit_type, "feat");
        assert!(commit.breaking);
    }

    #[test]
    fn parses_scope_and_footer_breaking_change() {
        let commit = ConventionalCommit::parse_message(
            "feat(api): add endpoint\n\nBREAKING CHANGE: removed old endpoint",
        )
        .expect("should parse");
        assert_eq!(commit.commit_type, "feat");
        assert!(commit.breaking);
    }
}