flowstdlib 0.142.0

The standard library of functions and flows for 'flow' programs
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

use serde_json::{json, Value};

use flowcore::{RUN_AGAIN, RunAgain};
use flowcore::errors::*;
use flowcore::model::datatype::{ARRAY_TYPE, BOOLEAN_TYPE, NULL_TYPE, NUMBER_TYPE, OBJECT_TYPE, STRING_TYPE};
use flowmacro::flow_function;

fn type_string(value: &Value) -> String {
    match value {
        Value::String(_) => STRING_TYPE.into(),
        Value::Bool(_) => BOOLEAN_TYPE.into(),
        Value::Number(_) => NUMBER_TYPE.into(),
        Value::Array(array) => format!("{ARRAY_TYPE}/{}", type_string(&array[0])),
        Value::Object(map) => {
            if let Some(value) = &map.values().next().cloned() {
                format!("{OBJECT_TYPE}/{}", type_string(value))
            } else {
                format!("{OBJECT_TYPE}/Unknown")
            }
        }
        Value::Null => NULL_TYPE.into(),
    }
}

#[flow_function]
fn _info(inputs: &[Value]) -> Result<(Option<Value>, RunAgain)> {
    let mut output_map = serde_json::Map::new();

    let (rows, cols) = match &inputs[0] {
        Value::String(string) => (1, string.len()),
        Value::Bool(_boolean) => (1, 1),
        Value::Number(_number) => (1, 1),
        Value::Array(vec) => match &vec[0] {
            Value::Array(row) => (vec.len(), row.len()), // Array of Arrays
            _ => (1, vec.len()),
        },
        Value::Object(map) => (map.len(), 2),
        Value::Null => (0, 0),
    };

    output_map.insert("rows".into(), json!(rows));
    output_map.insert("columns".into(), json!(cols));
    output_map.insert("type".into(), json!(type_string(&inputs[0])));

    Ok((Some(Value::Object(output_map)), RUN_AGAIN))
}

#[cfg(test)]
mod test {
    use serde_json::{Map, Value};
    use serde_json::json;

    use flowcore::model::datatype::{NUMBER_TYPE, OBJECT_TYPE};
    use flowcore::model::datatype::ARRAY_TYPE;
    use flowcore::model::datatype::BOOLEAN_TYPE;
    use flowcore::model::datatype::NULL_TYPE;
    use flowcore::model::datatype::STRING_TYPE;

    use super::_info;

    #[test]
    fn info_on_number() {
        let inputs = vec![json!(1)];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"), &json!(NUMBER_TYPE));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(1));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(1));
    }

    #[test]
    fn info_on_boolean() {
        let inputs = vec![json!(true)];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"), &json!(BOOLEAN_TYPE));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /row from the output"), &json!(1));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(1));
    }

    #[test]
    fn info_on_string() {
        let string = json!("Hello");
        let (result, _) = _info(&[string]).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"), &json!(STRING_TYPE));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /row from the output"), &json!(1));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(5));
    }

    #[test]
    fn info_on_null() {
        let inputs = vec![Value::Null];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"), &json!(NULL_TYPE));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(0));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /column from the output"), &json!(0));
    }

    #[test]
    fn info_on_array_of_number() {
        let inputs = vec![json!([1, 2, 3])];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"),
                   &json!(format!("{ARRAY_TYPE}/{NUMBER_TYPE}")));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(1));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /column from the output"), &json!(3));
    }

    #[test]
    fn info_on_array_of_array_of_number() {
        let array_array_numbers = json!([[1, 2, 3], [4, 5, 6]]);
        let (result, _) = _info(&[array_array_numbers]).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(
            output_map.pointer("/type").expect("Could not get the /type from the output"),
            &json!(format!("{ARRAY_TYPE}/{ARRAY_TYPE}/{NUMBER_TYPE}"))
        );
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(2));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(3));
    }

    #[test]
    fn info_on_map_of_number() {
        let mut map = Map::new();
        map.insert("0".into(), json!(1));
        map.insert("1".into(), json!(2));
        let inputs = vec![Value::Object(map)];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(output_map.pointer("/type").expect("Could not get the /type from the output"),
                   &json!(format!("{OBJECT_TYPE}/{NUMBER_TYPE}")));
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(2));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(2));
    }

    #[test]
    fn info_on_map_of_arrays_of_number() {
        let mut map = Map::new();
        map.insert("0".into(), json!([1, 2]));
        map.insert("1".into(), json!([3, 4]));
        let inputs = vec![Value::Object(map)];
        let (result, _) = _info(&inputs).expect("_info() failed");
        let output_map = result.expect("Could not get the Value from the output");

        assert_eq!(
            output_map.pointer("/type").expect("Could not get the /type from the output"),
            &json!(format!("{OBJECT_TYPE}/{ARRAY_TYPE}/{NUMBER_TYPE}"))
        );
        assert_eq!(output_map.pointer("/rows").expect("Could not get the /rows from the output"), &json!(2));
        assert_eq!(output_map.pointer("/columns").expect("Could not get the /columns from the output"), &json!(2));
    }
}