rails_admin 0.4.1 → 0.4.2

data/README.md

@@ -1,12 +1,14 @@
 # RailsAdmin
+[![Gem Version](https://badge.fury.io/rb/rails_admin.png)][gem]
 [![Build Status](https://secure.travis-ci.org/sferik/rails_admin.png?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/sferik/rails_admin.png?travis)][gemnasium]
 [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
-[![Pledgie](https://www.pledgie.com/campaigns/15917.png)][pledgie]
+[![Pledgie](http://www.pledgie.com/campaigns/15917.png)][pledgie]
 [![Flattr](http://api.flattr.com/button/flattr-badge-large.png)][flattr]
 
 RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.
 
+[gem]: https://rubygems.org/gems/rails_admin
 [travis]: http://travis-ci.org/sferik/rails_admin
 [gemnasium]: https://gemnasium.com/sferik/rails_admin
 [codeclimate]: https://codeclimate.com/github/sferik/rails_admin

data/app/assets/javascripts/rails_admin/jquery.pjax.js

@@ -4,28 +4,36 @@
 
 (function($){
 
-// 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.
+// When called on a container with a selector, fetches the href with
+// ajax into the container 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.
 //
+// Exported as $.fn.pjax
+//
 // 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)
+//             (default: current jquery context)
 //      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
+// For convenience the second parameter can be either the container or
 // the options object.
 //
 // Returns the jQuery object
-$.fn.pjax = function( container, options ) {
-  return this.live('click.pjax', function(event){
-    return handleClick(event, container, options)
+function fnPjax(selector, container, options) {
+  var context = this
+  return this.on('click.pjax', selector, function(event) {
+    var opts = $.extend({}, optionsFor(container, options))
+    if (!opts.container)
+      opts.container = $(this).attr('data-pjax') || context
+    handleClick(event, opts)
   })
 }
 
@@ -38,16 +46,16 @@ $.fn.pjax = function( container, options ) {
 //
 // Examples
 //
-//   $('a').live('click', $.pjax.click)
+//   $(document).on('click', 'a', $.pjax.click)
 //   // is the same as
-//   $('a').pjax()
+//   $(document).pjax('a')
 //
 //  $(document).on('click', 'a', function(event) {
 //    var container = $(this).closest('[data-pjax-container]')
-//    return $.pjax.click(event, container)
+//    $.pjax.click(event, container)
 //  })
 //
-// Returns false if pjax runs, otherwise nothing.
+// Returns nothing.
 function handleClick(event, container, options) {
   options = optionsFor(container, options)
 
@@ -58,7 +66,7 @@ function handleClick(event, container, options) {
 
   // Middle click, cmd click, and ctrl click should open
   // links in a new tab as normal.
-  if ( event.which > 1 || event.metaKey )
+  if ( event.which > 1 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey )
     return
 
   // Ignore cross origin links
@@ -66,24 +74,62 @@ function handleClick(event, container, options) {
     return
 
   // Ignore anchors on the same page
-  if ( link.hash && link.href.replace(link.hash, '') ===
-       location.href.replace(location.hash, '') )
+  if (link.hash && link.href.replace(link.hash, '') ===
+       location.href.replace(location.hash, ''))
+    return
+
+  // Ignore empty anchor "foo.html#"
+  if (link.href === location.href + '#')
     return
 
   var defaults = {
     url: link.href,
     container: $(link).attr('data-pjax'),
     target: link,
-    clickedElement: $(link), // DEPRECATED: use target
     fragment: null
   }
 
-  $.pjax($.extend({}, defaults, options))
+  pjax($.extend({}, defaults, options))
 
   event.preventDefault()
-  return false
 }
 
+// Public: pjax on form submit handler
+//
+// Exported as $.pjax.submit
+//
+// event   - "click" jQuery.Event
+// options - pjax options
+//
+// Examples
+//
+//  $(document).on('submit', 'form', function(event) {
+//    var container = $(this).closest('[data-pjax-container]')
+//    $.pjax.submit(event, container)
+//  })
+//
+// Returns nothing.
+function handleSubmit(event, container, options) {
+  options = optionsFor(container, options)
+
+  var form = event.currentTarget
+
+  if (form.tagName.toUpperCase() !== 'FORM')
+    throw "$.pjax.submit requires a form element"
+
+  var defaults = {
+    type: form.method,
+    url: form.action,
+    data: $(form).serializeArray(),
+    container: $(form).attr('data-pjax'),
+    target: form,
+    fragment: null
+  }
+
+  pjax($.extend({}, defaults, options))
+
+  event.preventDefault()
+}
 
 // Loads a URL with ajax, puts the response body inside a container,
 // then pushState()'s the loaded URL.
@@ -104,7 +150,7 @@ function handleClick(event, container, options) {
 //   console.log( xhr.readyState )
 //
 // Returns whatever $.ajax returns.
-var pjax = $.pjax = function( options ) {
+function pjax(options) {
   options = $.extend(true, {}, $.ajaxSettings, pjax.defaults, options)
 
   if ($.isFunction(options.url)) {
@@ -113,18 +159,8 @@ var pjax = $.pjax = function( options ) {
 
   var target = options.target
 
-  // DEPRECATED: use options.target
-  if (!target && options.clickedElement) target = options.clickedElement[0]
-
   var hash = parseURL(options.url).hash
 
-  // DEPRECATED: Save references to original event callbacks. However,
-  // listening for custom pjax:* events is prefered.
-  var oldBeforeSend = options.beforeSend,
-      oldComplete   = options.complete,
-      oldSuccess    = options.success,
-      oldError      = options.error
-
   var context = options.context = findContainerFor(options.container)
 
   // We want the browser to maintain two separate internal caches: one
@@ -143,13 +179,9 @@ var pjax = $.pjax = function( options ) {
   var timeoutTimer
 
   options.beforeSend = function(xhr, settings) {
-    if (settings.timeout > 0) {
-      timeoutTimer = setTimeout(function() {
-        if (fire('pjax:timeout', [xhr, options]))
-          xhr.abort('timeout')
-      }, settings.timeout)
-
-      // Clear timeout setting so jquerys internal timeout isn't invoked
+    // No timeout for non-GET requests
+    // Its not safe to request the resource again with a fallback method.
+    if (settings.type !== 'GET') {
       settings.timeout = 0
     }
 
@@ -158,68 +190,67 @@ var pjax = $.pjax = function( options ) {
 
     var result
 
-    // DEPRECATED: Invoke original `beforeSend` handler
-    if (oldBeforeSend) {
-      result = oldBeforeSend.apply(this, arguments)
-      if (result === false) return false
-    }
+    if (!fire('pjax:beforeSend', [xhr, settings]))
+      return false
+
+    if (settings.timeout > 0) {
+      timeoutTimer = setTimeout(function() {
+        if (fire('pjax:timeout', [xhr, options]))
+          xhr.abort('timeout')
+      }, settings.timeout)
 
-    if (!fire('pjax:beforeSend', [xhr, settings])) return false
+      // Clear timeout setting so jquerys internal timeout isn't invoked
+      settings.timeout = 0
+    }
 
-    fire('pjax:start', [xhr, options])
-    // start.pjax is deprecated
-    fire('start.pjax', [xhr, options])
+    options.requestUrl = parseURL(settings.url).href
   }
 
   options.complete = function(xhr, textStatus) {
     if (timeoutTimer)
       clearTimeout(timeoutTimer)
 
-    // DEPRECATED: Invoke original `complete` handler
-    if (oldComplete) oldComplete.apply(this, arguments)
-
     fire('pjax:complete', [xhr, textStatus, options])
 
     fire('pjax:end', [xhr, options])
-    // end.pjax is deprecated
-    fire('end.pjax', [xhr, options])
   }
 
   options.error = function(xhr, textStatus, errorThrown) {
     var container = extractContainer("", xhr, options)
 
-    // DEPRECATED: Invoke original `error` handler
-    if (oldError) oldError.apply(this, arguments)
-
     var allowed = fire('pjax:error', [xhr, textStatus, errorThrown, options])
-    if (textStatus !== 'abort' && allowed)
-      window.location = container.url
+    if (options.type == 'GET' && textStatus !== 'abort' && allowed) {
+      locationReplace(container.url)
+    }
   }
 
   options.success = function(data, status, xhr) {
     var container = extractContainer(data, xhr, options)
 
     if (!container.contents) {
-      window.location = container.url
+      locationReplace(container.url)
       return
     }
 
     pjax.state = {
       id: options.id || uniqueId(),
       url: container.url,
+      title: container.title,
       container: context.selector,
       fragment: options.fragment,
       timeout: options.timeout
     }
 
+    if (options.push || options.replace) {
+      window.history.replaceState(pjax.state, container.title, container.url)
+    }
+
     if (container.title) document.title = container.title
     context.html(container.contents)
 
-    if ( options.replace ) {
-      window.history.replaceState(pjax.state, container.title, container.url)
-    } else if ( options.push ) {
-      window.history.pushState(pjax.state, container.title, container.url)
-    }
+    // Scroll to top by default
+    if (typeof options.scrollTo === 'number')
+      $(window).scrollTop(options.scrollTo)
 
     // Google Analytics support
     if ( (options.replace || options.push) && window._gaq )
@@ -228,12 +259,21 @@ var pjax = $.pjax = function( options ) {
     // If the URL has a hash in it, make sure the browser
     // knows to navigate to the hash.
     if ( hash !== '' ) {
-      window.location.href = hash
+      // Avoid using simple hash set here. Will add another history
+      // entry. Replace the url with replaceState and scroll to target
+      // by hand.
+      //
+      //   window.location.hash = hash
+      var url = parseURL(container.url)
+      url.hash = hash
+
+      pjax.state.url = url.href
+      window.history.replaceState(pjax.state, container.title, url.href)
+
+      var target = $(url.hash)
+      if (target.length) $(window).scrollTop(target.offset().top)
     }
 
-    // DEPRECATED: Invoke original `success` handler
-    if (oldSuccess) oldSuccess.apply(this, arguments)
-
     fire('pjax:success', [data, status, xhr, options])
   }
 
@@ -246,6 +286,7 @@ var pjax = $.pjax = function( options ) {
     pjax.state = {
       id: uniqueId(),
       url: window.location.href,
+      title: document.title,
       container: context.selector,
       fragment: options.fragment,
       timeout: options.timeout
@@ -261,12 +302,148 @@ var pjax = $.pjax = function( options ) {
   }
 
   pjax.options = options
-  pjax.xhr = $.ajax(options)
-  $(document).trigger('pjax', [pjax.xhr, options])
+  var xhr = pjax.xhr = $.ajax(options)
+
+  if (xhr.readyState > 0) {
+    if (options.push && !options.replace) {
+      // Cache current container element before replacing it
+      cachePush(pjax.state.id, context.clone().contents())
+
+      window.history.pushState(null, "", stripPjaxParam(options.requestUrl))
+    }
+
+    fire('pjax:start', [xhr, options])
+    fire('pjax:send', [xhr, options])
+  }
 
   return pjax.xhr
 }
 
+// Public: Reload current page with pjax.
+//
+// Returns whatever $.pjax returns.
+function pjaxReload(container, options) {
+  var defaults = {
+    url: window.location.href,
+    push: false,
+    replace: true,
+    scrollTo: false
+  }
+
+  return pjax($.extend(defaults, optionsFor(container, options)))
+}
+
+// Internal: Hard replace current state with url.
+//
+// Work for around WebKit
+//   https://bugs.webkit.org/show_bug.cgi?id=93506
+//
+// Returns nothing.
+function locationReplace(url) {
+  window.history.replaceState(null, "", "#")
+  window.location.replace(url)
+}
+
+// popstate handler takes care of the back and forward buttons
+//
+// You probably shouldn't use pjax on pages with other pushState
+// stuff yet.
+function onPjaxPopstate(event) {
+  var state = event.state
+
+  if (state && state.container) {
+    var container = $(state.container)
+    if (container.length) {
+      var contents = cacheMapping[state.id]
+
+      if (pjax.state) {
+        // Since state ids always increase, we can deduce the history
+        // direction from the previous state.
+        var direction = pjax.state.id < state.id ? 'forward' : 'back'
+
+        // Cache current container before replacement and inform the
+        // cache which direction the history shifted.
+        cachePop(direction, pjax.state.id, container.clone().contents())
+      } else {
+        // Page was reloaded but we have an existing history entry.
+        // Set it to our initial state.
+        pjax.state = state;
+        return;
+      }
+
+      var popstateEvent = $.Event('pjax:popstate', {
+        state: state,
+        direction: direction
+      })
+      container.trigger(popstateEvent)
+
+      var options = {
+        id: state.id,
+        url: state.url,
+        container: container,
+        push: false,
+        fragment: state.fragment,
+        timeout: state.timeout,
+        scrollTo: false
+      }
+
+      if (contents) {
+        container.trigger('pjax:start', [null, options])
+
+        if (state.title) document.title = state.title
+        container.html(contents)
+        pjax.state = state
+
+        container.trigger('pjax:end', [null, options])
+      } else {
+        pjax(options)
+      }
+
+      // Force reflow/relayout before the browser tries to restore the
+      // scroll position.
+      container[0].offsetHeight
+    } else {
+      locationReplace(location.href)
+    }
+  }
+}
+
+// Fallback version of main pjax function for browsers that don't
+// support pushState.
+//
+// Returns nothing since it retriggers a hard form submission.
+function fallbackPjax(options) {
+  var url = $.isFunction(options.url) ? options.url() : options.url,
+      method = options.type ? options.type.toUpperCase() : 'GET'
+
+  var form = $('<form>', {
+    method: method === 'GET' ? 'GET' : 'POST',
+    action: url,
+    style: 'display:none'
+  })
+
+  if (method !== 'GET' && method !== 'POST') {
+    form.append($('<input>', {
+      type: 'hidden',
+      name: '_method',
+      value: method.toLowerCase()
+    }))
+  }
+
+  var data = options.data
+  if (typeof data === 'string') {
+    $.each(data.split('&'), function(index, value) {
+      var pair = value.split('=')
+      form.append($('<input>', {type: 'hidden', name: pair[0], value: pair[1]}))
+    })
+  } else if (typeof data === 'object') {
+    for (key in data)
+      form.append($('<input>', {type: 'hidden', name: key, value: data[key]}))
+  }
+
+  $(document.body).append(form)
+  form.submit()
+}
 
 // Internal: Generate unique id for state object.
 //
@@ -370,13 +547,7 @@ function findContainerFor(container) {
 //
 // Returns a jQuery object.
 function findAll(elems, selector) {
-  var results = $()
-  elems.each(function() {
-    if ($(this).is(selector))
-      results = results.add(this)
-    results = results.add(selector, this)
-  })
-  return results
+  return elems.filter(selector).add(elems.find(selector));
 }
 
 // Internal: Extracts container and metadata from response.
@@ -395,23 +566,32 @@ function extractContainer(data, xhr, options) {
 
   // Prefer X-PJAX-URL header if it was set, otherwise fallback to
   // using the original requested url.
-  obj.url = stripPjaxParam(xhr.getResponseHeader('X-PJAX-URL') || options.url)
+  obj.url = stripPjaxParam(xhr.getResponseHeader('X-PJAX-URL') || options.requestUrl)
 
   // Attempt to parse response html into elements
-  var $data = $(data)
+  if (/<html/i.test(data)) {
+    var $head = $(data.match(/<head[^>]*>([\s\S.]*)<\/head>/i)[0])
+    var $body = $(data.match(/<body[^>]*>([\s\S.]*)<\/body>/i)[0])
+  } else {
+    var $head = $body = $(data)
+  }
 
   // If response data is empty, return fast
-  if ($data.length === 0)
+  if ($body.length === 0)
     return obj
 
-  // If there's a <title> tag in the response, use it as
+  // If there's a <title> tag in the header, use it as
   // the page's title.
-  obj.title = findAll($data, 'title').last().text()
+  obj.title = findAll($head, 'title').last().text()
 
   if (options.fragment) {
     // If they specified a fragment, look for it in the response
     // and pull it out.
-    var $fragment = findAll($data, options.fragment).first()
+    if (options.fragment === 'body') {
+      var $fragment = $body
+    } else {
+      var $fragment = findAll($body, options.fragment).first()
+    }
 
     if ($fragment.length) {
       obj.contents = $fragment.contents()
@@ -423,7 +603,7 @@ function extractContainer(data, xhr, options) {
     }
 
   } else if (!/<html/i.test(data)) {
-    obj.contents = $data
+    obj.contents = $body
   }
 
   // Clean up any <title> tags
@@ -441,52 +621,110 @@ function extractContainer(data, xhr, options) {
   return obj
 }
 
+// Internal: History DOM caching class.
+var cacheMapping      = {}
+var cacheForwardStack = []
+var cacheBackStack    = []
 
-pjax.defaults = {
-  timeout: 650,
-  push: true,
-  replace: false,
-  type: 'GET',
-  dataType: 'html'
-}
+// Push previous state id and container contents into the history
+// cache. Should be called in conjunction with `pushState` to save the
+// previous container contents.
+//
+// id    - State ID Number
+// value - DOM Element to cache
+//
+// Returns nothing.
+function cachePush(id, value) {
+  cacheMapping[id] = value
+  cacheBackStack.push(id)
+
+  // Remove all entires in forward history stack after pushing
+  // a new page.
+  while (cacheForwardStack.length)
+    delete cacheMapping[cacheForwardStack.shift()]
 
-// Export $.pjax.click
-pjax.click = handleClick
+  // Trim back history stack to max cache length.
+  while (cacheBackStack.length > pjax.defaults.maxCacheLength)
+    delete cacheMapping[cacheBackStack.shift()]
+}
 
+// Shifts cache from directional history cache. Should be
+// called on `popstate` with the previous state id and container
+// contents.
+//
+// direction - "forward" or "back" String
+// id        - State ID Number
+// value     - DOM Element to cache
+//
+// Returns nothing.
+function cachePop(direction, id, value) {
+  var pushStack, popStack
+  cacheMapping[id] = value
 
-// 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
+  if (direction === 'forward') {
+    pushStack = cacheBackStack
+    popStack  = cacheForwardStack
+  } else {
+    pushStack = cacheForwardStack
+    popStack  = cacheBackStack
+  }
 
+  pushStack.push(id)
+  if (id = popStack.pop())
+    delete cacheMapping[id]
+}
 
-// popstate handler takes care of the back and forward buttons
+// Install pjax functions on $.pjax to enable pushState behavior.
 //
-// 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
+// Does nothing if already enabled.
+//
+// Examples
+//
+//     $.pjax.enable()
+//
+// Returns nothing.
+function enable() {
+  $.fn.pjax = fnPjax
+  $.pjax = pjax
+  $.pjax.enable = $.noop
+  $.pjax.disable = disable
+  $.pjax.click = handleClick
+  $.pjax.submit = handleSubmit
+  $.pjax.reload = pjaxReload
+  $.pjax.defaults = {
+    timeout: 650,
+    push: true,
+    replace: false,
+    type: 'GET',
+    dataType: 'html',
+    scrollTo: 0,
+    maxCacheLength: 20
+  }
+  $(window).bind('popstate.pjax', onPjaxPopstate)
+}
 
-  var state = event.state
+// Disable pushState behavior.
+//
+// This is the case when a browser doesn't support pushState. It is
+// sometimes useful to disable pushState for debugging on a modern
+// browser.
+//
+// Examples
+//
+//     $.pjax.disable()
+//
+// Returns nothing.
+function disable() {
+  $.fn.pjax = function() { return this }
+  $.pjax = fallbackPjax
+  $.pjax.enable = enable
+  $.pjax.disable = $.noop
+  $.pjax.click = $.noop
+  $.pjax.submit = $.noop
+  $.pjax.reload = function() { window.location.reload() }
 
-  if (state && state.container) {
-    var container = $(state.container)
-    if (container.length) {
-      $.pjax({
-        id: state.id,
-        url: state.url,
-        container: container,
-        push: false,
-        fragment: state.fragment,
-        timeout: state.timeout
-      })
-    } else {
-      window.location = location.href
-    }
-  }
-})
+  $(window).unbind('popstate.pjax', onPjaxPopstate)
+}
 
 
 // Add the state property to jQuery's event object so we can use it in
@@ -494,50 +732,12 @@ $(window).bind('popstate', function(event){
 if ( $.inArray('state', $.event.props) < 0 )
   $.event.props.push('state')
 
-
-// Is pjax supported by this browser?
+ // Is pjax supported by this browser?
 $.support.pjax =
-  window.history && window.history.pushState && window.history.replaceState
+  window.history && window.history.pushState && window.history.replaceState &&
   // pushState isn't reliable on iOS until 5.
-  && !navigator.userAgent.match(/((iPod|iPhone|iPad).+\bOS\s+[1-4]|WebApps\/.+CFNetwork)/)
-
-
-// Fall back to normalcy for older browsers.
-if ( !$.support.pjax ) {
-  $.pjax = function( options ) {
-    var url = $.isFunction(options.url) ? options.url() : options.url,
-        method = options.type ? options.type.toUpperCase() : 'GET'
-
-    var form = $('<form>', {
-      method: method === 'GET' ? 'GET' : 'POST',
-      action: url,
-      style: 'display:none'
-    })
-
-    if (method !== 'GET' && method !== 'POST') {
-      form.append($('<input>', {
-        type: 'hidden',
-        name: '_method',
-        value: method.toLowerCase()
-      }))
-    }
-
-    var data = options.data
-    if (typeof data === 'string') {
-      $.each(data.split('&'), function(index, value) {
-        var pair = value.split('=')
-        form.append($('<input>', {type: 'hidden', name: pair[0], value: pair[1]}))
-      })
-    } else if (typeof data === 'object') {
-      for (key in data)
-        form.append($('<input>', {type: 'hidden', name: key, value: data[key]}))
-    }
+  !navigator.userAgent.match(/((iPod|iPhone|iPad).+\bOS\s+[1-4]|WebApps\/.+CFNetwork)/)
 
-    $(document.body).append(form)
-    form.submit()
-  }
-  $.pjax.click = $.noop
-  $.fn.pjax = function() { return this }
-}
+$.support.pjax ? enable() : disable()
 
-})(jQuery);
+})(jQuery);