todo-tree 1.1.0

//! A single matched TODO-style comment.

use super::todo_priority::TodoPriority;
use serde::{Deserialize, Serialize};

/// A single matched TODO-style comment.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct TodoItem {
    /// The tag that matched, e.g. `"TODO"` or `"FIXME"`.
    pub tag: String,
    /// The comment text following the tag.
    pub message: String,
    /// 1-based line number the tag was found on.
    pub line: usize,
    /// 1-based column the tag starts at.
    pub column: usize,
    /// The full source line the tag was found on, if captured.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line_content: Option<String>,
    /// The optional author/assignee captured from `TAG(name): ...` syntax.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub author: Option<String>,
    /// The priority derived from the tag.
    pub priority: TodoPriority,
}

impl TodoItem {
    /// Formats the author as `"(name)"`, or an empty string if none was
    /// captured.
    pub fn format_author(&self) -> String {
        self.author
            .as_ref()
            .map(|a| format!("({})", a))
            .unwrap_or_default()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn item(author: Option<&str>) -> TodoItem {
        TodoItem {
            tag: "TODO".to_string(),
            message: "test".to_string(),
            line: 1,
            column: 1,
            line_content: None,
            author: author.map(str::to_string),
            priority: TodoPriority::Medium,
        }
    }

    #[test]
    fn format_author_wraps_in_parens_when_present() {
        assert_eq!(item(Some("alice")).format_author(), "(alice)");
    }

    #[test]
    fn format_author_is_empty_when_absent() {
        assert_eq!(item(None).format_author(), "");
    }
}