unpoly-rails 0.23.0 → 0.24.0

data/lib/assets/javascripts/unpoly/navigation.js.coffee

@@ -36,11 +36,8 @@ up.navigation = (($) ->
     classes.join(' ')
 
   CLASS_ACTIVE = 'up-active'
-  SELECTORS_SECTION = ['a', '[up-href]', '[up-alias]']
-  SELECTOR_SECTION = SELECTORS_SECTION.join(', ')
-  SELECTOR_SECTION_INSTANT = ("#{selector}[up-instant]" for selector in SELECTORS_SECTION).join(', ')
-  SELECTOR_ACTIVE = ".#{CLASS_ACTIVE}"
-  
+  SELECTOR_SECTION = 'a, [up-href]'
+
   normalizeUrl = (url) ->
     if u.isPresent(url)
       u.normalizeUrl(url,
@@ -102,6 +99,22 @@ up.navigation = (($) ->
       else if $section.hasClass(klass) && $section.closest('.up-destroying').length == 0
         $section.removeClass(klass)
 
+  ###*
+  @function findClickArea
+  @param {String|Element|jQuery} elementOrSelector
+  @param {Boolean} options.enlarge
+    If `true`, tries to find a containing link that has expanded the link's click area.
+    If we find one, we prefer to mark the larger area as active.
+  @internal
+  ###
+  findClickArea = (elementOrSelector, options) ->
+    $area = $(elementOrSelector)
+    options = u.options(options, enlarge: false)
+    if options.enlarge
+      u.presence($area.parent(SELECTOR_SECTION)) || $area
+    else
+      $area
+
   ###*
   Links that are currently loading are assigned the `up-active`
   class automatically. Style `.up-active` in your CSS to improve the
@@ -129,24 +142,23 @@ up.navigation = (($) ->
   @selector .up-active
   @stable
   ###
-  sectionClicked = ($section) ->
-    unmarkActive()
-    $section = enlargeClickArea($section)
-    $section.addClass(CLASS_ACTIVE)
-    
-  enlargeClickArea = ($section) ->
-    u.presence($section.parents(SELECTOR_SECTION)) || $section
-    
-  unmarkActive = ->
-    $(SELECTOR_ACTIVE).removeClass(CLASS_ACTIVE)
-
-  up.on 'click', SELECTOR_SECTION, (event, $section) ->
-    if u.isUnmodifiedMouseEvent(event) && !$section.is('[up-instant]')
-      sectionClicked($section)
-  
-  up.on 'mousedown', SELECTOR_SECTION_INSTANT, (event, $section) ->
-    if u.isUnmodifiedMouseEvent(event)
-      sectionClicked($section)
+  markActive = (elementOrSelector, options) ->
+    $element = findClickArea(elementOrSelector, options)
+    $element.addClass(CLASS_ACTIVE)
+
+  unmarkActive = (elementOrSelector, options) ->
+    $element = findClickArea(elementOrSelector, options)
+    $element.removeClass(CLASS_ACTIVE)
+
+  withActiveMark = (elementOrSelector, options, block) ->
+    $element = $(elementOrSelector)
+    markActive($element, options)
+    promise = block()
+    if u.isPromise(promise)
+      promise.always -> unmarkActive($element, options)
+    else
+      up.warn('Expected block to return a promise, but got %o', promise)
+    promise
 
   ###*
   Links that point to the current location are assigned
@@ -193,9 +205,6 @@ up.navigation = (($) ->
   @stable
   ###
   up.on 'up:fragment:inserted', ->
-    # If a new fragment is inserted, it's likely to be the result
-    # of the active action. So we can remove the active marker.
-    unmarkActive()
     # When a fragment is inserted it might either have brought a location change
     # with it, or it might have opened a modal / popup which we consider
     # to be secondary location sources (the primary being the browser's
@@ -215,5 +224,8 @@ up.navigation = (($) ->
 
   config: config
   defaults: -> u.error('up.navigation.defaults(...) no longer exists. Set values on he up.navigation.config property instead.')
+  markActive: markActive
+  unmarkActive: unmarkActive
+  withActiveMark: withActiveMark
 
 )(jQuery)

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

@@ -112,67 +112,26 @@ up.proxy = (($) ->
       if response = cache.get(candidate)
         return response
 
-  ###*
-  Manually stores a promise for the response to the given request.
-
-  @function up.proxy.set
-  @param {String} request.url
-  @param {String} [request.method='GET']
-  @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/).
-  @experimental
-  ###
-  set = cache.set
-
-  ###*
-  Manually removes the given request from the cache.
-
-  You can also [configure](/up.proxy.config) when the proxy
-  automatically removes cache entries.
-
-  @function up.proxy.remove
-  @param {String} request.url
-  @param {String} [request.method='GET']
-  @param {String} [request.target='body']
-  @experimental
-  ###
-  remove = cache.remove
-
-  ###*
-  Removes all cache entries.
-
-  Unpoly also automatically clears the cache whenever it processes
-  a request with a non-GET HTTP method.
-
-  @function up.proxy.clear
-  @stable
-  ###
-  clear = cache.clear
-
   cancelPreloadDelay = ->
     clearTimeout(preloadDelayTimer)
     preloadDelayTimer = null
 
-  cancelBusyDelay = ->
+  cancelSlowDelay = ->
     clearTimeout(slowDelayTimer)
     slowDelayTimer = null
 
   reset = ->
     $waitingLink = null
     cancelPreloadDelay()
-    cancelBusyDelay()
+    cancelSlowDelay()
     pendingCount = 0
     config.reset()
-    slowEventEmitted = false
     cache.clear()
+    slowEventEmitted = false
     queuedRequests = []
 
   reset()
 
-  alias = cache.alias
-
   normalizeRequest = (request) ->
     unless request._normalized
       request.method = u.normalizeMethod(request.method)
@@ -190,13 +149,23 @@ up.proxy = (($) ->
   Only requests with a method of `GET`, `OPTIONS` and `HEAD`
   are considered to be read-only.
 
+  \#\#\#\# Example
+
+      up.ajax('/search', data: { query: 'sunshine' }).then(function(data, status, xhr) {
+        console.log('The response body is %o', data);
+      }).fail(function(xhr, status, error) {
+        console.error('The request failed');
+      });
+
+  \#\#\#\# Events
+
   If a network connection is attempted, the proxy will emit
-  a `up:proxy:load` event with the `request` as its argument.
-  Once the response is received, a `up:proxy:receive` event will
+  a [`up:proxy:load`](/up:proxy:load) event with the `request` as its argument.
+  Once the response is received, a [`up:proxy:receive`](/up:proxy:receive) event will
   be emitted.
   
   @function up.ajax
-  @param {String} request.url
+  @param {String} url
   @param {String} [request.method='GET']
   @param {String} [request.target='body']
   @param {Boolean} [request.cache]
@@ -207,12 +176,18 @@ up.proxy = (($) ->
     with the request.
   @param {Object} [request.data={}]
     An object of request parameters.
+  @param {String} [request.url]
+    You can omit the first string argument and pass the URL as
+    a `request` property instead.
   @return
     A promise for the response that is API-compatible with the
     promise returned by [`jQuery.ajax`](http://api.jquery.com/jquery.ajax/).
   @stable
   ###
-  ajax = (options) ->
+  ajax = (args...) ->
+
+    options = u.extractOptions(args)
+    options.url = args[0] if u.isGiven(args[0])
 
     forceCache = (options.cache == true)
     ignoreCache = (options.cache == false)
@@ -293,10 +268,7 @@ up.proxy = (($) ->
         if isBusy() # a fast response might have beaten the delay
           up.emit('up:proxy:slow', message: 'Proxy is busy')
           slowEventEmitted = true
-      if config.slowDelay > 0
-        slowDelayTimer = setTimeout(emission, config.slowDelay)
-      else
-        emission()
+      slowDelayTimer = u.setTimer(config.slowDelay, emission)
 
   ###*
   This event is [emitted]/(up.emit) when [AJAX requests](/up.ajax)
@@ -423,6 +395,59 @@ up.proxy = (($) ->
       promise.done (args...) -> entry.deferred.resolve(args...)
       promise.fail (args...) -> entry.deferred.reject(args...)
 
+  ###*
+  Makes the proxy assume that `newRequest` has the same response as the
+  already cached `oldRequest`.
+
+  Unpoly uses this internally when the user redirects from `/old` to `/new`.
+  In that case, both `/old` and `/new` will cache the same response from `/new`.
+
+  @function up.proxy.alias
+  @param {Object} oldRequest
+  @param {Object} newRequest
+  @experimental
+  ###
+  alias = cache.alias
+
+  ###*
+  Manually stores a promise for the response to the given request.
+
+  @function up.proxy.set
+  @param {String} request.url
+  @param {String} [request.method='GET']
+  @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/).
+  @experimental
+  ###
+  set = cache.set
+
+  ###*
+  Manually removes the given request from the cache.
+
+  You can also [configure](/up.proxy.config) when the proxy
+  automatically removes cache entries.
+
+  @function up.proxy.remove
+  @param {String} request.url
+  @param {String} [request.method='GET']
+  @param {String} [request.target='body']
+  @experimental
+  ###
+  remove = cache.remove
+
+  ###*
+  Removes all cache entries.
+
+  Unpoly also automatically clears the cache whenever it processes
+  a request with a non-GET HTTP method.
+
+  @function up.proxy.clear
+  @stable
+  ###
+  clear = cache.clear
+
   ###*
   This event is [emitted]/(up.emit) before an [AJAX request](/up.ajax)
   is starting to load.

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

@@ -239,6 +239,7 @@ up.syntax = (($) ->
 
   Examples for built-in macros are [`up-dash`](/up-dash) and [`up-expand`](/up-expand).
 
+  @function up.macro
   @param {String} selector
     The selector to match.
   @param {Object} options

data/lib/assets/javascripts/unpoly/tooltip.js.coffee

@@ -52,6 +52,8 @@ up.tooltip = (($) ->
     closeAnimation: 'fade-out'
 
   reset = ->
+    # Destroy the tooltip container regardless whether it's currently in a closing animation
+    close(animation: false)
     config.reset()
 
   setPosition = ($link, $tooltip, position) ->

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

@@ -9,6 +9,14 @@ that might save you from loading something like [Underscore.js](http://underscor
 ###
 up.util = (($) ->
 
+  ###*
+  A function that does nothing.
+
+  @function up.util.noop
+  @experimental
+  ###
+  noop = $.noop
+
   ###*
   @function up.util.memoize
   @internal
@@ -755,6 +763,24 @@ up.util = (($) ->
     values = ($element.attr(attrName) for attrName in attrNames)
     detect(values, isPresent)
 
+  ###*
+  Waits for the given number of milliseconds, the nruns the given callback.
+
+  If the number of milliseconds is zero, the callback is run in the current execution frame.
+  See [`up.util.nextFrame`] for running a function in the next executation frame.
+
+  @function up.util.setTimer
+  @param {Number} millis
+  @param {Function} callback
+  @experimental
+  ###
+  setTimer = (millis, callback) ->
+    if millis > 0
+      setTimeout(callback, millis)
+    else
+      callback()
+
+
   ###*
   Schedules the given function to be called in the
   next Javascript execution frame.
@@ -868,6 +894,16 @@ up.util = (($) ->
       memo = ->
     memo
 
+  ###*
+  Forces a repaint of the given element.
+
+  @function up.util.forceRepaint
+  @internal
+  ###
+  forceRepaint = (element) ->
+    element = unJQuery(element)
+    element.offsetHeight
+
   ###*
   Animates the given element's CSS properties using CSS transitions.
   
@@ -901,23 +937,49 @@ up.util = (($) ->
       delay: 0,
       easing: 'ease'
     )
-    # We don't finish an existing animation here, since
-    # the public API `up.motion.animate` already does this.
+
+    # We don't finish an existing animation here, since the public API
+    # we expose as `up.motion.animate` already does this.
     deferred = $.Deferred()
     transition =
       'transition-property': Object.keys(lastFrame).join(', ')
       'transition-duration': "#{opts.duration}ms"
       'transition-delay': "#{opts.delay}ms"
       'transition-timing-function': opts.easing
+    oldTransition = $element.css(Object.keys(transition))
+
+    $element.addClass('up-animating')
     withoutCompositing = forceCompositing($element)
-    withoutTransition = temporaryCss($element, transition)
+    $element.css(transition)
     $element.css(lastFrame)
-    deferred.then(withoutCompositing)
-    deferred.then(withoutTransition)
     $element.data(ANIMATION_DEFERRED_KEY, deferred)
-    deferred.then(-> $element.removeData(ANIMATION_DEFERRED_KEY))
-    endTimeout = setTimeout((-> deferred.resolve()), opts.duration + opts.delay)
-    deferred.then(-> clearTimeout(endTimeout)) # clean up in case we're canceled
+
+    deferred.then ->
+      $element.removeData(ANIMATION_DEFERRED_KEY)
+      withoutCompositing()
+
+      # To interrupt the running transition we *must* set it to 'none' exactly.
+      # We cannot simply restore the old transition properties because browsers
+      # would simply keep transitioning the old properties.
+      $element.css('transition': 'none')
+
+      # Restoring a previous transition involves some work, so we only do it if
+      # we know the element was transitioning before.
+      hadTransitionBefore = !(oldTransition['transition-property'] == 'none' || (oldTransition['transition-property'] == 'all' && oldTransition['transition-duration'][0] == '0'))
+      if hadTransitionBefore
+        forceRepaint($element) # :(
+        $element.css(oldTransition)
+
+    # Since listening to transitionEnd events is painful, we wait for a timeout
+    # and then resolve our deferred. Maybe revisit that decision some day.
+    animationEnd = opts.duration + opts.delay
+    endTimeout = setTimer animationEnd, ->
+      $element.removeClass('up-animating')
+      deferred.resolve() unless isDetached($element)
+    # Clean up in case we're canceled through some other code that
+    # resolves our deferred.
+    deferred.then(-> clearTimeout(endTimeout))
+
     # Return the whole deferred and not just return a thenable.
     # Other code will need the possibility to cancel the animation
     # by resolving the deferred.
@@ -1299,49 +1361,46 @@ up.util = (($) ->
 
     store = undefined
 
+    optionEvaluator = (name) ->
+      ->
+        value = config[name]
+        if isNumber(value)
+          value
+        else if isFunction(value)
+          value()
+        else
+          undefined
+
+    maxKeys = optionEvaluator('size')
+
+    expiryMillis = optionEvaluator('expiry')
+
+    normalizeStoreKey = (key) ->
+      if config.key
+        config.key(key)
+      else
+        key.toString()
+
+    isEnabled = ->
+      maxKeys() isnt 0 && expiryMillis() isnt 0
+
     clear = ->
       store = {}
 
     clear()
 
     log = (args...) ->
-      if config.log
-        args[0] = "[#{config.log}] #{args[0]}"
+      if config.logPrefix
+        args[0] = "[#{config.logPrefix}] #{args[0]}"
         up.puts(args...)
 
     keys = ->
       Object.keys(store)
 
-    maxSize = ->
-      if isMissing(config.size)
-        undefined
-      else if isFunction(config.size)
-        config.size()
-      else if isNumber(config.size)
-        config.size
-      else
-        error("Invalid size config: %o", config.size)
-
-    expiryMilis = ->
-      if isMissing(config.expiry)
-        undefined
-      else if isFunction(config.expiry)
-        config.expiry()
-      else if isNumber(config.expiry)
-        config.expiry
-      else
-        error("Invalid expiry config: %o", config.expiry)
-
-    normalizeStoreKey = (key) ->
-      if config.key
-        config.key(key)
-      else
-        key.toString()
-
-    trim = ->
+    makeRoomForAnotherKey = ->
       storeKeys = copy(keys())
-      size = maxSize()
-      if size && storeKeys.length > size
+      max = maxKeys()
+      if max && storeKeys.length >= max
         oldestKey = null
         oldestTimestamp = null
         each storeKeys, (key) ->
@@ -1361,20 +1420,22 @@ up.util = (($) ->
       (new Date()).valueOf()
 
     set = (key, value) ->
-      storeKey = normalizeStoreKey(key)
-      store[storeKey] =
-        timestamp: timestamp()
-        value: value
+      if isEnabled()
+        makeRoomForAnotherKey()
+        storeKey = normalizeStoreKey(key)
+        store[storeKey] =
+          timestamp: timestamp()
+          value: value
 
     remove = (key) ->
       storeKey = normalizeStoreKey(key)
       delete store[storeKey]
 
     isFresh = (entry) ->
-      expiry = expiryMilis()
-      if expiry
+      millis = expiryMillis()
+      if millis
         timeSinceTouch = timestamp() - entry.timestamp
-        timeSinceTouch < expiryMilis()
+        timeSinceTouch < millis
       else
         true
 
@@ -1570,12 +1631,37 @@ up.util = (($) ->
     $error.text(asString)
     throw new Error(asString)
 
+  pluckKey = (object, key) ->
+    value = object[key]
+    delete object[key]
+    value
+
   pluckData = (elementOrSelector, key) ->
     $element = $(elementOrSelector)
     value = $element.data(key)
     $element.removeData(key)
     value
 
+  extractOptions = (args) ->
+    lastArg = last(args)
+    if isObject(lastArg)
+      args.pop()
+    else
+      {}
+
+  ###*
+  Returns whether the given element has been detached from the DOM
+  (or whether it was never attached).
+
+  @function up.util.isDetached
+  @internal
+  ###
+  isDetached = (element) ->
+    element = unJQuery(element)
+    # This is by far the fastest way to do this
+    not jQuery.contains(document.documentElement, element)
+
+  isDetached: isDetached
   requestDataAsArray: requestDataAsArray
   requestDataAsQuery: requestDataAsQuery
   appendRequestData: appendRequestData
@@ -1631,12 +1717,14 @@ up.util = (($) ->
   isUnmodifiedMouseEvent: isUnmodifiedMouseEvent
   nullJQuery: nullJQuery
   unJQuery: unJQuery
+  setTimer: setTimer
   nextFrame: nextFrame
   measure: measure
   temporaryCss: temporaryCss
   cssAnimate: cssAnimate
   finishCssAnimate: finishCssAnimate
   forceCompositing: forceCompositing
+  forceRepaint: forceRepaint
   escapePressed: escapePressed
   copyAttributes: copyAttributes
   findWithSelf: findWithSelf
@@ -1667,6 +1755,10 @@ up.util = (($) ->
   multiSelector: multiSelector
   error: error
   pluckData: pluckData
+  pluckKey: pluckKey
+  extractOptions: extractOptions
+  isDetached: isDetached
+  noop: noop
 
 )($)