obsidian-parser 0.9.4

//! impl parser for Obsidian notes

use thiserror::Error;

/// Parses Obsidian-style links in note content
///
/// Handles all link formats:
/// - `[[Note]]`
/// - `[[Note|Alias]]`
/// - `[[Note^block]]`
/// - `[[Note#heading]]`
/// - `[[Note#heading|Alias]]`
///
/// # Example
/// ```
/// # use obsidian_parser::note::parser::parse_links;
/// let content = "[[Physics]] and [[Math|Mathematics]]";
/// let links: Vec<_> = parse_links(content).collect();
/// assert_eq!(links, vec!["Physics", "Math"]);
/// ```
pub fn parse_links(text: &str) -> impl Iterator<Item = &str> {
    text.match_indices("[[").filter_map(move |(start_pos, _)| {
        let end_pos = text[start_pos + 2..].find("]]")?;
        let inner = &text[start_pos + 2..start_pos + 2 + end_pos];

        let note_name = inner
            .split('#')
            .next()?
            .split('^')
            .next()?
            .split('|')
            .next()?
            .trim();

        Some(note_name)
    })
}

#[derive(Debug, PartialEq, Eq)]
#[allow(missing_docs)]
pub enum ResultParse<'a> {
    WithProperties {
        content: &'a str,
        properties: &'a str,
    },
    WithoutProperties,
}

/// Errors for [`parse_note`]
#[derive(Debug, Error)]
pub enum Error {
    /// Not found closer in yanl like `---`
    #[error("Not found closer in yaml like `---`")]
    NotFoundCloser,
}

/// Parse obsidian note
pub fn parse_note(raw_text: &str) -> Result<ResultParse<'_>, Error> {
    let have_start_properties = raw_text
        .lines()
        .next()
        .is_some_and(|line| line.trim_end() == "---");

    if have_start_properties {
        let closed = raw_text["---".len()..]
            .find("---")
            .ok_or(Error::NotFoundCloser)?;

        return Ok(ResultParse::WithProperties {
            content: raw_text[(closed + 2 * "...".len())..].trim(),
            properties: raw_text["...".len()..(closed + "...".len())].trim(),
        });
    }

    Ok(ResultParse::WithoutProperties)
}

#[cfg(test)]
mod tests {
    use super::{ResultParse, parse_note};

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_without_properties() {
        let test_data = "test_data";
        let result = parse_note(test_data).unwrap();

        assert_eq!(result, ResultParse::WithoutProperties);
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_with_properties() {
        let test_data = "---\nproperties data\n---\ntest data";
        let result = parse_note(test_data).unwrap();

        assert_eq!(
            result,
            ResultParse::WithProperties {
                content: "test data",
                properties: "properties data"
            }
        );
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_without_properties_but_with_closed() {
        let test_data1 = "test_data---";
        let test_data2 = "test_data\n---\n";

        let result1 = parse_note(test_data1).unwrap();
        let result2 = parse_note(test_data2).unwrap();

        assert_eq!(result1, ResultParse::WithoutProperties);
        assert_eq!(result2, ResultParse::WithoutProperties);
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    #[should_panic]
    fn parse_note_with_properties_but_without_closed() {
        let test_data = "---\nproperties data\ntest data";
        let _ = parse_note(test_data).unwrap();
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_with_() {
        let test_data = "---properties data";

        let result = parse_note(test_data).unwrap();
        assert_eq!(result, ResultParse::WithoutProperties);
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_without_properties_but_with_spaces() {
        let test_data = "   ---\ndata";

        let result = parse_note(test_data).unwrap();
        assert_eq!(result, ResultParse::WithoutProperties);
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn parse_note_with_properties_but_check_trim_end() {
        let test_data = "---\r\nproperties data\r\n---\r   \ntest data";
        let result = parse_note(test_data).unwrap();

        assert_eq!(
            result,
            ResultParse::WithProperties {
                content: "test data",
                properties: "properties data"
            }
        );
    }

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn test_parse_links() {
        let test_data =
            "[[Note]] [[Note|Alias]] [[Note^block]] [[Note#Heading|Alias]] [[Note^block|Alias]]";

        let ds: Vec<_> = super::parse_links(test_data).collect();

        assert!(ds.iter().all(|x| *x == "Note"))
    }
}