quillmark-core 0.71.0

Core types and functionality for Quillmark
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

use super::QuillConfig;

impl QuillConfig {
    /// YAML encoding of [`QuillConfig::schema`] (structural schema, no ui).
    pub fn schema_yaml(&self) -> Result<String, serde_saphyr::ser::Error> {
        serde_saphyr::to_string(&self.schema())
    }

    /// YAML encoding of [`QuillConfig::form_schema`] (schema + ui hints).
    pub fn form_schema_yaml(&self) -> Result<String, serde_saphyr::ser::Error> {
        serde_saphyr::to_string(&self.form_schema())
    }
}

#[cfg(test)]
mod tests {
    use crate::quill::QuillConfig;

    fn cfg(yaml: &str) -> QuillConfig {
        QuillConfig::from_yaml(yaml).expect("valid quill yaml")
    }

    const FULL: &str = r#"
quill:
  name: full
  version: "1.0"
  backend: typst
  description: Full
main:
  fields:
    status:
      type: string
      enum: [draft, final]
      default: draft
      ui:
        group: Meta
    page_count:
      type: integer
card_types:
  indorsement:
    fields:
      signature_block:
        type: string
"#;

    #[test]
    fn schema_strips_ui_form_schema_keeps_it() {
        let config = cfg(FULL);
        let clean = config.schema_yaml().unwrap();
        assert!(clean.contains("enum:") && clean.contains("type: integer"));
        assert!(clean.contains("card_types:") && clean.contains("indorsement:"));
        assert!(!clean.contains("ui:"));

        let form = config.form_schema_yaml().unwrap();
        assert!(form.contains("ui:") && form.contains("group: Meta"));
    }

    #[test]
    fn omits_card_types_when_absent() {
        let yaml = cfg(r#"
quill: { name: solo, version: "1.0", backend: typst, description: x }
main:
  fields:
    title: { type: string }
"#)
        .schema_yaml()
        .unwrap();
        assert!(yaml.contains("main:") && !yaml.contains("card_types:"));
    }

    #[test]
    fn omits_example_and_ref() {
        let mut config = cfg(FULL);
        config.example_markdown = Some("# x".to_string());
        for yaml in [
            config.schema_yaml().unwrap(),
            config.form_schema_yaml().unwrap(),
        ] {
            assert!(!yaml.contains("example:"));
            assert!(!yaml.contains("ref:"));
        }
    }

    #[test]
    fn json_yaml_parity() {
        let config = cfg(FULL);
        let parse = |yaml: &str| serde_saphyr::from_str::<serde_json::Value>(yaml).unwrap();
        assert_eq!(config.schema(), parse(&config.schema_yaml().unwrap()));
        assert_eq!(
            config.form_schema(),
            parse(&config.form_schema_yaml().unwrap())
        );
    }
}