Added GeoFire.ref() method and bumped version to 2.1.0

jacobawenger · jacobawenger · commit 0bee5502a550 · 2014-06-29T16:27:01.000-07:00
diff --git a/.jshintrc b/.jshintrc
@@ -1,7 +1,8 @@
 {
   "predef": [
-    "require",
     "module",
+    "require",
+    "Firebase",
     "setInterval"
   ],
   "bitwise": true,
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+v2.1.0
+-------------
+Release Date: 2014-06-29
+
+  * Added GeoFire.ref() method.
+  * Added error checking for firebaseRef parameter.
+
 v2.0.2
 -------------
 Release Date: 2014-06-23
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ In order to use GeoFire in your project, you need to include the following files
 <script src="https://cdn.firebase.com/js/client/1.0.17/firebase.js"></script>
 
 <!-- GeoFire -->
-<script src="https://cdn.firebase.com/libs/geofire/2.0.2/geofire.min.js"></script>
+<script src="https://cdn.firebase.com/libs/geofire/2.1.0/geofire.min.js"></script>
 ```
 
 Use the URL above to download both the minified and non-minifed versions of GeoFire from the Firebase CDN. You can also download them from the
@@ -51,7 +51,7 @@ $ npm install geofire --save
 ```
 
 ```bash
-$ bower install geofire
+$ bower install geofire --save
 ```
 
 ## Getting Started with Firebase
@@ -71,10 +71,21 @@ the location pointed to by `firebaseRef`. Note that this `firebaseRef` can point
 
 ```JavaScript
 // Create a Firebase reference where GeoFire will store its information
-var dataRef = new Firebase("https://<my_firebase>.firebaseio.com/");
+var firebaseRef = new Firebase("https://<my_firebase>.firebaseio.com/");
 
 // Create a GeoFire index
-var geoFire = new GeoFire(dataRef);
+var geoFire = new GeoFire(firebaseRef);
+```
+
+#### GeoFire.ref()
+
+Returns the `Firebase` instance used to create this `GeoFire` instance.
+
+```JavaScript
+var firebaseRef = new Firebase("https://<my_firebase>.firebaseio.com/");
+var geoFire = new GeoFire(firebaseRef);
+
+var ref = geoFire.ref()  // ref === firebaseRef
 ```
 
 #### GeoFire.set(key, location)
@@ -329,11 +340,12 @@ If you'd like to contribute to GeoFire, you'll need to run the following command
 
 ```bash
 $ git clone https://github.com/firebase/geofire.git
-$ npm install    # install local npm build / test dependencies
-$ bower install  # install local JavaScript dependencies
-$ gulp watch     # watch for source file changes
+$ npm install -g gulp  # globally intall gulp task runnger
+$ npm install          # install local npm build / test dependencies
+$ bower install        # install local JavaScript dependencies
+$ gulp watch           # watch for source file changes
 ```
 
 `gulp watch` will watch for changes in the `/src/` directory and lint, concatenate, and minify the source files when a change occurs. The output files - `geofire.js` and `geofire.min.js` - are written to the `/dist/` directory.
 
-You can run the test suite by navigating to `file:///path/to/tests/TestRunner.html` or run the tests via the command line using `gulp test`.
+You can run the test suite by navigating to `file:///path/to/geofire/tests/TestRunner.html` or via the command line using `gulp test`.
diff --git a/bower.json b/bower.json
@@ -1,9 +1,18 @@
 {
   "name": "geofire",
   "description": "Location-based querying and filtering using Firebase",
-  "version": "2.0.2",
-  "main": [
-    "./dist/geofire.min.js"
+  "version": "2.1.0",
+  "main": "./dist/geofire.min.js",
+  "homepage": "https://github.com/firebase/geofire/",
+  "license": "MIT",
+  "authors": [
+    "jacobawenger <jacob@firebase.com>"
+  ],
+  "keywords": [
+    "geolocation",
+    "geoquery",
+    "location",
+    "firebase"
   ],
   "ignore": [
     "**/.*",
@@ -18,7 +27,7 @@
     "examples"
   ],
   "dependencies": {
-    "firebase": "~1.0.17",
+    "firebase": "1.0.x",
     "rsvp": "~3.0.8"
   },
   "devDependencies": {
diff --git a/build/header b/build/header
@@ -2,7 +2,7 @@
 // keys based on their geographic location. GeoFire uses Firebase for data
 // storage, allowing query results to be updated in realtime as they change.
 //
-//   GeoFire 2.0.2
+//   GeoFire 2.1.0
 //   https://github.com/firebase/geofire/
 //   License: MIT
 
diff --git a/dist/geofire.js b/dist/geofire.js
@@ -2,7 +2,7 @@
 // keys based on their geographic location. GeoFire uses Firebase for data
 // storage, allowing query results to be updated in realtime as they change.
 //
-//   GeoFire 2.0.2
+//   GeoFire 2.1.0
 //   https://github.com/firebase/geofire/
 //   License: MIT
 
@@ -172,6 +172,15 @@ var GeoFire = function(firebaseRef) {
   /********************/
   /*  PUBLIC METHODS  */
   /********************/
+  /**
+   * Returns the Firebase instance used to create this GeoFire instance.
+   *
+   * @return {Firebase} The Firebase instance used to create this GeoFire instance.
+   */
+  this.ref = function() {
+    return _firebaseRef;
+  };
+
   /**
    * Adds the provided key - location pair to Firebase. Returns an empty promise which is fulfilled when the write is complete.
    *
@@ -238,6 +247,10 @@ var GeoFire = function(firebaseRef) {
   /*****************/
   /*  CONSTRUCTOR  */
   /*****************/
+  if (firebaseRef instanceof Firebase === false) {
+    throw new Error("firebaseRef must be an instance of Firebase");
+  }
+
   var _firebaseRef = firebaseRef;
 };
 
@@ -1013,6 +1026,9 @@ var GeoQuery = function (firebaseRef, queryCriteria) {
   /*  CONSTRUCTOR  */
   /*****************/
   // Firebase reference of the GeoFire which created this query
+  if (firebaseRef instanceof Firebase === false) {
+    throw new Error("firebaseRef must be an instance of Firebase");
+  }
   var _firebaseRef = firebaseRef;
 
   // Event callbacks
diff --git a/dist/geofire.min.js b/dist/geofire.min.js
diff --git a/examples/fish1/js/vendor/geofire.min.js b/examples/fish1/js/vendor/geofire.min.js
diff --git a/examples/fish2/js/vendor/geofire.min.js b/examples/fish2/js/vendor/geofire.min.js
diff --git a/examples/fish3/js/vendor/geofire.min.js b/examples/fish3/js/vendor/geofire.min.js
diff --git a/examples/sfVehicles/js/vendor/geofire.min.js b/examples/sfVehicles/js/vendor/geofire.min.js
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "geofire",
   "description": "Location-based querying and filtering using Firebase",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "main": "./dist/geofire.min.js",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
     }
   ],
   "dependencies": {
-    "firebase": "~1.0.17",
+    "firebase": "1.0.x",
     "rsvp": "~3.0.9"
   },
   "devDependencies": {
diff --git a/release.sh b/release.sh
@@ -26,6 +26,13 @@ if [[ $PARSED_CLIENT_VERSION != $CHANGELOG_VERSION ]]; then
   exit 1
 fi
 
+# Ensure the README has been updated for the newest version
+README_VERSION="$(grep '<script src=\"https://cdn.firebase.com/libs/geofire/' README.md | awk -F '/' '{print $6}')"
+if [[ $PARSED_CLIENT_VERSION != $README_VERSION ]]; then
+  echo "Error: Script tag version in README (${README_VERSION}) does not match version you are releasing (${VERSION})."
+  exit 1
+fi
+
 # Ensure the version number in the package.json is correct
 NPM_VERSION=$(grep "version" package.json | head -1 | awk -F '"' '{print $4}')
 if [[ $PARSED_CLIENT_VERSION != $NPM_VERSION ]]; then
@@ -71,7 +78,7 @@ if [[ -e ${STANDALONE_TARGET_DIR} ]]; then
 fi
 
 # Make the target directory
-mkdir $STANDALONE_DEST/$VERSION
+mkdir $STANDALONE_TARGET_DIR
 
 # Copy the files to the target directory
 cp dist/$STANDALONE_STUB.js $STANDALONE_TARGET_DIR
@@ -88,6 +95,7 @@ echo
 
 # Push the new files to the firebase-clients repo
 cd ${STANDALONE_DEST}/
+git pull
 git add .
 git commit -am "[firebase-release] Updated GeoFire to $VERSION"
 git push
@@ -108,7 +116,7 @@ echo "Manual steps remaining:"
 echo "  1) Deploy firebase-clients to CDN via Jenkins"
 echo "  2) Update the release notes for GeoFire version ${VERSION} on GitHub"
 echo "  3) Update all GeoFire client version numbers specified in firebase-website to ${VERSION}"
-echo "  4) Tweet @FirebaseRelease: 'v${VERSION} of @Firebase GeoFire is available https://cdn.firebase.com/libs/geofire/$VERSION/geofire.min.js Changelog: https://cdn.firebase.com/libs/geofire/changelog.txt'"
+echo "  4) Tweet @FirebaseRelease: 'v${VERSION} of GeoFire is available https://cdn.firebase.com/libs/geofire/$VERSION/geofire.min.js Changelog: https://cdn.firebase.com/libs/geofire/changelog.txt'"
 echo
-echo "Done! Woo!"
+echo "Done! Woot!"
 echo
diff --git a/src/geoFire.js b/src/geoFire.js
@@ -126,6 +126,15 @@ var GeoFire = function(firebaseRef) {
   /********************/
   /*  PUBLIC METHODS  */
   /********************/
+  /**
+   * Returns the Firebase instance used to create this GeoFire instance.
+   *
+   * @return {Firebase} The Firebase instance used to create this GeoFire instance.
+   */
+  this.ref = function() {
+    return _firebaseRef;
+  };
+
   /**
    * Adds the provided key - location pair to Firebase. Returns an empty promise which is fulfilled when the write is complete.
    *
@@ -192,6 +201,10 @@ var GeoFire = function(firebaseRef) {
   /*****************/
   /*  CONSTRUCTOR  */
   /*****************/
+  if (firebaseRef instanceof Firebase === false) {
+    throw new Error("firebaseRef must be an instance of Firebase");
+  }
+
   var _firebaseRef = firebaseRef;
 };
 
diff --git a/src/geoQuery.js b/src/geoQuery.js
@@ -413,6 +413,9 @@ var GeoQuery = function (firebaseRef, queryCriteria) {
   /*  CONSTRUCTOR  */
   /*****************/
   // Firebase reference of the GeoFire which created this query
+  if (firebaseRef instanceof Firebase === false) {
+    throw new Error("firebaseRef must be an instance of Firebase");
+  }
   var _firebaseRef = firebaseRef;
 
   // Event callbacks
diff --git a/tests/specs/common.spec.js b/tests/specs/common.spec.js
@@ -9,8 +9,9 @@ var demoFirebaseUrl = "https://" + generateRandomString() + ".firebaseio-demo.co
 console.log(demoFirebaseUrl);
 
 // Define examples of valid and invalid parameters
+var invalidFirebaseRefs = [null, undefined, true, false, [], {}, 0, 5, "", "a", {a:1}, ["hi", 1]];
 var validKeys = ["a", "loc1", "(e@Xi:4t>*E2)hc<5oa:1s6{B0d?u", Array(743).join("a")];
-var invalidKeys = ["", 1, true, false, [], {}, [1, 2], {a: 1}, null, undefined, "loc.1", "loc$1", "[loc1", "loc1]", "loc#1", "a#i]$da[s", "te/nst", "te/rst", "te/u0000st", "te/u0015st", "te/007Fst", Array(800).join("a")];
+var invalidKeys = ["", 1, true, false, [], {}, [1, 2], {a: 1}, null, undefined, "loc.1", "loc$1", "[loc1", "loc1]", "loc#1", "loc/1", "a#i]$da[s", "te/nst", "te/rst", "te/u0000st", "te/u0015st", "te/007Fst", Array(800).join("a")];
 var validLocations = [[0, 0], [-90, 180], [90, -180], [23, 74], [47.235124363, 127.2379654226]];
 var invalidLocations = [[-91, 0], [91, 0], [0, 181], [0, -181], [[0, 0], 0], ["a", 0], [0, "a"], ["a", "a"], [null, 0], [null, null], [0, undefined], [undefined, undefined], "", "a", true, false, [], [1], {}, {a:1}, null, undefined];
 var validGeohashes = ["4", "d62dtu", "000000000000"];
@@ -59,7 +60,15 @@ function afterEachHelper(done) {
 
 /* Returns a random alphabetic string of variable length */
 function generateRandomString() {
-  return (Math.random() + 1).toString(36).substring(7);
+  var possibleCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+  var numPossibleCharacters = possibleCharacters.length;
+
+  var text = "";
+  for (var i = 0; i < 10; i++) {
+    text += possibleCharacters.charAt(Math.floor(Math.random() * numPossibleCharacters));
+  }
+
+  return text;
 }
 
 /* Returns the current data in the Firebase */
diff --git a/tests/specs/geoFire.spec.js b/tests/specs/geoFire.spec.js
@@ -8,9 +8,28 @@ describe("GeoFire Tests:", function() {
     afterEachHelper(done);
   });
 
+  describe("Constructor:", function() {
+    it("Constructor throws errors given invalid Firebase references", function() {
+      console.log("!!!!!  GeoFire Tests  !!!!!");
+
+      invalidFirebaseRefs.forEach(function(invalidFirebaseRef) {
+        expect(function() { new GeoFire(invalidFirebaseRef); }).toThrow();
+      });
+    });
+
+    it("Constructor does not throw errors given valid Firebase references", function() {
+      expect(function() { new GeoFire(firebaseRef); }).not.toThrow();
+    });
+  });
+
+  describe("ref():", function() {
+    it("ref() returns the Firebase reference used to create a GeoFire instance", function() {
+      expect(geoFire.ref()).toBe(firebaseRef);
+    });
+  });
+
   describe("Adding locations:", function() {
     it("set() returns a promise", function(done) {
-      console.log("!!!!!  GeoFire Tests  !!!!!");
 
       var cl = new Checklist(["p1"], expect, done);
 
