id_effect 0.3.0

Effect<A, E, R> (sync + async), capability DI, pipe — interpreter-style, no bundled executor
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

//! Law-checking helpers and macros for algebraic structures.
//!
//! Use in unit tests and property tests to verify monad and applicative laws
//! for concrete type constructors such as [`Option`] and [`Result`].
//!
//! The [`law_test!`] macro expects `f` and `g` to be **`fn` items** (not closure
//! literals) so Rust can reuse one function pointer type across law checks.

/// Generate monad law checks for a type constructor.
#[macro_export]
macro_rules! law_test {
  (
    monad $name:ident {
      pure = $pure:expr,
      flat_map = $flat_map:expr,
      fa = $fa:expr,
      a = $a:expr,
      f = $f:expr,
      g = $g:expr $(,)?
    }
  ) => {
    #[test]
    fn $name() {
      let pure = $pure;
      let flat_map = $flat_map;
      assert_eq!(
        flat_map(pure($a), $f),
        $f($a),
        "{}: left identity failed",
        stringify!($name)
      );
      assert_eq!(
        flat_map($fa, pure),
        $fa,
        "{}: right identity failed",
        stringify!($name)
      );
      let lhs = flat_map(flat_map($fa, $f), $g);
      let rhs = flat_map($fa, |x| flat_map($f(x), $g));
      assert_eq!(lhs, rhs, "{}: associativity failed", stringify!($name));
    }
  };
}

#[cfg(test)]
mod tests {
  use crate::algebra::monad::{option, result};

  fn inc(x: i32) -> Option<i32> {
    Some(x + 1)
  }
  fn double(x: i32) -> Option<i32> {
    Some(x * 2)
  }

  #[test]
  fn option_monad_laws() {
    let fa = Some(3);
    assert_eq!(option::flat_map(option::pure(7), inc), inc(7));
    assert_eq!(option::flat_map(fa, option::pure), fa);
    assert_eq!(
      option::flat_map(option::flat_map(fa, inc), double),
      option::flat_map(fa, |x| option::flat_map(inc(x), double))
    );
  }

  fn inc_result(x: i32) -> Result<i32, &'static str> {
    Ok(x + 1)
  }
  fn double_result(x: i32) -> Result<i32, &'static str> {
    Ok(x * 2)
  }

  #[test]
  fn result_monad_laws() {
    let fa: Result<i32, &str> = Ok(3);
    assert_eq!(
      result::flat_map(result::pure::<_, &str>(7), inc_result),
      inc_result(7)
    );
    assert_eq!(result::flat_map(fa, result::pure::<_, &str>), fa);
    assert_eq!(
      result::flat_map(result::flat_map(fa, inc_result), double_result),
      result::flat_map(fa, |x| result::flat_map(inc_result(x), double_result))
    );
  }

  #[test]
  fn applicative_identity_option() {
    use crate::algebra::applicative::option;
    let fa = Some(42);
    let id = |x: i32| x;
    assert_eq!(option::ap(Some(id), fa.clone()), fa);
  }

  #[test]
  fn applicative_homomorphism_option() {
    use crate::algebra::applicative::option;
    let f = |x: i32| x * 2;
    assert_eq!(
      option::ap(option::pure(f), option::pure(5)),
      option::pure(f(5))
    );
  }
}