feat(operator): add min operator

Author: adrianomelo

spec/operators/min-spec.js

@@ -0,0 +1,164 @@
+/* globals describe, it, expect, expectObservable, hot */
+var Rx = require('../../dist/cjs/Rx.KitchenSink');
+var Observable = Rx.Observable;
+
+describe('min', function () {
+  it('should be never when source is never', function () {
+    var e1 = Observable.never();
+    var expected = '-';
+    expectObservable(e1.min()).toBe(expected);
+  });
+
+  it('should be zero when source is empty', function () {
+    var e1 = Observable.empty();
+    var expected = '|';
+    expectObservable(e1.min()).toBe(expected);
+  });
+
+  it('should be never when source doesn\'t complete', function () {
+    var e1 = hot('--x--^--y--');
+    var expected =    '------';
+    expectObservable(e1.min()).toBe(expected);
+  });
+
+  it('should be completes when source doesn\'t have values', function () {
+    var e1 = hot('-x-^---|');
+    var expected =  '----|';
+    expectObservable(e1.min()).toBe(expected);
+  });
+
+  it('should min the unique value of an observable', function () {
+    var e1 = hot('-x-^--y--|', { y: 42 });
+    var expected =  '------(w|)';
+    expectObservable(e1.min()).toBe(expected, { w: 42 });
+  });
+
+  it('should min the values of an observable', function () {
+    var source = hot('--a--b--c--|', { a: 42, b: -1, c: 0 });
+    var expected =   '-----------(x|)';
+    expectObservable(source.min()).toBe(expected, { x: -1 });
+  });
+
+  it('should min the values of an ongoing hot observable', function () {
+    var source = hot('--a-^-b--c--d--|', { a: 42, b: -1, c: 0, d: 666 });
+    var expected =       '-----------(x|)';
+    expectObservable(source.min()).toBe(expected, { x: -1 });
+  });
+
+  it('should min a range() source observable', function (done) {
+    Rx.Observable.range(1, 10000).min().subscribe(
+      function (value) {
+        expect(value).toEqual(1);
+      },
+      done.fail,
+      done
+    );
+  });
+
+  it('should min a range().skip(1) source observable', function (done) {
+    Rx.Observable.range(1, 10).skip(1).min().subscribe(
+      function (value) {
+        expect(value).toEqual(2);
+      },
+      done.fail,
+      done
+    );
+  });
+
+  it('should min a range().take(1) source observable', function (done) {
+    Rx.Observable.range(1, 10).take(1).min().subscribe(
+      function (value) {
+        expect(value).toEqual(1);
+      },
+      done.fail,
+      done
+    );
+  });
+
+  it('should work with error', function () {
+    var e1 = hot('-x-^--y--z--#', { x: 1, y: 2, z: 3 }, 'too bad');
+    var expected =  '---------#';
+    expectObservable(e1.min()).toBe(expected, null, 'too bad');
+  });
+
+  it('should work with throw', function () {
+    var e1 = Observable.throw(new Error('too bad'));
+    var expected = '#';
+    expectObservable(e1.min()).toBe(expected, null, new Error('too bad'));
+  });
+
+  it('should handle a constant predicate on an empty hot observable', function () {
+    var e1 = hot('-x-^---|');
+    var expected =  '----|';
+    var predicate = function (x, y) {
+      return 42;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected);
+  });
+
+  it('should handle a constant predicate on an never hot observable', function () {
+    var e1 = hot('-x-^----');
+    var expected =  '-';
+    var predicate = function (x, y) {
+      return 42;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected);
+  });
+
+  it('should handle a constant predicate on a simple hot observable', function () {
+    var e1 = hot('-x-^-a-|', { a: 1 });
+    var expected =  '----(w|)';
+    var predicate = function () {
+      return 42;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected, { w: 1 });
+  });
+
+  it('should handle a constant predicate on observable with many values', function () {
+    var e1 = hot('-x-^-a-b-c-d-e-f-g-|');
+    var expected =  '----------------(w|)';
+    var predicate = function () {
+      return 42;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected, { w: 42 });
+  });
+
+  it('should handle a predicate on observable with many values', function () {
+    var e1 = hot('-a-^-b--c--d-|', { a: 42, b: -1, c: 0, d: 666 });
+    var expected =  '----------(w|)';
+    var predicate = function (x, y) {
+      return Math.max(x, y);
+    };
+    expectObservable(e1.min(predicate)).toBe(expected, { w: 666 });
+  });
+
+  it('should handle a predicate for string on observable with many values', function () {
+    var e1 = hot('-1-^-2--3--4-|');
+    var expected =  '----------(w|)';
+    var predicate = function (x, y) {
+      return x < y ? x : y;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected, { w: '2' });
+  });
+
+  it('should handle a constant predicate on observable that throws', function () {
+    var e1 = hot('-1-^---#');
+    var expected =  '----#';
+    var predicate = function () {
+      return 42;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected);
+  });
+
+  it('should handle a predicate that throws, on observable with many values', function () {
+    var e1 = hot('-1-^-2--3--|');
+    var expected =  '-----#';
+    var predicate = function (x, y) {
+      if (y === '3') {
+        throw 'error';
+      }
+      return x > y ? x : y;
+    };
+    expectObservable(e1.min(predicate)).toBe(expected);
+  });
+});

src/Rx.KitchenSink.ts

@@ -10,6 +10,7 @@ interface KitchenSinkOperators<T> extends CoreOperators<T> {
   find?: (predicate: (value: T, index: number, source: Observable<T>) => boolean, thisArg?: any) => Observable<T>;
   findIndex?: (predicate: (value: T, index: number, source: Observable<T>) => boolean, thisArg?: any) => Observable<number>;
   max?: <T, R>(comparer?: (x: R, y: T) => R) => Observable<R>;
+  min?: <T, R>(comparer?: (x: R, y: T) => R) => Observable<R>;
   timeInterval?: <T>(scheduler?: IScheduler) => Observable<T>;
 }
 
@@ -195,6 +196,9 @@ import mergeMapTo from './operators/mergeMapTo';
 observableProto.mergeMapTo = mergeMapTo;
 observableProto.flatMapTo = mergeMapTo;
 
+import min from './operators/extended/min';
+observableProto.min = min;
+
 import multicast from './operators/multicast';
 observableProto.multicast = multicast;
 

src/operators/extended/min.ts

@@ -0,0 +1,9 @@
+import Observable from '../../Observable';
+import { ReduceOperator } from '../reduce-support';
+
+export default function min<T, R>(comparer?: (x: R, y: T) => R): Observable<R> {
+  const min = (typeof comparer === 'function')
+    ? comparer
+    : (x, y) => x < y ? x : y;
+  return this.lift(new ReduceOperator(min));
+}