BREAKING CHANGE: remove use$geoWithin, always use $geoWithin over $within

Author: vkarpov15

lib/mquery.js

@@ -58,29 +58,6 @@ function Query(criteria, options) {
   }
 }
 
-/**
- * This is a parameter that the user can set which determines if mquery
- * uses $within or $geoWithin for queries. It defaults to true which
- * means $geoWithin will be used. If using MongoDB < 2.4 you should
- * set this to false.
- *
- * @api public
- * @property use$geoWithin
- */
-
-let $withinCmd = '$geoWithin';
-Object.defineProperty(Query, 'use$geoWithin', {
-  get: function() { return $withinCmd == '$geoWithin'; },
-  set: function(v) {
-    if (true === v) {
-      // mongodb >= 2.4
-      $withinCmd = '$geoWithin';
-    } else {
-      $withinCmd = '$within';
-    }
-  }
-});
-
 /**
  * Converts this query to a constructor function with all arguments and options retained.
  *
@@ -732,7 +709,7 @@ Query.prototype.elemMatch = function() {
 Query.prototype.within = function within() {
   // opinionated, must be used after where
   this._ensurePath('within');
-  this._geoComparison = $withinCmd;
+  this._geoComparison = '$geoWithin';
 
   if (0 === arguments.length) {
     return this;
@@ -800,7 +777,7 @@ Query.prototype.box = function() {
   }
 
   const conds = this._conditions[path] || (this._conditions[path] = {});
-  conds[this._geoComparison || $withinCmd] = { $box: box };
+  conds[this._geoComparison || '$geoWithin'] = { $box: box };
   return this;
 };
 
@@ -834,7 +811,7 @@ Query.prototype.polygon = function() {
   }
 
   const conds = this._conditions[path] || (this._conditions[path] = {});
-  conds[this._geoComparison || $withinCmd] = { $polygon: val };
+  conds[this._geoComparison || '$geoWithin'] = { $polygon: val };
   return this;
 };
 
@@ -882,7 +859,7 @@ Query.prototype.circle = function() {
     ? '$centerSphere'
     : '$center';
 
-  const wKey = this._geoComparison || $withinCmd;
+  const wKey = this._geoComparison || '$geoWithin';
   conds[wKey] = {};
   conds[wKey][type] = [val.center, val.radius];
 

test/index.js

@@ -546,33 +546,33 @@ describe('mquery', function() {
       describe('of length 1', function() {
         it('delegates to circle when center exists', function() {
           const m = mquery().where('loc').within({ center: [10, 10], radius: 3 });
-          assert.deepEqual({ $within: { $center: [[10, 10], 3] } }, m._conditions.loc);
+          assert.deepEqual({ $geoWithin: { $center: [[10, 10], 3] } }, m._conditions.loc);
         });
         it('delegates to box when exists', function() {
           const m = mquery().where('loc').within({ box: [[10, 10], [11, 14]] });
-          assert.deepEqual({ $within: { $box: [[10, 10], [11, 14]] } }, m._conditions.loc);
+          assert.deepEqual({ $geoWithin: { $box: [[10, 10], [11, 14]] } }, m._conditions.loc);
         });
         it('delegates to polygon when exists', function() {
           const m = mquery().where('loc').within({ polygon: [[10, 10], [11, 14], [10, 9]] });
-          assert.deepEqual({ $within: { $polygon: [[10, 10], [11, 14], [10, 9]] } }, m._conditions.loc);
+          assert.deepEqual({ $geoWithin: { $polygon: [[10, 10], [11, 14], [10, 9]] } }, m._conditions.loc);
         });
         it('delegates to geometry when exists', function() {
           const m = mquery().where('loc').within({ type: 'Polygon', coordinates: [[10, 10], [11, 14], [10, 9]] });
-          assert.deepEqual({ $within: { $geometry: { type: 'Polygon', coordinates: [[10, 10], [11, 14], [10, 9]] } } }, m._conditions.loc);
+          assert.deepEqual({ $geoWithin: { $geometry: { type: 'Polygon', coordinates: [[10, 10], [11, 14], [10, 9]] } } }, m._conditions.loc);
         });
       });
 
       describe('of length 2', function() {
         it('delegates to box()', function() {
           const m = mquery().where('loc').within([1, 2], [2, 5]);
-          assert.deepEqual(m._conditions.loc, { $within: { $box: [[1, 2], [2, 5]] } });
+          assert.deepEqual(m._conditions.loc, { $geoWithin: { $box: [[1, 2], [2, 5]] } });
         });
       });
 
       describe('of length > 2', function() {
         it('delegates to polygon()', function() {
           const m = mquery().where('loc').within([1, 2], [2, 5], [2, 4], [1, 3]);
-          assert.deepEqual(m._conditions.loc, { $within: { $polygon: [[1, 2], [2, 5], [2, 4], [1, 3]] } });
+          assert.deepEqual(m._conditions.loc, { $geoWithin: { $polygon: [[1, 2], [2, 5], [2, 4], [1, 3]] } });
         });
       });
     });