unpoly-rails 0.56.7 → 0.57.0

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

@@ -56,7 +56,7 @@ up.popup = (($) ->
   @param {string} [config.position='bottom-right']
     Defines where the popup is attached to the opening element.
 
-    Valid values are `bottom-right`, `bottom-left`, `top-right` and `top-left`.
+    Valid values are `'bottom-right'`, `'bottom-left'`, `'top-right'` and `'top-left'`.
   @param {string} [config.history=false]
     Whether opening a popup will add a browser history entry.
   @param {string} [config.openAnimation='fade-in']
@@ -199,7 +199,7 @@ up.popup = (($) ->
   @param {string} [options.position='bottom-right']
     Defines where the popup is attached to the opening element.
 
-    Valid values are `bottom-right`, `bottom-left`, `top-right` and `top-left`.
+    Valid values are `'bottom-right'`, `'bottom-left'`, `'top-right'` and `'top-left'`.
   @param {string} [options.html]
     A string of HTML from which to extract the popup contents. No network request will be made.
   @param {string} [options.confirm]
@@ -405,7 +405,7 @@ up.popup = (($) ->
   @param [up-position]
     Defines where the popup is attached to the opening element.
 
-    Valid values are `bottom-right`, `bottom-left`, `top-right` and `top-left`.
+    Valid values are `'bottom-right'`, `'bottom-left'`, `'top-right'` and `'top-left'`.
   @param {string} [up-confirm]
     A message that will be displayed in a cancelable confirmation dialog
     before the popup is opened.

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

@@ -157,7 +157,7 @@ up.proxy = (($) ->
 
   \#\#\# Example
 
-      up.request('/search', data: { query: 'sunshine' }).then(function(response) {
+      up.request('/search', params: { query: 'sunshine' }).then(function(response) {
         console.log('The response text is %o', response.text);
       }).catch(function() {
         console.error('The request failed');
@@ -192,14 +192,8 @@ up.proxy = (($) ->
     requests, if available. If set to `false` a network connection will always be attempted.
   @param {Object} [options.headers={}]
     An object of additional HTTP headers.
-  @param {Object|Array|FormData} [options.data={}]
-    Parameters 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
+  @param {Object|FormData|string|Array} [options.params={}]
+    [Parameters](/up.params) that should be sent as the request's payload.
   @param {string} [options.timeout]
     A timeout in milliseconds.
 
@@ -214,23 +208,30 @@ up.proxy = (($) ->
   @stable
   ###
   makeRequest = (args...) ->
-    options = u.extractOptions(args)
-    options.url = args[0] if u.isGiven(args[0])
+    if u.isString(args[0])
+      url = args.shift()
 
-    ignoreCache = (options.cache == false)
+    # We cannot use u.extractOptions() since sometimes the last argument
+    # is an up.Request instead of a basic object.
+    requestOrOptions = args.shift() || {}
 
-    request = up.Request.wrap(options)
+    if url
+      requestOrOptions.url = url
+
+    request = up.Request.wrap(requestOrOptions)
 
     # Non-GET requests always touch the network
-    # unless `options.cache` is explicitly set to `true`.
+    # unless `request.cache` is explicitly set to `true`.
     # These requests are never cached.
     if !request.isSafe()
       # We clear the entire cache before an unsafe request, since we
       # assume the user is writing a change.
       clear()
 
+    ignoreCache = (request.cache == false)
+
     # If we have an existing promise matching this new request,
-    # we use it unless `options.cache` is explicitly set to `false`.
+    # we use it unless `request.cache` is explicitly set to `false`.
     if !ignoreCache && (promise = get(request))
       up.puts 'Re-using cached response for %s %s', request.method, request.url
     else
@@ -241,7 +242,7 @@ up.proxy = (($) ->
       promise.catch (e) ->
         remove(request)
 
-    if !options.preload
+    if !request.preload
       # This might actually make `pendingCount` higher than the actual
       # number of outstanding requests. However, we need to cover the
       # following case:
@@ -264,7 +265,7 @@ up.proxy = (($) ->
 
   \#\#\# Example
 
-      up.request('/search', data: { query: 'sunshine' }).then(function(text) {
+      up.request('/search', params: { query: 'sunshine' }).then(function(text) {
         console.log('The response text is %o', text);
       }).catch(function() {
         console.error('The request failed');
@@ -286,14 +287,8 @@ up.proxy = (($) ->
   @param {Object} [request.headers={}]
     An object of additional header key/value pairs to send along
     with the request.
-  @param {Object|Array|FormData} [options.data]
-    Parameters 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
+  @param {Object|FormData|string|Array} [options.params]
+    [Parameters](/up.params) that should be sent as the request's payload.
   @param {string} [request.timeout]
     A timeout in milliseconds for the request.
 
@@ -305,7 +300,7 @@ up.proxy = (($) ->
     Use [`up.request()`](/up.request) instead.
   ###
   ajax = (args...) ->
-    up.log.warn('up.ajax() has been deprecated. Use up.request() instead.')
+    up.warn('up.ajax() has been deprecated. Use up.request() instead.')
     new Promise (resolve, reject) ->
       pickResponseText = (response) -> resolve(response.text)
       makeRequest(args...).then(pickResponseText, reject)
@@ -418,7 +413,6 @@ up.proxy = (($) ->
   @event up:proxy:recover
   @stable
   ###
-
   loadOrQueue = (request) ->
     if pendingCount < config.maxRequests
       load(request)
@@ -563,7 +557,7 @@ up.proxy = (($) ->
   ###
   clear = cache.clear
 
-  up.bus.renamedEvent('up:proxy:received', 'up:proxy:loaded')
+  up.bus.deprecateRenamedEvent('up:proxy:received', 'up:proxy:loaded')
 
   preloadAfterDelay = ($link) ->
     delay = parseInt(u.presentAttr($link, 'up-delay')) || config.preloadDelay
@@ -592,20 +586,34 @@ up.proxy = (($) ->
   @function up.proxy.preload
   @param {string|Element|jQuery}
     The element whose destination should be preloaded.
+  @param {object} options
+    Options that will be passed to the function making the HTTP requests.
   @return
     A promise that will be fulfilled when the request was loaded and cached
   @experimental
   ###
-  preload = (linkOrSelector) ->
+  preload = (linkOrSelector, options) ->
     $link = $(linkOrSelector)
 
     if up.link.isSafe($link)
-      up.log.group "Preloading link %o", $link.get(0), ->
+      preloadEventAttrs = { message: ['Preloading link %o', $link.get(0)], $element: $link, $link: $link }
+      up.bus.whenEmitted('up:link:preload', preloadEventAttrs).then ->
         variant = up.link.followVariantForLink($link)
-        variant.preloadLink($link)
+        variant.preloadLink($link, options)
     else
       Promise.reject(new Error("Won't preload unsafe link"))
 
+  ###**
+  This event is [emitted](/up.emit) before a link is [preloaded](/up.preload).
+
+  @event up:link:preload
+  @param {jQuery} event.$link
+    The link element that will be preloaded.
+  @param event.preventDefault()
+    Event listeners may call this method to prevent the link from being preloaded.
+  @stable
+  ###
+
   ###**
   @internal
   ###
@@ -615,11 +623,11 @@ up.proxy = (($) ->
   ###**
   @internal
   ###
-  wrapMethod = (method, data, appendOpts) ->
+  wrapMethod = (method, params) ->
     if u.contains(config.wrapMethods, method)
-      data = u.appendRequestData(data, up.protocol.config.methodParam, method, appendOpts)
+      params = up.params.add(params, up.protocol.config.methodParam, method)
       method = 'POST'
-    [method, data]
+    [method, params]
 
   ###**
   Links with an `up-preload` attribute will silently fetch their target

data/lib/assets/javascripts/unpoly/{syntax.coffee → syntax.coffee.erb}

@@ -23,9 +23,6 @@ up.syntax = (($) ->
 
   u = up.util
 
-  DESTRUCTIBLE_CLASS = 'up-destructible'
-  DESTRUCTORS_KEY = 'up-destructors'
-
   SYSTEM_MACRO_PRIORITIES = {
     '[up-back]': -100        # sets [up-href] to previous URL
     '[up-drawer]': -200      # sets [up-modal] and makes link followable
@@ -213,17 +210,11 @@ up.syntax = (($) ->
     such as timeouts and event handlers bound to the document.
     The destructor is *not* expected to remove the element from the DOM, which
     is already handled by [`up.destroy()`](/up.destroy).
-
-    The function may also return an array of destructor functions.
   @stable
   ###
-  compiler = (selector, args...) ->
-    # Developer might still call top-level compiler registrations even when we don't boot
-    # due to an unsupported browser. In that case do no work and exit early.
-    return unless up.browser.isSupported()
-    callback = args.pop()
-    options = u.options(args[0])
-    insertCompiler(compilers, selector, options, callback)
+  registerCompiler = (args...) ->
+    compiler = buildCompiler(args...)
+    insertCompiler(compilers, compiler)
 
   ###**
   Registers a [compiler](/up.compiler) that is run before all other compilers.
@@ -266,72 +257,36 @@ up.syntax = (($) ->
     See [`up.compiler()`](/up.compiler) for details.
   @stable
   ###
-  macro = (selector, args...) ->
-    # Developer might still call top-level compiler registrations even when we don't boot
-    # due to an unsupported browser. In that case do no work and exit early.
-    return unless up.browser.isSupported()
-    callback = args.pop()
-    options = u.options(args[0])
+  registerMacro = (args...) ->
+    macro = buildCompiler(args...)
     if isBooting
-      options.priority = detectSystemMacroPriority(selector) ||
-        up.fail('Unregistered priority for system macro %o', selector)
-    insertCompiler(macros, selector, options, callback)
+      macro.priority = detectSystemMacroPriority(macro.selector) ||
+        up.fail('Unregistered priority for system macro %o', macro.selector)
+    insertCompiler(macros, macro)
 
-  detectSystemMacroPriority = (fullMacroSelector) ->
+  detectSystemMacroPriority = (macroSelector) ->
     for substr, priority of SYSTEM_MACRO_PRIORITIES
-      if fullMacroSelector.indexOf(substr) >= 0
+      if macroSelector.indexOf(substr) >= 0
         return priority
 
-  buildCompiler = (selector, options, callback) ->
-    selector: selector
-    callback: callback
-    isSystem: isBooting
-    priority: options.priority || 0
-    batch: options.batch
-    keep: options.keep
-
-  insertCompiler = (queue, selector, options, callback) ->
-    # Silently discard any compilers that are registered on unsupported browsers
-    return unless up.browser.isSupported()
-    newCompiler = buildCompiler(selector, options, callback)
+  buildCompiler = (selector, args...) ->
+    callback = args.pop()
+    options = u.extractOptions(args)
+    options = u.options(options,
+      selector: selector,
+      isSystem: isBooting,
+      priority: 0,
+      batch: false
+      keep: false
+    )
+    return u.assign(callback, options)
+
+  insertCompiler = (queue, newCompiler) ->
     index = 0
-    while (oldCompiler = queue[index]) && (oldCompiler.priority >= newCompiler.priority)
+    while (existingCompiler = queue[index]) && (existingCompiler.priority >= newCompiler.priority)
       index += 1
     queue.splice(index, 0, newCompiler)
 
-  applyCompiler = (compiler, $jqueryElement, nativeElement) ->
-    up.puts ("Compiling '%s' on %o" unless compiler.isSystem), compiler.selector, nativeElement
-    if compiler.keep
-      value = if u.isString(compiler.keep) then compiler.keep else ''
-      $jqueryElement.attr('up-keep', value)
-    returnValue = compiler.callback.apply(nativeElement, [$jqueryElement, data($jqueryElement)])
-    addDestructor($jqueryElement, returnValue)
-
-  ###**
-  Tries to find a list of destructors in a compiler's return value.
-
-  @param {Object} returnValue
-  @return {Function|undefined}
-  @internal
-  ###
-  normalizeDestructor = (returnValue) ->
-    if u.isFunction(returnValue)
-      returnValue
-    else if u.isArray(returnValue) && u.all(returnValue, u.isFunction)
-      u.sequence(returnValue...)
-
-  addDestructor = ($element, newDestructor) ->
-    if newDestructor = normalizeDestructor(newDestructor)
-      $element.addClass(DESTRUCTIBLE_CLASS)
-      # The initial destructor function is a function that removes the destructor class and data.
-      elementDestructor = $element.data(DESTRUCTORS_KEY) || -> removeDestructors($element)
-      elementDestructor = u.sequence(elementDestructor, newDestructor)
-      $element.data(DESTRUCTORS_KEY, elementDestructor)
-
-  removeDestructors = ($element) ->
-    $element.removeData(DESTRUCTORS_KEY)
-    $element.removeClass(DESTRUCTIBLE_CLASS)
-
   ###**
   Applies all compilers on the given element and its descendants.
   Unlike [`up.hello()`](/up.hello), this doesn't emit any events.
@@ -342,30 +297,21 @@ up.syntax = (($) ->
   @internal
   ###
   compile = ($fragment, options) ->
-    options = u.options(options)
-    $skipSubtrees = $(options.skip)
-
-    up.log.group "Compiling fragment %o", $fragment.get(0), ->
-      for queue in [macros, compilers]
-        for compiler in queue
-          $matches = u.selectInSubtree($fragment, compiler.selector)
-
-          # Exclude all elements that are descendants of the subtrees we want to keep.
-          # We only do this if `options.skip` was given, since the exclusion
-          # process below is very expensive (we had a case where compiling 100 slements
-          # took 1.5s because of this).
-          if $skipSubtrees.length
-            $matches = $matches.filter ->
-              $match = $(this)
-              u.all $skipSubtrees, (skipSubtree) ->
-                $match.closest(skipSubtree).length == 0
-
-          if $matches.length
-            up.log.group ("Compiling '%s' on %d element(s)" unless compiler.isSystem), compiler.selector, $matches.length, ->
-              if compiler.batch
-                applyCompiler(compiler, $matches, $matches.get())
-              else
-                $matches.each -> applyCompiler(compiler, $(this), this)
+    orderedCompilers = macros.concat(compilers)
+    compileRun = new up.CompilePass($fragment, orderedCompilers, options)
+    compileRun.compile()
+
+  ###**
+  @function up.syntax.destructor
+  @internal
+  ###
+  registerDestructor = (element, destructor) ->
+    element = u.element(element)
+    unless destructors = element.upDestructors
+      destructors = []
+      element.upDestructors = destructors
+      element.classList.add('up-can-clean')
+    destructors.push(destructor)
 
   ###**
   Runs any destroyers on the given fragment and its descendants.
@@ -376,20 +322,18 @@ up.syntax = (($) ->
   @internal
   ###
   clean = ($fragment) ->
-    $destructibles = u.selectInSubtree($fragment, ".#{DESTRUCTIBLE_CLASS}")
-    u.each $destructibles, (destructible) ->
-      # The destructor function may be undefined at this point.
-      # Although destructible elements should always have an destructor function, we might be
-      # destroying a clone of such an element. E.g. Unpoly creates a clone when keeping an
-      # [up-keep] element, and that clone still has the .up-destructible class.
-      if destructor = $(destructible).data(DESTRUCTORS_KEY)
-        destructor()
+    cleanables = u.selectInSubtree($fragment, '.up-can-clean')
+    u.each cleanables, (cleanable) ->
+      if destructors = cleanable.upDestructors
+        destructor() for destructor in destructors
+      # We do not actually remove the #upDestructors property or .up-can-* classes for performance reasons.
+      # The element we just cleaned is about to be removed from the DOM.
 
   ###**
   Checks if the given element has an [`up-data`](/up-data) attribute.
   If yes, parses the attribute value as JSON and returns the parsed object.
 
-  Returns an empty object if the element has no `up-data` attribute.
+  Returns `undefined` if the element has no `up-data` attribute.
 
   \#\#\# Example
 
@@ -406,8 +350,8 @@ up.syntax = (($) ->
   @return
     The JSON-decoded value of the `up-data` attribute.
 
-    Returns an empty object (`{}`) if the element has no (or an empty) `up-data` attribute.
-  @stable
+    Returns `undefined` if the element has no (or an empty) `up-data` attribute.
+  @experimental
   ###
 
   ###**
@@ -453,13 +397,9 @@ up.syntax = (($) ->
     A serialized JSON string
   @stable
   ###
-  data = (elementOrSelector) ->
-    $element = $(elementOrSelector)
-    json = $element.attr('up-data')
-    if u.isString(json) && u.trim(json) != ''
-      JSON.parse(json)
-    else
-      {}
+  readData = (elementOrSelector) ->
+    if element = u.element(elementOrSelector)
+      u.jsonAttr(element, 'up-data') || {}
 
   ###**
   Resets the list of registered compiler directives to the
@@ -468,20 +408,22 @@ up.syntax = (($) ->
   @internal
   ###
   reset = ->
-    isSystem = (compiler) -> compiler.isSystem
-    compilers = u.select(compilers, isSystem)
-    macros = u.select(macros, isSystem)
+    compilers = u.select(compilers, 'isSystem')
+    macros = u.select(macros, 'isSystem')
 
   up.on 'up:framework:booted', -> isBooting = false
   up.on 'up:framework:reset', reset
 
-  compiler: compiler
-  macro: macro
+  <% if ENV['JS_KNIFE'] %>knife: eval(Knife.point)<% end %>
+  compiler: registerCompiler
+  macro: registerMacro
+  destructor: registerDestructor
   compile: compile
   clean: clean
-  data: data
+  data: readData
 
 )(jQuery)
 
 up.compiler = up.syntax.compiler
+up.destructor = up.syntax.destructor
 up.macro = up.syntax.macro