Change the scrolling API

The goal of this change is to avoid any false appearance
that we are implementing the proposed scrollIntoView() API [1],
while we clearly don't.

So, changes:

 - Rename scrollIntoView to scrollToView
   on both Anchor and Highlight
 - Stop returning promises at both methods

I also updated all the tests to reflect this change.

[1] http://dev.w3.org/csswg/cssom-view/#dom-element-scrollintoview

h/static/scripts/annotator/plugin/bucket-bar.coffee

@@ -142,7 +142,7 @@ class Annotator.Plugin.BucketBar extends Annotator.Plugin
 
     # Get an anchor from the page we want to go to
     anchor = next[0]
-    anchor.scrollIntoView()
+    anchor.scrollToView()
 
   _update: =>
     wrapper = @annotator.wrapper

h/static/scripts/annotator/plugin/enhancedanchoring.coffee

@@ -60,10 +60,8 @@ class Anchor
     # If we are supposed to scroll to the highlight on a page,
     # and it's available now, go scroll there.
     if @pendingScrollTargetPage? and (hl = @highlight[@pendingScrollTargetPage])
-      hl.scrollIntoView().then =>
-        @pendingScrollResolve()
-        delete @pendingScrollTargetPage
-        delete @pendingScrollResolve
+      hl.scrollToView()
+      delete @pendingScrollTargetPage
 
   # Remove the highlights for the given set of pages
   virtualize: (pageIndex) =>
@@ -94,12 +92,12 @@ class Anchor
       delete @anchoring.anchors[index] unless anchors.length
 
   # Scroll to this anchor
-  scrollIntoView: ->
+  scrollToView: ->
     currentPage = @anchoring.document.getPageIndex()
 
     if @startPage is @endPage and currentPage is @startPage
       # It's all in one page. Simply scrolling
-      @highlight[@startPage].scrollIntoView()
+      @highlight[@startPage].scrollToView()
     else
       if currentPage < @startPage
         # We need to go forward
@@ -118,13 +116,12 @@ class Anchor
       # Is this rendered?
       if @anchoring.document.isPageMapped wantedPage
         # The wanted page is already rendered, we can simply go there
-        @highlight[wantedPage].scrollIntoView()
+        @highlight[wantedPage].scrollToView()
       else
         # Not rendered yet. Go to the page, we will continue from there
         @pendingScrollTargetPage = wantedPage
-        new Promise (resolve, reject) =>
-          @pendingScrollResolve = resolve
-          @anchoring.document.setPageIndex scrollPage
+        @anchoring.document.setPageIndex scrollPage
+        null
 
 Annotator.Anchor = Anchor
 

h/static/scripts/annotator/plugin/texthighlights.coffee

@@ -115,10 +115,9 @@ class TextHighlight
   getHeight: -> $(@_highlights).outerHeight true
 
   # Scroll the highlight into view
-  scrollIntoView: ->
-    new Promise (resolve, reject) =>
-      $(@_highlights).scrollintoview complete: ->
-        resolve()
+  scrollToView: ->
+    $(@_highlights).scrollintoview()
+    null
 
 class Annotator.Plugin.TextHighlights extends Annotator.Plugin
 

h/static/scripts/guest.coffee

@@ -166,7 +166,7 @@ class Annotator.Guest extends Annotator
     crossframe.on 'scrollToAnnotation', (ctx, tag) =>
       for a in @anchoring.getAnchors()
         if a.annotation.$$tag is tag
-          a.scrollIntoView()
+          a.scrollToView()
           return
     crossframe.on 'getDocumentInfo', (trans) =>
       (@plugins.PDF?.getMetaData() ? Promise.reject())

tests/js/guest-test.coffee

@@ -197,11 +197,11 @@ describe 'Annotator.Guest', ->
       it 'scrolls to the anchor with the matching tag', ->
         guest = createGuest()
         anchors = [
-          {annotation: {$$tag: 'tag1'}, scrollIntoView: sandbox.stub()}
+          {annotation: {$$tag: 'tag1'}, scrollToView: sandbox.stub()}
         ]
         sandbox.stub(guest.anchoring, 'getAnchors').returns(anchors)
         emitGuestEvent('scrollToAnnotation', 'ctx', 'tag1')
-        assert.called(anchors[0].scrollIntoView)
+        assert.called(anchors[0].scrollToView)
 
     describe 'on "getDocumentInfo" event', ->
       guest = null

tests/js/plugin/enhancedanchoring-test.coffee

@@ -26,6 +26,11 @@ class TestAnchor extends Annotator.Anchor
 
 describe 'Annotator.Plugin.EnhancedAnchoring', ->
   sandbox = null
+  pendingTest = null
+
+  watchForScroll = ->
+    new Promise (resolve, reject) ->
+      pendingTest = resolve: resolve
 
   createAnchoringManager = ->
     annotator =
@@ -59,11 +64,11 @@ describe 'Annotator.Plugin.EnhancedAnchoring', ->
         anchor: anchor
         page: page
         removeFromDocument: sinon.spy()
-        scrollIntoView: sinon.spy ->
-          new Promise (resolve, reject) -> setTimeout -> resolve()
+        scrollToView: sinon.spy -> pendingTest?.resolve()
 
   afterEach ->
     sandbox.restore()
+    pendingTest = null
 
   describe "createAnchor", ->
 
@@ -223,14 +228,13 @@ describe 'Annotator.Plugin.EnhancedAnchoring', ->
       assert.include hls, anchor2.highlight[anchor2.startPage]
       assert.notInclude hls, anchor3.highlight[anchor3.startPage]
 
-  describe 'Anchor.scrollIntoView()', ->
+  describe 'Anchor.scrollToView()', ->
     it 'calls scrollIntoView() on the highlight', ->
       am = createAnchoringManager()
       ann = createTestAnnotation "a1"
       anchor = am.createAnchor(ann, ann.target[0]).result
-      anchor.scrollIntoView().then ->
-
-        assert.called anchor.highlight[anchor.startPage].scrollIntoView
+      anchor.scrollToView()
+      assert.called anchor.highlight[anchor.startPage].scrollToView
 
   describe 'two-phased anchoring', ->
 
@@ -658,8 +662,7 @@ describe 'Annotator.Plugin.EnhancedAnchoring', ->
         am.document.currentIndex = 5  # We start from page 5
         am.document.setPageIndex = sinon.spy()
 
-        # Now we trigger the actual action
-        anchor.scrollIntoView()
+        anchor.scrollToView()
         assert.calledWith am.document.setPageIndex, 9
 
       it 'gets the wanted page rendered', ->
@@ -673,11 +676,11 @@ describe 'Annotator.Plugin.EnhancedAnchoring', ->
             renderPage am.document, 9
             renderPage am.document, 10
 
-        # Now we trigger the actual action
-        anchor.scrollIntoView().then ->
+        anchor.scrollToView()
+        watchForScroll().then ->
           assert am.document.isPageMapped 10
 
-      it 'calls scrollIntoView() on the highlight', ->
+      it 'calls scrollToView() on the highlight', ->
         am = createAnchoringManagerAndLazyDocument()
         ann = createTestAnnotationForPages "a1", [10]
         anchor = am.createAnchor(ann, ann.target[0]).result
@@ -688,5 +691,6 @@ describe 'Annotator.Plugin.EnhancedAnchoring', ->
             renderPage am.document, 9
             renderPage am.document, 10
 
-        anchor.scrollIntoView().then ->
-          assert.called anchor.highlight[10].scrollIntoView
+        anchor.scrollToView()
+        watchForScroll().then ->
+          assert.called anchor.highlight[10].scrollToView

tests/js/plugin/texthighlight-test.coffee

@@ -55,19 +55,14 @@ describe 'Annotator.Plugin.TextHighlight', ->
       annotation = $(hl._highlights).data "annotation"
       assert.equal annotation, "test annotation"
 
-  describe "scrollIntoView", ->
+  describe "scrollToView", ->
 
     it 'calls jQuery scrollintoview', ->
       hl = createTestHighlight()
-      hl.scrollIntoView()
+      hl.scrollToView()
       assert.called Annotator.$.fn.scrollintoview
 
     it 'scrolls to the created highlight span', ->
       hl = createTestHighlight()
-      hl.scrollIntoView()
+      hl.scrollToView()
       assert.equal scrollTarget, hl._highlights
-
-    it 'resolves the promise after scrolling', ->
-      hl = createTestHighlight()
-      hl.scrollIntoView().then ->
-        assert.ok scrollTarget