codexa 0.0.3

A Git-native content compiler for building typed public and private knowledge artifacts.
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
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

use std::{error::Error, fmt};

use crate::model::{DocumentMetadata, SourceDocument};

/// Parses a Markdown source document with required YAML frontmatter.
pub fn parse_source_document(source: &str) -> Result<SourceDocument, FrontmatterError> {
    let (frontmatter, body) = split_frontmatter(source)?;
    let metadata: DocumentMetadata = serde_yaml::from_str(frontmatter)?;

    metadata
        .validate_schema()
        .map_err(FrontmatterError::InvalidSchema)?;

    Ok(SourceDocument {
        metadata,
        body: body.trim_start_matches('\n').to_string(),
    })
}

fn split_frontmatter(source: &str) -> Result<(&str, &str), FrontmatterError> {
    let source = source
        .strip_prefix("---\n")
        .ok_or(FrontmatterError::Missing)?;

    let end = source.find("\n---").ok_or(FrontmatterError::Unclosed)?;
    let frontmatter = &source[..end];

    let after_marker = &source[end + "\n---".len()..];
    let body = after_marker
        .strip_prefix("\r\n")
        .or_else(|| after_marker.strip_prefix('\n'))
        .unwrap_or(after_marker);

    Ok((frontmatter, body))
}

/// Frontmatter parsing errors.
#[derive(Debug)]
pub enum FrontmatterError {
    Missing,
    Unclosed,
    Yaml(serde_yaml::Error),
    InvalidSchema(String),
}

impl fmt::Display for FrontmatterError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Missing => write!(formatter, "missing YAML frontmatter"),
            Self::Unclosed => write!(formatter, "unclosed YAML frontmatter"),
            Self::Yaml(error) => write!(formatter, "frontmatter YAML error: {error}"),
            Self::InvalidSchema(message) => write!(formatter, "{message}"),
        }
    }
}

impl Error for FrontmatterError {}

impl From<serde_yaml::Error> for FrontmatterError {
    fn from(error: serde_yaml::Error) -> Self {
        Self::Yaml(error)
    }
}

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

    #[test]
    fn parses_frontmatter_and_body() {
        let source = r#"---
schema: codexa.document@2
id: notes.example
title: Example
description: One line.
kind: note
status: active
visibility: private
tags:
  - test
navigation:
  root: docs
  product: codexa
  section: Guides
  order: 10
distribution:
  notion: true
  web: private
  obsidian: true
notion:
  workspace: codexa
web:
  slug: /docs/codexa/guides/example
---

# Example

Body text.
"#;

        let document = parse_source_document(source).expect("source document should parse");

        assert_eq!(document.metadata.schema, "codexa.document@2");
        assert_eq!(document.metadata.id, "notes.example");
        assert_eq!(document.metadata.title, "Example");
        assert_eq!(document.metadata.description, "One line.");
        assert_eq!(document.metadata.tags, vec!["test"]);

        let navigation = &document.metadata.navigation;
        assert_eq!(navigation.root, "docs");
        assert_eq!(navigation.product, "codexa");

        let web = document.metadata.web.as_ref().unwrap();
        assert_eq!(web.slug, "/docs/codexa/guides/example");

        assert!(document.body.starts_with("# Example"));
    }
}