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
use std::slice::Iter;
use crate::{comment::Comment, fragment::Fragment};
/// A collection of comments from a [`CommitMessage`]
#[derive(Debug, PartialEq, Eq, Clone, Default)]
pub struct Comments<'a> {
comments: Vec<Comment<'a>>,
}
impl<'a> Comments<'a> {
/// Iterate over the [`Comment`] in the [`Comments`]
///
/// # Examples
///
/// ```
/// use mit_commit::{Comment, Comments};
///
/// let trailers = Comments::from(vec![
/// Comment::from("# Comment 1"),
/// Comment::from("# Comment 2"),
/// Comment::from("# Comment 3"),
/// ]);
/// let mut iterator = trailers.iter();
///
/// assert_eq!(iterator.next(), Some(&Comment::from("# Comment 1")));
/// assert_eq!(iterator.next(), Some(&Comment::from("# Comment 2")));
/// assert_eq!(iterator.next(), Some(&Comment::from("# Comment 3")));
/// assert_eq!(iterator.next(), None);
/// ```
pub fn iter(&self) -> Iter<'_, Comment<'_>> {
self.comments.iter()
}
}
impl<'a> IntoIterator for Comments<'a> {
type IntoIter = std::vec::IntoIter<Comment<'a>>;
type Item = Comment<'a>;
/// Iterate over the [`Comment`] in the [`Comments`]
///
/// # Examples
///
/// ```
/// use mit_commit::{Comment, Comments};
///
/// let trailers = Comments::from(vec![
/// Comment::from("# Comment 1"),
/// Comment::from("# Comment 2"),
/// Comment::from("# Comment 3"),
/// ]);
/// let mut iterator = trailers.into_iter();
///
/// assert_eq!(iterator.next(), Some(Comment::from("# Comment 1")));
/// assert_eq!(iterator.next(), Some(Comment::from("# Comment 2")));
/// assert_eq!(iterator.next(), Some(Comment::from("# Comment 3")));
/// assert_eq!(iterator.next(), None);
/// ```
fn into_iter(self) -> Self::IntoIter {
self.comments.into_iter()
}
}
impl<'a> From<Vec<Comment<'a>>> for Comments<'a> {
fn from(comments: Vec<Comment<'a>>) -> Self {
Self { comments }
}
}
impl<'a> From<Comments<'a>> for String {
fn from(comments: Comments<'_>) -> Self {
comments
.comments
.into_iter()
.map(Self::from)
.collect::<Vec<_>>()
.join("\n\n")
}
}
impl<'a> From<Vec<Fragment<'a>>> for Comments<'a> {
fn from(ast: Vec<Fragment<'a>>) -> Self {
ast.into_iter()
.filter_map(|values| {
if let Fragment::Comment(comment) = values {
Some(comment)
} else {
None
}
})
.collect::<Vec<Comment<'_>>>()
.into()
}
}