combined methos for sorted and unsorted queries by using sorted parameter

Author: mtrezza

integration/test/ParseGeoPointTest.js

@@ -73,7 +73,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(24, 19);
       query.equalTo('construct', 'line');
-      query.withinMiles('location', point, 10000);
+      query.withinMiles('location', point, 10000, true);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 10);
@@ -97,7 +97,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'large_dist');
-      query.withinRadians('location', point, 3.14);
+      query.withinRadians('location', point, 3.14, true);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 3);
@@ -119,7 +119,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'medium_dist');
-      query.withinRadians('location', point, 3.14 * 0.5);
+      query.withinRadians('location', point, 3.14 * 0.5, true);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 2);
@@ -143,7 +143,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'small_dist');
-      query.withinRadians('location', point, 3.14 * 0.25);
+      query.withinRadians('location', point, 3.14 * 0.25, true);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 1);
@@ -155,7 +155,7 @@ describe('Geo Point', () => {
   it('can measure distance within km - everywhere', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometers('location', sfo, 4000.0);
+    query.withinKilometers('location', sfo, 4000.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 3);
       done();
@@ -165,7 +165,7 @@ describe('Geo Point', () => {
   it('can measure distance within km - california', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometers('location', sfo, 3700.0);
+    query.withinKilometers('location', sfo, 3700.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 2);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -177,7 +177,7 @@ describe('Geo Point', () => {
   it('can measure distance within km - bay area', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometers('location', sfo, 100.0);
+    query.withinKilometers('location', sfo, 100.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 1);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -188,7 +188,7 @@ describe('Geo Point', () => {
   it('can measure distance within km - mid peninsula', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometers('location', sfo, 10.0);
+    query.withinKilometers('location', sfo, 10.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 0);
       done();
@@ -198,7 +198,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles - everywhere', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMiles('location', sfo, 2500.0);
+    query.withinMiles('location', sfo, 2500.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 3);
       done();
@@ -208,7 +208,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles - california', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMiles('location', sfo, 2200.0);
+    query.withinMiles('location', sfo, 2200.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 2);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -220,7 +220,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles - bay area', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMiles('location', sfo, 75.0);
+    query.withinMiles('location', sfo, 75.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 1);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -231,7 +231,7 @@ describe('Geo Point', () => {
   it('can measure distance within km - mid peninsula', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMiles('location', sfo, 10.0);
+    query.withinMiles('location', sfo, 10.0, true);
     query.find().then((results) => {
       assert.equal(results.length, 0);
       done();
@@ -252,7 +252,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'large_dist');
-      query.withinRadiansUnsorted('location', point, 3.14);
+      query.withinRadians('location', point, 3.14, false);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 3);
@@ -274,7 +274,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'medium_dist');
-      query.withinRadiansUnsorted('location', point, 3.14 * 0.5);
+      query.withinRadians('location', point, 3.14 * 0.5, false);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 2);
@@ -298,7 +298,7 @@ describe('Geo Point', () => {
       let query = new Parse.Query(TestObject);
       let point = new Parse.GeoPoint(1, -1);
       query.equalTo('construct', 'small_dist');
-      query.withinRadiansUnsorted('location', point, 3.14 * 0.25);
+      query.withinRadians('location', point, 3.14 * 0.25, false);
       return query.find();
     }).then((results) => {
       assert.equal(results.length, 1);
@@ -310,7 +310,7 @@ describe('Geo Point', () => {
   it('can measure distance within km unsorted - everywhere', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometersUnsorted('location', sfo, 4000.0);
+    query.withinKilometers('location', sfo, 4000.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 3);
       done();
@@ -320,7 +320,7 @@ describe('Geo Point', () => {
   it('can measure distance within km unsorted - california', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometersUnsorted('location', sfo, 3700.0);
+    query.withinKilometers('location', sfo, 3700.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 2);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -332,7 +332,7 @@ describe('Geo Point', () => {
   it('can measure distance within km unsorted - bay area', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometersUnsorted('location', sfo, 100.0);
+    query.withinKilometers('location', sfo, 100.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 1);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -343,7 +343,7 @@ describe('Geo Point', () => {
   it('can measure distance within km unsorted - mid peninsula', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinKilometersUnsorted('location', sfo, 10.0);
+    query.withinKilometers('location', sfo, 10.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 0);
       done();
@@ -353,7 +353,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles unsorted - everywhere', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMilesUnsorted('location', sfo, 2500.0);
+    query.withinMiles('location', sfo, 2500.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 3);
       done();
@@ -363,7 +363,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles unsorted - california', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMilesUnsorted('location', sfo, 2200.0);
+    query.withinMiles('location', sfo, 2200.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 2);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -375,7 +375,7 @@ describe('Geo Point', () => {
   it('can measure distance within miles unsorted - bay area', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMilesUnsorted('location', sfo, 75.0);
+    query.withinMiles('location', sfo, 75.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 1);
       assert.equal(results[0].get('name'), 'San Francisco');
@@ -386,7 +386,7 @@ describe('Geo Point', () => {
   it('can measure distance within km unsorted - mid peninsula', (done) => {
     let sfo = new Parse.GeoPoint(37.6189722, -122.3748889);
     let query = new Parse.Query(TestPoint);
-    query.withinMilesUnsorted('location', sfo, 10.0);
+    query.withinMiles('location', sfo, 10.0, false);
     query.find().then((results) => {
       assert.equal(results.length, 0);
       done();

src/ParseQuery.js

@@ -1100,88 +1100,49 @@ class ParseQuery {
    * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
    * @param {Number} maxDistance Maximum distance (in radians) of results to
    *   return.
+   * @param {Boolean} sorted A Bool value that is true if results should be
+   *   sorted by distance ascending, false is no sorting is required.
    * @return {Parse.Query} Returns the query, so you can chain this call.
    */
-  withinRadians(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    this.near(key, point);
-    return this._addCondition(key, '$maxDistance', distance);
-  }
-
-  /**
-   * Adds a proximity based constraint for finding objects with key point
-   * values near the point given and within the maximum distance given.
-   * Radius of earth used is 3958.8 miles.
-   * @param {String} key The key that the Parse.GeoPoint is stored in.
-   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
-   * @param {Number} maxDistance Maximum distance (in miles) of results to
-   *     return.
-   * @return {Parse.Query} Returns the query, so you can chain this call.
-   */
-  withinMiles(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    return this.withinRadians(key, point, distance / 3958.8);
-  }
-
-  /**
-   * Adds a proximity based constraint for finding objects with key point
-   * values near the point given and within the maximum distance given.
-   * Radius of earth used is 6371.0 kilometers.
-   * @param {String} key The key that the Parse.GeoPoint is stored in.
-   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
-   * @param {Number} maxDistance Maximum distance (in kilometers) of results
-   *     to return.
-   * @return {Parse.Query} Returns the query, so you can chain this call.
-   */
-  withinKilometers(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    return this.withinRadians(key, point, distance / 6371.0);
-  }
-
-  /**
-   * Adds a proximity based constraint for finding objects with key point
-   * values near the point given and within the maximum distance given.
-   * Results are unsorted for better performance compared to `withinRadians'.
-   * @param {String} key The key that the Parse.GeoPoint is stored in.
-   * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
-   * @param {Number} maxDistance Maximum distance (in radians) of results to
-   *   return.
-   * @return {Parse.Query} Returns the query, so you can chain this call.
-   */
-  withinRadiansUnsorted(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    
-    if (!(point instanceof ParseGeoPoint)) {
-      // Try to cast it as a GeoPoint
-      point = new ParseGeoPoint(point);
+  withinRadians(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {  
+    if (sorted) {
+      this.near(key, point);
+      return this._addCondition(key, '$maxDistance', distance);
+    } else {
+      return this._addCondition(key, '$geoWithin', { '$centerSphere': [[point.longitude, point.latitude], distance] });
     }
-    return this._addCondition(key, '$geoWithin', { '$centerSphere': [point, distance] });
   }
 
   /**
    * Adds a proximity based constraint for finding objects with key point
    * values near the point given and within the maximum distance given.
    * Radius of earth used is 3958.8 miles.
-   * Results are unsorted for better performance compared to `withinMiles'.
    * @param {String} key The key that the Parse.GeoPoint is stored in.
    * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
    * @param {Number} maxDistance Maximum distance (in miles) of results to
-   *     return.
+   *   return.
+   * @param {Boolean} sorted A Bool value that is true if results should be
+   *   sorted by distance ascending, false is no sorting is required.
    * @return {Parse.Query} Returns the query, so you can chain this call.
    */
-  withinMilesUnsorted(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    return this.withinRadiansUnsorted(key, point, distance / 3958.8);
+  withinMiles(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {
+    return this.withinRadians(key, point, distance / 3958.8, sorted);
   }
 
   /**
    * Adds a proximity based constraint for finding objects with key point
    * values near the point given and within the maximum distance given.
    * Radius of earth used is 6371.0 kilometers.
-   * Results are unsorted for better performance compared to `withinKilometers'.
    * @param {String} key The key that the Parse.GeoPoint is stored in.
    * @param {Parse.GeoPoint} point The reference Parse.GeoPoint that is used.
    * @param {Number} maxDistance Maximum distance (in kilometers) of results
-   *     to return.
+   *   to return.
+   * @param {Boolean} sorted A Bool value that is true if results should be
+   *   sorted by distance ascending, false is no sorting is required.
    * @return {Parse.Query} Returns the query, so you can chain this call.
    */
-  withinKilometersUnsorted(key: string, point: ParseGeoPoint, distance: number): ParseQuery {
-    return this.withinRadiansUnsorted(key, point, distance / 6371.0);
+  withinKilometers(key: string, point: ParseGeoPoint, distance: number, sorted: boolean): ParseQuery {
+    return this.withinRadians(key, point, distance / 6371.0, sorted);
   }
 
   /**