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

//! Conventional Commit components.

use std::fmt;
use std::ops::Deref;

/// A single Git trailer.
///
/// See: <https://git-scm.com/docs/git-interpret-trailers>
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub struct Trailer<'a> {
    key: TrailerKey<'a>,
    sep: TrailerSeparator,
    value: TrailerValue<'a>,
}

impl<'a> Trailer<'a> {
    /// The key of the trailer.
    pub const fn key(&self) -> TrailerKey<'a> {
        self.key
    }

    /// The separator between the trailer key and its value.
    pub const fn separator(&self) -> TrailerSeparator {
        self.sep
    }

    /// The value of the trailer.
    pub const fn value(&self) -> TrailerValue<'a> {
        self.value
    }
}

impl<'a> From<(&'a str, &'a str, &'a str)> for Trailer<'a> {
    fn from((key, sep, value): (&'a str, &'a str, &'a str)) -> Self {
        Self {
            key: TrailerKey(key),
            sep: sep.into(),
            value: TrailerValue(value),
        }
    }
}

/// The "simple trailer" variant, for convenient access to the string slice
/// values of its components.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub struct SimpleTrailer<'a> {
    pub(crate) trailer: &'a Trailer<'a>,
}

impl<'a> SimpleTrailer<'a> {
    /// The key of the trailer.
    pub fn key(&self) -> &str {
        &*self.trailer.key
    }

    /// The separator between the trailer key and its value.
    pub fn separator(&self) -> &str {
        &*self.trailer.sep
    }

    /// The value of the trailer.
    pub fn value(&self) -> &str {
        &*self.trailer.value
    }
}

/// The type of separator between the trailer key and value.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub enum TrailerSeparator {
    /// ": "
    ColonSpace,

    /// " #"
    SpacePound,
}

impl Deref for TrailerSeparator {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        match self {
            TrailerSeparator::ColonSpace => ": ",
            TrailerSeparator::SpacePound => " #",
        }
    }
}

impl fmt::Display for TrailerSeparator {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TrailerSeparator::ColonSpace => f.write_str(": "),
            TrailerSeparator::SpacePound => f.write_str(" #"),
        }
    }
}

impl From<&str> for TrailerSeparator {
    fn from(sep: &str) -> Self {
        match sep {
            ": " => TrailerSeparator::ColonSpace,
            " #" => TrailerSeparator::SpacePound,
            _ => unreachable!(),
        }
    }
}

macro_rules! components {
    ($($ty:ident),+) => (
        $(
            /// A component of the conventional commit.
            #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
            pub struct $ty<'a>(pub &'a str);

            impl Deref for $ty<'_> {
                type Target = str;

                fn deref(&self) -> &Self::Target {
                    &self.0
                }
            }

            impl fmt::Display for $ty<'_> {
                fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                    self.0.fmt(f)
                }
            }

            impl<'a> From<&'a str> for $ty<'a> {
                fn from(string: &'a str) -> Self {
                    Self(string)
                }
            }
        )+
    )
}

components![
    Type,
    Scope,
    Description,
    Body,
    BreakingChange,
    TrailerKey,
    TrailerValue
];