RubyGems - upjs-rails - Versions diffs - 0.11.1 → 0.12.0 - Mend

upjs-rails 0.11.1 → 0.12.0

Files changed (43) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +50 -0
data/dist/up-bootstrap.js +9 -17
data/dist/up-bootstrap.min.js +1 -1
data/dist/up.js +384 -458
data/dist/up.min.js +2 -2
data/lib/assets/javascripts/up/boot.js.coffee +2 -2
data/lib/assets/javascripts/up/browser.js.coffee +2 -2
data/lib/assets/javascripts/up/bus.js.coffee +39 -88
data/lib/assets/javascripts/up/flow.js.coffee +25 -33
data/lib/assets/javascripts/up/form.js.coffee +2 -2
data/lib/assets/javascripts/up/history.js.coffee +8 -7
data/lib/assets/javascripts/up/layout.js.coffee +19 -18
data/lib/assets/javascripts/up/link.js.coffee +2 -2
data/lib/assets/javascripts/up/magic.js.coffee +41 -27
data/lib/assets/javascripts/up/modal.js.coffee +74 -57
data/lib/assets/javascripts/up/motion.js.coffee +11 -10
data/lib/assets/javascripts/up/navigation.js.coffee +11 -10
data/lib/assets/javascripts/up/popup.js.coffee +19 -16
data/lib/assets/javascripts/up/proxy.js.coffee +17 -16
data/lib/assets/javascripts/up/tooltip.js.coffee +28 -14
data/lib/assets/javascripts/up/util.js.coffee +14 -22
data/lib/assets/javascripts/up-bootstrap/layout-ext.js.coffee +5 -6
data/lib/assets/javascripts/up-bootstrap/modal-ext.js.coffee +8 -8
data/lib/assets/javascripts/up-bootstrap/navigation-ext.js.coffee +2 -5
data/lib/assets/javascripts/up.js.coffee +0 -1
data/lib/upjs/rails/version.rb +1 -1
data/spec_app/Gemfile.lock +1 -1
data/spec_app/spec/javascripts/up/bus_spec.js.coffee +43 -6
data/spec_app/spec/javascripts/up/flow_spec.js.coffee +1 -1
data/spec_app/spec/javascripts/up/history_spec.js.coffee +3 -3
data/spec_app/spec/javascripts/up/layout_spec.js.coffee +9 -11
data/spec_app/spec/javascripts/up/link_spec.js.coffee +7 -9
data/spec_app/spec/javascripts/up/magic_spec.js.coffee +5 -5
data/spec_app/spec/javascripts/up/modal_spec.js.coffee +8 -10
data/spec_app/spec/javascripts/up/navigation_spec.js.coffee +13 -13
data/spec_app/spec/javascripts/up/popup_spec.js.coffee +1 -5
data/spec_app/spec/javascripts/up/proxy_spec.js.coffee +51 -52
data/spec_app/spec/javascripts/up/tooltip_spec.js.coffee +19 -5
data/spec_app/spec/javascripts/up/util_spec.js.coffee +14 -23
metadata +1 -3
data/lib/assets/javascripts/up/slot.js.coffee +0 -63
data/spec_app/spec/javascripts/up/slot_spec.js.coffee +0 -16

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

@@ -6,37 +6,37 @@ This modules contains functions to scroll the viewport and reveal contained elem
 @class up.layout
 ###
-up.layout = (->
+up.layout = (($) ->
   u = up.util
   ###*
   Configures the application layout.
-  @method up.layout.defaults
-  @param {Array<String>} [options.viewports]
+  @method up.layout.config
+  @param {Array<String>} [config.viewports]
     An array of CSS selectors that find viewports
     (containers that scroll their contents).
-  @param {Array<String>} [options.fixedTop]
+  @param {Array<String>} [config.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]
+  @param {Array<String>} [config.fixedBottom]
     An array of CSS selectors that find elements fixed to the
     bottom edge of the screen (using `position: fixed`).
-  @param {Array<String>} [options.anchoredRight]
+  @param {Array<String>} [config.anchoredRight]
     An array of CSS selectors that find elements anchored to the
     right edge of the screen (using `position: fixed` or `position: absolute`).
-  @param {Number} [options.duration]
+  @param {Number} [config.duration]
     The duration of the scrolling animation in milliseconds.
     Setting this to `0` will disable scrolling animations.
-  @param {String} [options.easing]
+  @param {String} [config.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]
+  @param {Number} [config.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`.
-  @param {Number} [options.substance]
+    to the top when the revealed element is closer to the top than `config.snap`.
+  @param {Number} [config.substance]
     A number indicating how many top pixel rows of an element to [reveal](#up.reveal).
   ###
   config = u.config
@@ -182,7 +182,7 @@ up.layout = (->
   - the currently open [modal](/up.modal)
   - an element with the attribute `[up-viewport]`
   - the `<body>` element
-  - an element matching the selector you have configured using `up.viewport.defaults({ viewSelector: 'my-custom-selector' })`
+  - an element matching the selector you have configured using `up.viewport.config.viewports.push('my-custom-selector')`
   \#\#\#\# Fixed elements obstruction the viewport
@@ -192,7 +192,7 @@ up.layout = (->
   To make `up.aware` of these fixed elements you can either:
   - give the element an attribute [`up-fixed="top"`](#up-fixed-top) or [`up-fixed="bottom"`](up-fixed-bottom)
-  - [configure default options](#up.layout.defaults) for `fixedTop` or `fixedBottom`
+  - [configure default options](#up.layout.config) for `fixedTop` or `fixedBottom`
   @method up.reveal
   @param {String|Element|jQuery} element
@@ -336,7 +336,7 @@ up.layout = (->
   ###*
   Saves the top scroll positions of all the
-  viewports configured in `up.layout.defaults('viewports').
+  viewports configured in [`up.layout.config.viewports`](#up.layout.config).
   The saved scroll positions can be restored by calling
   [`up.layout.restoreScroll()`](#up.layout.restoreScroll).
@@ -352,7 +352,7 @@ up.layout = (->
   ###*
   Restores the top scroll positions of all the
-  viewports configured in `up.layout.defaults('viewports')`.
+  viewports configured in [`up.layout.config.viewports`](#up.layout.config).
   @method up.layout.restoreScroll
   @param {jQuery} [options.around]
@@ -458,12 +458,13 @@ up.layout = (->
   @ujs
   ###
-  up.bus.on 'framework:reset', reset
+  up.on 'up:framework:reset', reset
   reveal: reveal
   scroll: scroll
   finishScrolling: finishScrolling
-  defaults: config.update
+  config: config
+  defaults: -> u.error('up.layout.defaults(...) no longer exists. Set values on he up.layout.config property instead.')
   viewportOf: viewportOf
   viewportsWithin: viewportsWithin
   viewports: viewports
@@ -473,7 +474,7 @@ up.layout = (->
   anchoredRight: anchoredRight
   fixedChildren: fixedChildren
-)()
+)(jQuery)
 up.scroll = up.layout.scroll
 up.reveal = up.layout.reveal

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

@@ -82,7 +82,7 @@ Read on
 @class up.link
 ###
-up.link = (->
+up.link = (($) ->
   u = up.util
@@ -409,7 +409,7 @@ up.link = (->
   childClicked: childClicked
   followMethod: followMethod
-)()
+)(jQuery)
 up.visit = up.link.visit
 up.follow = up.link.follow

data/lib/assets/javascripts/up/magic.js.coffee CHANGED Viewed

@@ -14,7 +14,7 @@ We need to work on this page:
 @class up.magic
 ###
-up.magic = (->
+up.magic = (($) ->
   u = up.util
@@ -69,8 +69,10 @@ up.magic = (->
   @method up.on
   @param {String} events
     A space-separated list of event names to bind.
-  @param {String} selector
-    The selector an on which the event must be triggered.
+  @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.
   @param {Function(event, $element, data)} behavior
     The handler that should be called.
     The function takes the affected element as the first argument (as a jQuery object).
@@ -80,16 +82,28 @@ up.magic = (->
   liveDescriptions = []
   defaultLiveDescriptions = null
-  live = (events, selector, behavior) ->
+  ###*
+  # Convert an Up.js style listener (second argument is the event target
+  # as a jQuery collection) to a vanilla jQuery listener
+  ###
+  upListenerToJqueryListener = (upListener) ->
+    (event) ->
+      $me = event.$element || $(this)
+      upListener.apply($me.get(0), [event, $me, data($me)])
+  live = (args...) ->
     # Silently discard any event handlers that are registered on unsupported browsers
     return unless up.browser.isSupported()
-    description = [
-      events,
-      selector,
-      (event) ->
-        behavior.apply(this, [event, $(this), data(this)])
-    ]
+    description = u.copy(args)
+    lastIndex = description.length - 1
+    behavior = description[lastIndex]
+    description[lastIndex] = upListenerToJqueryListener(behavior)
+    # Remember the descriptions we registered, so we can
+    # clean up after ourselves during a reset
     liveDescriptions.push(description)
     $(document).on(description...)
   ###*
@@ -326,13 +340,13 @@ up.magic = (->
   other Up.js methods. You will only need to call this if you
   manipulate the DOM without going through Up.js.
-  @method up.ready
-  @param {String|Element|jQuery} selectorOrFragment
+  @method up.hello
+  @param {String|Element|jQuery} selectorOrElement
   ###
-  ready = (selectorOrFragment) ->
-    $fragment = $(selectorOrFragment)
-    up.bus.emit('fragment:ready', $fragment)
-    $fragment
+  hello = (selectorOrElement) ->
+    $element = $(selectorOrElement)
+    up.bus.emit('up:fragment:inserted', $element: $element)
+    $element
   onEscape = (handler) ->
     live('keydown', 'body', (event) ->
@@ -340,23 +354,23 @@ up.magic = (->
         handler(event)
     )
-  up.bus.on 'app:ready', (-> ready(document.body))
-  up.bus.on 'fragment:ready', compile
-  up.bus.on 'fragment:destroy', destroy
-  up.bus.on 'framework:ready', snapshot
-  up.bus.on 'framework:reset', reset
+  live 'ready', (-> hello(document.body))
+  live 'up:fragment:inserted', (event) -> compile(event.$element)
+  live 'up:fragment:destroy', (event) -> destroy(event.$element)
+  live 'up:framework:boot', snapshot
+  live 'up:framework:reset', reset
   compiler: compiler
   on: live
-  ready: ready
+  hello: hello
   onEscape: onEscape
   data: data
-)()
+)(jQuery)
 up.compiler = up.magic.compiler
 up.on = up.magic.on
-up.ready = up.magic.ready
-up.awaken = (args...) ->
-  up.util.warn("up.awaken has been renamed to up.compiler and will be removed in a future version")
-  up.compiler(args...)
+up.hello = up.magic.hello
+up.ready = -> up.util.error('up.ready no longer exists. Please use up.hello instead.')
+up.awaken = -> up.util.error('up.awaken no longer exists. Please use up.compiler instead.')

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

@@ -9,30 +9,30 @@ For small popup overlays ("dropdowns") see [up.popup](/up.popup) instead.
 @class up.modal
 ###
-up.modal = (->
+up.modal = (($) ->
   u = up.util
   ###*
   Sets default options for future modals.
-  @method up.modal.defaults
-  @param {Number} [options.width]
+  @method up.modal.config
+  @param {Number} [config.width]
     The width of the dialog as a CSS value like `'400px'` or `50%`.
     Defaults to `undefined`, meaning that the dialog will grow to fit its contents
-    until it reaches `options.maxWidth`. Leaving this as `undefined` will
+    until it reaches `config.maxWidth`. Leaving this as `undefined` will
     also allow you to control the width using CSS on `.up-modal-dialog´.
-  @param {Number} [options.maxWidth]
+  @param {Number} [config.maxWidth]
     The width of the dialog as a CSS value like `'400px'` or `50%`.
     You can set this to `undefined` to make the dialog fit its contents.
     Be aware however, that e.g. Bootstrap stretches input elements
     to `width: 100%`, meaning the dialog will also stretch to the full
     width of the screen.
-  @param {Number} [options.height='auto']
+  @param {Number} [config.height='auto']
     The height of the dialog in pixels.
     Defaults to `undefined`, meaning that the dialog will grow to fit its contents.
-  @param {String|Function(config)} [options.template]
+  @param {String|Function(config)} [config.template]
     A string containing the HTML structure of the modal.
     You can supply an alternative template string, but make sure that it
     defines tag with the classes `up-modal`, `up-modal-dialog` and  `up-modal-content`.
@@ -40,12 +40,12 @@ up.modal = (->
     You can also supply a function that returns a HTML string.
     The function will be called with the modal options (merged from these defaults
     and any per-open overrides) whenever a modal opens.
-  @param {String} [options.closeLabel='X']
+  @param {String} [config.closeLabel='X']
     The label of the button that closes the dialog.
-  @param {String} [options.openAnimation='fade-in']
+  @param {String} [config.openAnimation='fade-in']
     The animation used to open the modal. The animation will be applied
     to both the dialog box and the overlay dimming the page.
-  @param {String} [options.closeAnimation='fade-out']
+  @param {String} [config.closeAnimation='fade-out']
     The animation used to close the modal. The animation will be applied
     to both the dialog box and the overlay dimming the page.
   ###
@@ -134,29 +134,27 @@ up.modal = (->
       unshiftElements.push(unshiftElement)
   updated = ($modal, animation, animateOptions) ->
-    up.bus.emit('modal:open')
     shiftElements()
     $modal.show()
-    promise = up.animate($modal, animation, animateOptions)
-    promise.then -> up.bus.emit('modal:opened')
-    promise
+    deferred = up.animate($modal, animation, animateOptions)
+    deferred.then -> up.bus.emit('up:modal:opened')
   ###*
   Opens the given link's destination in a modal overlay:
       var $link = $('...');
-      up.modal.open($link);
+      up.modal.follow($link);
   Any option attributes for [`a[up-modal]`](#a.up-modal) will be honored.
   \#\#\#\# Events
-  - Emits an [event](/up.bus) `modal:open` when the modal
+  - Emits an [event](/up.bus) `up:modal:open` when the modal
     is starting to open.
-  - Emits an [event](/up.bus) `modal:opened` when the opening
+  - Emits an [event](/up.bus) `up:modal:opened` when the opening
     animation has finished and the modal contents are fully visible.
-  @method up.modal.open
+  @method up.modal.follow
   @param {Element|jQuery|String} elementOrSelector
     The link to follow.
   @param {String} [options.target]
@@ -183,19 +181,24 @@ up.modal = (->
   @return {Promise}
     A promise that will be resolved when the modal has finished loading.
   ###
+  follow = ($link, options) ->
+    options = u.options(options)
+    options.$link = $link
+    open(options)
   ###*
   Opens a modal for the given URL.
   Example:
-      up.modal.open({ url: '/foo', target: '.list' })
+      up.modal.visit('/foo', { target: '.list' })
   This will request `/foo`, extract the `.list` selector from the response
   and open the selected container in a modal dialog.
-  @method up.modal.open
-  @param {String} options.url
+  @method up.modal.visit
+  @param {String} url
     The URL to load.
   @param {String} options.target
     The CSS selector to extract from the response.
@@ -203,15 +206,18 @@ up.modal = (->
   @param {Object} options
     See options for [previous `up.modal.open` variant](#up.modal.open).
   ###
-  open = (args...) ->
-    if u.isObject(args[0]) && !u.isElement(args[0]) && !u.isJQuery(args[0])
-      $link = u.nullJquery()
-      options = args[0]
-    else
-      $link = $(args[0])
-      options = args[1]
+  visit = (url, options) ->
+    options = u.options(options)
+    options.url = url
+    open(options)
+  ###*
+  @private
+  ###
+  open = (options) ->
     options = u.options(options)
+    $link = u.option(options.$link, u.nullJquery())
     url = u.option(options.url, $link.attr('up-href'), $link.attr('href'))
     selector = u.option(options.target, $link.attr('up-modal'), 'body')
     width = u.option(options.width, $link.attr('up-width'), config.width)
@@ -226,17 +232,21 @@ up.modal = (->
     animateOptions = up.motion.animateOptions(options, $link)
     close()
-    $modal = createHiddenModal
-      selector: selector
-      width: width
-      maxWidth: maxWidth
-      height: height
-      sticky: sticky
-    up.replace(selector, url,
-      history: history
-      insert: -> updated($modal, animation, animateOptions)
-    )
+    if up.bus.nobodyPrevents('up:modal:open', url: url)
+      $modal = createHiddenModal
+        selector: selector
+        width: width
+        maxWidth: maxWidth
+        height: height
+        sticky: sticky
+      up.replace selector, url,
+        history: history
+        insert: -> updated($modal, animation, animateOptions)
+    else
+      # Although someone prevented the destruction, keep a uniform API for
+      # callers by returning a Deferred that will never be resolved.
+      $.Deferred()
   ###*
   Returns the source URL for the fragment displayed in the current modal overlay,
@@ -267,18 +277,22 @@ up.modal = (->
   close = (options) ->
     $modal = $('.up-modal')
     if $modal.length
-      options = u.options(options,
-        animation: config.closeAnimation,
-        url: $modal.attr('up-previous-url')
-        title: $modal.attr('up-previous-title')
-      )
-      currentSource = undefined
-      up.bus.emit('modal:close')
-      deferred = up.destroy($modal, options)
-      deferred.then ->
-        unshifter() while unshifter = unshiftElements.pop()
-        up.bus.emit('modal:closed')
-      deferred
+      if up.bus.nobodyPrevents('up:modal:close', $element: $modal)
+        options = u.options(options,
+          animation: config.closeAnimation,
+          url: $modal.attr('up-previous-url')
+          title: $modal.attr('up-previous-title')
+        )
+        currentSource = undefined
+        deferred = up.destroy($modal, options)
+        deferred.then ->
+          unshifter() while unshifter = unshiftElements.pop()
+          up.bus.emit('up:modal:closed')
+        deferred
+      else
+        # Although someone prevented the destruction, keep a uniform API for
+        # callers by returning a Deferred that will never be resolved.
+        $.Deferred()
     else
       u.resolvedDeferred()
@@ -339,7 +353,7 @@ up.modal = (->
       </div>
   If you want to change the design beyond CSS, you can
-  configure Up.js to [use a different HTML structure](#up.modal.defaults).
+  configure Up.js to [use a different HTML structure](#up.modal.config).
   \#\#\#\# Closing behavior
@@ -379,7 +393,7 @@ up.modal = (->
       close()
   )
-  up.bus.on('fragment:ready', ($fragment) ->
+  up.on('up:fragment:inserted', (event, $fragment) ->
     if contains($fragment)
       if newSource = $fragment.attr('up-source')
         currentSource = newSource
@@ -407,12 +421,15 @@ up.modal = (->
   )
   # The framework is reset between tests
-  up.bus.on 'framework:reset', reset
+  up.on 'up:framework:reset', reset
-  open: open
+  visit: visit
+  follow: follow
+  open: -> up.error('up.modal.open no longer exists. Please use either up.modal.follow or up.modal.visit.')
   close: close
   source: source
-  defaults: config.update
+  config: config
+  defaults: -> u.error('up.modal.defaults(...) no longer exists. Set values on he up.modal.config property instead.')
   contains: contains
-)()
+)(jQuery)

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

@@ -25,7 +25,7 @@ We need to work on this page:
 @class up.motion
 ###
-up.motion = (->
+up.motion = (($) ->
   u = up.util
@@ -37,10 +37,10 @@ up.motion = (->
   ###*
   Sets default options for animations and transitions.
-  @method up.motion.defaults
-  @param {Number} [options.duration=300]
-  @param {Number} [options.delay=0]
-  @param {String} [options.easing='ease']
+  @method up.motion.config
+  @param {Number} [config.duration=300]
+  @param {Number} [config.delay=0]
+  @param {String} [config.easing='ease']
   ###
   config = u.config
     duration: 300
@@ -151,7 +151,7 @@ up.motion = (->
     options
   findAnimation = (name) ->
-    animations[name] or u.error("Unknown animation %o", animation)
+    animations[name] or u.error("Unknown animation %o", name)
   GHOSTING_PROMISE_KEY = 'up-ghosting-promise'
@@ -577,8 +577,8 @@ up.motion = (->
     )
   )
-  up.bus.on 'framework:ready', snapshot
-  up.bus.on 'framework:reset', reset
+  up.on 'up:framework:boot', snapshot
+  up.on 'up:framework:reset', reset
   morph: morph
   animate: animate
@@ -586,12 +586,13 @@ up.motion = (->
   finish: finish
   transition: transition
   animation: animation
-  defaults: config.update
+  config: config
+  defaults: -> u.error('up.motion.defaults(...) no longer exists. Set values on he up.motion.config property instead.')
   none: none
   when: resolvableWhen
   prependCopy: prependCopy
-)()
+)(jQuery)
 up.transition = up.motion.transition
 up.animation = up.motion.animation

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

@@ -11,16 +11,16 @@ by providing instant feedback for user interactions.
 @class up.navigation
 ###
-up.navigation = (->
+up.navigation = (($) ->
   u = up.util
   ###*
   Sets default options for this module.
-  @method up.navigation.defaults
-  @param {Number} [options.currentClass]
-    The class to set on [links that point the current location](#up-current).
+  @method up.navigation.config
+  @param {Number} [config.currentClasses]
+    An array of classes to set on [links that point the current location](#up-current).
   ###
   config = u.config
     currentClasses: ['up-current']
@@ -189,17 +189,17 @@ up.navigation = (->
   @method [up-current]
   @ujs
   ###
-  up.bus.on 'fragment:ready', ->
+  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 ready it might either have brought a location change
+    # 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
     # location bar).
     locationChanged()
-  up.bus.on 'fragment:destroy', ($fragment) ->
+  up.on 'up:fragment:destroy', (event, $fragment) ->
     # If the destroyed fragment is a modal or popup container
     # this changes which URLs we consider currents.
     # Also modals and popups restore their previous history
@@ -208,8 +208,9 @@ up.navigation = (->
       locationChanged()
   # The framework is reset between tests
-  up.bus.on 'framework:reset', reset
+  up.on 'up:framework:reset', reset
-  defaults: config.update
+  config: config
+  defaults: -> u.error('up.navigation.defaults(...) no longer exists. Set values on he up.navigation.config property instead.')
-)()
+)(jQuery)