flowstdlib 1.0.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

use serde_json::{json, Value};

use flowcore::errors::Result;
use flowcore::flow_output;
use flowcore::RunAgain;
use flowmacro::flow_function;

#[flow_function]
fn inner_divide(dividend: &Value, divisor: &Value) -> Result<(Option<Value>, RunAgain)> {
    if dividend.is_null() || divisor.is_null() {
        return flow_output!("result" => Value::Null, "remainder" => Value::Null);
    }

    let dividend = dividend
        .as_f64()
        .ok_or("Could not get dividend as number")?;
    let divisor = divisor.as_f64().ok_or("Could not get divisor as number")?;

    flow_output!(
        "result" => json!(dividend / divisor),
        "remainder" => json!(dividend % divisor)
    )
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod test {
    use serde_json::{json, Value};

    use super::inner_divide;

    #[test]
    fn divide_exact() {
        let (output, again) = inner_divide(&json!(99), &json!(3)).expect("divide failed");
        assert!(again);
        let out = output.expect("no output");
        assert_eq!(*out.pointer("/result").expect("no result"), json!(33.0));
        assert_eq!(
            *out.pointer("/remainder").expect("no remainder"),
            json!(0.0)
        );
    }

    #[test]
    fn divide_with_remainder() {
        let (output, _) = inner_divide(&json!(100), &json!(3)).expect("divide failed");
        let out = output.expect("no output");
        let result = out
            .pointer("/result")
            .expect("no result")
            .as_f64()
            .expect("not f64");
        assert!((result - 33.333_333_333_333_336).abs() < 1e-10);
    }

    #[test]
    fn divide_floats() {
        let (output, _) = inner_divide(&json!(10.5), &json!(2.5)).expect("divide failed");
        let out = output.expect("no output");
        assert_eq!(*out.pointer("/result").expect("no result"), json!(4.2));
    }

    #[test]
    fn divide_mixed_int_and_float() {
        let (output, _) = inner_divide(&json!(10), &json!(2.5)).expect("divide failed");
        let out = output.expect("no output");
        assert_eq!(*out.pointer("/result").expect("no result"), json!(4.0));
    }

    #[test]
    fn divide_null_propagation() {
        let (output, _) = inner_divide(&json!(null), &json!(5)).expect("divide failed");
        let out = output.expect("no output");
        assert_eq!(*out.pointer("/result").expect("no result"), Value::Null);
        assert_eq!(
            *out.pointer("/remainder").expect("no remainder"),
            Value::Null
        );
    }
}