genson-core 1.0.3

Core library for JSON schema inference using genson-rs
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
pub mod array;
pub mod base;
pub mod object;
pub mod scalar;

use serde_json::Value;

use array::{ListStrategy, TupleStrategy};
use base::{ScalarSchemaStrategy, SchemaStrategy};
use object::ObjectStrategy;
use scalar::{BooleanStrategy, NullStrategy, NumberStrategy, StringStrategy, TypelessStrategy};

use self::array::ListSchemaStrategy;
use crate::dag::{kw, Dag, Id, ObjBuf, Sym};
use crate::genson_rs::interned::{RowStates, Strat};
use crate::genson_rs::node::{DeferredStrategy, SchemaNode};

/// A strategy's extra keywords as a DAG object being built: where its `to_schema` starts.
pub(crate) fn keywords(extra: &Value, dag: &mut Dag) -> ObjBuf {
    match extra {
        Value::Object(map) => ObjBuf(
            map.iter()
                .map(|(key, value)| (dag.sym(key), dag.intern_value(value)))
                .collect(),
        ),
        _ => ObjBuf::default(),
    }
}

/// Whether a strategy's extra keywords are none, as they mostly are.
pub(crate) fn is_empty_object(extra: &Value) -> bool {
    extra.as_object().is_some_and(|map| map.is_empty())
}

/// A list's `to_schema` as a DAG, given its items' schema if it has items.
fn list_to_dag(extra: &Value, items: Option<Id>, dag: &mut Dag) -> Id {
    if is_empty_object(extra) {
        let array = dag.string(kw::ARRAY);
        return match items {
            Some(items) => dag.object(&[(kw::TYPE, array), (kw::ITEMS, items)]),
            None => dag.object(&[(kw::TYPE, array)]),
        };
    }
    let mut schema = keywords(extra, dag);
    let array = dag.string(kw::ARRAY);
    schema.insert(kw::TYPE, array);
    if let Some(items) = items {
        schema.insert(kw::ITEMS, items);
    }
    schema.build(dag)
}

#[derive(Debug, PartialEq)]
pub enum BasicSchemaStrategy {
    Object(ObjectStrategy),
    List(ListStrategy),
    Tuple(TupleStrategy),
    Null(NullStrategy),
    Boolean(BooleanStrategy),
    Number(NumberStrategy),
    String(StringStrategy),
    Typeless(TypelessStrategy),
}

// TODO: the match check is repeated everywhere, maybe we can optimize this with a macro!

impl BasicSchemaStrategy {
    pub fn new_for_object(object: crate::genson_rs::JsonValue) -> Option<Self> {
        if ObjectStrategy::match_object(object) {
            Some(BasicSchemaStrategy::Object(ObjectStrategy::new()))
        } else if <ListStrategy as ListSchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::List(ListStrategy::new()))
        } else if <TupleStrategy as ListSchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::Tuple(TupleStrategy::new()))
        } else if <NullStrategy as SchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::Null(NullStrategy::new()))
        } else if <BooleanStrategy as SchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::Boolean(BooleanStrategy::new()))
        } else if <NumberStrategy as SchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::Number(NumberStrategy::new()))
        } else if <StringStrategy as SchemaStrategy>::match_object(object) {
            Some(BasicSchemaStrategy::String(StringStrategy::new()))
        } else {
            None
        }
    }

    pub fn new_for_schema(schema: &Value) -> Option<Self> {
        if ObjectStrategy::match_schema(schema) {
            Some(BasicSchemaStrategy::Object(ObjectStrategy::new()))
        } else if ListStrategy::match_schema(schema) {
            Some(BasicSchemaStrategy::List(ListStrategy::new()))
        } else if TupleStrategy::match_schema(schema) {
            Some(BasicSchemaStrategy::Tuple(TupleStrategy::new()))
        } else if <NullStrategy as SchemaStrategy>::match_schema(schema) {
            Some(BasicSchemaStrategy::Null(NullStrategy::new()))
        } else if <BooleanStrategy as SchemaStrategy>::match_schema(schema) {
            Some(BasicSchemaStrategy::Boolean(BooleanStrategy::new()))
        } else if <NumberStrategy as SchemaStrategy>::match_schema(schema) {
            Some(BasicSchemaStrategy::Number(NumberStrategy::new()))
        } else if <StringStrategy as SchemaStrategy>::match_schema(schema) {
            Some(BasicSchemaStrategy::String(StringStrategy::new()))
        } else {
            None
        }
    }

    pub fn same_kind(&self, other: &BasicSchemaStrategy) -> bool {
        std::mem::discriminant(self) == std::mem::discriminant(other)
    }

    /// A new, empty strategy of the same kind.
    pub fn new_of_same_kind(&self) -> Self {
        match self {
            BasicSchemaStrategy::Object(_) => BasicSchemaStrategy::Object(ObjectStrategy::new()),
            BasicSchemaStrategy::List(_) => BasicSchemaStrategy::List(ListStrategy::new()),
            BasicSchemaStrategy::Tuple(_) => BasicSchemaStrategy::Tuple(TupleStrategy::new()),
            BasicSchemaStrategy::Null(_) => BasicSchemaStrategy::Null(NullStrategy::new()),
            BasicSchemaStrategy::Boolean(_) => BasicSchemaStrategy::Boolean(BooleanStrategy::new()),
            BasicSchemaStrategy::Number(_) => BasicSchemaStrategy::Number(NumberStrategy::new()),
            BasicSchemaStrategy::String(_) => BasicSchemaStrategy::String(StringStrategy::new()),
            BasicSchemaStrategy::Typeless(_) => {
                BasicSchemaStrategy::Typeless(TypelessStrategy::new())
            }
        }
    }

    /// The type, when this strategy's schema is nothing but `{"type": <type>}` (such schemas
    /// are collapsed into one type list by `SchemaNode::to_schema`).
    pub fn bare_type(&self) -> Option<&'static str> {
        let no_keywords = |keywords: &Value| keywords.as_object().is_some_and(|k| k.is_empty());
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.is_bare().then_some("object"),
            BasicSchemaStrategy::List(_)
            | BasicSchemaStrategy::Tuple(_)
            | BasicSchemaStrategy::Typeless(_) => None,
            BasicSchemaStrategy::Null(strategy) => {
                no_keywords(strategy.get_extra_keywords()).then_some("null")
            }
            BasicSchemaStrategy::Boolean(strategy) => {
                no_keywords(strategy.get_extra_keywords()).then_some("boolean")
            }
            BasicSchemaStrategy::Number(strategy) => {
                no_keywords(strategy.get_extra_keywords()).then(|| strategy.number_type())
            }
            BasicSchemaStrategy::String(strategy) => {
                no_keywords(strategy.get_extra_keywords()).then_some("string")
            }
        }
    }

    /// Merge `other`, of the same kind, into this strategy: the same as
    /// `self.add_schema(&other.to_schema())`. Objects and lists merge their child nodes
    /// directly, and a scalar without keywords adds nothing but a `number` over an
    /// `integer`; other scalars hold no more than a few keywords, so take that route.
    pub fn absorb(&mut self, other: BasicSchemaStrategy) {
        match (self, other) {
            (BasicSchemaStrategy::Object(strategy), BasicSchemaStrategy::Object(other)) => {
                strategy.absorb(other)
            }
            (BasicSchemaStrategy::List(strategy), BasicSchemaStrategy::List(other)) => {
                strategy.absorb(other)
            }
            (strategy, other) if strategy.same_kind(&other) && other.bare_type().is_some() => {
                if let (BasicSchemaStrategy::Number(strategy), Some(number_type)) =
                    (strategy, other.bare_type())
                {
                    strategy.add_number_type(number_type);
                }
            }
            (strategy, other) => strategy.add_schema(&other.to_schema()),
        }
    }

    /// Whether an interned strategy is of this strategy's kind.
    pub(crate) fn same_kind_as_interned(&self, strat: Strat) -> bool {
        matches!(
            (self, strat),
            (BasicSchemaStrategy::Object(_), Strat::Object(_))
                | (BasicSchemaStrategy::List(_), Strat::List(_))
                | (BasicSchemaStrategy::Null(_), Strat::Null)
                | (BasicSchemaStrategy::Boolean(_), Strat::Boolean)
                | (BasicSchemaStrategy::Number(_), Strat::Number(_))
                | (BasicSchemaStrategy::String(_), Strat::String)
        )
    }

    /// A new, empty strategy of an interned strategy's kind.
    pub(crate) fn new_of_interned_kind(strat: Strat) -> Self {
        match strat {
            Strat::Object(_) => BasicSchemaStrategy::Object(ObjectStrategy::new()),
            Strat::List(_) => BasicSchemaStrategy::List(ListStrategy::new()),
            Strat::Null => BasicSchemaStrategy::Null(NullStrategy::new()),
            Strat::Boolean => BasicSchemaStrategy::Boolean(BooleanStrategy::new()),
            Strat::Number(_) => BasicSchemaStrategy::Number(NumberStrategy::new()),
            Strat::String => BasicSchemaStrategy::String(StringStrategy::new()),
        }
    }

    /// `absorb` of the strategy an interned one (of the same kind) stands for: objects and
    /// lists merge their child nodes, and of the scalars, which have no keywords, only a
    /// float adds anything (`number` over `integer`).
    pub(crate) fn absorb_interned(&mut self, rows: &RowStates, strat: Strat) {
        match (self, strat) {
            (BasicSchemaStrategy::Object(strategy), Strat::Object(obj)) => {
                strategy.absorb_interned(rows, obj)
            }
            (BasicSchemaStrategy::List(strategy), Strat::List(items)) => {
                strategy.absorb_interned(rows, items)
            }
            (BasicSchemaStrategy::Number(strategy), Strat::Number(float)) => {
                strategy.add_number_type(if float { "number" } else { "integer" })
            }
            _ => {}
        }
    }

    /// `absorb_interned`, with the child absorbs added to `deferred`.
    pub(crate) fn absorb_interned_deferred<'a>(
        &mut self,
        rows: &'a RowStates,
        strat: Strat,
        deferred: &mut DeferredStrategy<'a>,
    ) {
        match (self, strat) {
            (BasicSchemaStrategy::Object(strategy), Strat::Object(obj)) => {
                strategy.absorb_interned_deferred(rows, obj, deferred)
            }
            (BasicSchemaStrategy::List(_), Strat::List(items)) => {
                if !matches!(deferred, DeferredStrategy::List(_)) {
                    *deferred = DeferredStrategy::List(Vec::new());
                }
                if let DeferredStrategy::List(states) = deferred {
                    states.push((rows, items));
                }
            }
            (BasicSchemaStrategy::Number(strategy), Strat::Number(float)) => {
                strategy.add_number_type(if float { "number" } else { "integer" })
            }
            _ => {}
        }
    }

    /// The child absorbs `absorb_interned_deferred` held back.
    pub(crate) fn absorb_deferred(&mut self, deferred: DeferredStrategy) {
        match (self, deferred) {
            (BasicSchemaStrategy::Object(strategy), DeferredStrategy::Object(groups)) => {
                strategy.absorb_deferred(groups)
            }
            (BasicSchemaStrategy::List(strategy), DeferredStrategy::List(states)) => {
                strategy.items_node_mut().absorb_interned_all(&states)
            }
            _ => {}
        }
    }

    /// See `SchemaNode::visit_properties_mut`.
    pub fn visit_properties_mut<F>(&mut self, f: &mut F)
    where
        F: FnMut(&str, &mut SchemaNode) -> bool,
    {
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.visit_properties_mut(f),
            BasicSchemaStrategy::List(strategy) => strategy.get_items_mut().for_each(|node| {
                node.visit_properties_mut(f);
            }),
            BasicSchemaStrategy::Tuple(strategy) => strategy.get_items_mut().for_each(|node| {
                node.visit_properties_mut(f);
            }),
            _ => {}
        }
    }

    /// Feed `hasher` what identifies this strategy's schema (see `SchemaNode::hash_schema`).
    pub fn hash_schema<H: std::hash::Hasher>(&self, hasher: &mut H) {
        match self {
            BasicSchemaStrategy::Object(strategy) => {
                hasher.write_u8(b'O');
                strategy.hash_schema(hasher);
            }
            BasicSchemaStrategy::List(strategy) => {
                hasher.write_u8(b'L');
                strategy.items_node().hash_schema(hasher);
            }
            _ => {
                hasher.write_u8(b'S');
                match self.bare_type() {
                    // A scalar without keywords serialises as `{"type":"<name>"}`, so feed
                    // those bytes without building the schema value
                    Some(name) => {
                        hasher.write(br#"{"type":""#);
                        hasher.write(name.as_bytes());
                        hasher.write(br#""}"#);
                    }
                    None => crate::genson_rs::node::hash_value(&self.to_schema(), hasher),
                }
            }
        }
    }

    /// `to_schema` as a DAG.
    pub(crate) fn to_dag(&self, dag: &mut Dag) -> Id {
        let typed = |extra: &Value, js_type: Sym, dag: &mut Dag| {
            if is_empty_object(extra) {
                return dag.typed(js_type);
            }
            let mut schema = keywords(extra, dag);
            let js_type = dag.string(js_type);
            schema.insert(kw::TYPE, js_type);
            schema.build(dag)
        };
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.to_dag(dag),
            BasicSchemaStrategy::List(strategy) => {
                let items = strategy.get_items().next().map(|items| items.to_dag(dag));
                list_to_dag(strategy.get_extra_keywords(), items, dag)
            }
            BasicSchemaStrategy::Tuple(strategy) => {
                let items: Vec<Id> = strategy.get_items().map(|item| item.to_dag(dag)).collect();
                let items = (!items.is_empty()).then(|| dag.array(&items));
                list_to_dag(strategy.get_extra_keywords(), items, dag)
            }
            BasicSchemaStrategy::Null(strategy) => {
                typed(strategy.get_extra_keywords(), kw::NULL, dag)
            }
            BasicSchemaStrategy::Boolean(strategy) => {
                typed(strategy.get_extra_keywords(), kw::BOOLEAN, dag)
            }
            BasicSchemaStrategy::Number(strategy) => typed(
                strategy.get_extra_keywords(),
                match strategy.number_type() {
                    "integer" => kw::INTEGER,
                    _ => kw::NUMBER,
                },
                dag,
            ),
            BasicSchemaStrategy::String(strategy) => {
                typed(strategy.get_extra_keywords(), kw::STRING, dag)
            }
            BasicSchemaStrategy::Typeless(strategy) => {
                keywords(strategy.get_extra_keywords(), dag).build(dag)
            }
        }
    }

    pub fn to_schema(&self) -> Value {
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.to_schema(),
            BasicSchemaStrategy::List(strategy) => ListSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::Tuple(strategy) => ListSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::Null(strategy) => ScalarSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::Boolean(strategy) => ScalarSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::Number(strategy) => ScalarSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::String(strategy) => ScalarSchemaStrategy::to_schema(strategy),
            BasicSchemaStrategy::Typeless(strategy) => strategy.to_schema(),
        }
    }

    pub fn match_object(&self, object: crate::genson_rs::JsonValue) -> bool {
        match self {
            BasicSchemaStrategy::Object(_) => ObjectStrategy::match_object(object),
            BasicSchemaStrategy::List(_) => {
                <ListStrategy as ListSchemaStrategy>::match_object(object)
            }
            BasicSchemaStrategy::Tuple(_) => {
                <TupleStrategy as ListSchemaStrategy>::match_object(object)
            }
            BasicSchemaStrategy::Null(_) => <NullStrategy as SchemaStrategy>::match_object(object),
            BasicSchemaStrategy::Boolean(_) => {
                <BooleanStrategy as SchemaStrategy>::match_object(object)
            }
            BasicSchemaStrategy::Number(_) => {
                <NumberStrategy as SchemaStrategy>::match_object(object)
            }
            BasicSchemaStrategy::String(_) => {
                <StringStrategy as SchemaStrategy>::match_object(object)
            }
            BasicSchemaStrategy::Typeless(_) => TypelessStrategy::match_object(object),
        }
    }

    pub fn match_schema(&self, schema: &Value) -> bool {
        match self {
            BasicSchemaStrategy::Object(_) => ObjectStrategy::match_schema(schema),
            BasicSchemaStrategy::List(_) => ListStrategy::match_schema(schema),
            BasicSchemaStrategy::Tuple(_) => TupleStrategy::match_schema(schema),
            BasicSchemaStrategy::Null(_) => <NullStrategy as SchemaStrategy>::match_schema(schema),
            BasicSchemaStrategy::Boolean(_) => {
                <BooleanStrategy as SchemaStrategy>::match_schema(schema)
            }
            BasicSchemaStrategy::Number(_) => {
                <NumberStrategy as SchemaStrategy>::match_schema(schema)
            }
            BasicSchemaStrategy::String(_) => {
                <StringStrategy as SchemaStrategy>::match_schema(schema)
            }
            BasicSchemaStrategy::Typeless(_) => TypelessStrategy::match_schema(schema),
        }
    }

    pub fn add_schema(&mut self, schema: &Value) {
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::List(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::Tuple(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::Null(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::Boolean(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::Number(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::String(strategy) => strategy.add_schema(schema),
            BasicSchemaStrategy::Typeless(strategy) => strategy.add_schema(schema),
        }
    }

    /// Add multiple schemas at once - delegates to strategy-specific implementation
    pub fn add_schemas(&mut self, schemas: &[&Value]) {
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::List(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::Tuple(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::Boolean(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::Number(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::String(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::Null(strategy) => strategy.add_schemas(schemas),
            BasicSchemaStrategy::Typeless(strategy) => strategy.add_schemas(schemas),
        }
    }

    pub fn add_object(&mut self, object: crate::genson_rs::JsonValue) {
        match self {
            BasicSchemaStrategy::Object(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::List(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::Tuple(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::Null(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::Boolean(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::Number(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::String(strategy) => strategy.add_object(object),
            BasicSchemaStrategy::Typeless(strategy) => strategy.add_object(object),
        }
    }
}