From 03451b0f3a132d6fd736e104b83c3df78d69c2bf Mon Sep 17 00:00:00 2001
From: futpib <futpib@gmail.com>
Date: Wed, 31 Jul 2019 15:32:49 +0300
Subject: [PATCH] Add `fromLeft` and `fromRight`

Co-authored-by: David Chambers <dc@davidchambers.me>
---
 index.js          | 55 +++++++++++++++++++++++++++++++++++++++++++++--
 test/fromLeft.js  | 15 +++++++++++++
 test/fromRight.js | 15 +++++++++++++
 3 files changed, 83 insertions(+), 2 deletions(-)
 create mode 100644 test/fromLeft.js
 create mode 100644 test/fromRight.js

diff --git a/index.js b/index.js
index b9fa21fa..f0f62a55 100644
--- a/index.js
+++ b/index.js
@@ -2079,7 +2079,7 @@
   //. a Just, the return value is the result of applying the function to
   //. the Just's value. Otherwise, the first argument is returned.
   //.
-  //. See also [`maybe_`](#maybe_).
+  //. See also [`maybe_`](#maybe_) and [`fromMaybe`](#fromMaybe).
   //.
   //. ```javascript
   //. > S.maybe (0) (S.prop ('length')) (S.Just ('refuge'))
@@ -2133,7 +2133,7 @@
   //. Takes a default value and a Maybe, and returns the Maybe's value
   //. if the Maybe is a Just; the default value otherwise.
   //.
-  //. See also [`fromMaybe_`](#fromMaybe_) and
+  //. See also [`maybe`](#maybe), [`fromMaybe_`](#fromMaybe_), and
   //. [`maybeToNullable`](#maybeToNullable).
   //.
   //. ```javascript
@@ -2342,6 +2342,8 @@
   //. is a Left, or the result of applying the second function to the
   //. Right's value, if the Either is a Right.
   //.
+  //. See also [`fromLeft`](#fromLeft) and [`fromRight`](#fromRight).
+  //.
   //. ```javascript
   //. > S.either (S.toUpper) (S.show) (S.Left ('Cannot divide by zero'))
   //. 'CANNOT DIVIDE BY ZERO'
@@ -2362,11 +2364,60 @@
     impl: either
   };
 
+  //# fromLeft :: a -> Either a b -> a
+  //.
+  //. Takes a default value and an Either, and returns the Left value
+  //. if the Either is a Left; the default value otherwise.
+  //.
+  //. See also [`either`](#either) and [`fromRight`](#fromRight).
+  //.
+  //. ```javascript
+  //. > S.fromLeft ('abc') (S.Left ('xyz'))
+  //. 'xyz'
+  //.
+  //. > S.fromLeft ('abc') (S.Right (123))
+  //. 'abc'
+  //. ```
+  function fromLeft(x) {
+    return either (I) (K (x));
+  }
+  _.fromLeft = {
+    consts: {},
+    types: [a, $.Either (a) (b), a],
+    impl: fromLeft
+  };
+
+  //# fromRight :: b -> Either a b -> b
+  //.
+  //. Takes a default value and an Either, and returns the Right value
+  //. if the Either is a Right; the default value otherwise.
+  //.
+  //. See also [`either`](#either) and [`fromLeft`](#fromLeft).
+  //.
+  //. ```javascript
+  //. > S.fromRight (123) (S.Right (789))
+  //. 789
+  //.
+  //. > S.fromRight (123) (S.Left ('abc'))
+  //. 123
+  //. ```
+  function fromRight(x) {
+    return either (K (x)) (I);
+  }
+  _.fromRight = {
+    consts: {},
+    types: [b, $.Either (a) (b), b],
+    impl: fromRight
+  };
+
   //# fromEither :: b -> Either a b -> b
   //.
   //. Takes a default value and an Either, and returns the Right value
   //. if the Either is a Right; the default value otherwise.
   //.
+  //. The behaviour of `fromEither` is likely to change in a future release.
+  //. Please use [`fromRight`](#fromRight) instead.
+  //.
   //. ```javascript
   //. > S.fromEither (0) (S.Right (42))
   //. 42
diff --git a/test/fromLeft.js b/test/fromLeft.js
new file mode 100644
index 00000000..eab9f80f
--- /dev/null
+++ b/test/fromLeft.js
@@ -0,0 +1,15 @@
+'use strict';
+
+const S = require ('..');
+
+const eq = require ('./internal/eq');
+
+
+test ('fromLeft', () => {
+
+  eq (S.show (S.fromLeft)) ('fromLeft :: a -> Either a b -> a');
+
+  eq (S.fromLeft ('abc') (S.Left ('xyz'))) ('xyz');
+  eq (S.fromLeft ('abc') (S.Right (123))) ('abc');
+
+});
diff --git a/test/fromRight.js b/test/fromRight.js
new file mode 100644
index 00000000..ac554eef
--- /dev/null
+++ b/test/fromRight.js
@@ -0,0 +1,15 @@
+'use strict';
+
+const S = require ('..');
+
+const eq = require ('./internal/eq');
+
+
+test ('fromRight', () => {
+
+  eq (S.show (S.fromRight)) ('fromRight :: b -> Either a b -> b');
+
+  eq (S.fromRight (123) (S.Right (789))) (789);
+  eq (S.fromRight (123) (S.Left ('abc'))) (123);
+
+});