pjax-rails 0.1

data/README.md

@@ -0,0 +1,48 @@
+PJAX for Rails 3.1+
+===================
+
+Integrate Chris Wanstrath's PJAX into Rails 3.1+ via the asset pipeline.
+
+To activate, add this to your app/assets/javascripts/application.js (or whatever bundle you use):
+
+    //=require pjax
+
+All links that matches $('a:not([data-remote]):not([data-behavior])') will then use PJAX. 
+
+FIXME: Currently the layout is hardcoded to "application". Need to delegate that to the specific layout of the controller.
+
+Examples for redirect_pjax_to
+-----------------------------
+
+    class ProjectsController < ApplicationController
+      before_filter :set_project, except: [ :index, :create ]
+
+      def index
+        @projects = current_user.projects
+      end
+  
+      def show
+      end
+  
+      def create
+        @project = Project.create params[:project]
+        redirect_pjax_to :show, @project
+      end
+  
+      def update
+        @project.update_attributes params[:project]
+        redirect_pjax_to :show, @project
+      end
+  
+      def destroy
+        @project.destroy
+
+        index # set the objects needed for rendering index
+        redirect_pjax_to :index
+      end
+  
+      private
+        def set_project
+          @project = current_user.projects.find params[:id].to_i
+        end
+    end

data/lib/assets/javascripts/pjax/enable_pjax.js.coffee

@@ -0,0 +1 @@
+$ -> $('a:not([data-remote]):not([data-behavior])').pjax('div#main')

data/lib/assets/javascripts/pjax/index.js

@@ -0,0 +1,3 @@
+//= require ./jquery_pjax
+//= require ./page_triggers
+//= require ./enable_pjax

data/lib/assets/javascripts/pjax/jquery_pjax.js

@@ -0,0 +1,208 @@
+// jquery_pjax.js
+// copyright chris wanstrath
+// https://github.com/defunkt/pjax
+
+// When called on a link, fetches the href with ajax into the
+// container specified as the first parameter or with the data-pjax
+// attribute on the link itself.
+//
+// Tries to make sure the back button and ctrl+click work the way
+// you'd expect.
+//
+// Accepts a jQuery ajax options object that may include these
+// pjax specific options:
+//
+// container - Where to stick the response body. Usually a String selector.
+//             $(container).html(xhr.responseBody)
+//      push - Whether to pushState the URL. Defaults to true (of course).
+//   replace - Want to use replaceState instead? That's cool.
+//
+// For convenience the first parameter can be either the container or
+// the options object.
+//
+// Returns the jQuery object
+$.fn.pjax = function( container, options ) {
+  if ( options )
+    options.container = container
+  else
+    options = $.isPlainObject(container) ? container : {container:container}
+
+  return this.live('click', function(event){
+    // Middle click, cmd click, and ctrl click should open
+    // links in a new tab as normal.
+    if ( event.which > 1 || event.metaKey )
+      return true
+
+    var defaults = {
+      url: this.href,
+      container: $(this).attr('data-pjax')
+    }
+
+    $.pjax($.extend({}, defaults, options))
+
+    event.preventDefault()
+  })
+}
+
+
+// Loads a URL with ajax, puts the response body inside a container,
+// then pushState()'s the loaded URL.
+//
+// Works just like $.ajax in that it accepts a jQuery ajax
+// settings object (with keys like url, type, data, etc).
+//
+// Accepts these extra keys:
+//
+// container - Where to stick the response body.
+//             $(container).html(xhr.responseBody)
+//      push - Whether to pushState the URL. Defaults to true (of course).
+//   replace - Want to use replaceState instead? That's cool.
+//
+// Use it just like $.ajax:
+//
+//   var xhr = $.pjax({ url: this.href, container: '#main' })
+//   console.log( xhr.readyState )
+//
+// Returns whatever $.ajax returns.
+$.pjax = function( options ) {
+  var $container = $(options.container),
+      success = options.success || $.noop
+
+  // We don't want to let anyone override our success handler.
+  delete options.success
+
+  var defaults = {
+    timeout: 650,
+    push: true,
+    replace: false,
+    // We want the browser to maintain two separate internal caches: one for
+    // pjax'd partial page loads and one for normal page loads. Without
+    // adding this secret parameter, some browsers will often confuse the two.
+    data: { _pjax: true },
+    type: 'GET',
+    dataType: 'html',
+    beforeSend: function(xhr){
+      $(document).trigger('start.pjax')
+      xhr.setRequestHeader('X-PJAX', 'true')
+    },
+    error: function(){
+      window.location = options.url
+    },
+    complete: function(){
+      $(document).trigger('end.pjax')
+    },
+    success: function(data){
+      // If we got no data or an entire web page, go directly
+      // to the page and let normal error handling happen.
+      if ( !$.trim(data) || /<html/i.test(data) )
+        return window.location = options.url
+
+      // Make it happen.
+      $container.html(data)
+
+      // If there's a <title> tag in the response, use it as
+      // the page's title.
+      var oldTitle = document.title,
+          title = $.trim( $container.find('title').remove().text() )
+      if ( title ) document.title = title
+
+      var state = {
+        pjax: options.container,
+        timeout: options.timeout
+      }
+
+      // We can't persist $objects using the history API so we need to store
+      // the string selector.
+      if ( $.isPlainObject(state.pjax) )
+        state.pjax = state.pjax.selector
+
+      // If there are extra params, save the complete URL in the state object
+      var query = $.param(options.data)
+      if ( query != "_pjax=true" )
+        state.url = options.url + (/\?/.test(options.url) ? "&" : "?") + query
+
+      if ( options.replace ) {
+        window.history.replaceState(state, document.title, options.url)
+      } else if ( options.push ) {
+        // this extra replaceState before first push ensures good back
+        // button behavior
+        if ( !$.pjax.active ) {
+          window.history.replaceState($.extend({}, state, {url:null}), oldTitle)
+          $.pjax.active = true
+        }
+
+        window.history.pushState(state, document.title, options.url)
+      }
+
+      // Google Analytics support
+      if ( (options.replace || options.push) && window._gaq )
+        _gaq.push(['_trackPageview'])
+
+      // Invoke their success handler if they gave us one.
+      success.apply(this, arguments)
+    }
+  }
+
+  options = $.extend(true, {}, defaults, options)
+
+  if ( $.isFunction(options.url) ) {
+    options.url = options.url()
+  }
+
+  // Cancel the current request if we're already pjaxing
+  var xhr = $.pjax.xhr
+  if ( xhr && xhr.readyState < 4) {
+    xhr.onreadystatechange = $.noop
+    xhr.abort()
+  }
+
+  $.pjax.xhr = $.ajax(options)
+  $(document).trigger('pjax', $.pjax.xhr, options)
+
+  return $.pjax.xhr
+}
+
+
+// Used to detect initial (useless) popstate.
+// If history.state exists, assume browser isn't going to fire initial popstate.
+var popped = ('state' in window.history), initialURL = location.href
+
+
+// popstate handler takes care of the back and forward buttons
+//
+// You probably shouldn't use pjax on pages with other pushState
+// stuff yet.
+$(window).bind('popstate', function(event) {
+  // Ignore inital popstate that some browsers fire on page load
+  var initialPop = !popped && location.href == initialURL
+  popped = true
+  if ( initialPop ) return
+
+  var state = event.state
+
+  if ( state && state.pjax ) {
+    var $container = $(state.pjax+'')
+    if ( $container.length )
+      $.pjax({
+        url: state.url || location.href,
+        container: $container,
+        push: false,
+        timeout: state.timeout
+      })
+    else
+      window.location = location.href
+  }
+})
+
+
+// Add the state property to jQuery's event object so we can use it in
+// $(window).bind('popstate')
+if ( $.event.props.indexOf('state') < 0 )
+  $.event.props.push('state')
+
+
+// Fall back to normalcy for older browsers.
+if ( !window.history || !window.history.pushState ) {
+  $.pjax = $.noop
+  $.fn.pjax = function() { return this }
+}

data/lib/assets/javascripts/pjax/page_triggers.js.coffee

@@ -0,0 +1,10 @@
+$(document).ready ->
+  $(document).trigger 'pageChanged'
+  $(document).trigger 'pageUpdated'
+
+$(document).bind 'end.pjax', ->
+  $(document).trigger 'pageChanged'
+  $(document).trigger 'pageUpdated'
+
+$(document).bind 'ajaxComplete', ->
+  $(document).trigger 'pageUpdated'

data/lib/pjax-rails.rb

@@ -0,0 +1,11 @@
+require 'pjax'
+
+module PjaxRails
+  class Engine < ::Rails::Engine
+    initializer "pjax_rails.add_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        ::ApplicationController.send :include, Pjax
+      end
+    end
+  end
+end

data/lib/pjax.rb

@@ -0,0 +1,29 @@
+module Pjax
+  extend ActiveSupport::Concern
+  
+  included do
+    layout ->(c) { pjax_request? ? false : 'application' }
+  end
+  
+  private  
+    def redirect_pjax_to(action, url = nil)
+      new_url = url_for(url ? url : { action: action })
+      
+      render js: <<-EJS
+        if (!window.history || !window.history.pushState) {
+          window.location.href = '#{new_url}';
+        } else {
+          $('div.pages').html(#{render_to_string("#{action}.html.erb").to_json});
+          $(document).trigger('end.pjax');
+
+          var title = $.trim($('div.pages').find('title').remove().text());
+          if (title) document.title = title;
+          window.history.pushState({}, document.title, '#{new_url}');
+        }
+      EJS
+    end
+
+    def pjax_request?
+      env['HTTP_X_PJAX'].present?
+    end
+end

data/pjax-rails.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name    = 'pjax-rails'
+  s.version = '0.1'
+  s.author  = 'David Heinemeier Hansson (PJAX by Chris Wanstrath)'
+  s.email   = 'david@loudthinking.com'
+  s.summary = 'PJAX integration for Rails 3.1+'
+
+  s.add_dependency 'jquery-rails'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: pjax-rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- David Heinemeier Hansson (PJAX by Chris Wanstrath)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jquery-rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: david@loudthinking.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ./lib/assets/javascripts/pjax/enable_pjax.js.coffee
+- ./lib/assets/javascripts/pjax/index.js
+- ./lib/assets/javascripts/pjax/jquery_pjax.js
+- ./lib/assets/javascripts/pjax/page_triggers.js.coffee
+- ./lib/pjax-rails.rb
+- ./lib/pjax.rb
+- ./pjax-rails.gemspec
+- ./README.md
+has_rdoc: true
+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.6.2
+signing_key: 
+specification_version: 3
+summary: PJAX integration for Rails 3.1+
+test_files: []
+