Fire page:load on Turbolinks.replace and attach loaded nodes to the event

Author: Thibaut

CHANGELOG.md

@@ -138,7 +138,7 @@
     Turbolinks.visit url, scroll: false
     ```
 
-*   Attach affected nodes to the `page:before-unload` and `page:change` events (in `event.data`).
+*   Attach affected nodes to the `page:before-unload`, `page:change` and `page:load` events (in `event.data`).
 
     *Thibaut Courouble*
 

lib/assets/javascripts/turbolinks.js.coffee

@@ -67,12 +67,12 @@ fetchReplacement = (url, options) ->
     if doc = processResponse()
       reflectNewUrl url
       reflectRedirectedUrl()
-      changePage doc, options
+      loadedNodes = changePage doc, options
       if options.showProgressBar
         progressBar?.done()
       manuallyTriggerHashChangeForFirefox()
       updateScrollPosition(options.scroll)
-      triggerEvent EVENTS.LOAD
+      triggerEvent EVENTS.LOAD, loadedNodes
     else
       progressBar?.done()
       document.location.href = crossOriginRedirect() or url.absolute
@@ -125,7 +125,8 @@ constrainPageCacheTo = (limit) ->
     delete pageCache[key]
 
 replace = (html, options = {}) ->
-  changePage createDocument(html), options
+  loadedNodes = changePage createDocument(html), options
+  triggerEvent EVENTS.LOAD, loadedNodes
 
 changePage = (doc, options) ->
   [title, targetBody, csrfToken] = extractTitleAndBody(doc)
@@ -161,6 +162,7 @@ changePage = (doc, options) ->
 
   triggerEvent EVENTS.CHANGE, changedNodes
   triggerEvent EVENTS.UPDATE
+  return changedNodes
 
 findNodes = (body, selector) ->
   Array::slice.apply(body.querySelectorAll(selector))

test/javascript/turbolinks_replace_test.coffee

@@ -53,9 +53,10 @@ suite 'Turbolinks.replace()', ->
       assert.equal event.data, body
       assert.notEqual permanent, event.data.querySelector('#permanent')
       afterRemoveFired = true
-    @document.addEventListener 'page:change', =>
+    @document.addEventListener 'page:load', (event) =>
       assert.ok beforeUnloadFired
       assert.ok afterRemoveFired
+      assert.deepEqual event.data, [@document.body]
       assert.equal @window.j, 1
       assert.isUndefined @window.headScript
       assert.isUndefined @window.bodyScriptEvalFalse
@@ -170,9 +171,10 @@ suite 'Turbolinks.replace()', ->
     @document.addEventListener 'page:after-remove', (event) =>
       assert.isNull event.data.parentNode
       assert.equal event.data, afterRemoveNodes.shift()
-    @document.addEventListener 'page:change', =>
+    @document.addEventListener 'page:load', (event) =>
       assert.ok beforeUnloadFired
       assert.equal afterRemoveNodes.length, 0
+      assert.deepEqual event.data, [@$('#temporary'), @$('#change'), @$('[id="change:key"]')]
       assert.equal @window.i, 2 # scripts are re-run
       assert.isUndefined @window.bodyScript
       assert.isUndefined @window.headScript

test/javascript/turbolinks_visit_test.coffee

@@ -47,11 +47,12 @@ suite 'Turbolinks.visit()', ->
     @document.addEventListener 'page:change', (event) =>
       assert.deepEqual event.data, [@document.body]
       pageChangeFired = true
-    @document.addEventListener 'page:load', =>
+    @document.addEventListener 'page:load', (event) =>
       assert.ok pageReceivedFired
       assert.ok beforeUnloadFired
       assert.ok afterRemoveFired
       assert.ok pageChangeFired
+      assert.deepEqual event.data, [@document.body]
       assert.equal @window.i, 1
       assert.equal @window.j, 1
       assert.isUndefined @window.headScript
@@ -90,9 +91,10 @@ suite 'Turbolinks.visit()', ->
     @document.addEventListener 'page:change', (event) =>
       assert.deepEqual event.data, [@$('#temporary'), @$('#change'), @$('[id="change:key"]')]
       pageChangeFired = true
-    @document.addEventListener 'page:load', =>
+    @document.addEventListener 'page:load', (event) =>
       assert.ok beforeUnloadFired
       assert.ok pageChangeFired
+      assert.deepEqual event.data, [@$('#temporary'), @$('#change'), @$('[id="change:key"]')]
       assert.equal @window.i, 2
       assert.isUndefined @window.j
       assert.isUndefined @window.headScript