stof 0.3.24

Stof is a unified data interface and interchange format for creating, sharing, and manipulating data. Stof removes the fragile and cumbersome parts of combining and using data in applications.
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

//
// Copyright 2024 Formata, Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

pub mod import;
use export::json_value_from_node;
use import::parse_object_value;
pub mod export;

use serde_json::{Map, Value};
use crate::{lang::SError, Format, IntoNodeRef, SDoc, SGraph};

#[cfg(test)]
mod tests;


/// Stof NDJSON interface.
pub struct NDJSON;
impl NDJSON {
    /// Parse a NDJSON string into a new document.
    pub fn parse_new(json: &str) -> Result<SDoc, SError> {
        Ok(SDoc::new(Self::parse(json)?))
    }

    /// Parse a NDJSON string into a singular graph.
    pub fn parse(ndjson: &str) -> Result<SGraph, SError> {
        let mut graphs = Vec::new();
        for json in ndjson.split('\n').collect::<Vec<&str>>() {
            if json.len() > 0 && json.contains('{') && json.contains('}') {
                graphs.push(JSON::parse(json)?);
            }
        }
        let mut result = SGraph::default();
        for graph in graphs {
            result.default_absorb_merge(graph)?;
        }
        Ok(result)
    }
}


/// Stof JSON interface.
pub struct JSON;
impl JSON {
    /// Parse a JSON string into a new document.
    pub fn parse_new(json: &str) -> Result<SDoc, SError> {
        Ok(SDoc::new(Self::parse(json)?))
    }

    /// Parse a JSON string into a Stof graph.
    pub fn parse(json: &str) -> Result<SGraph, SError> {
        if let Ok(value) = serde_json::from_str::<Value>(json) {
            Ok(Self::from_value(value))
        } else {
            Err(SError::empty_fmt("json", "unable to parse JSON string into graph"))
        }
    }

    /// Create a Stof graph from a serde_json Value.
    pub fn from_value(mut value: Value) -> SGraph {
        if !value.is_object() {
            let mut map = Map::new();
            map.insert("field".to_string(), value);
            value = Value::Object(map);
        }
        let mut graph = SGraph::default();
        let root = graph.insert_root("root");
        parse_object_value(&mut graph, &root, value);
        graph
    }

    /// Export a graph as a JSON string.
    /// Exports the main root of the graph only.
    pub fn stringify(pid: &str, doc: &SDoc) -> Result<String, SError> {
        if let Some(main) = doc.graph.main_root() {
            let value = json_value_from_node(&doc.graph, &main);
            if let Ok(json) = serde_json::to_string(&value) {
                return Ok(json);
            }
            return Err(SError::fmt(pid, doc, "json", "could not parse serde_json::Value into json string"));
        }
        Err(SError::fmt(pid, doc, "json", "did not find a main root to stringify"))
    }

    /// Export a node as a JSON string.
    pub fn stringify_node(pid: &str, doc: &SDoc, node: impl IntoNodeRef) -> Result<String, SError> {
        let value = json_value_from_node(&doc.graph, &node.node_ref());
        if let Ok(json) = serde_json::to_string(&value) {
            return Ok(json);
        }
        Err(SError::fmt(pid, doc, "json", "could not parse serde_json::Value into json string"))
    }

    /// To serde_json Value.
    pub fn to_value(pid: &str, doc: &SDoc) -> Result<Value, SError> {
        if let Some(main) = doc.graph.main_root() {
            return Ok(json_value_from_node(&doc.graph, &main));
        }
        Err(SError::fmt(pid, doc, "json", "did not find a main root to parse into a Value"))
    }

    /// To serde_json Value from a node.
    pub fn to_node_value(graph: &SGraph, node: impl IntoNodeRef) -> Value {
        json_value_from_node(graph, &node.node_ref())
    }
}


impl Format for JSON {
    /// Format getter for JSON.
    fn format(&self) -> String {
        "json".to_string()
    }

    /// Content type for JSON.
    fn content_type(&self) -> String {
        "application/json".to_string()
    }

    /// Header import.
    fn header_import(&self, pid: &str, doc: &mut crate::SDoc, _content_type: &str, bytes: &mut bytes::Bytes, as_name: &str) -> Result<(), SError> {
        let res = std::str::from_utf8(bytes.as_ref());
        match res {
            Ok(str) => {
                self.string_import(pid, doc, str, as_name)
            },
            Err(error) => {
                Err(SError::fmt(pid, &doc, "json", &error.to_string()))
            }
        }
    }

    /// String import.
    fn string_import(&self, pid: &str, doc: &mut crate::SDoc, src: &str, as_name: &str) -> Result<(), SError> {
        let mut graph = JSON::parse(src)?;
        if as_name.len() > 0 && as_name != "root" {
            let mut path = as_name.replace(".", "/");
            if as_name.starts_with("self") || as_name.starts_with("super") {
                if let Some(ptr) = doc.self_ptr(pid) {
                    path = format!("{}/{}", ptr.path(&doc.graph), path);
                }
            }

            // as_name is really a location, so ensure the nodes and move it there
            let mut loc_graph = SGraph::default();
            let loc = loc_graph.ensure_nodes(&path, '/', true, None);
            if let Some(main) = graph.main_root() {
                if let Some(main) = main.node(&graph) {
                    loc_graph.absorb_external_node(&graph, main, &loc);
                }
            }
            graph = loc_graph;
        }
        doc.graph.default_absorb_merge(graph)
    }

    /// File import.
    fn file_import(&self, pid: &str, doc: &mut crate::SDoc, _format: &str, full_path: &str, _extension: &str, as_name: &str) -> Result<(), SError> {
        let src = doc.fs_read_string(pid, full_path)?;
        self.string_import(pid, doc, &src, as_name)
    }

    /// Export string.
    fn export_string(&self, pid: &str, doc: &crate::SDoc, node: Option<&crate::SNodeRef>) -> Result<String, SError> {
        if node.is_some() {
            JSON::stringify_node(pid, &doc, node)
        } else {
            JSON::stringify(pid, &doc)
        }
    }
}


impl Format for NDJSON {
    /// Format getter for NDJSON.
    fn format(&self) -> String {
        "ndjson".to_string()
    }

    /// Content type for NDJSON.
    fn content_type(&self) -> String {
        "application/x-ndjson".to_string()
    }

    /// Header import.
    fn header_import(&self, pid: &str, doc: &mut crate::SDoc, _content_type: &str, bytes: &mut bytes::Bytes, as_name: &str) -> Result<(), SError> {
        let res = std::str::from_utf8(bytes.as_ref());
        match res {
            Ok(str) => {
                self.string_import(pid, doc, str, as_name)
            },
            Err(error) => {
                Err(SError::fmt(pid, &doc, "ndjson", &error.to_string()))
            }
        }
    }

    /// String import.
    fn string_import(&self, pid: &str, doc: &mut crate::SDoc, src: &str, as_name: &str) -> Result<(), SError> {
        let mut graph = NDJSON::parse(src)?;
        if as_name.len() > 0 && as_name != "root" {
            let mut path = as_name.replace(".", "/");
            if as_name.starts_with("self") || as_name.starts_with("super") {
                if let Some(ptr) = doc.self_ptr(pid) {
                    path = format!("{}/{}", ptr.path(&doc.graph), path);
                }
            }

            // as_name is really a location, so ensure the nodes and move it there
            let mut loc_graph = SGraph::default();
            let loc = loc_graph.ensure_nodes(&path, '/', true, None);
            if let Some(main) = graph.main_root() {
                if let Some(main) = main.node(&graph) {
                    loc_graph.absorb_external_node(&graph, main, &loc);
                }
            }
            graph = loc_graph;
        }
        doc.graph.default_absorb_merge(graph)
    }

    /// File import.
    fn file_import(&self, pid: &str, doc: &mut crate::SDoc, _format: &str, full_path: &str, _extension: &str, as_name: &str) -> Result<(), SError> {
        let src = doc.fs_read_string(pid, full_path)?;
        self.string_import(pid, doc, &src, as_name)
    }

    /// Export string.
    /// NDJSON is just JSON here...
    fn export_string(&self, pid: &str, doc: &crate::SDoc, node: Option<&crate::SNodeRef>) -> Result<String, SError> {
        if node.is_some() {
            JSON::stringify_node(pid, &doc, node)
        } else {
            JSON::stringify(pid, &doc)
        }
    }
}