rojo 7.6.1

Enables professional-grade development tools for Roblox developers
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

//! Utiilty that helps redact nondeterministic information from trees so that
//! they can be part of snapshot tests.

use rbx_dom_weak::{
    types::{Ref, Variant},
    Ustr, UstrMap,
};
use rojo_insta_ext::RedactionMap;
use serde::Serialize;

use crate::snapshot::{InstanceMetadata, RojoTree};

/// Adds the given Rojo tree into the redaction map and produces a redacted
/// copy that can be immediately fed to one of Insta's snapshot macros like
/// `assert_snapshot_yaml`.
pub fn view_tree(tree: &RojoTree, redactions: &mut RedactionMap) -> serde_yaml::Value {
    intern_tree(tree, redactions);

    let view = extract_instance_view(tree, tree.get_root_id());
    redactions.redacted_yaml(view)
}

/// Adds the given Rojo tree into the redaction map.
pub fn intern_tree(tree: &RojoTree, redactions: &mut RedactionMap) {
    let root_id = tree.get_root_id();
    redactions.intern(root_id);

    for descendant in tree.descendants(root_id) {
        redactions.intern(descendant.id());
    }
}

/// Copy of data from RojoTree in the right shape to have useful snapshots.
#[derive(Debug, Serialize)]
struct InstanceView {
    id: Ref,
    name: String,
    class_name: Ustr,
    properties: UstrMap<Variant>,
    metadata: InstanceMetadata,
    children: Vec<InstanceView>,
}

fn extract_instance_view(tree: &RojoTree, id: Ref) -> InstanceView {
    let instance = tree.get_instance(id).unwrap();

    InstanceView {
        id: instance.id(),
        name: instance.name().to_owned(),
        class_name: instance.class_name(),
        properties: instance.properties().clone(),
        metadata: instance.metadata().clone(),
        children: instance
            .children()
            .iter()
            .copied()
            .map(|id| extract_instance_view(tree, id))
            .collect(),
    }
}