clog 0.11.0

A conventional changelog for the rest of us
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

use std::str::FromStr;

use strum::{Display, EnumString};

/// Determines the hyperlink style used in commit and issue links. Defaults to
/// `LinksStyle::Github`
///
/// # Example
///
/// ```no_run
/// # use clog::{LinkStyle, Clog};
/// let clog = Clog::new().unwrap();
/// clog.link_style(LinkStyle::Stash);
/// ```
#[derive(Debug, Copy, Clone, PartialEq, Eq, Default, Display, EnumString)]
#[strum(ascii_case_insensitive)]
pub enum LinkStyle {
    #[default]
    Github,
    Gitlab,
    Stash,
    Cgit,
}

impl<'de> serde::de::Deserialize<'de> for LinkStyle {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::de::Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        FromStr::from_str(&s).map_err(serde::de::Error::custom)
    }
}

impl LinkStyle {
    /// Gets a hyperlink url to an issue in the specified format.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use clog::{LinkStyle, Clog};
    /// let link = LinkStyle::Github;
    /// let issue = link.issue_link("141", Some("https://github.com/thoughtram/clog"));
    ///
    /// assert_eq!("https://github.com/thoughtram/clog/issues/141", issue);
    /// ```
    pub fn issue_link<S: AsRef<str>>(&self, issue: S, repo: Option<S>) -> String {
        let issue = issue.as_ref();
        if let Some(link) = repo {
            let link = link.as_ref();
            match *self {
                LinkStyle::Github | LinkStyle::Gitlab => format!("{link}/issues/{issue}"),
                // cgit does not support issues
                LinkStyle::Stash | LinkStyle::Cgit => issue.to_string(),
            }
        } else {
            issue.to_string()
        }
    }

    /// Gets a hyperlink url to a commit in the specified format.
    ///
    /// # Example
    /// ```no_run
    /// # use clog::{LinkStyle, Clog};
    /// let link = LinkStyle::Github;
    /// let commit = link.commit_link(
    ///     "123abc891234567890abcdefabc4567898724",
    ///     Some("https://github.com/clog-tool/clog-lib"),
    /// );
    ///
    /// assert_eq!(
    ///     "https://github.com/thoughtram/clog/commit/123abc891234567890abcdefabc4567898724",
    ///     commit
    /// );
    /// ```
    pub fn commit_link<S: AsRef<str>>(&self, hash: S, repo: Option<S>) -> String {
        let hash = hash.as_ref();
        if let Some(link) = repo {
            let link = link.as_ref();
            match *self {
                LinkStyle::Github | LinkStyle::Gitlab => format!("{link}/commit/{hash}"),
                LinkStyle::Stash => format!("{link}/commits/{hash}"),
                LinkStyle::Cgit => format!("{link}/commit/?id={hash}"),
            }
        } else {
            (hash[0..8]).to_string()
        }
    }
}