Result.forEach with tests and docs (#116)

* Result.forEach

* Changelog - Result.forEach

Author: jmagaram

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## main
 
+### API changes
+
+- Add `Result.forEach` https://github.com/rescript-association/rescript-core/pull/116
+
 ## 0.2.0
 
 ### API changes

src/Core__Result.mjs

@@ -102,6 +102,13 @@ function cmp(a, b, f) {
   }
 }
 
+function forEach(r, f) {
+  if (r.TAG === /* Ok */0) {
+    return Curry._1(f, r._0);
+  }
+  
+}
+
 export {
   getExn ,
   mapWithDefault ,
@@ -112,5 +119,6 @@ export {
   isError ,
   eq ,
   cmp ,
+  forEach ,
 }
 /* No side effect */

src/Core__Result.res

@@ -91,3 +91,9 @@ let cmpU = (a, b, f) =>
   }
 
 let cmp = (a, b, f) => cmpU(a, b, (. x, y) => f(x, y))
+
+let forEach = (r, f) =>
+  switch r {
+  | Ok(ok) => f(ok)
+  | Error(_) => ()
+  }

src/Core__Result.resi

@@ -197,3 +197,15 @@ let eq: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => bool) => bool
   ```
 */
 let cmp: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => int) => int
+
+/**
+`forEach(res, f)` runs the provided function `f` on the `Ok` value. If `res` is `Error`, nothing happens. 
+
+## Examples
+
+```rescript
+Result.forEach(Ok(3), Console.log) // Logs "3", returns ()
+Result.forEach(Error("x"), Console.log) // Does nothing, returns ()
+```
+*/
+let forEach: (t<'a, 'b>, 'a => unit) => unit

test/ResultTests.mjs

@@ -0,0 +1,60 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Test from "./Test.mjs";
+import * as Caml_obj from "rescript/lib/es6/caml_obj.js";
+import * as Core__Result from "../src/Core__Result.mjs";
+
+var eq = Caml_obj.equal;
+
+function forEachIfOkCallFunction(param) {
+  var called = {
+    contents: []
+  };
+  Core__Result.forEach({
+        TAG: /* Ok */0,
+        _0: 3
+      }, (function (i) {
+          called.contents.push(i);
+        }));
+  Test.run([
+        [
+          "ResultTests.res",
+          12,
+          22,
+          72
+        ],
+        "forEach: if ok, call function with ok value once"
+      ], called.contents, eq, [3]);
+}
+
+forEachIfOkCallFunction(undefined);
+
+function forEachIfErrorDoNotCallFunction(param) {
+  var called = {
+    contents: []
+  };
+  Core__Result.forEach({
+        TAG: /* Error */1,
+        _0: 3
+      }, (function (i) {
+          called.contents.push(i);
+        }));
+  Test.run([
+        [
+          "ResultTests.res",
+          19,
+          22,
+          63
+        ],
+        "forEach: if error, do not call function"
+      ], called.contents, eq, []);
+}
+
+forEachIfErrorDoNotCallFunction(undefined);
+
+export {
+  eq ,
+  forEachIfOkCallFunction ,
+  forEachIfErrorDoNotCallFunction ,
+}
+/*  Not a pure module */

test/ResultTests.res

@@ -0,0 +1,21 @@
+open RescriptCore
+
+let eq = (a, b) => a == b
+
+// =======
+// forEach
+// =======
+
+let forEachIfOkCallFunction = () => {
+  let called = ref([])
+  Ok(3)->Result.forEach(i => called.contents->Array.push(i))
+  Test.run(__POS_OF__("forEach: if ok, call function with ok value once"), called.contents, eq, [3])
+}
+forEachIfOkCallFunction()
+
+let forEachIfErrorDoNotCallFunction = () => {
+  let called = ref([])
+  Error(3)->Result.forEach(i => called.contents->Array.push(i))
+  Test.run(__POS_OF__("forEach: if error, do not call function"), called.contents, eq, [])
+}
+forEachIfErrorDoNotCallFunction()

test/TestSuite.mjs

@@ -5,6 +5,7 @@ import * as TestTests from "./TestTests.mjs";
 import * as ArrayTests from "./ArrayTests.mjs";
 import * as ErrorTests from "./ErrorTests.mjs";
 import * as PromiseTest from "./PromiseTest.mjs";
+import * as ResultTests from "./ResultTests.mjs";
 
 var bign = TestTests.bign;
 
@@ -26,10 +27,14 @@ var Concurrently = PromiseTest.Concurrently;
 
 var panicTest = ErrorTests.panicTest;
 
-var eq = IntTests.eq;
-
 var $$catch = IntTests.$$catch;
 
+var eq = ResultTests.eq;
+
+var forEachIfOkCallFunction = ResultTests.forEachIfOkCallFunction;
+
+var forEachIfErrorDoNotCallFunction = ResultTests.forEachIfErrorDoNotCallFunction;
+
 export {
   bign ,
   TestError ,
@@ -41,7 +46,9 @@ export {
   Catching ,
   Concurrently ,
   panicTest ,
-  eq ,
   $$catch ,
+  eq ,
+  forEachIfOkCallFunction ,
+  forEachIfErrorDoNotCallFunction ,
 }
 /* IntTests Not a pure module */

test/TestSuite.res

@@ -3,3 +3,4 @@ include PromiseTest
 include ErrorTests
 include ArrayTests
 include IntTests
+include ResultTests