Merge branch 'master' into kato-indexfor

katowulf · katowulf · commit 3cb6742c3238 · 2014-11-14T11:33:12.000-07:00
Conflicts:
	src/FirebaseArray.js
diff --git a/bower.json b/bower.json
@@ -36,6 +36,6 @@
   "devDependencies": {
     "lodash": "~2.4.1",
     "angular-mocks": "~1.2.18",
-    "mockfirebase": "~0.4.0"
+    "mockfirebase": "0.5.0"
   }
 }
diff --git a/src/FirebaseArray.js b/src/FirebaseArray.js
@@ -5,7 +5,7 @@
    * manually invoked. Instead, one should create a $firebase object and call $asArray
    * on it:  <code>$firebase( firebaseRef ).$asArray()</code>;
    *
-   * Internally, the $firebase object depends on this class to provide 5 methods, which it invokes
+   * Internally, the $firebase object depends on this class to provide 5 $$ methods, which it invokes
    * to notify the array whenever a change has been made at the server:
    *    $$added - called whenever a child_added event occurs
    *    $$updated - called whenever a child_changed event occurs
@@ -15,8 +15,9 @@
    *    $$process - called immediately after $$added/$$updated/$$moved/$$removed
    *                to splice/manipulate the array and invokes $$notify
    *
-   * Additionally, there is one more method of interest to devs extending this class:
+   * Additionally, these methods may be of interest to devs extending this class:
    *    $$notify - triggers notifications to any $watch listeners, called by $$process
+   *    $$getKey - determines how to look up a record's key (returns $id by default)
    *
    * Instead of directly modifying this class, one should generally use the $extendFactory
    * method to add or change how methods behave. $extendFactory modifies the prototype of
@@ -34,7 +35,7 @@
    *
    *    // change how records are updated
    *    $$updated: function(snap) {
-   *      return this.$getRecord(snap.name()).update(snap);
+   *      return this.$getRecord(snap.key()).update(snap);
    *    }
    * });
    * </code></pre>
@@ -169,7 +170,7 @@
          */
         $keyAt: function(indexOrItem) {
           var item = this._resolveItem(indexOrItem);
-          return this._getKey(item);
+          return this.$$getKey(item);
         },
 
         /**
@@ -186,7 +187,7 @@
           // evaluate whether our key is cached and, if so, whether it is up to date
           if( !cache.hasOwnProperty(key) || self.$keyAt(cache[key]) !== key ) {
             // update the hashmap
-            var pos = self.$list.findIndex(function(rec) { return self._getKey(rec) === key; });
+            var pos = self.$list.findIndex(function(rec) { return self.$$getKey(rec) === key; });
             if( pos !== -1 ) {
               cache[key] = pos;
             }
@@ -364,22 +365,22 @@
          * @returns {string||null}
          * @private
          */
-        _getKey: function(rec) { //todo rename this to $$getId
+        $$getKey: function(rec) {
           return angular.isObject(rec)? rec.$id : null;
         },
 
         /**
          * Handles placement of recs in the array, sending notifications,
          * and other internals. Called by the $firebase synchronization process
-         * after $$added, $$updated, $$moved, and $$removed
+         * after $$added, $$updated, $$moved, and $$removed.
          *
          * @param {string} event one of child_added, child_removed, child_moved, or child_changed
          * @param {object} rec
          * @param {string} [prevChild]
          * @private
          */
         $$process: function(event, rec, prevChild) {
-          var key = this._getKey(rec);
+          var key = this.$$getKey(rec);
           var changed = false;
           var curPos;
           switch(event) {
@@ -398,7 +399,7 @@
               changed = true;
               break;
             default:
-              throw new Error('Invalid event type ' + event);
+              throw new Error('Invalid event type: ' + event);
           }
           if( angular.isDefined(curPos) ) {
             // add it to the array
@@ -448,7 +449,7 @@
             if( i === 0 ) { i = this.$list.length; }
           }
           this.$list.splice(i, 0, rec);
-          this._indexCache[this._getKey(rec)] = i;
+          this._indexCache[this.$$getKey(rec)] = i;
           return i;
         },
 
@@ -487,7 +488,7 @@
             // a $id or even a $id that is in the array, it must be an actual record
             // the fastest way to determine this is to use $getRecord (to avoid iterating all recs)
             // and compare the two
-            var key = this._getKey(indexOrItem);
+            var key = this.$$getKey(indexOrItem);
             var rec = this.$getRecord(key);
             return rec === indexOrItem? rec : null;
           }
@@ -548,4 +549,4 @@
       return FirebaseArray;
     }
   ]);
-})();
+})();
diff --git a/src/firebase.js b/src/firebase.js
@@ -227,7 +227,7 @@
             }
           });
           var updated = batch(function(snap) {
-            var rec = array.$getRecord(snap.name());
+            var rec = array.$getRecord($firebaseUtils.getKey(snap));
             if( rec ) {
               var changed = array.$$updated(snap);
               if( changed ) {
@@ -236,7 +236,7 @@
             }
           });
           var moved   = batch(function(snap, prevChild) {
-            var rec = array.$getRecord(snap.name());
+            var rec = array.$getRecord($firebaseUtils.getKey(snap));
             if( rec ) {
               var confirmed = array.$$moved(snap, prevChild);
               if( confirmed ) {
@@ -245,7 +245,7 @@
             }
           });
           var removed = batch(function(snap) {
-            var rec = array.$getRecord(snap.name());
+            var rec = array.$getRecord($firebaseUtils.getKey(snap));
             if( rec ) {
               var confirmed = array.$$removed(snap);
               if( confirmed ) {
diff --git a/tests/lib/module.testutils.js b/tests/lib/module.testutils.js
@@ -35,8 +35,11 @@ angular.module('testutils', ['firebase'])
           getPriority: function () {
             return angular.isDefined(pri) ? pri : null;
           },
+          key: function() {
+            return ref.ref().key();
+          },
           name: function () {
-            return ref.ref().name();
+            return ref.ref().key();
           },
           child: function (key) {
             var childData = angular.isObject(data) && data.hasOwnProperty(key) ? data[key] : null;
diff --git a/tests/mocks/mocks.firebase.js b/tests/mocks/mocks.firebase.js
@@ -1,9 +1,9 @@
 
 angular.module('mock.firebase', [])
   .run(function($window) {
-    MockFirebase.override();
-    $window.Firebase = MockFirebase;
+    $window.mockfirebase.override();
+    $window.Firebase = $window.MockFirebase;
   })
-  .factory('Firebase', function() {
-    return MockFirebase;
+  .factory('Firebase', function($window) {
+    return $window.MockFirebase;
   });
diff --git a/tests/protractor/priority/priority.spec.js b/tests/protractor/priority/priority.spec.js
@@ -127,7 +127,7 @@ describe('Priority App', function () {
         data.makeItChange = true;
         snap.ref().setWithPriority(data, pri, function(err) {
           if( err ) { def.reject(err); }
-          else { def.fulfill(snap.name()); }
+          else { def.fulfill(snap.key()); }
         })
       }, def.reject);
       return def.promise;
diff --git a/tests/unit/FirebaseArray.spec.js b/tests/unit/FirebaseArray.spec.js
@@ -235,7 +235,7 @@ describe('$FirebaseArray', function () {
       var resRef = whiteSpy.calls.argsFor(0)[0];
       expect(whiteSpy).toHaveBeenCalled();
       expect(resRef).toBeAFirebaseRef();
-      expect(resRef.name()).toBe(expName);
+      expect(resRef.key()).toBe(expName);
       expect(blackSpy).not.toHaveBeenCalled();
     });
 
diff --git a/tests/unit/FirebaseObject.spec.js b/tests/unit/FirebaseObject.spec.js
@@ -31,7 +31,7 @@ describe('$FirebaseObject', function() {
 
   describe('constructor', function() {
     it('should set the record id', function() {
-      expect(obj.$id).toEqual($fb.$ref().name());
+      expect(obj.$id).toEqual($fb.$ref().key());
     });
 
     it('should accept a query', function() {
diff --git a/tests/unit/firebase.spec.js b/tests/unit/firebase.spec.js
@@ -112,7 +112,7 @@ describe('$firebase', function () {
       expect(whiteSpy).toHaveBeenCalled();
       expect(blackSpy).not.toHaveBeenCalled();
       var ref = whiteSpy.calls.argsFor(0)[0];
-      expect(ref.name()).toBe(newId);
+      expect(ref.key()).toBe(newId);
     });
 
     it('should reject if fails', function() {
@@ -127,7 +127,7 @@ describe('$firebase', function () {
 
     it('should save correct data into Firebase', function() {
       var spy = jasmine.createSpy('push callback').and.callFake(function(ref) {
-        expect($fb.$ref().getData()[ref.name()]).toEqual({foo: 'pushtest'});
+        expect($fb.$ref().getData()[ref.key()]).toEqual({foo: 'pushtest'});
       });
       $fb.$push({foo: 'pushtest'}).then(spy);
       flushAll();
@@ -324,7 +324,7 @@ describe('$firebase', function () {
       flushAll();
       var arg = spy.calls.argsFor(0)[0];
       expect(arg).toBeAFirebaseRef();
-      expect(arg.name()).toBe('index');
+      expect(arg.key()).toBe('index');
     });
 
     it('should reject if failed', function() {

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,6 @@`
`36`	`36`	`"devDependencies": {`
`37`	`37`	`"lodash": "~2.4.1",`
`38`	`38`	`"angular-mocks": "~1.2.18",`
`39`		`- "mockfirebase": "~0.4.0"`
	`39`	`+ "mockfirebase": "0.5.0"`
`40`	`40`	`}`
`41`	`41`	`}`