feat(maybe): add a function to convert maybe to an rxjs observable (#128)

* feat(maybe): add a function to convert maybe to an rxjs observable

* chore: update package-lock

Author: williamareynolds

package-lock.json

@@ -39,11 +39,13 @@
     "@types/jest": "^25.1.3",
     "@types/node": "^13.7.4",
     "codecov": "^3.6.5",
+    "fast-check": "^1.22.2",
     "fs-extra": "^8.1.0",
     "istanbul": "^0.4.5",
     "jest": "25.1.0",
     "jest-junit": "^10.0.0",
     "rollup": "^1.31.1",
+    "rxjs": "^6.5.4",
     "semantic-release": "^17.0.4",
     "terser": "^4.6.3",
     "ts-jest": "^25.2.1",
@@ -53,7 +55,8 @@
     "typescript": "^3.7.5"
   },
   "peerDependencies": {
-    "tslib": "^1.11.0"
+    "tslib": "^1.11.0",
+    "rxjs": "^6.0"
   },
   "jest": {
     "testURL": "http://localhost",

package.json

@@ -8,14 +8,26 @@ export default [
       name: 'monads',
       file: `dist/${pkg.main}`,
       format: 'umd',
+      globals: {
+        rxjs: 'rxjs',
+        'rxjs/operators': 'rxjs/operators'
+      },
       sourcemap: true
     },
+    external: [
+      'rxjs',
+      'rxjs/operators'
+    ]
   },
   {
   input: 'src/index.ts',
   output: [
     { file: `dist/${pkg.module}`, format: 'es', sourcemap: true },
     { file: `dist/${pkg.commonJs}`, format: 'cjs', sourcemap: true }
   ],
+  external: [
+    'rxjs',
+    'rxjs/operators'
+  ],
   plugins: [typescript()]
 }]

rollup.config.js

@@ -1,2 +1,5 @@
 export * from './monads/index'
 export * from './interfaces/index'
+export {
+  maybeToObservable
+} from './util/index'

src/index.ts

@@ -6,4 +6,7 @@ export {
   curry5,
   curry6,
   curry7
-} from './curry'
+} from './curry'
+export {
+  maybeToObservable
+} from './maybe/maybe-to-observable'

src/util/index.ts

@@ -1,4 +1,4 @@
-import { reader, maybe } from '..'
+import { reader, maybe } from '../monads/index'
 
 export interface GetFromEnvironmentReader {
   readEnv(key: string): string | undefined
@@ -15,4 +15,4 @@ const maybeFromEnvReader = (key: string) => (reader: GetFromEnvironmentReader) =
 export function maybeEnv(key: string, config?: GetFromEnvironmentReader) {
   return reader(maybeFromEnvReader(key))
     .run(maybe(config).valueOr(DEFAULT_NODE_ENV_READER))
-}
+}

src/util/maybe-env.ts

@@ -0,0 +1,28 @@
+import { IMaybe } from '../../interfaces'
+import { EMPTY, Observable, of } from 'rxjs'
+import { take } from 'rxjs/operators'
+
+/**
+ * Convert a Maybe into an observable
+ *
+ * If the Maybe is empty, the observable will immediately complete without emitting a value, otherwise it will emit
+ * the value contained and complete.
+ *
+ * @requires rxjs@^6.0
+ * @example
+ * of(maybe(5)).pipe(
+ *   flatMap(maybeToObservable)
+ * ).subscribe(a => console.log(a))
+ * // prints 5 and completes
+ *
+ * of(maybe()).pipe(
+ *   flatMap(maybeToObservable)
+ * ).subscribe(a => console.log(a))
+ * // immediately completes with no emitted value
+ */
+export const maybeToObservable = <A>(m: IMaybe<A>): Observable<A> => {
+  return m.isNone()
+    ? EMPTY
+    : of(m.valueOrThrow('isNone returned false for empty IMaybe.'))
+      .pipe(take(1))
+}

src/util/maybe/maybe-to-observable.ts

@@ -0,0 +1,38 @@
+import { assert, integer, property } from 'fast-check'
+import { maybe } from '../../../src/monads'
+import { maybeToObservable } from '../../../src/util'
+import { merge, of } from 'rxjs'
+import { count } from 'rxjs/operators'
+
+describe('maybeToObservable', () => {
+  const numRuns = 100
+  it('emits a value when containing a value', () => {
+    expect.assertions(numRuns)
+    assert(
+      property(
+        integer(),
+        a => {
+          const m = maybe(a)
+          const o = maybeToObservable(m)
+          o.subscribe(val => expect(val).toBe(a))
+        }
+      ), {
+        numRuns
+      }
+    )
+  })
+
+  it('immediately completes if there is no contained value', done => {
+
+    const m = maybe()
+    const o = maybeToObservable(m)
+    const c = of(1)
+
+    merge(o, c)
+      .pipe(count())
+      .subscribe(count => {
+        expect(count).toBe(1)
+        done()
+      })
+  })
+})