unpoly-rails 0.56.7 → 0.57.0

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

@@ -6,7 +6,7 @@ class up.Record
     throw 'Return an array of property names'
 
   constructor: (options) ->
-    u.assign(@, @attributes(options))
+    u.assign(this, @attributes(options))
 
   attributes: (source = @) =>
     u.only(source, @fields()...)

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

@@ -27,16 +27,10 @@ class up.Request extends up.Record
   ###
 
   ###**
-  Parameters that should be sent as the request's payload.
+  [Parameters](/up.params) that should be sent as the request's payload.
 
-  Parameters may be passed as one of the following forms:
-
-  1. An object where keys are param names and the values are param values
-  2. An array of `{ name: 'param-name', value: 'param-value' }` objects
-  3. A [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) object
-
-  @property up.Request#data
-  @param {String} data
+  @property up.Request#params
+  @param {object|FormData|string|Array} params
   @stable
   ###
 
@@ -78,11 +72,14 @@ class up.Request extends up.Record
     [
       'method',
       'url',
-      'data',
+      'params',
+      'data', # deprecated. use #params.
       'target',
       'failTarget',
       'headers',
-      'timeout'
+      'timeout',
+      'preload' # since up.proxy.request() options are sometimes wrapped in this class
+      'cache'   # since up.proxy.request() options are sometimes wrapped in this class
     ]
 
   ###**
@@ -94,37 +91,34 @@ class up.Request extends up.Record
     @normalize()
 
   normalize: =>
+    u.deprecateRenamedKey(@, 'data', 'params')
     @method = u.normalizeMethod(@method)
     @headers ||= {}
     @extractHashFromUrl()
 
     if u.methodAllowsPayload(@method)
-      @transferSearchToData()
+      @transferSearchToParams()
     else
-      @transferDataToUrl()
+      @transferParamsToUrl()
 
   extractHashFromUrl: =>
     urlParts = u.parseUrl(@url)
     # Remember the #hash for later revealing.
     # It will be lost during normalization.
-    @hash = urlParts.hash
+    @hash = u.presence(urlParts.hash)
     @url = u.normalizeUrl(urlParts, hash: false)
 
-  transferDataToUrl: =>
-    if @data && !u.isFormData(@data)
-      # GET methods are not allowed to have a payload, so we transfer { data } params to the URL.
-      query = u.requestDataAsQuery(@data)
-      separator = if u.contains(@url, '?') then '&' else '?'
-      @url += separator + query
-      # Now that we have transfered the params into the URL, we delete them from the { data } option.
-      @data = undefined
+  transferParamsToUrl: =>
+    if @params && !u.isFormData(@params)
+      # GET methods are not allowed to have a payload, so we transfer { params } params to the URL.
+      @url = up.params.buildURL(@url, @params)
+      # Now that we have transfered the params into the URL, we delete them from the { params } option.
+      @params = undefined
 
-  transferSearchToData: =>
-    urlParts = u.parseUrl(@url)
-    query = urlParts.search
-    if query
-      @data = u.mergeRequestData(@data, query)
-      @url = u.normalizeUrl(urlParts, search: false)
+  transferSearchToParams: =>
+    if query = up.params.fromURL(@url)
+      @params = up.params.merge(@params, query)
+      @url = u.normalizeUrl(@url, search: false)
 
   isSafe: =>
     up.proxy.isSafeMethod(@method)
@@ -136,27 +130,25 @@ class up.Request extends up.Record
       xhr = new XMLHttpRequest()
 
       xhrHeaders = u.copy(@headers)
-      xhrData = @data
+      xhrPayload = @params
       xhrMethod = @method
       xhrUrl = @url
 
-      [xhrMethod, xhrData] = up.proxy.wrapMethod(xhrMethod, xhrData)
+      [xhrMethod, xhrPayload] = up.proxy.wrapMethod(xhrMethod, xhrPayload)
 
-      if u.isFormData(xhrData)
+      if xhrPayload
         delete xhrHeaders['Content-Type'] # let the browser set the content type
-      else if u.isPresent(xhrData)
-        xhrData = u.requestDataAsQuery(xhrData, purpose: 'form')
-        xhrHeaders['Content-Type'] = 'application/x-www-form-urlencoded'
+        xhrPayload = up.params.toFormData(xhrPayload)
       else
         # XMLHttpRequest expects null for an empty body
-        xhrData = null
+        xhrPayload = null
 
-      xhrHeaders[up.protocol.config.targetHeader] = @target if @target
-      xhrHeaders[up.protocol.config.failTargetHeader] = @failTarget if @failTarget
+      pc = up.protocol.config
+      xhrHeaders[pc.targetHeader] = @target if @target
+      xhrHeaders[pc.failTargetHeader] = @failTarget if @failTarget
       xhrHeaders['X-Requested-With'] ||= 'XMLHttpRequest' unless @isCrossDomain()
-
       if csrfToken = @csrfToken()
-        xhrHeaders[up.protocol.config.csrfHeader] = csrfToken
+        xhrHeaders[pc.csrfHeader] = csrfToken
 
       xhr.open(xhrMethod, xhrUrl)
 
@@ -177,12 +169,12 @@ class up.Request extends up.Record
 
       xhr.timeout = @timeout if @timeout
 
-      xhr.send(xhrData)
+      xhr.send(xhrPayload)
 
   navigate: =>
     # GET forms cannot have an URL with a query section in their [action] attribute.
     # The query section would be overridden by the serialized input values on submission.
-    @transferSearchToData()
+    @transferSearchToParams()
 
     $form = $('<form class="up-page-loader"></form>')
 
@@ -202,9 +194,9 @@ class up.Request extends up.Record
     if (csrfParam = up.protocol.csrfParam()) && (csrfToken = @csrfToken())
       addField(name: csrfParam, value: csrfToken)
 
-    # @data will be undefined for GET requests, since we have already
+    # @params will be undefined for GET requests, since we have already
     # transfered all params to the URL during normalize().
-    u.each u.requestDataAsArray(@data), addField
+    u.each(up.params.toArray(@params), addField)
 
     $form.hide().appendTo('body')
     up.browser.submitForm($form)
@@ -236,10 +228,11 @@ class up.Request extends up.Record
     new up.Response(responseAttrs)
 
   isCachable: =>
-    @isSafe() && !u.isFormData(@data)
+    @isSafe() && !u.isFormData(@params)
 
   cacheKey: =>
-    [@url, @method, u.requestDataAsQuery(@data), @target].join('|')
+    query = up.params.toQuery(@params)
+    [@url, @method, query, @target].join('|')
 
   @wrap: (object) ->
     if object instanceof @

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

@@ -94,7 +94,7 @@ class up.Response extends up.Record
       'status',
       'request',
       'xhr',
-      'title'
+      'title',
     ]
 
   constructor: (options) ->
@@ -136,3 +136,18 @@ class up.Response extends up.Record
   ###
   isFatalError: =>
     @isError() && u.isBlank(@text)
+
+  ###**
+  Returns the HTTP header value with the given name.
+
+  The search for the header name is case-insensitive.
+
+  Returns `undefined` if the given header name was not included in the response.
+
+  @function up.Response#getHeader
+  @param {string} name
+  @return {string|undefined} value
+  @experimental
+  ###
+  getHeader: (name) =>
+    @xhr.getResponseHeader(name)

data/lib/assets/javascripts/unpoly/classes/store/memory.coffee

@@ -0,0 +1,26 @@
+up.store ||= {}
+
+u = up.util
+
+class up.store.Memory
+
+  constructor: ->
+    @clear()
+
+  clear: =>
+    @data = {}
+
+  get: (key) =>
+    @data[key]
+
+  set: (key, value) =>
+    @data[key] = value
+
+  remove: (key) =>
+    delete @data[key]
+
+  keys: =>
+    Object.keys(@data)
+
+  values: =>
+    u.values(@data)

data/lib/assets/javascripts/unpoly/classes/store/session.coffee

@@ -0,0 +1,59 @@
+u = up.util
+
+##
+# Store implementation backed by window.sessionStorage
+# ====================================================
+#
+# This improves plain sessionStorage access in several ways:
+#
+# - Falls back to in-memory storage if window.sessionStorage is not available (see below).
+# - Allows to store other types of values than just strings.
+# - Allows to store structured values.
+# - Allows to invalidate existing data by incrementing a version number on the server.
+#
+# On sessionStorage availability
+# ------------------------------
+#
+# All supported browsers have sessionStorage, but the property is `null`
+# in private browsing mode in Safari and the default Android webkit browser.
+# See https://makandracards.com/makandra/32865-sessionstorage-per-window-browser-storage
+#
+# Also Chrome explodes upon access of window.sessionStorage when
+# user blocks third-party cookies and site data and this page is embedded
+# as an <iframe>. See https://bugs.chromium.org/p/chromium/issues/detail?id=357625
+#
+class up.store.Session extends up.store.Memory
+
+  constructor: (rootKey) ->
+    @rootKey = rootKey
+    @loadFromSessionStorage()
+
+  clear: =>
+    super()
+    @saveToSessionStorage()
+
+  set: (key, value) =>
+    super(key, value)
+    @saveToSessionStorage()
+
+  remove: (key) =>
+    super(key)
+    @saveToSessionStorage()
+
+  loadFromSessionStorage: =>
+    try
+      if raw = sessionStorage?.getItem(@rootKey)
+        @data = JSON.parse(raw)
+    catch
+      # window.sessionStorage not supported (see class comment)
+      # or JSON syntax error. We start with a blank object instead.
+
+    @data ||= {}
+
+  saveToSessionStorage: =>
+    json = JSON.stringify(@data)
+    try
+      sessionStorage?.setItem(@rootKey, json)
+    catch
+      # window.sessionStorage not supported (see class comment).
+      # We do nothing and only keep data in-memory.

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

@@ -0,0 +1,56 @@
+####**
+#Cookies
+#=======
+#
+#class up.cookies
+####
+#up.cookie = (->
+#  u = up.util
+#
+#  escape = encodeURIComponent
+#  unescape = decodeURIComponent
+#
+#  lastRaw = undefined
+#  lastParsed = {}
+#
+#  all = ->
+#    currentRaw = document.cookie
+#    if u.isUndefined(lastRaw) || lastRaw != currentRaw
+#      lastParsed = parse()
+#      lastRaw = currentRaw
+#    lastParsed
+#
+#  parse = ->
+#    hash = {}
+#    pairs = u.splitValues(document.cookie, ';')
+#    for pair in pairs
+#      parts = u.splitValues(pair, '=')
+#      name = unescape(parts[0])
+#      value = unescape(parts[1])
+#      hash[name] = value
+#    hash
+#
+#  remove = (name) ->
+#    set(name, '', 'expires=Thu, 01-Jan-70 00:00:01 GMT; path=/')
+#
+#  get = (name) ->
+#    all()[name]
+#
+#  set = (name, value, meta) ->
+#    str = escape(name) + '=' + escape(value)
+#    str += ';' + meta if meta
+#    document.cookie = str
+#    lastRaw = undefined
+#
+#  pop = (name) ->
+#    value = get(name)
+#    if u.isPresent(value)
+#      remove(name)
+#    value
+#
+#  all: all
+#  get: get
+#  set: set
+#  remove: remove
+#  pop: pop
+#)()

data/lib/assets/javascripts/unpoly/dom.coffee.erb

@@ -70,6 +70,7 @@ up.dom = (($) ->
   @param {string|Element|jQuery} origin
     The element that this selector resolution is relative to.
     That element's selector will be substituted for `&` ([like in Sass](https://sass-lang.com/documentation/file.SASS_REFERENCE.html#parent-selector)).
+  @return {string}
   @internal
   ###
   resolveSelector = (selectorOrElement, origin) ->
@@ -179,13 +180,8 @@ up.dom = (($) ->
     You can also pass `false` to explicitly prevent the title from being updated.
   @param {string} [options.method='get']
     The HTTP method to use for the request.
-  @param {Object|Array|FormData} [options.data]
-    Parameters that should be sent as the request's payload.
-
-    Parameters can either be passed as an object (where the property names become
-    the param names and the property values become the param values) or as
-    an array of `{ name: 'param-name', value: 'param-value' }` objects
-
+  @param {Object|FormData|string|Array} [options.params]
+    [Parameters](/up.params) that should be sent as the request's payload.
   @param {string} [options.transition='none']
   @param {string|boolean} [options.history=true]
     If a string is given, it is used as the URL the browser's location bar and history.
@@ -211,18 +207,15 @@ up.dom = (($) ->
   @param {Object} [options.headers={}]
     An object of additional header key/value pairs to send along
     with the request.
-  @param {boolean} [options.requireMatch=true]
-    Whether to raise an error if the given selector is missing in
-    either the current page or in the response.
   @param {Element|jQuery} [options.origin]
     The element that triggered the replacement.
 
     The element's selector will be substituted for the `&` shorthand in the target selector ([like in Sass](https://sass-lang.com/documentation/file.SASS_REFERENCE.html#parent-selector)).
   @param {string} [options.layer='auto']
     The name of the layer that ought to be updated. Valid values are
-    `auto`, `page`, `modal` and `popup`.
+    `'auto'`, `'page'`, `'modal'` and `'popup'`.
 
-    If set to `auto` (default), Unpoly will try to find a match in the
+    If set to `'auto'` (default), Unpoly will try to find a match in the
     same layer as the element that triggered the replacement (see `options.origin`).
     If that element is not known, or no match was found in that layer,
     Unpoly will search in other layers, starting from the topmost layer.
@@ -240,7 +233,7 @@ up.dom = (($) ->
   replace = (selectorOrElement, url, options) ->
     options = u.options(options)
 
-    options.inspectResponse = fullLoad = -> up.browser.navigate(url, u.only(options, 'method', 'data'))
+    options.inspectResponse = fullLoad = -> up.browser.navigate(url, u.only(options, 'method', 'params'))
 
     if !up.browser.canPushState() && options.history != false
       fullLoad() unless options.preload
@@ -266,26 +259,28 @@ up.dom = (($) ->
       # http://2ality.com/2016/03/promise-rejections-vs-exceptions.html
       return Promise.reject(e)
 
-    request =
+    request = new up.Request(
       url: url
       method: options.method
-      data: options.data
+      data: options.data # deprecated, use { params }
+      params: options.params
       target: improvedTarget
       failTarget: improvedFailTarget
       cache: options.cache
       preload: options.preload
       headers: options.headers
       timeout: options.timeout
+    )
 
     onSuccess = (response) ->
-      processResponse(true, improvedTarget, response, successOptions)
+      processResponse(true, improvedTarget, request, response, successOptions)
 
     onFailure = (response) ->
       rejection = -> Promise.reject(response)
       if response.isFatalError()
         rejection()
       else
-        promise = processResponse(false, improvedFailTarget, response, failureOptions)
+        promise = processResponse(false, improvedFailTarget, request, response, failureOptions)
         # Although processResponse() we will perform a successful replacement of options.failTarget,
         # we still want to reject the promise that's returned to our API client.
         u.always(promise, rejection)
@@ -297,15 +292,12 @@ up.dom = (($) ->
   ###**
   @internal
   ###
-  processResponse = (isSuccess, selector, response, options) ->
-    request = response.request
+  processResponse = (isSuccess, selector, request, response, options) ->
     sourceUrl = response.url
     historyUrl = sourceUrl
-    hash = request.hash
 
-    if options.reveal == true && hash
-      # If the request URL had a #hash and options.reveal is not given, we reveal that #hash.
-      options.reveal = hash
+    if hash = request.hash
+      options.hash = hash
       historyUrl += hash
 
     isReloadable = (response.method == 'GET')
@@ -376,7 +368,6 @@ up.dom = (($) ->
     up.log.group 'Extracting %s from %d bytes of HTML', selectorOrElement, html?.length, ->
       options = u.options options,
         historyMethod: 'push'
-        requireMatch: true
         keep: true
         layer: 'auto'
 
@@ -452,7 +443,7 @@ up.dom = (($) ->
       # Reveal element that was being prepended/appended.
       # Since we will animate (not morph) it's OK to allow animation of scrolling
       # if the user has configured up.layout.config.duration.
-      promise = up.layout.revealOrRestoreScroll($wrapper, options)
+      promise = up.layout.scrollAfterInsertFragment($wrapper, options)
 
       # Since we're adding content instead of replacing, we'll only
       # animate $new instead of morphing between $old and $new
@@ -490,6 +481,7 @@ up.dom = (($) ->
 
       return up.morph($old, $new, transition, morphOptions)
 
+
   # This will find all [up-keep] descendants in $old an, overwrite their partner
   # element in $new and leave a visually identical clone in $old for a later transition.
   # Returns an array of keepPlans.
@@ -512,6 +504,7 @@ up.dom = (($) ->
           keepPlans.push(plan)
     keepPlans
 
+
   findKeepPlan = ($element, $new, options) ->
     if options.keep
       $keepable = $element
@@ -525,8 +518,8 @@ up.dom = (($) ->
         $partner = $partner.first()
         if $partner.length && $partner.is('[up-keep]')
           plan =
-            $element: $keepable               # the element that should be kept
-            $newElement: $partner             # the element that would have replaced it but now does not
+            $element: $keepable # the element that should be kept
+            $newElement: $partner # the element that would have replaced it but now does not
             newData: up.syntax.data($partner) # the parsed up-data attribute of the element we will discard
           keepEventArgs = u.merge(plan, message: ['Keeping element %o', $keepable.get(0)])
           if up.bus.nobodyPrevents('up:fragment:keep', keepEventArgs)
@@ -652,7 +645,7 @@ up.dom = (($) ->
     keptElements = []
     for plan in options.keepPlans
       emitFragmentKept(plan)
-      keptElements.push(plan.$element)
+      keptElements.push(plan.$element[0])
     up.syntax.compile($element, skip: keptElements)
     emitFragmentInserted($element, options)
     $element
@@ -718,9 +711,10 @@ up.dom = (($) ->
 
   @function up.first
   @param {string|Element|jQuery|Array<Element>} selectorOrElement
-  @param {string} options.layer
-    The name of the layer in which to find the element. Valid values are
-    `auto`, `page`, `modal` and `popup`.
+  @param {string} [options.layer='auto']
+    The name of the layer in which to find the element.
+
+    Valid values are `'auto'`, `'page'`, `'modal'` and `'popup'`.
   @param {string|Element|jQuery} [options.origin]
     An second element or selector that can be referenced as `&` in the first selector:
 
@@ -762,17 +756,48 @@ up.dom = (($) ->
         break
     $match
 
+  ###**
+  @function up.dom.layerOf
+  @internal
+  ###
   layerOf = (selectorOrElement) ->
     $element = $(selectorOrElement)
-    if up.popup.contains($element)
-      'popup'
-    else if up.modal.contains($element)
-      'modal'
-    else
-      'page'
+    if $element.length
+      if up.popup.contains($element)
+        'popup'
+      else if up.modal.contains($element)
+        'modal'
+      else
+        'page'
 
   matchesLayer = (selectorOrElement, layer) ->
-    layerOf(selectorOrElement) == layer
+    !layer || layerOf(selectorOrElement) == layer
+
+  ###**
+  Returns all elements matching the given selector, but
+  ignores elements that are being [destroyed](/up.destroy) or [transitioned](/up.morph).
+
+  If the given argument is already a jQuery collection (or an array
+  of DOM elements), returns the subset of the given list that is matching these conditions.
+
+  @function up.all
+  @param {string|jQuery|Array<Element>} selectorOrElements
+  @param {string|Element|jQuery} [options.origin]
+    An second element or selector that can be referenced as `&` in the first selector.
+  @param {string} [options.layer]
+    The name of the layer in which to find the element. Valid values are
+    `'page'`, `'modal'` and `'popup'`.
+  @return {jQuery}
+    A jQuery collection of matching elements.
+  @experimental
+  ###
+  all = (selectorOrElements, options) ->
+    options = u.options(options)
+    resolved = resolveSelector(selectorOrElements, options.origin)
+    $root = $(u.option(options.root, document))
+    $root.find(resolved).filter (index, element) ->
+      $element = $(element)
+      isRealElement($element) && matchesLayer($element, options.layer)
 
   ###**
   Destroys the given element or selector.
@@ -912,10 +937,12 @@ up.dom = (($) ->
   destroy: destroy
   extract: extract
   first: first
+  all: all
   source: source
   resolveSelector: resolveSelector
   hello: hello
   config: config
+  layerOf: layerOf
 
 )(jQuery)
 
@@ -924,6 +951,7 @@ up.extract = up.dom.extract
 up.reload = up.dom.reload
 up.destroy = up.dom.destroy
 up.first = up.dom.first
+up.all = up.dom.all
 up.hello = up.dom.hello
 
-up.renamedModule 'flow', 'dom'
+up.deprecateRenamedModule 'flow', 'dom'