MichaelSolati / geofirestore-core / #56

Build # #56

Build Type

push

Committed by

Commit Message

<a href="https://github.com/MichaelSolati/geofirestore-core/commit/<a class=hub.com/MichaelSolati/geofirestore-core/commit/e185590a54ff28ae80cd292f5837f4fa9b864cdf">e185590a5<a href="https://github.com/MichaelSolati/geofirestore-core/commit/e185590a54ff28ae80cd292f5837f4fa9b864cdf">">Merge </a><a class="double-link" href="https://github.com/MichaelSolati/geofirestore-core/commit/<a class="double-link" href="https://github.com/MichaelSolati/geofirestore-core/commit/bbb000f54d82e813a3bff15abbd2283549072935">bbb000f54</a>">bbb000f54</a><a href="https://github.com/MichaelSolati/geofirestore-core/commit/e185590a54ff28ae80cd292f5837f4fa9b864cdf"> into ea0fff8fe">ea0fff8fe</a>

Run Details

166 of 220 branches covered (75.45%)

Branch coverage included in aggregate %.

7 of 7 new or added lines in 3 files covered. (100.0%)

264 of 320 relevant lines covered (82.5%)

17146.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

47.62

/src/api/snapshot.ts

import {validateLocation} from './validate';
import {GeoFirestoreTypes} from '../definitions';
import {generateGeoQueryDocumentSnapshot} from '../utils';

/**
 * A `GeoQuerySnapshot` contains zero or more `QueryDocumentSnapshot` objects
 * representing the results of a query. The documents can be accessed as an
 * array via the `docs` property or enumerated using the `forEach` method. The
 * number of documents can be determined via the `empty` and `size`
 * properties.
 */
export class GeoQuerySnapshot {
  private _docs: GeoFirestoreTypes.QueryDocumentSnapshot[];

  /**
   * @param _querySnapshot The `QuerySnapshot` instance.
   * @param geoQueryCriteria The center and radius of geo based queries.
   */
  constructor(
    private _querySnapshot:
      | GeoFirestoreTypes.compat.QuerySnapshot
      | GeoFirestoreTypes.admin.QuerySnapshot,
    private _center?:
      | GeoFirestoreTypes.admin.GeoPoint
      | GeoFirestoreTypes.compat.GeoPoint
  ) {
    if (_center) {
      // Validate the _center coordinates
      validateLocation(_center);
    }

    this._docs = (
      _querySnapshot as GeoFirestoreTypes.admin.QuerySnapshot
    ).docs.map((snapshot: GeoFirestoreTypes.admin.QueryDocumentSnapshot) =>
      generateGeoQueryDocumentSnapshot(snapshot, _center)
    );
  }

  /** The native `QuerySnapshot` instance. */
  get native():
    | GeoFirestoreTypes.admin.QuerySnapshot
    | GeoFirestoreTypes.compat.QuerySnapshot {
    return this._querySnapshot;
  }

  /** An array of all the documents in the GeoQuerySnapshot. */
  get docs(): GeoFirestoreTypes.QueryDocumentSnapshot[] {
    return this._docs;
  }

  /** The number of documents in the GeoQuerySnapshot. */
  get size(): number {
    return this._docs.length;
  }

  /** True if there are no documents in the GeoQuerySnapshot. */
  get empty(): boolean {
    return !this._docs.length;
  }

  /**
   * Returns an array of the documents changes since the last snapshot. If
   * this is the first snapshot, all documents will be in the list as added
   * changes.
   *
   * @returns Array of DocumentChanges.
   */
  docChanges(): GeoFirestoreTypes.DocumentChange[] {
    const docChanges = Array.isArray(this._querySnapshot.docChanges)
      ? (this._querySnapshot
          .docChanges as any as GeoFirestoreTypes.compat.DocumentChange[])
      : this._querySnapshot.docChanges();
    return (docChanges as GeoFirestoreTypes.compat.DocumentChange[]).map(
      (change: GeoFirestoreTypes.compat.DocumentChange) => {
        return {
          doc: generateGeoQueryDocumentSnapshot(change.doc, this._center),
          newIndex: change.newIndex,
          oldIndex: change.oldIndex,
          type: change.type,
        };
      }
    );
  }

  /**
   * Enumerates all of the documents in the GeoQuerySnapshot.
   *
   * @param callback A callback to be called with a `DocumentSnapshot` for
   * each document in the snapshot.
   * @param thisArg The `this` binding for the callback.
   */
  forEach(
    callback: (result: GeoFirestoreTypes.QueryDocumentSnapshot) => void,
    thisArg?: any
  ): void {
    this.docs.forEach(callback, thisArg);
  }
}

1	import {validateLocation} from './validate';	1✔
2	import {GeoFirestoreTypes} from '../definitions';
3	import {generateGeoQueryDocumentSnapshot} from '../utils';	1✔
4
5	/**
6	* A `GeoQuerySnapshot` contains zero or more `QueryDocumentSnapshot` objects
7	* representing the results of a query. The documents can be accessed as an
8	* array via the `docs` property or enumerated using the `forEach` method. The
9	* number of documents can be determined via the `empty` and `size`
10	* properties.
11	*/
12	export class GeoQuerySnapshot {	1✔
13	private _docs: GeoFirestoreTypes.QueryDocumentSnapshot[];
14
15	/**
16	* @param _querySnapshot The `QuerySnapshot` instance.
17	* @param geoQueryCriteria The center and radius of geo based queries.
18	*/
19	constructor(
20	private _querySnapshot:	1✔
21	\| GeoFirestoreTypes.compat.QuerySnapshot
22	\| GeoFirestoreTypes.admin.QuerySnapshot,
23	private _center?:	1✔
24	\| GeoFirestoreTypes.admin.GeoPoint
25	\| GeoFirestoreTypes.compat.GeoPoint
26	) {
27	if (_center) {	1!
28	// Validate the _center coordinates
29	validateLocation(_center);	1✔
30	}
31
32	this._docs = (	1✔
33	_querySnapshot as GeoFirestoreTypes.admin.QuerySnapshot
34	).docs.map((snapshot: GeoFirestoreTypes.admin.QueryDocumentSnapshot) =>
35	generateGeoQueryDocumentSnapshot(snapshot, _center)	2✔
36	);
37	}
38
39	/** The native `QuerySnapshot` instance. */
40	get native():
41	\| GeoFirestoreTypes.admin.QuerySnapshot
42	\| GeoFirestoreTypes.compat.QuerySnapshot {
43	return this._querySnapshot;	×
44	}
45
46	/** An array of all the documents in the GeoQuerySnapshot. */
47	get docs(): GeoFirestoreTypes.QueryDocumentSnapshot[] {
48	return this._docs;	×
49	}
50
51	/** The number of documents in the GeoQuerySnapshot. */
52	get size(): number {
53	return this._docs.length;	×
54	}
55
56	/** True if there are no documents in the GeoQuerySnapshot. */
57	get empty(): boolean {
58	return !this._docs.length;	×
59	}
60
61	/**
62	* Returns an array of the documents changes since the last snapshot. If
63	* this is the first snapshot, all documents will be in the list as added
64	* changes.
65	*
66	* @returns Array of DocumentChanges.
67	*/
68	docChanges(): GeoFirestoreTypes.DocumentChange[] {
69	const docChanges = Array.isArray(this._querySnapshot.docChanges)	×
70	? (this._querySnapshot
71	.docChanges as any as GeoFirestoreTypes.compat.DocumentChange[])
72	: this._querySnapshot.docChanges();
73	return (docChanges as GeoFirestoreTypes.compat.DocumentChange[]).map(	×
74	(change: GeoFirestoreTypes.compat.DocumentChange) => {
75	return {	×
76	doc: generateGeoQueryDocumentSnapshot(change.doc, this._center),
77	newIndex: change.newIndex,
78	oldIndex: change.oldIndex,
79	type: change.type,
80	};
81	}
82	);
83	}
84
85	/**
86	* Enumerates all of the documents in the GeoQuerySnapshot.
87	*
88	* @param callback A callback to be called with a `DocumentSnapshot` for
89	* each document in the snapshot.
90	* @param thisArg The `this` binding for the callback.
91	*/
92	forEach(
93	callback: (result: GeoFirestoreTypes.QueryDocumentSnapshot) => void,
94	thisArg?: any
95	): void {
96	this.docs.forEach(callback, thisArg);	×
97	}
98	}

MichaelSolati / geofirestore-core / #56

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous