upjs-rails 0.9.1 → 0.10.0

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

@@ -11,26 +11,44 @@ up.layout = (->
   u = up.util
 
   ###*
-
+  Configures the application layout.
 
   @method up.layout.defaults
-  @param {String} [options.viewport]
-  @param {String} [options.fixedTop]
-  @param {String} [options.fixedBottom]
+  @param {Array<String>} [options.viewports]
+    An array of CSS selectors that find viewports
+    (containers that scroll their contents).
+  @param {Array<String>} [options.fixedTop]
+    An array of CSS selectors that find elements fixed to the
+    top edge of the screen (using `position: fixed`).
+  @param {Array<String>} [options.fixedBottom]
+    An array of CSS selectors that find elements fixed to the
+    bottom edge of the screen (using `position: fixed`).
   @param {Number} [options.duration]
+    The duration of the scrolling animation in milliseconds.
+    Setting this to `0` will disable scrolling animations.
   @param {String} [options.easing]
+    The timing function that controls the animation's acceleration.
+    See [W3C documentation](http://www.w3.org/TR/css3-transitions/#transition-timing-function)
+    for a list of pre-defined timing functions.
   @param {Number} [options.snap]
+    When [revealing](#up.reveal) elements, Up.js will scroll an viewport
+    to the top when the revealed element is closer to the top than `options.snap`.
   ###
   config = u.config
     duration: 0
-    viewport: 'body, .up-modal, [up-viewport]'
-    fixedTop: '[up-fixed~=top]'
-    fixedBottom: '[up-fixed~=bottom]'
+    viewports: ['body', '.up-modal', '[up-viewport]']
+    fixedTop: ['[up-fixed~=top]']
+    fixedBottom: ['[up-fixed~=bottom]']
     snap: 50
     easing: 'swing'
 
+  lastScrollTops = u.cache
+    size: 30,
+    key: up.history.normalizeUrl
+
   reset = ->
     config.reset()
+    lastScrollTops.clear()
 
   SCROLL_PROMISE_KEY = 'up-scroll-promise'
 
@@ -73,35 +91,35 @@ up.layout = (->
     A promise that will be resolved when the scrolling ends.
   ###
   scroll = (viewport, scrollTop, options) ->
-    $view = $(viewport)
+    $viewport = $(viewport)
     options = u.options(options)
     duration = u.option(options.duration, config.duration)
     easing = u.option(options.easing, config.easing)
 
-    finishScrolling($view)
+    finishScrolling($viewport)
 
     if duration > 0
       deferred = $.Deferred()
 
-      $view.data(SCROLL_PROMISE_KEY, deferred)
+      $viewport.data(SCROLL_PROMISE_KEY, deferred)
       deferred.then ->
-        $view.removeData(SCROLL_PROMISE_KEY)
+        $viewport.removeData(SCROLL_PROMISE_KEY)
         # Since we're scrolling using #animate, #finish can be
         # used to jump to the last frame:
         # https://api.jquery.com/finish/
-        $view.finish()
+        $viewport.finish()
 
       targetProps =
         scrollTop: scrollTop
 
-      $view.animate targetProps,
+      $viewport.animate targetProps,
         duration: duration,
         easing: easing,
         complete: -> deferred.resolve()
 
       deferred
     else
-      $view.scrollTop(scrollTop)
+      $viewport.scrollTop(scrollTop)
       u.resolvedDeferred()
 
   ###*
@@ -122,10 +140,10 @@ up.layout = (->
         u.error("Fixed element %o must have a CSS attribute %o", $obstructor, cssAttr)
       parseInt(anchorPosition) + $obstructor.height()
 
-    fixedTopBottoms = for obstructor in $(config.fixedTop)
+    fixedTopBottoms = for obstructor in $(config.fixedTop.join(', '))
       measurePosition(obstructor, 'top')
 
-    fixedBottomTops = for obstructor in $(config.fixedBottom)
+    fixedBottomTops = for obstructor in $(config.fixedBottom.join(', '))
       measurePosition(obstructor, 'bottom')
 
     top: Math.max(0, fixedTopBottoms...)
@@ -171,7 +189,7 @@ up.layout = (->
   reveal = (elementOrSelector, options) ->
     options = u.options(options)
     $element = $(elementOrSelector)
-    $viewport = findViewport($element, options.viewport)
+    $viewport = viewportOf($element, options.viewport)
 
     snap = u.option(options.snap, config.snap)
 
@@ -220,23 +238,112 @@ up.layout = (->
     else
       u.resolvedDeferred()
 
+  viewportSelector = ->
+    config.viewports.join(', ')
+
   ###*
-  @private
-  @method up.viewport.findViewport
+  Returns the viewport for the given element.
+
+  Throws an error if no viewport could be found.
+
+  @protected
+  @method up.layout.viewportOf
+  @param {String|Element|jQuery} selectorOrElement
   ###
-  findViewport = ($element, viewportSelectorOrElement) ->
+  viewportOf = (selectorOrElement, viewportSelectorOrElement) ->
+    $element = $(selectorOrElement)
     $viewport = undefined
     # If someone has handed as a jQuery element, that's the
     # view period.
     if u.isJQuery(viewportSelectorOrElement)
       $viewport = viewportSelectorOrElement
     else
-      vieportSelector = u.presence(viewportSelectorOrElement) || config.viewport
+      vieportSelector = u.presence(viewportSelectorOrElement) || viewportSelector()
       $viewport = $element.closest(vieportSelector)
 
     $viewport.length or u.error("Could not find viewport for %o", $element)
     $viewport
 
+  ###*
+  Returns a jQuery collection of all the viewports contained within the
+  given selector or element.
+
+  @protected
+  @method up.layout.viewportsIn
+  @param {String|Element|jQuery} selectorOrElement
+  @return jQuery
+  ###
+  viewportsIn = (selectorOrElement) ->
+    $element = $(selectorOrElement)
+    u.findWithSelf($element, viewportSelector())
+
+  ###*
+  Returns a jQuery collection of all the viewports on the screen.
+
+  @protected
+  @method up.layout.viewports
+  ###
+  viewports = ->
+    $(viewportSelector())
+
+  ###*
+  Returns a hash with scroll positions.
+
+  Each key in the hash is a viewport selector. The corresponding
+  value is the viewport's top scroll position:
+
+      up.layout.scrollTops()
+      => { '.main': 0, '.sidebar': 73 }
+
+  @protected
+  @method up.layout.scrollTops
+  @return Object<String, Number>
+  ###
+  scrollTops = ->
+    topsBySelector = {}
+    for viewport in config.viewports
+      $viewport = $(viewport)
+      if $viewport.length
+        topsBySelector[viewport] = $viewport.scrollTop()
+    topsBySelector
+
+  ###*
+  Saves the top scroll positions of all the
+  viewports configured in `up.layout.defaults('viewports').
+  The saved scroll positions can be restored by calling
+  [`up.layout.restoreScroll()`](#up.layout.restoreScroll).
+
+  @method up.layout.saveScroll
+  @param {String} [options.url]
+  @param {Object<String, Number>} [options.tops]
+  @protected
+  ###
+  saveScroll = (options = {}) ->
+    url = u.option(options.url, up.history.url())
+    tops = u.option(options.tops, scrollTops())
+    lastScrollTops.set(url, tops)
+
+  ###*
+  Restores the top scroll positions of all the
+  viewports configured in `up.layout.defaults('viewports')`.
+
+  @method up.layout.restoreScroll
+  @param {String} [options.within]
+  @protected
+  ###
+  restoreScroll = (options = {}) ->
+
+    $viewports = if options.within
+      viewportsIn(options.within)
+    else
+      viewports()
+
+    tops = lastScrollTops.get(up.history.url())
+
+    for selector, scrollTop of tops
+      $matchingViewport = $viewports.filter(selector)
+      up.scroll($matchingViewport, scrollTop, duration: 0)
+
   ###*
   Marks this element as a scrolling container. Apply this ttribute if your app uses
   a custom panel layout with fixed positioning instead of scrolling `<body>`.
@@ -323,6 +430,12 @@ up.layout = (->
   scroll: scroll
   finishScrolling: finishScrolling
   defaults: config.update
+  viewportOf: viewportOf
+  viewportsIn: viewportsIn
+  viewports: viewports
+  scrollTops: scrollTops
+  saveScroll: saveScroll
+  restoreScroll: restoreScroll
 
 )()
 

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

@@ -132,9 +132,8 @@ up.link = (->
     or to `body` if such an attribute does not exist.
   @param {Function|String} [options.transition]
     A transition function or name.
-  @param {Element|jQuery|String} [options.scroll]
-    An element or selector that will be scrolled to the top in
-    case the replaced element is not visible in the viewport.
+  @param {Element|jQuery|String} [options.reveal]
+    Whether to reveal the followed element within its viewport.
   @param {Number} [options.duration]
     The duration of the transition. See [`up.morph`](/up.motion#up.morph).
   @param {Number} [options.delay]
@@ -148,10 +147,11 @@ up.link = (->
     options = u.options(options)
     url = u.option($link.attr('up-href'), $link.attr('href'))
     selector = u.option(options.target, $link.attr('up-target'), 'body')
-    options.transition = u.option(options.transition, $link.attr('up-transition'), $link.attr('up-animation')) 
-    options.history = u.option(options.history, $link.attr('up-history'))
-    options.scroll = u.option(options.scroll, $link.attr('up-scroll'), 'body')
-    options.cache = u.option(options.cache, $link.attr('up-cache'))
+    options.transition = u.option(options.transition, u.castedAttr($link, 'up-transition'), u.castedAttr($link, 'up-animation'))
+    options.history = u.option(options.history, u.castedAttr($link, 'up-history'))
+    options.reveal = u.option(options.reveal, u.castedAttr($link, 'up-reveal'))
+    options.cache = u.option(options.cache, u.castedAttr($link, 'up-cache'))
+    options.restoreScroll = u.option(options.restoreScroll, u.castedAttr($link, 'up-restore-scroll'))
     options.method = followMethod($link, options)
     options = u.merge(options, up.motion.animateOptions(options, $link))
 
@@ -219,6 +219,9 @@ up.link = (->
   @param [up-href]
     The destination URL to follow.
     If omitted, the the link's `href` attribute will be used.
+  @param [up-restore-scroll='false']
+    Whether to restore the scroll position of all viewports
+    within the target selector.
   ###
   up.on 'click', 'a[up-target], [up-href][up-target]', (event, $link) ->
     if shouldProcessLinkEvent(event, $link)
@@ -265,7 +268,21 @@ up.link = (->
     
   shouldProcessLinkEvent = (event, $link) ->
     u.isUnmodifiedMouseEvent(event) && !childClicked(event, $link)
-    
+
+  ###*
+  Makes sure that the given link is handled by Up.js.
+
+  This is done by giving the link an `up-follow` attribute
+  if it doesn't already have it an `up-target` or `up-follow` attribute.
+
+  @method up.link.makeFollowable
+  @protected
+  ###
+  makeFollowable = (link) ->
+    $link = $(link)
+    if u.isMissing($link.attr('up-target')) && u.isMissing($link.attr('up-follow'))
+      $link.attr('up-follow', '')
+
   ###*
   If applied on a link, Follows this link via AJAX and replaces the
   current `<body>` element with the response's `<body>` element.
@@ -292,6 +309,9 @@ up.link = (->
   @param [up-href]
     The destination URL to follow.
     If omitted, the the link's `href` attribute will be used.
+  @param [up-restore-scroll='false']
+    Whether to restore the scroll position of all viewports
+    within the response.
   ###
   up.on 'click', 'a[up-follow], [up-href][up-follow]', (event, $link) ->
     if shouldProcessLinkEvent(event, $link)
@@ -321,9 +341,9 @@ up.link = (->
   @ujs
   @method [up-expand]
   ###
-  up.compiler '[up-expand]', ($fragment) ->
-    link = $fragment.find('a, [up-href]').get(0)
-    link or u.error('No link to expand within %o', $fragment)
+  up.compiler '[up-expand]', ($area) ->
+    link = $area.find('a, [up-href]').get(0)
+    link or u.error('No link to expand within %o', $area)
     upAttributePattern = /^up-/
     newAttrs = {}
     newAttrs['up-href'] = $(link).attr('href')
@@ -331,10 +351,10 @@ up.link = (->
       name = attribute.name
       if name.match(upAttributePattern)
         newAttrs[name] = attribute.value
-    # Make sure that the containing area will be considered a link
-    u.isGiven(newAttrs['up-target']) or newAttrs['up-follow'] = ''
-    u.setMissingAttrs($fragment, newAttrs)
-    $fragment.removeAttr('up-expand')
+    u.setMissingAttrs($area, newAttrs)
+    $area.removeAttr('up-expand')
+    makeFollowable($area)
+
   
   ###*
   Marks up the current link to be followed *as fast as possible*.
@@ -356,12 +376,14 @@ up.link = (->
   @ujs
   ###
   up.compiler '[up-dash]', ($element) ->
-    target = $element.attr('up-dash')
+    target = u.castedAttr($element, 'up-dash')
     newAttrs = {
       'up-preload': 'true',
       'up-instant': 'true'
     }
-    if u.isBlank(target) || u.castsToTrue(target)
+    if target is true
+      # If it's literally `true` then we don't have a target selector.
+      # Just follow the link by replacing `<body>`.
       newAttrs['up-follow'] = ''
     else
       newAttrs['up-target'] = target
@@ -371,6 +393,7 @@ up.link = (->
   knife: eval(Knife?.point)
   visit: visit
   follow: follow
+  makeFollowable: makeFollowable
   childClicked: childClicked
   followMethod: followMethod
 

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

@@ -207,8 +207,8 @@ up.modal = (->
     maxWidth = u.option(options.maxWidth, $link.attr('up-max-width'), config.maxWidth)
     height = u.option(options.height, $link.attr('up-height'), config.height)
     animation = u.option(options.animation, $link.attr('up-animation'), config.openAnimation)
-    sticky = u.option(options.sticky, $link.is('[up-sticky]'))
-    history = if up.browser.canPushState() then u.option(options.history, $link.attr('up-history'), true) else false
+    sticky = u.option(options.sticky, u.castedAttr($link, 'up-sticky'))
+    history = if up.browser.canPushState() then u.option(options.history, u.castedAttr($link, 'up-history'), true) else false
     animateOptions = up.motion.animateOptions(options, $link)
 
     close()

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

@@ -123,6 +123,8 @@ up.motion = (->
     $element = $(elementOrSelector)
     finish($element)
     options = animateOptions(options)
+    if animation == 'none' || animation == false
+      none()
     if u.isFunction(animation)
       assertIsDeferred(animation($element, options), animation)
     else if u.isString(animation)
@@ -260,7 +262,7 @@ up.motion = (->
       $new = $(target)
       finish($old)
       finish($new)
-      if transitionOrName == 'none'
+      if transitionOrName == 'none' or transitionOrName == false
         # don't create ghosts if we aren't really transitioning
         none()
       else if transition = u.presence(transitionOrName, u.isFunction) || transitions[transitionOrName]

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

@@ -23,16 +23,16 @@ up.navigation = (->
     The class to set on [links that point the current location](#up-current).
   ###
   config = u.config
-    currentClass: 'up-current'
+    currentClasses: ['up-current']
 
   reset = ->
     config.reset()
 
   currentClass = ->
-    klass = config.currentClass
-    unless u.contains(klass, 'up-current')
-      klass += ' up-current'
-    klass
+    classes = config.currentClasses
+    classes = classes.concat(['up-current'])
+    classes = u.uniq(classes)
+    classes.join(' ')
 
   CLASS_ACTIVE = 'up-active'
   SELECTORS_SECTION = ['a', '[up-href]', '[up-alias]']

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

@@ -141,8 +141,8 @@ up.popup = (->
     selector = u.option(options.target, $link.attr('up-popup'), 'body')
     position = u.option(options.position, $link.attr('up-position'), config.position)
     animation = u.option(options.animation, $link.attr('up-animation'), config.openAnimation)
-    sticky = u.option(options.sticky, $link.is('[up-sticky]'))
-    history = if up.browser.canPushState() then u.option(options.history, $link.attr('up-history'), false) else false
+    sticky = u.option(options.sticky, u.castedAttr($link, 'up-sticky'))
+    history = if up.browser.canPushState() then u.option(options.history, u.castedAttr($link, 'up-history'), false) else false
     animateOptions = up.motion.animateOptions(options, $link)
 
     close()

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

@@ -53,7 +53,6 @@ up.proxy = (->
 
   u = up.util
 
-  cache = undefined
   $waitingLink = undefined
   preloadDelayTimer = undefined
   busyDelayTimer = undefined
@@ -81,6 +80,44 @@ up.proxy = (->
     cacheSize: 70
     cacheExpiry: 1000 * 60 * 5
 
+  cacheKey = (request) ->
+    normalizeRequest(request)
+    [ request.url,
+      request.method,
+      request.data,
+      request.selector
+    ].join('|')
+
+  cache = u.cache
+    size: -> config.cacheSize
+    expiry: -> config.cacheExpiry
+    key: cacheKey
+    log: 'up.proxy'
+
+  ###*
+  @protected
+  @method up.proxy.get
+  ###
+  get = cache.get
+
+  ###*
+  @protected
+  @method up.proxy.set
+  ###
+  set = cache.set
+
+  ###*
+  @protected
+  @method up.proxy.remove
+  ###
+  remove = cache.remove
+
+  ###*
+  @protected
+  @method up.proxy.clear
+  ###
+  clear = cache.clear
+
   cancelPreloadDelay = ->
     clearTimeout(preloadDelayTimer)
     preloadDelayTimer = null
@@ -90,40 +127,18 @@ up.proxy = (->
     busyDelayTimer = null
 
   reset = ->
-    cache = {}
     $waitingLink = null
     cancelPreloadDelay()
     cancelBusyDelay()
     pendingCount = 0
     config.reset()
     busyEventEmitted = false
+    cache.clear()
 
   reset()
 
-  cacheKey = (request) ->
-    normalizeRequest(request)
-    [ request.url,
-      request.method,
-      request.data,
-      request.selector
-    ].join('|')
-    
-  trim = ->
-    keys = u.keys(cache)
-    if keys.length > config.cacheSize
-      oldestKey = null
-      oldestTimestamp = null
-      u.each keys, (key) ->
-        promise = cache[key] # we don't need to call cacheKey here
-        timestamp = promise.timestamp
-        if !oldestTimestamp || oldestTimestamp > timestamp
-          oldestKey = key
-          oldestTimestamp = timestamp
-      delete cache[oldestKey] if oldestKey
-    
-  timestamp = ->
-    (new Date()).valueOf()
-    
+  alias = cache.alias
+
   normalizeRequest = (request) ->
     unless request._normalized
       request.method = u.normalizeMethod(request.method)
@@ -131,11 +146,6 @@ up.proxy = (->
       request.selector ||= 'body'
       request._normalized = true
     request
-    
-  alias = (oldRequest, newRequest) ->
-    u.debug("Aliasing %o to %o", oldRequest, newRequest)
-    if promise = get(oldRequest)
-      set(newRequest, promise)
 
   ###*
   Makes a request to the given URL and caches the response.
@@ -160,8 +170,8 @@ up.proxy = (->
     If set to `false` a network connection will always be attempted.
   ###
   ajax = (options) ->
-    forceCache = u.castsToTrue(options.cache)
-    ignoreCache = u.castsToFalse(options.cache)
+    forceCache = (options.cache == true)
+    ignoreCache = (options.cache == false)
 
     request = u.only(options, 'url', 'method', 'data', 'selector', '_normalized')
 
@@ -254,55 +264,6 @@ up.proxy = (->
     normalizeRequest(request)
     u.contains(SAFE_HTTP_METHODS, request.method)
 
-  isFresh = (promise) ->
-    timeSinceTouch = timestamp() - promise.timestamp
-    timeSinceTouch < config.cacheExpiry
-
-  ###*
-  @protected
-  @method up.proxy.get
-  ###
-  get = (request) ->
-    key = cacheKey(request)
-    if promise = cache[key]
-      if !isFresh(promise)
-        u.debug("Discarding stale cache entry for %o (%o)", request.url, request)
-        remove(request)
-        undefined
-      else
-        u.debug("Cache hit for %o (%o)", request.url, request)
-#        $('body').css('background-color': 'green')
-        promise
-    else
-      u.debug("Cache miss for %o (%o)", request.url, request)
-      undefined
-
-  ###*
-  @protected
-  @method up.proxy.set
-  ###
-  set = (request, promise) ->
-    trim()
-    key = cacheKey(request)
-    promise.timestamp = timestamp()
-    cache[key] = promise
-    promise
-
-  ###*
-  @protected
-  @method up.proxy.remove
-  ###
-  remove = (request) ->
-    key = cacheKey(request)
-    delete cache[key]
-
-  ###*
-  @protected
-  @method up.proxy.clear
-  ###
-  clear = ->
-    cache = {}
-  
   checkPreload = ($link) ->
     delay = parseInt(u.presentAttr($link, 'up-delay')) || config.preloadDelay 
     unless $link.is($waitingLink)

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

@@ -60,7 +60,7 @@ up.tooltip = (->
     $link = $(linkOrSelector)
     html = u.option(options.html, $link.attr('up-tooltip'), $link.attr('title'))
     position = u.option(options.position, $link.attr('up-position'), 'top')
-    animation = u.option(options.animation, $link.attr('up-animation'), 'fade-in')
+    animation = u.option(options.animation, u.castedAttr($link, 'up-animation'), 'fade-in')
     animateOptions = up.motion.animateOptions(options, $link)
     close()
     $tooltip = createElement(html)