angular-turbolinks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 154e3cc700a4bc97f9bf09d61400d4c72a10a050
+  data.tar.gz: c544bdd9905690010f65bd0216b29a637801672a
+SHA512:
+  metadata.gz: 79ea116909e48bc963193b8de2faf5e5bee3bca335d301be57ae335af52f201d945c467497419d0eee39f725c9747de439cc6454df6711218fa0745ca0b0e1ca
+  data.tar.gz: f62564cb01d3f3b2203c478b4d9dd29c199f6e11ba5a991e58e87bff82c702792933fb94bcb50c8cc84dfc4a87cb7ed0711a1ff32b9a413dee15f9ca0512e26e

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in angular-turbolinks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cary Dunn
+
+MIT License
+
+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,47 @@
+# Angular::Turbolinks
+
+##### Add angular-turbolinks and turbolinks to your Gemfile
+```sh
+gem "turbolinks"
+gem "angular-turbolinks"
+```
+
+##### Add angular-turbolinks to your sprockets
+```sh
+//= require angular-turbolinks
+```
+
+##### Add 'ngTurbolinks' and 'ngRoute' to your angular.module
+```sh
+var app = angular.module('...', [..., 'ngRoute', 'ngTurbolinks'])
+```
+
+##### Make sure HTML5 mode is enabled...
+```sh
+app.config([
+  "$locationProvider", function($locationProvider) {
+    $locationProvider.html5Mode(true);
+  }
+]);
+```
+
+##### Move angular bootstrapping to turbolinks event
+```sh
+$(document).on('ready page:load', ->
+  angular.bootstrap($("body"), ['app'])
+).on('page:before-change', ->
+  angular.element("body").scope().$broadcast("$destroy")
+)
+```
+
+##### TODO
+* add support for turbolinks redirection logic
+
+##### Caveats
+* This is a first stab just to try to get around the '10 $digest() iterations reached using $locationWatch' errors I was receiving when using turbolinks with angular
+  * https://github.com/angular/angular.js/issues/3915
+  * https://github.com/angular/angular.js/issues/2815 (among others)
+  * none of the suggested fixes worked for me and this was happening on chrome
+* This approach uses the angular $location/$locationProvider services for click tracking and pushState, steals the $locationChangeStart event and runs the changed url through turbolinks methods
+* Does not support any of the turbolinks caching
+* Eventually im hoping angular $locationWatch can play nice with external plugins using pushState...

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/angular-turbolinks.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'angular/turbolinks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "angular-turbolinks"
+  spec.version       = Angular::Turbolinks::VERSION
+  spec.authors       = ["Cary Dunn"]
+  spec.email         = ["cary.dunn@gmail.com"]
+  spec.description   = %q{Rails Turbolinks + Angular}
+  spec.summary       = %q{Rails Turbolinks + Angular}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'coffee-rails'
+  spec.add_dependency 'turbolinks'
+end

data/lib/angular/turbolinks.rb

@@ -0,0 +1,8 @@
+require "angular/turbolinks/version"
+
+module Angular
+  module Turbolinks
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/angular/turbolinks/version.rb

@@ -0,0 +1,5 @@
+module Angular
+  module Turbolinks
+    VERSION = "0.0.1"
+  end
+end

data/lib/assets/javascripts/angular-turbolinks.js.coffee

@@ -0,0 +1,193 @@
+angular.module('ngTurbolinks', []).run(($location, $rootScope, $http, $q)->
+
+  loadedAssets = null
+  createDocument = null
+  xhr_req = null
+  referer = null
+
+  triggerEvent = (name, data) ->
+    event = document.createEvent 'Events'
+    event.data = data if data
+    event.initEvent name, true, true
+    document.dispatchEvent event
+
+  popCookie = (name) ->
+    value = document.cookie.match(new RegExp(name+"=(\\w+)"))?[1].toUpperCase() or ''
+    document.cookie = name + '=; expires=Thu, 01-Jan-70 00:00:01 GMT; path=/'
+    value
+
+  rememberReferer = ->
+    referer = document.location.href
+
+  processResponse = (responseText, status, headers)->
+    clientOrServerError = ->
+      400 <= status < 600
+
+    validContent = ->
+      headers()["content-type"].match /^(?:text\/html|application\/xhtml\+xml|application\/xml)(?:;|$)/
+
+    extractTrackAssets = (doc) ->
+      for node in doc.head.childNodes when node.getAttribute?('data-turbolinks-track')?
+        node.getAttribute('src') or node.getAttribute('href')
+
+    assetsChanged = (doc) ->
+      loadedAssets ||= extractTrackAssets document
+      fetchedAssets  = extractTrackAssets doc
+      fetchedAssets.length isnt loadedAssets.length or intersection(fetchedAssets, loadedAssets).length isnt loadedAssets.length
+
+    intersection = (a, b) ->
+      [a, b] = [b, a] if a.length > b.length
+      value for value in a when value in b
+
+    if not clientOrServerError() and validContent()
+      doc = createDocument responseText
+      if doc and !assetsChanged doc
+        return doc
+
+  browserCompatibleDocumentParser = ->
+    createDocumentUsingParser = (html) ->
+      (new DOMParser).parseFromString html, 'text/html'
+
+    createDocumentUsingDOM = (html) ->
+      doc = document.implementation.createHTMLDocument ''
+      doc.documentElement.innerHTML = html
+      doc
+
+    createDocumentUsingWrite = (html) ->
+      doc = document.implementation.createHTMLDocument ''
+      doc.open 'replace'
+      doc.write html
+      doc.close()
+      doc
+
+    # Use createDocumentUsingParser if DOMParser is defined and natively
+    # supports 'text/html' parsing (Firefox 12+, IE 10)
+    #
+    # Use createDocumentUsingDOM if createDocumentUsingParser throws an exception
+    # due to unsupported type 'text/html' (Firefox < 12, Opera)
+    #
+    # Use createDocumentUsingWrite if:
+    #  - DOMParser isn't defined
+    #  - createDocumentUsingParser returns null due to unsupported type 'text/html' (Chrome, Safari)
+    #  - createDocumentUsingDOM doesn't create a valid HTML document (safeguarding against potential edge cases)
+    try
+      if window.DOMParser
+        testDoc = createDocumentUsingParser '<html><body><p>test'
+        createDocumentUsingParser
+    catch e
+      testDoc = createDocumentUsingDOM '<html><body><p>test'
+      createDocumentUsingDOM
+    finally
+      unless testDoc?.body?.childNodes.length is 1
+        return createDocumentUsingWrite
+
+  extractTitleAndBody = (doc) ->
+    title = doc.querySelector 'title'
+    [ title?.textContent, removeNoscriptTags(doc.body), CSRFToken.get(doc).token, 'runScripts' ]
+
+  CSRFToken =
+    get: (doc = document) ->
+      node:   tag = doc.querySelector 'meta[name="csrf-token"]'
+      token:  tag?.getAttribute? 'content'
+
+    update: (latest) ->
+      current = @get()
+      if current.token? and latest? and current.token isnt latest
+        current.node.setAttribute 'content', latest
+
+  changePage = (title, body, csrfToken, runScripts) ->
+    document.title = title
+    document.documentElement.replaceChild body, document.body
+    CSRFToken.update csrfToken if csrfToken?
+    executeScriptTags() if runScripts
+    currentState = window.history.state
+    triggerEvent 'page:change'
+    triggerEvent 'page:update'
+
+  executeScriptTags = ->
+    scripts = Array::slice.call document.body.querySelectorAll 'script:not([data-turbolinks-eval="false"])'
+    for script in scripts when script.type in ['', 'text/javascript']
+      copy = document.createElement 'script'
+      copy.setAttribute attr.name, attr.value for attr in script.attributes
+      copy.appendChild document.createTextNode script.innerHTML
+      { parentNode, nextSibling } = script
+      parentNode.removeChild script
+      parentNode.insertBefore copy, nextSibling
+    return
+
+  removeNoscriptTags = (node) ->
+    node.innerHTML = node.innerHTML.replace /<noscript[\S\s]*?<\/noscript>/ig, ''
+    node
+
+  fetch = (url)->
+    rememberReferer()
+
+    xhr_req.resolve() if xhr_req
+    xhr_req = $q.defer()
+
+    $http.get(url, {
+      headers: {
+        'Accept' : 'text/html, application/xhtml+xml, application/xml'
+        'X-XHR-Referer' : referer
+      },
+      timeout: xhr_req.promise
+    }).success((data, status, headers)->
+      if doc = processResponse(data, status, headers)
+        changePage extractTitleAndBody(doc)...
+        #reflectRedirectedUrl()
+        triggerEvent 'page:load'
+      else
+        document.location.href = url
+    ).error(->
+      console.log 'error'
+    )
+
+  # Handle bug in Firefox 26/27 where history.state is initially undefined
+  historyStateIsDefined =
+    window.history.state != undefined or navigator.userAgent.match /Firefox\/2[6|7]/
+
+  browserSupportsPushState =
+    window.history and window.history.pushState and window.history.replaceState and historyStateIsDefined
+
+  browserIsntBuggy =
+    !navigator.userAgent.match /CriOS\//
+
+  requestMethodIsSafe =
+    popCookie('request_method') in ['GET','']
+
+  browserSupportsTurbolinks = browserSupportsPushState and browserIsntBuggy and requestMethodIsSafe
+
+  browserSupportsCustomEvents =
+    document.addEventListener and document.createEvent
+
+  installDocumentReadyPageEventTriggers = ->
+    document.addEventListener 'DOMContentLoaded', ( ->
+      triggerEvent 'page:change'
+      triggerEvent 'page:update'
+    ), true
+
+  installJqueryAjaxSuccessPageUpdateTrigger = ->
+    if typeof jQuery isnt 'undefined'
+      jQuery(document).on 'ajaxSuccess', (event, xhr, settings) ->
+        return unless jQuery.trim xhr.responseText
+        triggerEvent 'page:update'
+
+  if browserSupportsCustomEvents
+    installDocumentReadyPageEventTriggers()
+    installJqueryAjaxSuccessPageUpdateTrigger()
+
+  if browserSupportsTurbolinks
+    visit = fetch
+    createDocument = browserCompatibleDocumentParser()
+  else
+    visit = (url) ->
+      document.location.href = url
+
+  $rootScope.$on("$locationChangeStart", (event, url, prev_url)->
+    if url == prev_url
+      event.preventDefault()
+      return false
+
+    visit(url)
+  )
+)

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: angular-turbolinks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cary Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails Turbolinks + Angular
+email:
+- cary.dunn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- angular-turbolinks.gemspec
+- lib/angular/turbolinks.rb
+- lib/angular/turbolinks/version.rb
+- lib/assets/javascripts/angular-turbolinks.js.coffee
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Rails Turbolinks + Angular
+test_files: []