test($anchorScroll): add tests regarding waiting for readyState === 'complete'

Author: gkalpak

test/ng/anchorScrollSpec.js

@@ -3,6 +3,7 @@
 describe('$anchorScroll', function() {
 
   var elmSpy;
+  var docSpies;
   var windowSpies;
 
   function addElements() {
@@ -69,7 +70,7 @@ describe('$anchorScroll', function() {
     return function($window) {
       forEach(elmSpy, function(spy, id) {
         var count = map[id] || 0;
-        expect(spy.calls.length).toBe(count);
+        expect(spy.callCount).toBe(count);
       });
       expect($window.scrollTo).not.toHaveBeenCalled();
     };
@@ -79,17 +80,66 @@ describe('$anchorScroll', function() {
     return expectScrollingTo(NaN);
   }
 
+  function mockDocumentReadyState() {
+    var docMock = {
+      readyState: 'mocked',
+      updateReadyState: function(newState) {
+        this.readyState = newState;
+        this.dispatchFakeReadyStateChangeEvent();
+      }
+    };
+
+    docSpies = {};
+    var i = 0;
+
+    return function($rootScope, $window) {
+      var propsToMock = ['body', 'documentElement'];
+      var methodsToMock = [
+        'getElementById',
+        'getElementsByName',
+        'addEventListener',
+        'removeEventListener'
+      ];
+
+      var document_ = $window.document;
+
+      propsToMock.forEach(function(prop) {
+        docMock[prop] = document_[prop];
+      });
+      methodsToMock.forEach(function(method) {
+        docMock[method] = document_[method].bind(document_);
+        docSpies[method] = spyOn(docMock, method).andCallThrough();
+      });
+
+      docMock.dispatchFakeReadyStateChangeEvent = function() {
+        var evt = document.createEvent('Event');
+        evt.initEvent('readystatechange', false, false);
+        document_.dispatchEvent(evt);
+        $rootScope.$digest();
+      };
+
+      $window.document = docMock;
+    };
+  }
+
   function resetAllSpies() {
     function resetSpy(spy) {
       spy.reset();
     }
 
     return function($window) {
       forEach(elmSpy, resetSpy);
+      forEach(docSpies, resetSpy);
       forEach(windowSpies, resetSpy);
     };
   }
 
+  function updateMockReadyState(newState) {
+    return function($window) {
+      $window.document.updateReadyState(newState);
+    };
+  }
+
 
   beforeEach(module(function($provide) {
     elmSpy = {};
@@ -155,6 +205,61 @@ describe('$anchorScroll', function() {
     expectScrollingTo('id=top')));
 
 
+  it('should wait for `document.readyState === "complete"', inject(
+    mockDocumentReadyState(),
+    addElements('id=some1'),
+
+    changeHashTo('some1'),
+    expectNoScrolling(),
+
+    updateMockReadyState('some-arbitrary-state'),
+    expectNoScrolling(),
+
+    updateMockReadyState('complete'),
+    expectScrollingTo('id=some1')));
+
+
+  it('should only register one execution for when `document.readyState === "complete"', inject(
+    mockDocumentReadyState(),
+    addElements('id=some1', 'id=some2'),
+
+    changeHashTo('some1'),
+    changeHashTo('some2'),
+    updateMockReadyState('some-other-arbitrary-state'),
+    changeHashTo('some1'),
+    changeHashTo('some2'),
+    expectNoScrolling(),
+
+    updateMockReadyState('complete'),
+    expectScrollingTo('id=some2')));
+
+
+  it('should properly register and unregister listeners for `readystatechange` event', inject(
+    mockDocumentReadyState(),
+    addElements('id=some1', 'id=some2'),
+
+    changeHashTo('some1'),
+    changeHashTo('some2'),
+    updateMockReadyState('some-other-arbitrary-state'),
+    changeHashTo('some1'),
+    changeHashTo('some2'),
+    updateMockReadyState('complete'),
+
+    function() {
+      expect(docSpies.addEventListener.callCount).toBe(1);
+      expect(docSpies.addEventListener).
+          toHaveBeenCalledWith('readystatechange', jasmine.any(Function));
+
+      expect(docSpies.removeEventListener.callCount).toBe(1);
+      expect(docSpies.removeEventListener).
+          toHaveBeenCalledWith('readystatechange', jasmine.any(Function));
+
+      var registeredListener = docSpies.addEventListener.calls[0].args[1];
+      var unregisteredListener = docSpies.removeEventListener.calls[0].args[1];
+      expect(unregisteredListener).toBe(registeredListener);
+    }));
+
+
   describe('watcher', function() {
 
     function initAnchorScroll() {
@@ -270,7 +375,7 @@ describe('$anchorScroll', function() {
 
       return function($window) {
         expectScrollingTo(identifierCountMap)($window);
-        expect($window.scrollBy.calls.length).toBe(list.length);
+        expect($window.scrollBy.callCount).toBe(list.length);
         forEach(list, function(offset, idx) {
           // Due to sub-pixel rendering, there is a +/-1 error margin in the actual offset
           var args = $window.scrollBy.calls[idx].args;