specfold-core 0.3.0

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
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

//! Document identifiers: `<type>:<owner>/<key>`, optionally followed by `#<anchor>`.

use serde::{Serialize, Serializer};
use std::fmt;

#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct DocId {
    pub ty: String,
    pub owner: String,
    pub key: String,
}

impl DocId {
    pub fn new(ty: &str, owner: &str, key: &str) -> Self {
        DocId { ty: ty.into(), owner: owner.into(), key: key.into() }
    }

    /// Parses `type:owner/key`. The owner may contain dots; the key may not contain `/`.
    pub fn parse(s: &str) -> Option<Self> {
        let (ty, rest) = s.split_once(':')?;
        let (owner, key) = rest.rsplit_once('/')?;
        let valid = |p: &str| !p.is_empty() && p.bytes().all(|b| b.is_ascii_alphanumeric() || b"-._".contains(&b));
        if !valid(ty) || !valid(owner) || !valid(key) {
            return None;
        }
        Some(DocId::new(ty, owner, key))
    }
}

impl fmt::Display for DocId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}:{}/{}", self.ty, self.owner, self.key)
    }
}

impl Serialize for DocId {
    fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        s.serialize_str(&self.to_string())
    }
}

/// A reference as written in a document or on the command line: an id, an id with an anchor,
/// an alias, or a path.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RefText {
    pub target: String,
    pub anchor: Option<String>,
}

impl RefText {
    pub fn parse(s: &str) -> Self {
        let s = s.trim();
        match s.split_once('#') {
            Some((t, a)) if !a.is_empty() => RefText { target: t.to_string(), anchor: Some(a.to_string()) },
            _ => RefText { target: s.trim_end_matches('#').to_string(), anchor: None },
        }
    }
}

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

    #[test]
    fn parse_ids() {
        let id = DocId::parse("adr:core.infra.proxy/20261027073000").unwrap();
        assert_eq!(id.owner, "core.infra.proxy");
        assert_eq!(id.to_string(), "adr:core.infra.proxy/20261027073000");
        assert!(DocId::parse("ADR-7").is_none());
        assert!(DocId::parse("plan:/x").is_none());
        let r = RefText::parse("sot:shop/checkout#CO-102");
        assert_eq!(r.anchor.as_deref(), Some("CO-102"));
    }
}