cdoc-base 0.10.0-alpha.1

Base type definitions for the Courses ecosystem.
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 anyhow::Result;

use minijinja::value::StructObject;
use minijinja::Value;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
pub struct Document<T: Serialize> {
    pub meta: Metadata,
    pub content: T,
    pub code_outputs: HashMap<String, CodeOutput>,
    pub data: HashMap<String, Value>,
}

#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Metadata {
    pub title: String,
    #[serde(default)]
    pub draft: bool,
    #[serde(default = "default_true")]
    pub exercises: bool,
    #[serde(default)]
    pub code_solutions: Option<bool>,
    #[serde(default = "default_true")]
    pub cell_outputs: bool,
    #[serde(default)]
    pub interactive: bool,
    #[serde(default)]
    pub editable: bool,
    #[serde(default)]
    pub layout: LayoutSettings,
    #[serde(default)]
    pub exclude_outputs: Option<Vec<String>>,
    #[serde(default)]
    pub user: HashMap<String, serde_json::Value>,
}

impl<T: Send + Sync + Serialize> StructObject for Document<T> {
    fn get_field(&self, name: &str) -> Option<Value> {
        match name {
            "meta" => Some(Value::from_struct_object(self.meta.clone())),
            s => self.data.get(s).cloned(),
        }
    }
}

impl StructObject for Metadata {
    fn get_field(&self, name: &str) -> Option<Value> {
        match name {
            "title" => Some(Value::from(self.title.as_str())),
            "draft" => Some(Value::from(self.draft)),
            "exercises" => Some(Value::from(self.exercises)),
            "code_solutions" => self.code_solutions.map(Value::from),
            "interactive" => Some(Value::from(self.interactive)),
            "editable" => Some(Value::from(self.editable)),
            "layout" => Some(Value::from_serializable(&self.layout)),
            "exclude_outputs" => self.exclude_outputs.as_ref().map(Value::from_serializable),
            s => self.user.get(s).map(Value::from_serializable),
        }
    }
}

const fn default_true() -> bool {
    true
}

#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct LayoutSettings {
    pub hide_sidebar: bool,
}

#[derive(Debug, PartialEq, Clone, Serialize, Deserialize, Default)]
pub struct CodeOutput {
    pub values: Vec<OutputValue>,
}

#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
pub enum OutputValue {
    Plain(String),
    Text(String),
    Image(Image),
    Json(serde_json::Value),
    Html(String),
    Javascript(String),
    Error(String),
}

#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
pub enum Image {
    Png(String),
    Svg(String),
}

impl<T: Serialize> Document<T> {
    pub fn map<O: Serialize, F: Fn(T) -> O>(self, f: F) -> Document<O> {
        Document {
            content: f(self.content),
            meta: self.meta,
            code_outputs: self.code_outputs,
            data: HashMap::new(),
            // references: self.references,
            // references_by_type: self.references_by_type,
        }
    }

    pub fn try_map<O: Serialize, F: Fn(T) -> Result<O>>(self, f: F) -> Result<Document<O>> {
        Ok(Document {
            content: f(self.content)?,
            meta: self.meta,
            code_outputs: self.code_outputs,
            data: HashMap::new(),
            // references: self.references,
            // references_by_type: self.references_by_type,
        })
    }
}