turbograft 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aff9e76ad586eab0a400892c5f596ffeac608b0
-  data.tar.gz: 0e0c807cb3e2b1f6897de5977ae37850225b306c
+  metadata.gz: f0cae3c571903c38a3f4202abcf69b3be1759c79
+  data.tar.gz: 1763b567311c50e6a20348c2b68a8fdc2b872084
 SHA512:
-  metadata.gz: 161fbc9a0d5312ce29364cabe5689aa8d25f9588b6504c1fde1f1a348c5daf9f47065a08e5533aa3e666d558469923ea9be4e9e26b677b1a80fcbaf5cc7aa238
-  data.tar.gz: 9b2346f149f5ead38e386d5a8fbff973c70075bf33018b94c3125518bc3b39b282d0a86cacc3c68c60c2595a80f78bf62c6ba427b4d07d98eb81597cf3e66b5d
+  metadata.gz: 39adb2b25cb0414a2360850d35a82c418a96f884d6648b6f682f630127e13b2dcf79f9edaeea641ce46a58076107007a961c49329be397e09af83e81decc2d30
+  data.tar.gz: 115abe752d2a6e1c7300007dad6acb16c1cdc0878d78a16ad05bbfb4b620a13a8f422dc0307324d32f5eccfcafce96aa44c207520b574f472649cad61e975c24

data/README.md

@@ -145,6 +145,15 @@ There is an example app that you can boot to play with TurboGraft.  Open the con
 ./server
 ```
 
+## jQuery and memory leaks
+
+When turbograft replaces or removes a node it uses native DOM API to do so. If any objects use jQuery to listen to events on a node then these objects will leak when the node is replaced because jQuery will still have references to it. To clean these up you'll need to tell jQuery that they're removed. This can be done with something like:
+
+```coffeescript
+document.addEventListener 'page:after-node-removed', (event) ->
+  $(event.data).remove()
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/Shopify/turbograft/fork )

data/lib/assets/javascripts/turbograft/initializers.coffee

@@ -4,13 +4,10 @@ hasClass = (node, search) ->
 nodeIsDisabled = (node) ->
    node.getAttribute('disabled') || hasClass(node, 'disabled')
 
-TurboGraft.handlers.remoteMethodHandler = (ev) ->
-  target = ev.clickTarget
-  httpRequestType = target.getAttribute('tg-remote')
-  return unless httpRequestType
-  ev.preventDefault()
-  httpUrl = target.getAttribute('href')
-  throw new Error("Turbograft developer error: You did not provide a URL ('href' attribute) for tg-remote") unless httpUrl
+setupRemoteFromTarget = (target, httpRequestType, urlAttribute, form = null) ->
+  httpUrl = target.getAttribute(urlAttribute)
+
+  throw new Error("Turbograft developer error: You did not provide a URL ('#{urlAttribute}' attribute) for tg-remote") unless httpUrl
 
   if target.getAttribute("remote-once")
     target.removeAttribute("remote-once")
@@ -25,36 +22,35 @@ TurboGraft.handlers.remoteMethodHandler = (ev) ->
     refreshOnError: target.getAttribute('refresh-on-error')
     refreshOnErrorExcept: target.getAttribute('full-refresh-on-error-except')
 
-  remote = new TurboGraft.Remote(options, null, target)
+  new TurboGraft.Remote(options, form, target)
+
+TurboGraft.handlers.remoteMethodHandler = (ev) ->
+  target = ev.clickTarget
+  httpRequestType = target.getAttribute('tg-remote')
+
+  return unless httpRequestType
+  ev.preventDefault()
+
+  remote = setupRemoteFromTarget(target, httpRequestType, 'href')
   remote.submit()
   return
 
 TurboGraft.handlers.remoteFormHandler = (ev) ->
   target = ev.target
+  method = target.getAttribute('method')
+
   return unless target.getAttribute('tg-remote')?
   ev.preventDefault()
-  httpUrl = target.getAttribute('action')
-  throw new Error("Turbograft developer error: You did not provide a URL ('action' attribute) for tg-remote") unless httpUrl
-
-  options =
-    httpRequestType: target.getAttribute('method')
-    httpUrl: httpUrl
-    fullRefresh: target.getAttribute('full-refresh')?
-    refreshOnSuccess: target.getAttribute('refresh-on-success')
-    refreshOnSuccessExcept: target.getAttribute('full-refresh-on-success-except')
-    refreshOnError: target.getAttribute('refresh-on-error')
-    refreshOnErrorExcept: target.getAttribute('full-refresh-on-error-except')
 
-  remote = new TurboGraft.Remote(options, target, target)
+  remote = setupRemoteFromTarget(target, method, 'action', target)
   remote.submit()
   return
 
 documentListenerForButtons = (eventType, handler, useCapture = false) ->
   document.addEventListener eventType, (ev) ->
     target = ev.target
-    return if !target
 
-    while target != document && (typeof target != "undefined")
+    while target != document && target?
       if target.nodeName == "A" || target.nodeName == "BUTTON"
         isNodeDisabled = nodeIsDisabled(target)
         ev.preventDefault() if isNodeDisabled

data/lib/assets/javascripts/turbograft/turbolinks.coffee

@@ -48,6 +48,14 @@ if browserSupportsCustomEvents
   installDocumentReadyPageEventTriggers()
   installJqueryAjaxSuccessPageUpdateTrigger()
 
+replaceNode = (newNode, oldNode) ->
+  replacedNode = oldNode.parentNode.replaceChild(newNode, oldNode)
+  triggerEvent('page:after-node-removed', replacedNode)
+
+removeNode = (node) ->
+  removedNode = node.parentNode.removeChild(node)
+  triggerEvent('page:after-node-removed', removedNode)
+
 # TODO: triggerEvent should be accessible to all these guys
 # on some kind of eventbus
 # TODO: clean up everything above me ^
@@ -129,7 +137,7 @@ class window.Turbolinks
         deleteRefreshNeverNodes(body)
 
       triggerEvent 'page:before-replace'
-      document.documentElement.replaceChild body, document.body
+      replaceNode(body, document.body)
       CSRFToken.update csrfToken if csrfToken?
       setAutofocusElement()
       executeScriptTags() if runScripts
@@ -168,7 +176,7 @@ class window.Turbolinks
 
   deleteRefreshNeverNodes = (body) ->
     for node in body.querySelectorAll('[refresh-never]')
-      node.parentNode.removeChild(node)
+      removeNode(node)
 
     return
 
@@ -189,7 +197,7 @@ class window.Turbolinks
 
       if newNode = body.querySelector("##{ nodeId }")
         newNode = newNode.cloneNode(true)
-        existingNode.parentNode.replaceChild(newNode, existingNode)
+        replaceNode(newNode, existingNode)
 
         if newNode.nodeName == 'SCRIPT' && newNode.getAttribute("data-turbolinks-eval") != "false"
           executeScriptTag(newNode)
@@ -197,7 +205,7 @@ class window.Turbolinks
           refreshedNodes.push(newNode)
 
       else if existingNode.getAttribute("refresh-always") == null
-        existingNode.parentNode.removeChild(existingNode)
+        removeNode(existingNode)
 
     refreshedNodes
 
@@ -207,7 +215,7 @@ class window.Turbolinks
         throw new Error("TurboGraft refresh: Kept nodes must have an id.")
 
       if remoteNode = body.querySelector("##{ nodeId }")
-        remoteNode.parentNode.replaceChild(existingNode, remoteNode)
+        replaceNode(existingNode, remoteNode)
 
   persistStaticElements = (body) ->
     allNodesToKeep = []

data/lib/turbograft/version.rb

@@ -1,3 +1,3 @@
 module TurboGraft
-  VERSION = '0.1.14'
+  VERSION = '0.1.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbograft
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Kristian Plettenberg-Dussault
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails