turbolinks-js 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+Turbolinks-js
+=============
+
+Same as [Turbolinks](https://github.com/rails/turbolinks) but without CoffeeScript
+requirement.
+
+Turbolinks makes following links in your web application faster. Instead of
+letting the browser recompile the JavaScript and CSS between each page change,
+and potentially spend extra HTTP requests checking if the assets are up-to-date,
+we keep the current instance alive and replace only the body and the title in the
+head. Think CGI vs persistent process.
+
+This is similar to pjax, but instead of worrying about what element on the page to
+replace, and tailoring the server-side response to fit, we replace the entire body.
+This means that you get the bulk of the speed benefits from pjax (no recompiling of
+the JavaScript or CSS) without having to tailor the server-side response. It just
+works.
+
+By default, all internal links will be funneled through Turbolinks, but you can opt
+out by marking links with data-no-turbolink.
+
+No jQuery or any other framework
+--------------------------------
+
+Turbolinks is designed to be as light-weight as possible (so you won't think twice about using it even for mobile stuff). It does not require jQuery or any other framework to work.
+But it works great _with_ jQuery or Prototype or whatever else have you.
+
+The page:update event
+---------------------
+
+Since pages will change without a full reload with Turbolinks, you can't by default
+rely on `dom:loaded` to trigger your JavaScript code. Instead, Turbolinks uses the
+`page:update` event.
+
+Triggering a Turbolinks visit manually
+---------------------------------------
+
+You can use `Turbolinks.visit(path)` to go to a URL through Turbolinks.
+
+Available only for pushState browsers
+-------------------------------------
+
+Like pjax, this naturally only works with browsers capable of `pushState`. But of
+course we fall back gracefully to full page reloads for browsers that do not support
+it.
+
+Work left to do
+---------------
+
+* CSS/JS asset change detection and reload.
+* Add a DOM cache for faster back button.
+* Remember scroll position when using back button.

data/lib/assets/javascripts/turbolinks.js

@@ -0,0 +1,146 @@
+(function() {
+  var anchoredLink, browserSupportsPushState, createDocument, crossOriginLink, extractLink, fetchReplacement, fullReplacement, handleClick, ignoreClick, newTabClick, noTurbolink, nonHtmlLink, reflectNewUrl, rememberInitialPage, replaceHTML, triggerPageChange, visit;
+
+  visit = function(url) {
+    if (typeof browserSupportsPushState !== "undefined" && browserSupportsPushState !== null) {
+      reflectNewUrl(url);
+      return fetchReplacement(url);
+    } else {
+      return document.location.href = url;
+    }
+  };
+
+  fetchReplacement = function(url) {
+    var xhr;
+    xhr = new XMLHttpRequest;
+    xhr.open('GET', url, true);
+    xhr.setRequestHeader('Accept', 'text/html, application/xhtml+xml, application/xml');
+    xhr.onload = function() {
+      return fullReplacement(xhr.responseText, url);
+    };
+    xhr.onabort = function() {
+      return console.log("Aborted turbolink fetch!");
+    };
+    return xhr.send();
+  };
+
+  fullReplacement = function(html, url) {
+    replaceHTML(html);
+    return triggerPageChange();
+  };
+
+  reflectNewUrl = function(url) {
+    return window.history.pushState({
+      turbolinks: true
+    }, "", url);
+  };
+
+  triggerPageChange = function() {
+    var event;
+    event = document.createEvent('Events');
+    event.initEvent('page:change', true, true);
+    return document.dispatchEvent(event);
+  };
+
+  createDocument = (function() {
+    var createDocumentUsingParser, createDocumentUsingWrite, testDoc, _ref;
+    createDocumentUsingParser = function(html) {
+      return (new DOMParser).parseFromString(html, "text/html");
+    };
+    createDocumentUsingWrite = function(html) {
+      var doc;
+      doc = document.implementation.createHTMLDocument("");
+      doc.open("replace");
+      doc.write(html);
+      doc.close;
+      return doc;
+    };
+    if (window.DOMParser) {
+      testDoc = createDocumentUsingParser("<html><body><p>test");
+    }
+    if ((testDoc != null ? (_ref = testDoc.body) != null ? _ref.childNodes.length : void 0 : void 0) === 1) {
+      return createDocumentUsingParser;
+    } else {
+      return createDocumentUsingWrite;
+    }
+  })();
+
+  replaceHTML = function(html) {
+    var doc, originalBody, title;
+    doc = createDocument(html);
+    originalBody = document.body;
+    document.documentElement.appendChild(doc.body, originalBody);
+    document.documentElement.removeChild(originalBody);
+    if (title = doc.querySelector("title")) {
+      return document.title = title.textContent;
+    }
+  };
+
+  extractLink = function(event) {
+    var link;
+    link = event.target;
+    while (!(link === document || link.nodeName === 'A')) {
+      link = link.parentNode;
+    }
+    return link;
+  };
+
+  crossOriginLink = function(link) {
+    return location.protocol !== link.protocol || location.host !== link.host;
+  };
+
+  anchoredLink = function(link) {
+    return ((link.hash && link.href.replace(link.hash, '')) === location.href.replace(location.hash, '')) || (link.href === location.href + '#');
+  };
+
+  nonHtmlLink = function(link) {
+    return link.href.match(/\.[a-z]+$/g) && !link.href.match(/\.html?$/g);
+  };
+
+  noTurbolink = function(link) {
+    return link.getAttribute('data-no-turbolink') != null;
+  };
+
+  newTabClick = function(event) {
+    return event.which > 1 || event.metaKey || event.ctrlKey;
+  };
+
+  ignoreClick = function(event, link) {
+    return crossOriginLink(link) || anchoredLink(link) || nonHtmlLink(link) || noTurbolink(link) || newTabClick(event);
+  };
+
+  handleClick = function(event) {
+    var link;
+    link = extractLink(event);
+    if (link.nodeName === 'A' && !ignoreClick(event, link)) {
+      visit(link.href);
+      return event.preventDefault();
+    }
+  };
+
+  browserSupportsPushState = window.history && window.history.pushState && window.history.replaceState;
+
+  rememberInitialPage = function() {
+    return window.history.replaceState({
+      turbolinks: true
+    }, "", document.location.href);
+  };
+
+  if (browserSupportsPushState) {
+    rememberInitialPage();
+    window.addEventListener('popstate', function(event) {
+      var _ref;
+      if ((_ref = event.state) != null ? _ref.turbolinks : void 0) {
+        return fetchReplacement(document.location.href);
+      }
+    });
+    document.addEventListener('click', function(event) {
+      return handleClick(event);
+    });
+  }
+
+  this.Turbolinks = {
+    visit: visit
+  };
+
+}).call(this);

data/lib/turbolinks.rb

@@ -0,0 +1,4 @@
+module Turbolinks
+  class Engine < ::Rails::Engine
+  end
+end

data/test/config.ru

@@ -0,0 +1,14 @@
+require 'sprockets'
+require 'coffee-script'
+
+Root = File.expand_path("../..", __FILE__)
+
+Assets = Sprockets::Environment.new do |env|
+  env.append_path File.join(Root, "lib", "assets", "javascripts")
+end
+
+map "/js" do
+  run Assets
+end
+
+run Rack::Directory.new(Root)

data/test/index.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Home</title>
+  <script type="text/javascript" src="/js/turbolinks.js"></script>
+  <script type="text/javascript">
+    document.addEventListener("page:change", function() {
+      console.log("page changed");
+    });
+  </script>
+</head>
+<body>
+  <ul>
+    <li><a href="/test/other.html">Other page</a></li>
+    <li><a href="/test/other.html"><span>Wrapped link</span></a></li>
+    <li><a href="http://www.google.com/">Cross origin</a></li>
+  </ul>
+</body>
+</html>

data/test/other.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Home</title>
+  <script type="text/javascript" src="/js/turbolinks.js"></script>
+  <script type="text/javascript">
+    document.addEventListener("page:change", function() {
+      console.log("page changed");
+    });
+  </script>
+</head>
+<body>
+  <ul>
+    <li><a href="/test/index.html">Home</a></li>
+  </ul>
+</body>
+</html>

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: turbolinks-js
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Heinemeier Hansson
+- Francesco Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- lrodriguezsanc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/assets/javascripts/turbolinks.js
+- lib/turbolinks.rb
+- README.md
+- MIT-LICENSE
+- test/config.ru
+- test/index.html
+- test/other.html
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Turbolinks-js makes following links in your web application faster (use with
+  Rails Asset Pipeline). No CoffeeScript requirement.
+test_files: []
+has_rdoc: