turbograft 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cf7f7c936415c6a11516f9a43f533f5b67b178
-  data.tar.gz: ad506629d8ad4c6c27b778b3b2bfabbb40ca70ad
+  metadata.gz: 02d54ea2e6cd5256f9d5de5124c826d0c5a4873c
+  data.tar.gz: 67b141c9ea5940bd766e625ed451f79dfde388a8
 SHA512:
-  metadata.gz: 4d98dd4f884babcf6538344e42ae3e728877711d37bc38cca97ca837eb7b2e606e32e455d4f33fca7b57fa21a3f53e7c57e5aabd51f0cbaaa6a0a82ff37e68af
-  data.tar.gz: 54c66bd97efdbb41bdafb7a0edf710bb5f9b8a85a358fe3b9480052ce34159c5556f4494a9109b9c2922bcd9f3be01ca8d07a9166c75139def907e29eb59f59d
+  metadata.gz: 9f77a1c9d71b92cce89c4681210798d2159fa1607c8e09ffbfba67c24bf8db0bee9f052212cff74bf4c914dd97060ceefa7ae00e767d46e160fdad36ccd27de8
+  data.tar.gz: 7bb7e66e72f3969bfd076152244eb9f3afa727e5d42032e5744d2e78bb8a7d1e8a263dabac5592db27581f5165815a26bb270bc30badfeafc768c33cdad8ab10

data/README.md

@@ -1,14 +1,22 @@
 # TurboGraft
-
-It's like turbolinks, but with partial page replacement and tests
+Turbograft extends [Turbolinks](https://github.com/rails/turbolinks), allowing you to perform partial page refreshes.
 
 `Graft` - (noun) a shoot or twig inserted into a slit on the trunk or stem of a living plant, from which it receives sap.
 
 In botony, one can take parts of a tree and splice it onto another tree.  The DOM is a tree.  In this library, we're cutting off sub-trees of the DOM and splicing new ones on.
 
+ Turbolinks works by intercepting navigation requests and loading them via Ajax when possible, swapping the body tag of the document with the newly loaded copy. Turbograft builds on this to allow you to perform a partial page refresh on specified DOM nodes by adding a refresh key. This allows you reduce page load time, while the feeling of a native, single-page application.
+
+## One render path
+Turbograft gives you the ability to maintain a single, canonical render path for views. Your ERB views are the single definition of what will be rendered, without the worry of conditionally fetching snippets of HTML from elsewhere. This approach leads to clear, simplified code.
+## Client-side performance
+Partial page refreshes mean that CSS and JavaScript are only reloaded when you need them to be. Turbograft improves on the native, single-page application feel for the user while keeping these benefits inherited from Turbolinks.
+## Simplicity
+Turbograft was built with simplicity in mind. It intends to offer the smallest amount of overhead required on top of a traditional Rails stack to solve the problem of making a Rails app feel native to the browser.
+
 ## Status
 [![Gem Version](https://badge.fury.io/rb/turbograft.svg)](http://badge.fury.io/rb/turbograft)
-[![Build Status](https://api.travis-ci.org/Shopify/turbograft.svg)](http://travis-ci.org/Shopify/turbograft)
+[![Build Status](https://travis-ci.org/Shopify/turbograft.svg?branch=master)](http://travis-ci.org/Shopify/turbograft)
 
 ## Installation
 
@@ -17,18 +25,133 @@ In botony, one can take parts of a tree and splice it onto another tree.  The DO
 * Add `#= require turbograft` to _app/assets/javascripts/application.js_
 
 ## Usage
+### Partial page refresh
+
+```html
+<div id="content" refresh="page">
+  ...
+</div>
+```
+
+
+```html
+<a href="#" id="partial-refresh-page" refresh="page" onclick="event.preventDefault(); Page.refresh({url: '<%= page_path(@next_id) %>',onlyKeys: ['page']});">Refresh the page</a>
+```
+
+This performs a `GET` request, but our client state is maintained. Using the refresh attribute, we tell TurboGraft to grab the new page, but only refresh elements where refresh="page".  This is the lowest-level way to use TurboGraft.
+
+`refresh` attributes on your DOM nodes can be considered somewhat analoguous to how `class` will apply styles to any nodes with that class.  That is to say, many nodes can be decorated `refresh="foo"` and all matching nodes will be replaced with `onlyKeys: ['foo']`.  Each node with `refresh` must have its own unique ID (this is how nodes are matched during the replacement stage).  At the moment, `refresh` does not support multiple keys (e.g., `refresh="foo bar"`) like the `class` attribute does.
+
+### onlyKeys
+You can specify multiple refresh keys on a page, and you can tell TurboGraft to refresh on one or more refresh keys for a given action.
+
+```html
+<button id='refresh-a-and-b' href="<%= page_path(@id) %>" onclick="event.preventDefault(); Page.refresh({url: '<%= page_path(@id) %>', onlyKeys: ['section-a', 'section-b']});">Refresh Section A and B</button>
+```
+
+### exceptKeys
+You can also tell TurboGraft to refresh the page, but exclude certain elements from being refreshed.
+
+```html
+<button id='refresh-a-and-b' href="<%= page_path(@id) %>" onclick="event.preventDefault(); Page.refresh({url: '<%= page_path(@id) %>', exceptKeys: ['section-a', 'section-b']});">Refresh everything but Section A and B</button>
+```
+
+### refresh-never
+The `refresh-never` attribute will cause a node only appear once in the `body` of the document. This can be used to include and initialize a tracking pixel or script just once inside the body.
+
+```html
+<div refresh-never>
+  <%= link_to "Never refresh", page_path(@next_id), id: "next-page-refresh-never", refresh: "page" %>
+</div>
+```
+
+## tg-remote
+
+The `tg-remote` option allows you to query methods on or submit forms to different endpoints, and gives partial page replacement on specified refresh keys depending on the response status.
+
+It requires your `<form>`, `<a>`, or `<button>` to be marked up with:
+
+* `tg-remote`: (optionally valueless for `<form>`, but requires an HTTP method for links) the HTTP method you wish to call on your endpoint
+* `href`: (if node is `<a>` or `<button>`) the URL of the endpoint you wish to hit
+* `refresh-on-success`: (optional) The refresh keys to be refreshed, using the body of the response. This is space-delimited
+* `refresh-on-error`: (optional) The refresh keys to be refreshed, but using body of XHR which has failed. Only works with error 422. If the XHR returns and error and you do not supply a refresh-on-error, nothing is changed
+* `full-refresh-on-error-except`: (optional) Replaces body except for specified refresh keys, using the body of the XHR which has failed.  Only works with error 422
+* `remote-once`: (optional) The action will only be performed once. Removes `remote-method` and `remote-once` from element after consumption
+* `full-refresh`: Rather than using the content of the XHR response for partial page replacement, a full page refresh is performed. If `refresh-on-success` is defined, the page will be reloaded on these keys. If `refresh-on-success` is not defined, a full page refresh is performed. Defaults to true if neither refresh-on-success nor refresh-on-error are provided
+* `tg-remote-norefresh`: Prevents `Page.refresh()` from being called, allowing methods to be executed without updating client state
+
+### Examples
 
-    TODO
+Call a remote method:
+
+```html
+<a href="#" tg-remote="post" refresh-on-success="page section-a section-b">Remote-method</a>
+```
+
+The Rails way:
+
+```erb
+<%= link_to "Remote method", method_path, 'refresh-on-success' => 'page section-a section-b', 'full-refresh' => 'true', 'tg-remote' => 'post' %>
+```
+
+Post to a remote form:
+
+```html
+<div id="results" refresh="results">
+  Use the field below to submit some content, and get a result.
+</div>
+<form tg-remote="" action="/pages/submit" method="post" refresh-on-success="results" refresh-on-error="results">
+  <input name="form-input" type="text">
+  <button type="submit">Submit</button>
+</form>
+```
+
+### tg-remote events
+
+* `turbograft:remote:init`: Before XHR is sent
+* `turbograft:remote:start`: When XHR is sent
+* `turbograft:remote:always`: Always fires when XHR is complete
+* `turbograft:remote:success`: Always fires when XHR was successful
+* `turbograft:remote:fail`: Always fires when XHR failed
+* `turbograft:remote:fail:unhandled`: Fires after `turbograft:remote:fail`, but when no partial replacement with refresh-on-error was performed (because no `refresh-on-error` was supplied)
+
+Each event also is sent with a copy of the XHR, as well as a reference to the element that initated the `remote-method`.
+
+### tg-static
+
+With the `tg-static` attribute decorating a node, we can make sure that this node is not replaced during a fullpage refresh.  Contrast this to partial page refreshes, where we normally specify the set of elements that need to change.  With `tg-static`, we can define a set of elements (by annotating them with this attribute) that must never change.
+
+The internal state of any nodes marked with `tg-static` will remain, even though the entire page has been swapped out.  A partial page refresh with `onlyKeys` targeting a node inside of the `tg-static` node is also possible, persisting your static element but swapping the innards.
+
+Though, if you were to refresh the page at a higher level -- e.g., refreshing an ancestor of the `tg-static`, the static aspect is no longer obeyed and it is replaced!
+
+Examples of where this may be useful include:
+
+- running `<video>` or `<audio>` element
+- a client-controlled static nav
+
+### refresh-always
+
+For the lazy developer in all of us, we can use the attribute `refresh-always` when we want to be sure we've absolutely replaced a certain element, if it exists.  An example of such a node you may want to apply this might be an unread notification count -- always being sure to update it if it exists in the response.
 
 ## Example App
 
-    cd test/example
-    bundle exec rails server
+There is an example app that you can boot to play with TurboGraft.  Open the console and network inspector and see it in action!  This same app is also used in the TurboGraft browser testing suite.
+
+```
+./server
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/turbograft/fork )
+1. Fork it ( http://github.com/Shopify/turbograft/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Write some tests, and edit the example app
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+## Testing
+
+- `./server` and visit http://localhost:3000/teaspoon to run the JS test suite
+- `bundle exec rake test` to run the browser test suite

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

@@ -104,6 +104,7 @@ class window.Turbolinks
   @loadPage: (url, xhr, partialReplace = false, onLoadFunction = (->), replaceContents = [], replaceAllExcept = []) ->
     triggerEvent 'page:receive'
 
+
     if doc = processResponse(xhr, partialReplace)
       reflectNewUrl url
       nodes = changePage(extractTitleAndBody(doc)..., partialReplace, replaceContents, replaceAllExcept)
@@ -115,13 +116,16 @@ class window.Turbolinks
 
     return
 
-  changePage = (title, body, csrfToken, runScripts, partialReplace, replaceContents = [], replaceAllExcept = []) ->
+  changePage = (title, body, csrfToken, runScripts, partialReplace, onlyKeys = [], exceptKeys = []) ->
     document.title = title if title
-    if replaceContents.length
-      return refreshNodesWithKeys(replaceContents, body)
+
+    refreshRefreshAlwaysNodes(body)
+    if onlyKeys.length
+      return refreshNodesWithKeys(onlyKeys, body)
     else
-      if replaceAllExcept.length
-        refreshAllExceptWithKeys(replaceAllExcept, body)
+      persistStaticElements(body)
+      if exceptKeys.length
+        refreshAllExceptWithKeys(exceptKeys, body)
       else
         deleteRefreshNeverNodes(body)
 
@@ -141,15 +145,7 @@ class window.Turbolinks
 
     return
 
-  refreshNodesWithKeys = (keys, body) ->
-    allNodesToBeRefreshed = []
-    for node in document.querySelectorAll("[refresh-always]")
-      allNodesToBeRefreshed.push(node)
-
-    for key in keys
-      for node in document.querySelectorAll("[refresh=#{key}]")
-        allNodesToBeRefreshed.push(node)
-
+  refreshNodes = (allNodesToBeRefreshed, body) ->
     triggerEvent 'page:before-partial-replace', allNodesToBeRefreshed
 
     parentIsRefreshing = (node) ->
@@ -177,19 +173,49 @@ class window.Turbolinks
 
     refreshedNodes
 
-  refreshAllExceptWithKeys = (keys, body) ->
-    allNodesToKeep = []
+  refreshRefreshAlwaysNodes = (body) ->
+    allNodesToBeRefreshed = []
+    for node in document.querySelectorAll("[refresh-always]")
+      allNodesToBeRefreshed.push(node)
+
+    refreshNodes(allNodesToBeRefreshed, body)
+    return
 
+  refreshNodesWithKeys = (keys, body) ->
+    allNodesToBeRefreshed = []
     for key in keys
       for node in document.querySelectorAll("[refresh=#{key}]")
-        allNodesToKeep.push(node)
+        allNodesToBeRefreshed.push(node)
 
+    refreshNodes(allNodesToBeRefreshed, body)
+    return
+
+  keepNodes = (body, allNodesToKeep) ->
     for existingNode in allNodesToKeep
       unless nodeId = existingNode.getAttribute('id')
-        throw new Error "Turbolinks refresh: Refresh key elements must have an id."
+        throw new Error("TurboGraft refresh: Kept nodes must have an id.")
 
-      remoteNode = body.querySelector("##{ nodeId }")
-      remoteNode.parentNode.replaceChild(existingNode, remoteNode)
+      if remoteNode = body.querySelector("##{ nodeId }")
+        remoteNode.parentNode.replaceChild(existingNode, remoteNode)
+
+  persistStaticElements = (body) ->
+    allNodesToKeep = []
+
+    nodes = document.querySelectorAll("[tg-static]")
+    allNodesToKeep.push(node) for node in nodes
+
+    keepNodes(body, allNodesToKeep)
+    return
+
+  refreshAllExceptWithKeys = (keys, body) ->
+    allNodesToKeep = []
+
+    for key in keys
+      for node in document.querySelectorAll("[refresh=#{key}]")
+        allNodesToKeep.push(node)
+
+    keepNodes(body, allNodesToKeep)
+    return
 
   executeScriptTags = ->
     scripts = Array::slice.call document.body.querySelectorAll 'script:not([data-turbolinks-eval="false"])'

data/lib/turbograft/version.rb

@@ -1,3 +1,3 @@
 module TurboGraft
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbograft
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kristian Plettenberg-Dussault
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails