upjs-rails 0.17.0 → 0.18.0

data/lib/assets/javascripts/up/proxy.js.coffee

@@ -88,6 +88,16 @@ up.proxy = (($) ->
 
     Note that your browser might [impose its own request limit](http://www.browserscope.org/?category=network)
     regardless of what you configure here.
+  @param {Array<String>} [config.wrapMethods]
+    An array of uppercase HTTP method names. AJAX requests with one of these methods
+    will be converted into a `POST` request and carry their original method as a `_method`
+    parameter. This is to [prevent unexpected redirect behavior](https://makandracards.com/makandra/38347).
+  @param {String} [config.wrapMethodParam]
+    The name of the POST parameter when wrapping HTTP methods in a `POST` request.
+  @param {Array<String>} [config.safeMethods]
+    An array of uppercase HTTP method names that are considered idempotent.
+    The proxy cache will only cache idempotent requests and will clear the entire
+    cache after a non-idempotent request.
   @stable
   ###
   config = u.config
@@ -96,13 +106,16 @@ up.proxy = (($) ->
     cacheSize: 70
     cacheExpiry: 1000 * 60 * 5
     maxRequests: 4
+    wrapMethods: ['PATCH', 'PUT', 'DELETE']
+    wrapMethodParam: '_method'
+    safeMethods: ['GET', 'OPTIONS', 'HEAD']
 
   cacheKey = (request) ->
     normalizeRequest(request)
     [ request.url,
       request.method,
       request.data,
-      request.selector
+      request.target
     ].join('|')
 
   cache = u.cache
@@ -125,11 +138,11 @@ up.proxy = (($) ->
   get = (request) ->
     request = normalizeRequest(request)
     candidates = [request]
-    unless request.selector is 'html'
-      requestForHtml = u.merge(request, selector: 'html')
+    unless request.target is 'html'
+      requestForHtml = u.merge(request, target: 'html')
       candidates.push(requestForHtml)
-      unless request.selector is 'body'
-        requestForBody = u.merge(request, selector: 'body')
+      unless request.target is 'body'
+        requestForBody = u.merge(request, target: 'body')
         candidates.push(requestForBody)
     for candidate in candidates
       if response = cache.get(candidate)
@@ -141,7 +154,7 @@ up.proxy = (($) ->
   @function up.proxy.set
   @param {String} request.url
   @param {String} [request.method='GET']
-  @param {String} [request.selector='body']
+  @param {String} [request.target='body']
   @param {Promise} response
     A promise for the response that is API-compatible with the
     promise returned by [`jQuery.ajax`](http://api.jquery.com/jquery.ajax/).
@@ -158,7 +171,7 @@ up.proxy = (($) ->
   @function up.proxy.remove
   @param {String} request.url
   @param {String} [request.method='GET']
-  @param {String} [request.selector='body']
+  @param {String} [request.target='body']
   @experimental
   ###
   remove = cache.remove
@@ -200,7 +213,7 @@ up.proxy = (($) ->
     unless request._normalized
       request.method = u.normalizeMethod(request.method)
       request.url = u.normalizeUrl(request.url) if request.url
-      request.selector ||= 'body'
+      request.target ||= 'body'
       request._normalized = true
     request
 
@@ -221,13 +234,15 @@ up.proxy = (($) ->
   @function up.proxy.ajax
   @param {String} request.url
   @param {String} [request.method='GET']
-  @param {String} [request.selector='body']
+  @param {String} [request.target='body']
   @param {Boolean} [request.cache]
     Whether to use a cached response, if available.
     If set to `false` a network connection will always be attempted.
   @param {Object} [request.headers={}]
     An object of additional header key/value pairs to send along
     with the request.
+  @param {Object} [request.data={}]
+    An object of request parameters.
   @return
     A promise for the response that is API-compatible with the
     promise returned by [`jQuery.ajax`](http://api.jquery.com/jquery.ajax/).
@@ -238,7 +253,7 @@ up.proxy = (($) ->
     forceCache = (options.cache == true)
     ignoreCache = (options.cache == false)
 
-    request = u.only(options, 'url', 'method', 'data', 'selector', 'headers', '_normalized')
+    request = u.only(options, 'url', 'method', 'data', 'target', 'headers', '_normalized')
 
     pending = true
 
@@ -276,8 +291,6 @@ up.proxy = (($) ->
 
     promise
 
-  SAFE_HTTP_METHODS = ['GET', 'OPTIONS', 'HEAD']
-
   ###*
   Returns `true` if the proxy is not currently waiting
   for a request to finish. Returns `false` otherwise.
@@ -372,9 +385,25 @@ up.proxy = (($) ->
     deferred.promise()
 
   load = (request) ->
-    u.debug('Loading URL %o', request.url)
+    u.debug('Fetching %o via %o', request.url, request.method)
     up.emit('up:proxy:load', request)
-    promise = u.ajax(request)
+
+    # We will modify the request below for features like method wrapping.
+    # Let's not change the original request which would confuse API clients
+    # and cache key logic.
+    request = u.copy(request)
+
+    request.headers ||= {}
+    request.headers['X-Up-Target'] = request.target
+    request.data = u.requestDataAsArray(request.data)
+
+    if u.contains(config.wrapMethods, request.method)
+      request.data.push
+        name: config.wrapMethodParam
+        value: request.method
+      request.method = 'POST'
+
+    promise = $.ajax(request)
     promise.always ->
       up.emit('up:proxy:received', request)
       pokeQueue()
@@ -393,7 +422,7 @@ up.proxy = (($) ->
   @event up:proxy:load
   @param event.url
   @param event.method
-  @param event.selector
+  @param event.target
   @experimental
   ###
 
@@ -404,13 +433,13 @@ up.proxy = (($) ->
   @event up:proxy:received
   @param event.url
   @param event.method
-  @param event.selector
+  @param event.target
   @experimental
   ###
 
   isIdempotent = (request) ->
     normalizeRequest(request)
-    u.contains(SAFE_HTTP_METHODS, request.method)
+    u.contains(config.safeMethods, request.method)
 
   checkPreload = ($link) ->
     delay = parseInt(u.presentAttr($link, 'up-delay')) || config.preloadDelay 

data/lib/assets/javascripts/up/rails.js.coffee

@@ -10,9 +10,27 @@ up.rails = (($) ->
   willHandle = ($element) ->
     $element.is('[up-follow], [up-target], [up-modal], [up-popup]')
 
-  up.compiler '[data-method]', ($element) ->
-    if $.rails && willHandle($element)
-      u.setMissingAttrs($element, 'up-method': $element.attr('data-method'))
-      $element.removeAttr('data-method')
+  isRails = ->
+    u.isGiven($.rails)
+
+  u.each ['method', 'confirm'], (feature) ->
+
+    dataAttribute = "data-#{feature}"
+    upAttribute = "up-#{feature}"
+
+    up.compiler "[#{dataAttribute}]", ($element) ->
+      if isRails() && willHandle($element)
+        replacement = {}
+        replacement[upAttribute] = $element.attr(dataAttribute)
+        u.setMissingAttrs($element, replacement)
+        $element.removeAttr(dataAttribute)
+
+  csrfField = ->
+    if isRails()
+      name: $.rails.csrfParam()
+      value: $.rails.csrfToken()
+
+  csrfField: csrfField
+  isRails: isRails
 
 )(jQuery)

data/lib/assets/javascripts/up/syntax.js.coffee

@@ -332,8 +332,8 @@ up.syntax = (($) ->
   ###
 
   up.on 'ready', (-> hello(document.body))
-  up.on 'up:fragment:inserted', (event) -> compile(event.$element)
-  up.on 'up:fragment:destroy', (event) -> runDestroyers(event.$element)
+  up.on 'up:fragment:inserted', (event, $element) -> compile($element)
+  up.on 'up:fragment:destroy', (event, $element) -> runDestroyers($element)
   up.on 'up:framework:boot', snapshot
   up.on 'up:framework:reset', reset
 

data/lib/assets/javascripts/up/util.js.coffee

@@ -23,18 +23,6 @@ up.util = (($) ->
         cached = true
         cache = func(args...)
 
-  ###*
-  @function up.util.ajax
-  @internal
-  ###
-  ajax = (request) ->
-    request = copy(request)
-    if request.selector
-      request.headers ||= {}
-      request.headers['X-Up-Selector'] = request.selector
-    # Delegate to jQuery
-    $.ajax(request)
-
   ###*
   Returns if the given port is the default port for the given protocol.
 
@@ -247,8 +235,8 @@ up.util = (($) ->
       selector = "##{id}"
     else if name = presence($element.attr("name"))
       selector = "[name='#{name}']"
-    else if classString = presence($element.attr("class"))
-      classes = classString.split(' ')
+    else if classes = presence(nonUpClasses($element))
+      console.log("using klass!", classes)
       selector = ''
       for klass in classes
         selector += ".#{klass}"
@@ -256,6 +244,11 @@ up.util = (($) ->
       selector = $element.prop('tagName').toLowerCase()
     selector
 
+  nonUpClasses = ($element) ->
+    classString = $element.attr('class') || ''
+    classes = classString.split(' ')
+    select classes, (klass) -> isPresent(klass) && !klass.match(/^up-/)
+
   # jQuery's implementation of $(...) cannot create elements that have
   # an <html> or <body> tag. So we're using native elements.
   # Also IE9 cannot set innerHTML on a <html> or <head> element.
@@ -761,6 +754,30 @@ up.util = (($) ->
         matches.push(element)
     matches
 
+  ###*
+  Returns all elements from the given array that do not return
+  a truthy value when passed to the given function.
+
+  @function up.util.reject
+  @param {Array<T>} array
+  @return {Array<T>}
+  @stable
+  ###
+  reject = (array, tester) ->
+    select(array, (element) -> !tester(element))
+
+  ###*
+  Returns the intersection of the given two arrays.
+
+  Implementation is not optimized. Don't use it for large arrays.
+
+  @function up.util.intersect
+  @internal
+  ###
+  intersect = (array1, array2) ->
+    select array1, (element) ->
+      contains(array2, element)
+
   ###*
   Returns the first [present](/up.util.isPresent) element attribute
   among the given list of attribute names.
@@ -1098,6 +1115,21 @@ up.util = (($) ->
         filtered[property] = object[property]
     filtered
 
+  ###*
+  Returns a copy of the given object that contains all except
+  the given properties.
+
+  @function up.util.except
+  @param {Object} object
+  @param {Array} keys...
+  @stable
+  ###
+  except = (object, properties...) ->
+    filtered = copy(object)
+    for property in properties
+      delete filtered[property]
+    filtered
+
   ###*
   @function up.util.isUnmodifiedKeyEvent
   @internal
@@ -1179,7 +1211,20 @@ up.util = (($) ->
     joined.resolve = ->
       each deferreds, (deferred) -> deferred.resolve?()
     joined
-    
+
+#  resolvableSequence = (first, callbacks...) ->
+#    sequence = $.Deferred().promise()
+#    values = [first]
+#    current = first
+#    for callback in callbacks
+#      current = current.then ->
+#        value = callback()
+#        values.push(value) if u.isPromise(value)
+#        value
+#    sequence.resolve = ->
+#      each values, (deferred) -> deferred.resolve?()
+#    sequence
+
   ###*
   On the given element, set attributes that are still missing.
 
@@ -1446,6 +1491,43 @@ up.util = (($) ->
 #    else
 #      error('Could not parse argument names of %o', fun)
 
+  ###*
+  Normalizes the given params object to the form returned by
+  [`jQuery.serializeArray`](https://api.jquery.com/serializeArray/).
+
+  @function up.util.requestDataAsArray
+  @param {Object|Array|Undefined|Null} data
+  @internal
+  ###
+  requestDataAsArray = (data) ->
+    if isMissing(data)
+      []
+    else if isArray(data)
+      data
+    else if isObject(data)
+      { name: name, value: value } for name, value of data
+    else
+      error('Unknown options.data type for %o', data)
+
+  ###*
+  Returns an URL-encoded query string for the given params object.
+
+  @function up.util.requestDataAsQueryString
+  @param {Object|Array|Undefined|Null} data
+  @internal
+  ###
+  requestDataAsQueryString = (data) ->
+    array = requestDataAsArray(data)
+    query = ''
+    if isPresent(array)
+      query += '?'
+      each array, (field, index) ->
+        query += '&' unless index == 0
+        query += encodeURIComponent(field.name) + '=' + encodeURIComponent(field.value)
+    query
+
+  requestDataAsArray: requestDataAsArray
+  requestDataAsQueryString: requestDataAsQueryString
   offsetParent: offsetParent
   fixedToAbsolute: fixedToAbsolute
   presentAttr: presentAttr
@@ -1456,7 +1538,6 @@ up.util = (($) ->
   createElementFromHtml: createElementFromHtml
   $createElementFromSelector: $createElementFromSelector
   selectorForElement: selectorForElement
-  ajax: ajax
   extend: extend
   copy: copy
   merge: merge
@@ -1471,6 +1552,8 @@ up.util = (($) ->
   any: any
   detect: detect
   select: select
+  reject: reject
+  intersect: intersect
   compact: compact
   uniq: uniq
   last: last
@@ -1514,6 +1597,7 @@ up.util = (($) ->
   methodFromXhr: methodFromXhr
   clientSize: clientSize
   only: only
+  except: except
   trim: trim
   unresolvableDeferred: unresolvableDeferred
   unresolvablePromise: unresolvablePromise

data/lib/upjs/rails/inspector.rb

@@ -16,7 +16,7 @@ module Upjs
       # [page fragment update](http://upjs.io/up.replace) triggered by an
       # Up.js frontend.
       def up?
-        selector.present?
+        target.present?
       end
 
       ##
@@ -29,8 +29,8 @@ module Upjs
       #
       # Server-side code is free to optimize its response by only returning HTML
       # that matches this selector.
-      def selector
-        request.headers['X-Up-Selector']
+      def target
+        request.headers['X-Up-Target']
       end
 
       ##

data/lib/upjs/rails/version.rb

@@ -4,6 +4,6 @@ module Upjs
     # The current version of the upjs-rails gem.
     # This version number is also used for releases of the Up.js
     # frontend code.
-    VERSION = '0.17.0'
+    VERSION = '0.18.0'
   end
 end

data/spec_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    upjs-rails (0.16.0)
+    upjs-rails (0.17.0)
       rails (>= 3)
 
 GEM
@@ -210,6 +210,3 @@ DEPENDENCIES
   uglifier (>= 1.3.0)
   upjs-rails!
   web-console (~> 2.0)
-
-BUNDLED WITH
-   1.11.2

data/spec_app/app/controllers/test_controller.rb

@@ -4,8 +4,8 @@ class TestController < ActionController::Base
     render :text => up?.to_s
   end
 
-  def up_selector
-    render :text => up.selector
+  def up_target
+    render :text => up.target
   end
 
   def is_up_validate

data/spec_app/spec/controllers/test_controller_spec.rb

@@ -2,13 +2,13 @@ describe TestController do
 
   describe '#up?' do
 
-    it 'returns true if the request has an X-Up-Selector header' do
-      request.headers['X-Up-Selector'] = 'body'
+    it 'returns true if the request has an X-Up-Target header' do
+      request.headers['X-Up-Target'] = 'body'
       get :is_up
       expect(response.body).to eq('true')
     end
 
-    it 'returns false if the request has no X-Up-Selector header' do
+    it 'returns false if the request has no X-Up-Target header' do
       get :is_up
       expect(response.body).to eq('false')
     end
@@ -20,8 +20,8 @@ describe TestController do
     describe '#selector' do
 
       it 'returns the CSS selector that is requested via Up.js' do
-        request.headers['X-Up-Selector'] = '.foo'
-        get :up_selector
+        request.headers['X-Up-Target'] = '.foo'
+        get :up_target
         expect(response.body).to eq('.foo')
       end