Skip to content

Commit

Permalink
feat(sequenceEqual): add higher-order lettable version of sequenceEqual
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonaden committed Sep 6, 2017
1 parent ba6a9ce commit 7cd3165
Show file tree
Hide file tree
Showing 3 changed files with 166 additions and 104 deletions.
106 changes: 2 additions & 104 deletions src/operator/sequenceEqual.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { Operator } from '../Operator';
import { Observer } from '../Observer';
import { Observable } from '../Observable';
import { Subscriber } from '../Subscriber';
import { tryCatch } from '../util/tryCatch';
import { errorObject } from '../util/errorObject';
import { sequenceEqual as higherOrder } from '../operators/sequenceEqual';

/**
* Compares all values of two observables in sequence using an optional comparor function
Expand Down Expand Up @@ -59,103 +55,5 @@ import { errorObject } from '../util/errorObject';
*/
export function sequenceEqual<T>(this: Observable<T>, compareTo: Observable<T>,
comparor?: (a: T, b: T) => boolean): Observable<boolean> {
return this.lift(new SequenceEqualOperator(compareTo, comparor));
}

export class SequenceEqualOperator<T> implements Operator<T, boolean> {
constructor(private compareTo: Observable<T>,
private comparor: (a: T, b: T) => boolean) {
}

call(subscriber: Subscriber<boolean>, source: any): any {
return source.subscribe(new SequenceEqualSubscriber(subscriber, this.compareTo, this.comparor));
}
}

/**
* We need this JSDoc comment for affecting ESDoc.
* @ignore
* @extends {Ignored}
*/
export class SequenceEqualSubscriber<T, R> extends Subscriber<T> {
private _a: T[] = [];
private _b: T[] = [];
private _oneComplete = false;

constructor(destination: Observer<R>,
private compareTo: Observable<T>,
private comparor: (a: T, b: T) => boolean) {
super(destination);
this.add(compareTo.subscribe(new SequenceEqualCompareToSubscriber(destination, this)));
}

protected _next(value: T): void {
if (this._oneComplete && this._b.length === 0) {
this.emit(false);
} else {
this._a.push(value);
this.checkValues();
}
}

public _complete(): void {
if (this._oneComplete) {
this.emit(this._a.length === 0 && this._b.length === 0);
} else {
this._oneComplete = true;
}
}

checkValues() {
const { _a, _b, comparor } = this;
while (_a.length > 0 && _b.length > 0) {
let a = _a.shift();
let b = _b.shift();
let areEqual = false;
if (comparor) {
areEqual = tryCatch(comparor)(a, b);
if (areEqual === errorObject) {
this.destination.error(errorObject.e);
}
} else {
areEqual = a === b;
}
if (!areEqual) {
this.emit(false);
}
}
}

emit(value: boolean) {
const { destination } = this;
destination.next(value);
destination.complete();
}

nextB(value: T) {
if (this._oneComplete && this._a.length === 0) {
this.emit(false);
} else {
this._b.push(value);
this.checkValues();
}
}
}

class SequenceEqualCompareToSubscriber<T, R> extends Subscriber<T> {
constructor(destination: Observer<R>, private parent: SequenceEqualSubscriber<T, R>) {
super(destination);
}

protected _next(value: T): void {
this.parent.nextB(value);
}

protected _error(err: any): void {
this.parent.error(err);
}

protected _complete(): void {
this.parent._complete();
}
return higherOrder(compareTo, comparor)(this);
}
1 change: 1 addition & 0 deletions src/operators/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export { refCount } from './refCount';
export { sample } from './sample';
export { sampleTime } from './sampleTime';
export { scan } from './scan';
export { sequenceEqual } from './sequenceEqual';
export { subscribeOn } from './subscribeOn';
export { switchAll } from './switchAll';
export { switchMap } from './switchMap';
Expand Down
163 changes: 163 additions & 0 deletions src/operators/sequenceEqual.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
import { Operator } from '../Operator';
import { Observer } from '../Observer';
import { Observable } from '../Observable';
import { Subscriber } from '../Subscriber';
import { tryCatch } from '../util/tryCatch';
import { errorObject } from '../util/errorObject';

import { OperatorFunction } from '../interfaces';

/**
* Compares all values of two observables in sequence using an optional comparor function
* and returns an observable of a single boolean value representing whether or not the two sequences
* are equal.
*
* <span class="informal">Checks to see of all values emitted by both observables are equal, in order.</span>
*
* <img src="./img/sequenceEqual.png" width="100%">
*
* `sequenceEqual` subscribes to two observables and buffers incoming values from each observable. Whenever either
* observable emits a value, the value is buffered and the buffers are shifted and compared from the bottom
* up; If any value pair doesn't match, the returned observable will emit `false` and complete. If one of the
* observables completes, the operator will wait for the other observable to complete; If the other
* observable emits before completing, the returned observable will emit `false` and complete. If one observable never
* completes or emits after the other complets, the returned observable will never complete.
*
* @example <caption>figure out if the Konami code matches</caption>
* var code = Rx.Observable.from([
* "ArrowUp",
* "ArrowUp",
* "ArrowDown",
* "ArrowDown",
* "ArrowLeft",
* "ArrowRight",
* "ArrowLeft",
* "ArrowRight",
* "KeyB",
* "KeyA",
* "Enter" // no start key, clearly.
* ]);
*
* var keys = Rx.Observable.fromEvent(document, 'keyup')
* .map(e => e.code);
* var matches = keys.bufferCount(11, 1)
* .mergeMap(
* last11 =>
* Rx.Observable.from(last11)
* .sequenceEqual(code)
* );
* matches.subscribe(matched => console.log('Successful cheat at Contra? ', matched));
*
* @see {@link combineLatest}
* @see {@link zip}
* @see {@link withLatestFrom}
*
* @param {Observable} compareTo The observable sequence to compare the source sequence to.
* @param {function} [comparor] An optional function to compare each value pair
* @return {Observable} An Observable of a single boolean value representing whether or not
* the values emitted by both observables were equal in sequence.
* @method sequenceEqual
* @owner Observable
*/
export function sequenceEqual<T>(compareTo: Observable<T>,
comparor?: (a: T, b: T) => boolean): OperatorFunction<T, boolean> {
return (source: Observable<T>) => source.lift(new SequenceEqualOperator(compareTo, comparor));
}

export class SequenceEqualOperator<T> implements Operator<T, boolean> {
constructor(private compareTo: Observable<T>,
private comparor: (a: T, b: T) => boolean) {
}

call(subscriber: Subscriber<boolean>, source: any): any {
return source.subscribe(new SequenceEqualSubscriber(subscriber, this.compareTo, this.comparor));
}
}

/**
* We need this JSDoc comment for affecting ESDoc.
* @ignore
* @extends {Ignored}
*/
export class SequenceEqualSubscriber<T, R> extends Subscriber<T> {
private _a: T[] = [];
private _b: T[] = [];
private _oneComplete = false;

constructor(destination: Observer<R>,
private compareTo: Observable<T>,
private comparor: (a: T, b: T) => boolean) {
super(destination);
this.add(compareTo.subscribe(new SequenceEqualCompareToSubscriber(destination, this)));
}

protected _next(value: T): void {
if (this._oneComplete && this._b.length === 0) {
this.emit(false);
} else {
this._a.push(value);
this.checkValues();
}
}

public _complete(): void {
if (this._oneComplete) {
this.emit(this._a.length === 0 && this._b.length === 0);
} else {
this._oneComplete = true;
}
}

checkValues() {
const { _a, _b, comparor } = this;
while (_a.length > 0 && _b.length > 0) {
let a = _a.shift();
let b = _b.shift();
let areEqual = false;
if (comparor) {
areEqual = tryCatch(comparor)(a, b);
if (areEqual === errorObject) {
this.destination.error(errorObject.e);
}
} else {
areEqual = a === b;
}
if (!areEqual) {
this.emit(false);
}
}
}

emit(value: boolean) {
const { destination } = this;
destination.next(value);
destination.complete();
}

nextB(value: T) {
if (this._oneComplete && this._a.length === 0) {
this.emit(false);
} else {
this._b.push(value);
this.checkValues();
}
}
}

class SequenceEqualCompareToSubscriber<T, R> extends Subscriber<T> {
constructor(destination: Observer<R>, private parent: SequenceEqualSubscriber<T, R>) {
super(destination);
}

protected _next(value: T): void {
this.parent.nextB(value);
}

protected _error(err: any): void {
this.parent.error(err);
}

protected _complete(): void {
this.parent._complete();
}
}

0 comments on commit 7cd3165

Please sign in to comment.