unpoly-rails 0.37.0 → 0.50.0

data/lib/assets/javascripts/unpoly/browser.coffee

@@ -2,14 +2,16 @@
 Browser support
 ===============
 
-Unpoly supports all modern browsers. It degrades gracefully with old versions of Internet Explorer:
+Unpoly supports all modern browsers.
 
-IE11, Edge
+Chrome, Firefox, Edge, Safari
 : Full support
 
-IE 10 or lower
-: Unpoly prevents itself from booting itself, leaving you with a classic server-side application.
+Internet Explorer 11
+: Full support with a `Promise` polyfill like [es6-promise](https://github.com/stefanpenner/es6-promise) (2.4 KB).
 
+Internet Explorer 10 or lower
+: Unpoly prevents itself from booting itself, leaving you with a classic server-side application.
 
 @class up.browser
 ###
@@ -18,30 +20,15 @@ up.browser = (($) ->
   u = up.util
 
   ###*
-  @method up.browser.loadPage
-  @param {String} url
-  @param {String} [options.method='get']
+  @method up.browser.navigate
+  @param {string} url
+  @param {string} [options.method='get']
   @param {Object|Array} [options.data]
   @internal
   ###
-  loadPage = (url, options = {}) ->
-    method = u.option(options.method, 'get').toLowerCase()
-    if method == 'get'
-      query = u.requestDataAsQuery(options.data)
-      url = "#{url}?#{query}" if query
-      setLocationHref(url)
-    else
-      $form = $("<form method='post' action='#{url}' class='up-page-loader'></form>")
-      addField = (field) ->
-        $field = $('<input type="hidden">')
-        $field.attr(field)
-        $field.appendTo($form)
-      addField(name: up.protocol.config.methodParam, value: method)
-      if csrfField = up.rails.csrfField()
-        addField(csrfField)
-      u.each u.requestDataAsArray(options.data), addField
-      $form.hide().appendTo('body')
-      submitForm($form)
+  navigate = (url, options = {}) ->
+    request = new up.Request(u.merge(options, { url }))
+    request.navigate()
 
   ###*
   For mocking in specs.
@@ -51,14 +38,6 @@ up.browser = (($) ->
   submitForm = ($form) ->
     $form.submit()
 
-  ###*
-  For mocking in specs.
-
-  @method setLocationHref
-  ###
-  setLocationHref = (url) ->
-    location.href = url
-
   ###*
   A cross-browser way to interact with `console.log`, `console.error`, etc.
 
@@ -155,10 +134,10 @@ up.browser = (($) ->
   a request method other than GET.
 
   @function up.browser.canPushState
-  @return {Boolean}
+  @return {boolean}
   @experimental
   ###
-  canPushState = u.memoize ->
+  canPushState = ->
     # We cannot use pushState if the initial request method is a POST for two reasons:
     #
     # 1. Unpoly replaces the initial state so it can handle the pop event when the
@@ -168,7 +147,8 @@ up.browser = (($) ->
     # 2. Some browsers have a bug where the initial request method is used for all
     #    subsequently pushed states. That means if the user reloads the page on a later
     #    GET state, the browser will wrongly attempt a POST request.
-    #    Modern Firefoxes, Chromes and IE10+ don't seem to be affected by this.
+    #    This issue affects Safari 9 and 10 (last tested in 2017-08).
+    #    Modern Firefoxes, Chromes and IE10+ don't have this behavior.
     #
     # The way that we work around this is that we don't support pushState if the
     # initial request method was anything other than GET (but allow the rest of the
@@ -185,52 +165,62 @@ up.browser = (($) ->
   animation by instantly jumping to the last frame.
 
   @function up.browser.canCssTransition
-  @return {Boolean}
+  @return {boolean}
   @internal
   ###
-  canCssTransition = u.memoize ->
+  canCssTransition = ->
     'transition' of document.documentElement.style
 
   ###*
   Returns whether this browser supports the DOM event [`input`](https://developer.mozilla.org/de/docs/Web/Events/input).
 
   @function up.browser.canInputEvent
-  @return {Boolean}
+  @return {boolean}
   @internal
   ###
-  canInputEvent = u.memoize ->
+  canInputEvent = ->
     'oninput' of document.createElement('input')
 
+  ###*
+  Returns whether this browser supports promises.
+
+  @function up.browser.canPromise
+  @return {boolean}
+  @internal
+  ###
+  canPromise = ->
+    !!window.Promise
+
   ###*
   Returns whether this browser supports the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
   interface.
 
   @function up.browser.canFormData
-  @return {Boolean}
+  @return {boolean}
   @experimental
   ###
-  canFormData = u.memoize ->
+  canFormData = ->
     !!window.FormData
 
   ###*
   Returns whether this browser supports the [`DOMParser`](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser)
   interface.
 
-  @function up.browser.canDomParser
-  @return {Boolean}
+  @function up.browser.canDOMParser
+  @return {boolean}
   @internal
   ###
-  canDomParser = u.memoize ->
+  canDOMParser = ->
     !!window.DOMParser
 
   ###*
   Returns whether this browser supports the [`debugging console`](https://developer.mozilla.org/en-US/docs/Web/API/Console).
 
   @function up.browser.canConsole
-  @return {Boolean}
+  @return {boolean}
   @internal
   ###
-  canConsole = u.memoize ->
+  canConsole = ->
     window.console &&
       console.debug &&
       console.info &&
@@ -240,7 +230,7 @@ up.browser = (($) ->
       console.groupCollapsed &&
       console.groupEnd
 
-  isRecentJQuery = u.memoize ->
+  isRecentJQuery = ->
     version = $.fn.jquery
     parts = version.split('.')
     major = parseInt(parts[0])
@@ -264,15 +254,15 @@ up.browser = (($) ->
   ###*
   @function up,browser.whenConfirmed
   @return {Promise}
-  @param {String} options.confirm
-  @param {Boolean} options.preload
+  @param {string} options.confirm
+  @param {boolean} options.preload
   @internal
   ###
   whenConfirmed = (options) ->
     if options.preload || u.isBlank(options.confirm) || window.confirm(options.confirm)
-      u.resolvedPromise()
+      Promise.resolve()
     else
-      u.unresolvablePromise()
+      Promise.reject(new Error('User canceled action'))
 
   ###*
   Returns whether Unpoly supports the current browser.
@@ -283,13 +273,6 @@ up.browser = (($) ->
   This is usually a better fallback than loading incompatible Javascript and causing
   many errors on load.
 
-  \#\#\# Graceful degradation
-
-  This function also returns `true` if Unpoly only support some features, but can degrade
-  gracefully for other features. E.g. Internet Explorer 9 is almost fully supported, but due to
-  its lack of [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
-  Unpoly falls back to a full page load when asked to manipulate history.
-
   @function up.browser.isSupported
   @stable
   ###
@@ -297,11 +280,13 @@ up.browser = (($) ->
     !isIE10OrWorse() &&
       isRecentJQuery() &&
       canConsole() &&
-      canPushState() &&
-      canDomParser() &&
+      # We don't require pushState in order to cater for Safari booting Unpoly with a non-GET method.
+      # canPushState() &&
+      canDOMParser() &&
       canFormData() &&
       canCssTransition() &&
-      canInputEvent()
+      canInputEvent() &&
+      canPromise()
 
   ###*
   @internal
@@ -342,7 +327,8 @@ up.browser = (($) ->
 
   knife: eval(Knife?.point)
   url: url
-  loadPage: loadPage
+  navigate: navigate
+  submitForm: submitForm
   canPushState: canPushState
   whenConfirmed: whenConfirmed
   isSupported: isSupported
@@ -352,5 +338,7 @@ up.browser = (($) ->
   sessionStorage: sessionStorage
   popCookie: popCookie
   hash: hash
+  canPushState: canPushState
 
 )(jQuery)
+

data/lib/assets/javascripts/unpoly/bus.coffee

@@ -55,6 +55,9 @@ up.bus = (($) ->
   liveUpDescriptions = {}
   nextUpDescriptionNumber = 0
 
+  # A hash mapping oldEventName => newEventName
+  renamedEvents = {}
+
   ###*
   Convert an Unpoly style listener (second argument is the event target
   as a jQuery collection) to a vanilla jQuery listener
@@ -76,6 +79,13 @@ up.bus = (($) ->
   ###
   upDescriptionToJqueryDescription = (upDescription, isNew) ->
     jqueryDescription = u.copy(upDescription)
+
+    # Prefer to rename events in the copied jQuery description instead of
+    # changing the original up description.
+    fixRenamedEvents(jqueryDescription)
+
+    # We remove the listener function from the end of the description.
+    # We will re-push it to the description at the end.
     upListener = jqueryDescription.pop()
     jqueryListener = undefined
     if isNew
@@ -84,10 +94,19 @@ up.bus = (($) ->
       upListener._descriptionNumber = ++nextUpDescriptionNumber
     else
       jqueryListener = upListener._asJqueryListener
-      jqueryListener or up.fail('up.off: The event listener %o was never registered through up.on')
+      jqueryListener or up.fail('up.off(): The callback %o was never registered through up.on()', upListener)
     jqueryDescription.push(jqueryListener)
     jqueryDescription
 
+  fixRenamedEvents = (description) ->
+    events = description[0].split(/\s+/)
+    events = u.map events, (event) ->
+      if newEvent = renamedEvents[event]
+        up.log.warn("#{event} has been renamed to #{newEvent}")
+        newEvent
+      else
+        event
+    description[0] = events.join(' ')
 
   ###*
   Listens to an event on `document`.
@@ -165,9 +184,9 @@ up.bus = (($) ->
       });
 
   @function up.on
-  @param {String} events
+  @param {string} events
     A space-separated list of event names to bind.
-  @param {String} [selector]
+  @param {string} [selector]
     The selector of an element on which the event must be triggered.
     Omit the selector to listen to all events with that name, regardless
     of the event target.
@@ -251,7 +270,7 @@ up.bus = (($) ->
       # Prints "bar" to the console
 
   @function up.emit
-  @param {String} eventName
+  @param {string} eventName
     The name of the event.
   @param {Object} [eventProps={}]
     A list of properties to become part of the event object
@@ -260,7 +279,7 @@ up.bus = (($) ->
     or `stopPropagation()`.
   @param {jQuery} [eventProps.$element=$(document)]
     The element on which the event is triggered.
-  @param {String|Array} [eventProps.message]
+  @param {string|Array} [eventProps.message]
     A message to print to the console when the event is emitted.
     If omitted, a default message is printed.
     Set this to `false` to prevent any console output.
@@ -303,40 +322,37 @@ up.bus = (($) ->
   has prevented the default action.
 
   @function up.bus.nobodyPrevents
-  @param {String} eventName
+  @param {string} eventName
   @param {Object} eventProps
-  @param {String|Array} [eventProps.message]
-  @return {Boolean}
+  @param {string|Array} [eventProps.message]
+  @return {boolean}
     whether no listener has prevented the default action
   @experimental
   ###
   nobodyPrevents = (args...) ->
     event = emit(args...)
-    if event.isDefaultPrevented()
-      up.puts "An observer prevented the event %s", args[0]
-      false
-    else
-      true
+    not event.isDefaultPrevented()
 
   ###*
   [Emits](/up.emit) the given event and returns a promise
-  that will be resolved if no listener has prevented the default action.
+  that will be fulfilled if no listener has prevented the default action.
 
   If any listener prevented the default listener
   the returned promise will never be resolved.
 
   @function up.bus.whenEmitted
-  @param {String} eventName
+  @param {string} eventName
   @param {Object} eventProps
-  @param {String|Array} [eventProps.message]
+  @param {string|Array} [eventProps.message]
   @return {Promise}
   @internal
   ###
   whenEmitted = (args...) ->
-    deferred = $.Deferred()
-    if nobodyPrevents(args...)
-      deferred.resolve()
-    deferred.promise()
+    new Promise (resolve, reject) ->
+      if nobodyPrevents(args...)
+        resolve()
+      else
+        reject(new Error("Event #{args[0]} was prevented"))
 
   ###*
   Registers an event listener to be called when the user
@@ -386,18 +402,22 @@ up.bus = (($) ->
   @internal
   ###
   snapshot = ->
-    for description in liveUpDescriptions
+    for number, description of liveUpDescriptions
       description.isDefault = true
 
-  ###*
-  Resets the list of registered event listeners to the
-  moment when the framework was booted.
+  resetBus = ->
+    # Resets the list of registered event listeners to the
+    # moment when the framework was booted.
 
-  @internal
-  ###
-  restoreSnapshot = ->
-    doomedDescriptions = u.reject(liveUpDescriptions, (description) -> description.isDefault)
-    unbind(description...) for description in doomedDescriptions
+    # Copy a list of the descriptions we're going to unbind and iterate over
+    # them a second time below. This way we avoid manipulate the object we're
+    # iterating over.
+    doomedDescriptions = []
+    for number, description of liveUpDescriptions
+      doomedDescriptions.push(description) unless description.isDefault
+
+    for description in doomedDescriptions
+      unbind(description...)
 
   ###*
   Resets Unpoly to the state when it was booted.
@@ -414,6 +434,9 @@ up.bus = (($) ->
   ###
   emitReset = ->
     emit('up:framework:reset', message: 'Resetting framework')
+    # Unfortunately we cannot reset up.protocol via event
+    # without introducing cycles in the asset load order
+    up.protocol.reset()
 
   ###*
   This event is [emitted](/up.emit) when Unpoly is [reset](/up.reset) during unit tests.
@@ -422,6 +445,9 @@ up.bus = (($) ->
   @experimental
   ###
 
+  renamedEvent = (oldEvent, newEvent) ->
+    renamedEvents[oldEvent] = newEvent
+
   ###*
   Boots the Unpoly framework.
 
@@ -435,11 +461,9 @@ up.bus = (($) ->
   ###
   boot = ->
     if up.browser.isSupported()
-      # Can't decouple this via the event bus, since up.bus would require
-      # up.browser.isSupported() and up.browser would require up.on()
       emit('up:framework:boot', message: 'Booting framework')
+      # Unpoly modules now snapshot themselves to suppot reset()
       emit('up:framework:booted', message: 'Framework booted')
-      # User-provided compiler definitions will be registered once this function terminates.
       u.nextFrame ->
         # At this point all user-provided compilers have been registered.
         u.whenReady().then ->
@@ -457,7 +481,7 @@ up.bus = (($) ->
   ###
 
   live 'up:framework:booted', snapshot
-  live 'up:framework:reset', restoreSnapshot
+  live 'up:framework:reset', resetBus
 
   knife: eval(Knife?.point)
   on: live # can't name symbols `on` in Coffeescript
@@ -469,6 +493,7 @@ up.bus = (($) ->
   emitReset: emitReset
   haltEvent: haltEvent
   consumeAction: consumeAction
+  renamedEvent: renamedEvent
   boot: boot
 
 )(jQuery)

data/lib/assets/javascripts/unpoly/classes/cache.coffee

@@ -0,0 +1,117 @@
+u = up.util
+
+###*
+@class up.Cache
+@internal
+###
+class up.Cache
+
+  ###*
+  @constructor
+  @param {number|Function() :number} [config.size]
+    Maximum number of cache entries.
+    Set to `undefined` to not limit the cache size.
+  @param {number|Function(): number} [config.expiry]
+    The number of milliseconds after which a cache entry
+    will be discarded.
+  @param {string} [config.log]
+    A prefix for log entries printed by this cache object.
+  @param {Function(any): string} [config.key]
+    A function that takes an argument and returns a string key
+    for storage. If omitted, `toString()` is called on the argument.
+  @param {Function(any): boolean} [config.cachable]
+    A function that takes a potential cache entry and returns whether
+    this entry  can be stored in the hash. If omitted, all entries are considered
+    cachable.
+  ###
+  constructor: (@config = {}) ->
+    @store = {}
+
+  maxKeys: =>
+    u.evalOption(@config.size)
+
+  expiryMillis: =>
+    u.evalOption(@config.expiry)
+
+  normalizeStoreKey: (key) =>
+    if @config.key
+      @config.key(key)
+    else
+      @key.toString()
+
+  isEnabled: =>
+    @maxKeys() isnt 0 && @expiryMillis() isnt 0
+
+  isCachable: (key) =>
+    if @config.cachable
+      @config.cachable(key)
+    else
+      true
+
+  clear: =>
+    @store = {}
+
+  log: (args...) =>
+    if @config.logPrefix
+      args[0] = "[#{@config.logPrefix}] #{args[0]}"
+      up.puts(args...)
+
+  keys: =>
+    Object.keys(@store)
+
+  makeRoomForAnotherKey: =>
+    storeKeys = u.copy(@keys())
+    max = @maxKeys()
+    if max && storeKeys.length >= max
+      oldestKey = null
+      oldestTimestamp = null
+      u.each storeKeys, (key) =>
+        promise = @store[key] # we don't need to call cacheKey here
+        timestamp = promise.timestamp
+        if !oldestTimestamp || oldestTimestamp > timestamp
+          oldestKey = key
+          oldestTimestamp = timestamp
+      delete @store[oldestKey] if oldestKey
+
+  alias: (oldKey, newKey) =>
+    value = @get(oldKey, silent: true)
+    if u.isDefined(value)
+      @set(newKey, value)
+
+  timestamp: =>
+    (new Date()).valueOf()
+
+  set: (key, value) =>
+    if @isEnabled() && @isCachable(key)
+      @makeRoomForAnotherKey()
+      storeKey = @normalizeStoreKey(key)
+      @log("Setting entry %o to %o", storeKey, value)
+      @store[storeKey] =
+        timestamp: @timestamp()
+        value: value
+
+  remove: (key) =>
+    if @isCachable(key)
+      storeKey = @normalizeStoreKey(key)
+      delete @store[storeKey]
+
+  isFresh: (entry) =>
+    millis = @expiryMillis()
+    if millis
+      timeSinceTouch = @timestamp() - entry.timestamp
+      timeSinceTouch < millis
+    else
+      true
+
+  get: (key, options = {}) =>
+    if @isCachable(key) && (entry = @store[@normalizeStoreKey(key)])
+      if @isFresh(entry)
+        @log("Cache hit for '%s'", key) unless options.silent
+        entry.value
+      else
+        @log("Discarding stale cache entry for '%s'", key) unless options.silent
+        @remove(key)
+        undefined
+    else
+      @log("Cache miss for '%s'", key) unless options.silent
+      undefined

data/lib/assets/javascripts/unpoly/{dom → classes}/extract_cascade.coffee

@@ -1,6 +1,6 @@
 u = up.util
 
-class up.dom.ExtractCascade
+class up.ExtractCascade
 
   constructor: (selector, options) ->
     @options = u.options(options, humanizedTarget: 'selector', layer: 'auto')
@@ -11,7 +11,7 @@ class up.dom.ExtractCascade
         # If we're using a fallback (any candidate that's not the first),
         # the original transition might no longer be appropriate.
         planOptions.transition = up.dom.config.fallbackTransition
-      new up.dom.ExtractPlan(candidate, planOptions)
+      new up.ExtractPlan(candidate, planOptions)
 
   buildCandidates: (selector) ->
     candidates = [selector, @options.fallback, up.dom.config.fallbacks]
@@ -63,7 +63,7 @@ class up.dom.ExtractCascade
         message = "Could not find #{@options.humanizedTarget} in response"
       else
         message = "Could not match #{@options.humanizedTarget} in current page and response"
-      if @response && @options.inspectResponse
+      if @options.inspectResponse
         inspectAction = { label: 'Open response', callback: @options.inspectResponse }
       up.fail(["#{message} (tried %o)", @candidates], action: inspectAction)
 

data/lib/assets/javascripts/unpoly/{dom → classes}/extract_plan.coffee

@@ -1,6 +1,6 @@
 u = up.util
 
-class up.dom.ExtractPlan
+class up.ExtractPlan
 
   constructor: (selector, options) ->
     @origin = options.origin

data/lib/assets/javascripts/unpoly/classes/field_observer.coffee

@@ -0,0 +1,57 @@
+u = up.util
+
+class up.FieldObserver
+
+  # Although (depending on the browser) we only need/receive either input or change,
+  # we always bind to both events in case another script manually triggers it.
+  CHANGE_EVENTS = 'input change'
+
+  constructor: (@$field, options) ->
+    @delay = options.delay
+    @callback = options.callback
+
+  start: =>
+    # Don't use undefined since an unchecked checkbox actually has an undefined value
+    @scheduledValue = null
+    @processedValue = @readFieldValue()
+    @currentTimer = undefined
+    @currentCallback = undefined
+    @$field.on(CHANGE_EVENTS, @check)
+
+  stop: =>
+    @$field.off(CHANGE_EVENTS, @check)
+    @cancelTimer()
+
+  cancelTimer: =>
+    clearTimeout(@currentTimer)
+    @currentTimer = undefined
+
+  scheduleTimer: =>
+    @currentTimer = u.setTimer @delay, =>
+      @currentTimer = undefined
+      @requestCallback()
+
+  isNewValue: (value) =>
+    value != @processedValue && (@scheduledValue == null || @scheduledValue != value)
+
+  requestCallback: =>
+    if @scheduledValue != null && !@currentTimer && !@currentCallback
+      @processedValue = @scheduledValue
+      @scheduledValue = null
+      @currentCallback = => @callback.call(@$field.get(0), @processedValue, @$field)
+      # If the callback returns a promise x, Promise.resolve(x) will wait for it
+      callbackDone = Promise.resolve(@currentCallback())
+      u.always callbackDone, =>
+        # Don't use undefined since an unchecked checkbox actually has an undefined value
+        @currentCallback = undefined
+        @requestCallback()
+
+  readFieldValue: =>
+    u.submittedValue(@$field)
+
+  check: =>
+    value = @readFieldValue()
+    if @isNewValue(value)
+      @scheduledValue = value
+      @cancelTimer()
+      @scheduleTimer()