unpoly-rails 2.0.0.pre.rc9 → 2.0.0.pre.rc10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c0f7d238ba1da43445304e1d105040164212030467ceb43063566b9c6785b5
-  data.tar.gz: b55dc0d3ced473078a18cdf9ee00fd0ede39bc50b435497d354c6726dbe16a56
+  metadata.gz: 7bd5baa3c26dc137e7944861528cbacbd458d842c20ed3864e07840161a62662
+  data.tar.gz: cbcf34505f475b8cbd062ab16081f49b98d904c027d0dfbd7c2a50c1871e0a09
 SHA512:
-  metadata.gz: 5c020d0edd5b365ce563c29d96b5956cce4be079bef381dac9cd7371173422cd85aef96d841582a20f6eaeb2bf22d9cec2c1fab021b3bfc5a2f19b6547ad8e03
-  data.tar.gz: bdd8c76a4feeea89eaa26b8cfb68a75ec28dc8cbea520c2a0003401879fd8b52276b633c2305b6a5bc6501f1ef25c1971db80185c727ba468af94466366dd192
+  metadata.gz: f679fc7972c6149277d204609026039daa94a4f802dfc5fbb2ec5f4926c926b2f9befa524a3e6b5fc7c1c8b63388733a230b0e7059eea172dc9b5afeea2add21
+  data.tar.gz: 122e0706cee0950c164dc5bf6aefc693edffa0e40218ae95037a13dacb7a1f911a9a5c04871c2e05b739a1cc47c958598ae384ed57a75bffad3c05124f872252

data/README.md

@@ -35,6 +35,7 @@ Install dependencies for tests:
 
 - Install Ruby 2.3.8
 - Install Bundler by running `gem install bundler`
+- Install Node.js (required for building the library)
 - `cd` into `spec_app`
 - Install dependencies by running `bundle install`
 
@@ -52,11 +53,9 @@ To run RSpec tests for the `unpoly-rails` gem:
 
 ### Making a new release
 
-We are currently feeding four release channels:
+We are currently feeding two release channels:
 
-- Manual download from GitHub
 - npm
-- Bower (which is based on Git and version tags)
 - Rubygems (as the `unpoly-rails` gem)
 
 We always release to all channel simultaneously.

data/dist/unpoly.js

@@ -5,7 +5,7 @@
 
 (function() {
   window.up = {
-    version: "2.0.0-rc9"
+    version: "2.0.0-rc10"
   };
 
 }).call(this);
@@ -2239,7 +2239,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
   var slice = [].slice;
 
   up.element = (function() {
-    var CSS_LENGTH_PROPS, MATCH_FN_NAME, SINGLETON_PATTERN, SINGLETON_TAG_NAMES, affix, all, ancestor, around, attributeSelector, booleanAttr, booleanOrStringAttr, callbackAttr, closest, closestAttr, computedStyle, computedStyleNumber, concludeCSSTransition, createDocumentFromHTML, createFromHTML, createFromSelector, cssLength, elementTagName, extractFromStyleObject, first, fixedToAbsolute, getList, getOne, getRoot, hasCSSTransition, hide, idSelector, inlineStyle, insertBefore, isDetached, isInSubtree, isSingleton, isSingletonSelector, isVisible, jsonAttr, matches, metaContent, normalizeStyleValueForWrite, numberAttr, paint, remove, replace, setAttrs, setInlineStyle, setMissingAttr, setMissingAttrs, setTemporaryAttrs, setTemporaryStyle, show, stringAttr, subtree, toSelector, toggle, toggleAttr, toggleClass, trueAttributeSelector, u, unwrap, upAttrs, valueToList, wrapChildren;
+    var CSS_LENGTH_PROPS, MATCH_FN_NAME, SINGLETON_PATTERN, SINGLETON_TAG_NAMES, affix, all, ancestor, around, attributeSelector, booleanAttr, booleanOrStringAttr, callbackAttr, classSelector, closest, closestAttr, computedStyle, computedStyleNumber, concludeCSSTransition, createDocumentFromHTML, createFromHTML, createFromSelector, cssLength, elementTagName, extractFromStyleObject, first, fixedToAbsolute, getList, getOne, getRoot, hasCSSTransition, hide, idSelector, inlineStyle, insertBefore, isDetached, isInSubtree, isSingleton, isSingletonSelector, isVisible, jsonAttr, matches, metaContent, normalizeStyleValueForWrite, numberAttr, paint, remove, replace, setAttrs, setInlineStyle, setMissingAttr, setMissingAttrs, setTemporaryAttrs, setTemporaryStyle, show, stringAttr, subtree, toSelector, toggle, toggleAttr, toggleClass, trueAttributeSelector, u, unwrap, upAttrs, valueToList, wrapChildren;
     u = up.util;
     MATCH_FN_NAME = up.browser.isIE11() ? 'msMatchesSelector' : 'matches';
 
@@ -2521,12 +2521,8 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
     [this WHATWG mailing list post](http://lists.w3.org/Archives/Public/public-whatwg-archive/2014Apr/0094.html).
     
     @function up.element.show
-    <<<<<<< HEAD:lib/assets/javascripts/unpoly/element.coffee
-    @stable
-    =======
     @param {Element} element
-    @experimental
-    >>>>>>> 0d20e224... Adjust docs:lib/assets/javascripts/unpoly/element.coffee.erb
+    @stable
      */
     show = function(element) {
       return element.style.display = '';
@@ -2916,6 +2912,15 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
       }
     };
 
+    /***
+    @function up.element.classSelector
+    @internal
+     */
+    classSelector = function(klass) {
+      klass = klass.replace(/:/g, '\\:');
+      return "." + klass;
+    };
+
     /***
     Always creates a full document with a <html> root, even if the given `html`
     is only a fragment.
@@ -3449,6 +3454,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
       affix: affix,
       toSelector: toSelector,
       idSelector: idSelector,
+      classSelector: classSelector,
       isSingleton: isSingleton,
       isSingletonSelector: isSingletonSelector,
       attributeSelector: attributeSelector,
@@ -6266,66 +6272,45 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    This layer's mode which governs its appearance and behavior.
-    
-    Available layer modes are:
+    Whether fragment updates within this layer can affect browser history and window title.
     
-    - `'root'`
-    - `'modal'`
-    - `'popup'`
-    - `'drawer'`
-    - `'cover'`
+    If a layer does not have visible history, its desendant layers cannot have history either.
     
-    @property up.Layer#mode
-    @param {string} mode
-    @stable
+    @property up.Layer#historyVisible
+    @param {boolean} historyVisible
      */
 
 
     /***
-    Whether fragment updates within this layer can affect browser history and window title.
+    This layer's mode which governs its appearance and behavior.
     
-    @property up.Layer#historyVisible
-    @param {boolean} historyVisible
+    @see layer-terminology
+    
+    @property up.Layer#mode
+    @param {string} mode
+    @stable
      */
 
 
     /***
-    This layer's context object.
-    
-    Think of *context* as [session storage](/https://makandracards.com/makandra/32865), but specific to a [layer](/up.layer)
-    rather than specific to an entire browser tab.
-    
-    You may access the context object's properties like a regular JavaScript object.
+    This layer's [context](/context).
     
     \#\#\# Example
     
+    You may access the context properties like a regular JavaScript object.
+    
     ```js
     let layer = up.layer.current
     layer.context.message = 'Please select a contact'
     console.log(layer.context) // logs "{ message: 'Please select a contact' }"
     ```
     
-    \#\#\# Accessing the context from the server
-    
-    The context is is sent as an `X-Up-Context` header along with every
-    [request](/up.request) to the server. The server may also update the updating
-    layer's context by including an `X-Up-Context` header in its response.
-    
     @property up.Layer#context
     @param {Object} context
-    @stable
-     */
-
-
-    /***
-    Whether fragment updates within this layer will affect [browser history](/up.history).
-    
-    If a layer does not have visible history, its desendant layers cannot have history either.
+      The context object.
     
-    @property up.Layer#historyVisible
-    @param {boolean} historyVisible
-    @stable
+      If no context has been set an empty object is returned.
+    @experimental
      */
 
     Layer.prototype.keys = function() {
@@ -9348,6 +9333,23 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
      */
 
 
+    /***
+    The [hash component](https://en.wikipedia.org/wiki/URI_fragment) of this request's URL.
+    
+    The `{ hash }` property is automatically extracted from the given URL:
+    
+    ```js
+    let request = up.request({ url: '/path#section' })
+    request.url // => '/path'
+    request.hash // => '#section'
+    ```
+    
+    @property up.Request#hash
+    @param {string} hash
+    @stable
+     */
+
+
     /***
     [Parameters](/up.Params) that should be sent as the request's payload.
     
@@ -9358,7 +9360,9 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    The CSS selector that will be sent as an `X-Up-Target` header.
+    The CSS selector targeted by this request.
+    
+    The selector will be sent as an `X-Up-Target` header.
     
     @property up.Request#target
     @param {string} target
@@ -9367,7 +9371,10 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    The CSS selector that will be sent as an `X-Up-Fail-Target` header.
+    The CSS selector targeted by this request in case the server responds
+    with an [error code](/server-errors).
+    
+    The selector will be sent as an `X-Up-Fail-Target` header.
     
     @property up.Request#failTarget
     @param {string} failTarget
@@ -9378,7 +9385,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
     /***
     An object of additional HTTP headers.
     
-    Note that Unpoly will by default send a number of custom request headers.
+    Unpoly will by default send a number of custom request headers.
     See `up.protocol` and `up.network.config.metaKeys` for details.
     
     @property up.Request#headers
@@ -9414,25 +9421,67 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    TODO: Docs
+    The [context](/contact) of the layer targeted by this request.
+    
+    The context object will be sent as an `X-Up-Context` header.
     
     @property up.Request#context
     @param {Object} context
-    @stable
+    @experimental
      */
 
 
     /***
-    TODO: Docs
+    The [context](/contact) of the layer targeted by this request in case the server responds with an [error code](/server-errors).
+    
+    The context object will be sent as an `X-Up-Fail-Context` header.
     
     @property up.Request#failContext
     @param {Object} failContext
-    @stable
+    @experimental
      */
 
 
     /***
-    TODO: Docs
+    The [layer](/up.layer) targeted by this request.
+    
+    To prevent memory leaks, this property is removed shortly after the response is received.
+    
+    @property up.Request#layer
+    @param {up.Layer} layer
+    @experimental
+     */
+
+
+    /***
+    The [layer](/up.layer) targeted by this request in case the server responds with an [error code](/server-errors).
+    
+    To prevent memory leaks, this property is removed shortly after the response is received.
+    
+    @property up.Request#failLayer
+    @param {up.Layer} layer
+    @experimental
+     */
+
+
+    /***
+    The element that triggered the request.
+    
+    For example, when this request was triggered by a click on a link, the lonk
+    element is set as the `{ origin }`.
+    
+    To prevent memory leaks, this property is removed shortly after the response is received.
+    
+    @property up.Request#origin
+    @param {Element} origin
+    @experimental
+     */
+
+
+    /***
+    The [mode](/up.Layer.prototype.mode) of the layer targeted by this request.
+    
+    The value will be sent as an `X-Up-Mode` header.
     
     @property up.Request#mode
     @param {string} mode
@@ -9441,7 +9490,9 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    TODO: Docs
+    The [mode](/up.Layer.prototype.mode) of the layer targeted by this request in case the server responds with an [error code](/server-errors).
+    
+    The value will be sent as an `X-Up-Fail-Mode` header.
     
     @property up.Request#failMode
     @param {string} failMode
@@ -9450,7 +9501,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    TODO: Docs
+    The format in which the [request params](/up.Layer.prototype.params) will be encoded.
     
     @property up.Request#contentType
     @param {string} contentType
@@ -9459,13 +9510,22 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
 
     /***
-    TODO: Docs
+    The payload that the request will encode into its body.
+    
+    By default Unpoly will build a payload from the given `{ params }` option.
     
     @property up.Request#payload
     @param {string} payload
     @stable
      */
 
+
+    /***
+    @property up.Request#preload
+    @param {boolean} preload
+    @experimental
+     */
+
     Request.prototype.keys = function() {
       return ['method', 'url', 'hash', 'params', 'target', 'failTarget', 'headers', 'timeout', 'preload', 'cache', 'clearCache', 'layer', 'mode', 'context', 'failLayer', 'failMode', 'failContext', 'origin', 'solo', 'queueTime', 'wrapMethod', 'contentType', 'payload', 'onQueued'];
     };
@@ -10299,6 +10359,14 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
     @experimental
      */
 
+
+    /***
+    Changes to the current [context](/context) as [set by the server](/X-Up-Context).
+    
+    @property up.Response#context
+    @experimental
+     */
+
     Response.prototype.keys = function() {
       return ['method', 'url', 'text', 'status', 'request', 'xhr', 'target', 'title', 'acceptLayer', 'dismissLayer', 'eventPlans', 'context', 'clearCache', 'headers'];
     };
@@ -11688,7 +11756,11 @@ document.addEventListener('up:modal:open', (event) => {
     This hyperlink will emit an `user:select` event when clicked:
     
     ```
-    <a href='/users/5" up-emit='user:select' up-emit-props='{ "id": 5, "firstName": "Alice" }'>Alice</a>
+    <a href='/users/5'
+      up-emit='user:select'
+      up-emit-props='{ "id": 5, "firstName": "Alice" }'>
+      Alice
+    </a>
     
     <script>
       up.on('a', 'user:select', function(event) {
@@ -11703,6 +11775,7 @@ document.addEventListener('up:modal:open', (event) => {
       The type of the event to be emitted.
     @param [up-emit-props='{}']
       The event properties, serialized as JSON.
+    @stable
      */
     executeEmitAttr = function(event, element) {
       var eventProps, eventType, forkedEvent;
@@ -11771,7 +11844,7 @@ There are existing implementations for various web frameworks:
 - [Roda](https://github.com/adam12/roda-unpoly)
 - [Rack](https://github.com/adam12/rack-unpoly) (Sinatra, Padrino, Hanami, Cuba, ...)
 - [Phoenix](https://elixirforum.com/t/unpoly-a-framework-like-turbolinks/3614/15) (Elixir)
-- [PHP](https://github.com/adam12/rack-unpoly) (Symfony, Laravel, Stack)
+- [PHP](https://github.com/webstronauts/php-unpoly) (Symfony, Laravel, Stack)
 
 @module up.protocol
  */
@@ -12050,7 +12123,7 @@ There are existing implementations for various web frameworks:
     };
 
     /***
-    This request header contains the targeted layer's [context](/up.context), serialized as JSON.
+    This request header contains the targeted layer's [context](/context), serialized as JSON.
     
     The user may choose to not send this header by configuring
     `up.network.config.requestMetaKeys`.
@@ -12091,11 +12164,11 @@ There are existing implementations for various web frameworks:
     the request was in flight will get overridden by the server-provided context.
     
     @header X-Up-Context
-    @stable
+    @experimental
      */
 
     /***
-    This request header contains the [context](/up.context) of the layer
+    This request header contains the [context](/context) of the layer
     targeted for a failed fragment update, serialized as JSON.
     
     A fragment update is considered *failed* if the server responds with a
@@ -12114,7 +12187,7 @@ There are existing implementations for various web frameworks:
     ```
     
     @header X-Up-Fail-Context
-    @stable
+    @experimental
      */
 
     /***
@@ -13549,9 +13622,11 @@ In an Unpoly app, every page has an URL.
       register = function() {
         window.history.scrollRestoration = 'manual';
         window.addEventListener('popstate', pop);
-        return replace(currentLocation(), {
-          event: false
-        });
+        if (up.protocol.initialRequestMethod() === 'GET') {
+          return replace(currentLocation(), {
+            event: false
+          });
+        }
       };
       if (typeof jasmine !== "undefined" && jasmine !== null) {
         return register();
@@ -13614,31 +13689,33 @@ In an Unpoly app, every page has an URL.
   })();
 
 }).call(this);
+(function() {
+  var e, u,
+    slice = [].slice;
 
-/***
-Fragment update API
-===================
-  
-The `up.fragment` module exposes a high-level Javascript API to [update](/up.replace) or
-[destroy](/up.destroy) page fragments.
-
-Fragments are [compiled](/up.compiler) elements that can be updated from a server URL.
-They also exist on a layer (page, modal, popup).
+  u = up.util;
 
-Most of Unpoly's functionality (like [fragment links](/up.link) or [modals](/up.modal))
-is built from `up.fragment` functions. You may use them to extend Unpoly from your
-[custom Javascript](/up.syntax).
+  e = up.element;
 
-@module up.fragment
- */
 
-(function() {
-  var slice = [].slice;
+  /***
+  Fragment update API
+  ===================
+    
+  The `up.fragment` module exposes a high-level Javascript API to [update](/up.replace) or
+  [destroy](/up.destroy) page fragments.
+  
+  Fragments are [compiled](/up.compiler) elements that can be updated from a server URL.
+  They also exist on a layer (page, modal, popup).
+  
+  Most of Unpoly's functionality (like [fragment links](/up.link) or [modals](/up.modal))
+  is built from `up.fragment` functions. You may use them to extend Unpoly from your
+  [custom Javascript](/up.syntax).
+  
+  @module up.fragment
+   */
 
   up.fragment = (function() {
-    var CSS_HAS_SUFFIX_PATTERN, closest, config, contains, destroy, e, emitFragmentDestroyed, emitFragmentInserted, emitFragmentKeep, emitFragmentKept, emitFromKeepPlan, expandTargets, failKey, getAll, getDumb, getSmart, getSubtree, hasAutoHistory, hello, isDestroying, isGoodClassForTarget, isNotDestroying, markFragmentAsDestroying, matches, navigate, parseSelector, parseTargetAndOptions, reload, render, renderLocalContent, renderRemoteContent, reset, resolveOriginReference, sourceOf, successKey, timeOf, toTarget, u, visit;
-    u = up.util;
-    e = up.element;
 
     /***
     Configures defaults for fragment updates.
@@ -13712,6 +13789,7 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
     
     @stable
      */
+    var CSS_HAS_SUFFIX_PATTERN, closest, config, contains, destroy, emitFragmentDestroyed, emitFragmentInserted, emitFragmentKeep, emitFragmentKept, emitFromKeepPlan, expandTargets, failKey, getAll, getDumb, getSmart, getSubtree, hasAutoHistory, hello, isDestroying, isGoodClassForTarget, isNotDestroying, markFragmentAsDestroying, matches, navigate, parseSelector, parseTargetAndOptions, reload, render, renderLocalContent, renderRemoteContent, reset, resolveOriginReference, sourceOf, successKey, timeOf, toTarget, visit;
     config = new up.Config(function() {
       return {
         badTargetClasses: [/^up-/],
@@ -13732,13 +13810,8 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
         autoScroll: ['hash', 'layer-if-main']
       };
     });
-    Object.defineProperty(config, 'mainTargets', {
-      get: function() {
-        return up.layer.config.any.mainTargets;
-      },
-      set: function(value) {
-        return up.layer.config.any.mainTargets = value;
-      }
+    u.delegate(config, 'mainTargets', function() {
+      return up.layer.config.any;
     });
     reset = function() {
       return config.reset();
@@ -14071,7 +14144,7 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
       This is only relevant when updating a layer that is not the [frontmost layer](/up.layer.front).
     
     @param {Object} [options.context]
-      An object that will be merged into the [context](/up.context) of the current layer once the fragment is rendered.
+      An object that will be merged into the [context](/context) of the current layer once the fragment is rendered.
     
     @param {boolean} [options.keep=true]
       Whether [`[up-keep]`](/up-keep) elements will be preserved in the updated fragment.
@@ -14931,7 +15004,7 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
         element.className = 'klass'
         selector = up.fragment.toTarget(element) // returns '.klass'
     
-    @function up.element.toTarget
+    @function up.fragment.toTarget
     @param {string|Element|jQuery}
       The element for which to create a selector.
     @stable
@@ -14954,7 +15027,7 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
         selector = '';
         for (i = 0, len = goodClasses.length; i < len; i++) {
           klass = goodClasses[i];
-          selector += "." + klass;
+          selector += e.classSelector(klass);
         }
         return selector;
       } else {
@@ -15260,6 +15333,24 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
 
   up.visit = up.fragment.visit;
 
+
+  /***
+  Returns the current [context](/context).
+  
+  This is aliased as `up.layer.context`.
+  
+  @property up.context
+  @param {Object} context
+    The context object.
+  
+    If no context has been set an empty object is returned.
+  @experimental
+   */
+
+  u.delegate(up, 'context', function() {
+    return up.layer.current;
+  });
+
 }).call(this);
 
 /***
@@ -17973,7 +18064,7 @@ You can define custom animations using `up.transition()` and
       How the overlay may be [dismissed](/closing-overlays) by the user.
     
       Supported values are `'key'`, `'outside'` and `'button'`.
-      See [user dismiss controls](/closing-overlays#user-facing-dismiss-controls)
+      See [customizing dismiss controls](/closing-overlays#customizing-dismiss-controls)
       for details.
     
       You may enable multiple dismiss controls by passing an array or
@@ -18222,7 +18313,7 @@ You can define custom animations using `up.transition()` and
     @param [up-dismissable]
       How the overlay may be [dismissed](/closing-overlays) by the user.
     
-      See [user dismiss controls](/closing-overlays#user-facing-dismiss-controls)
+      See [customizing dismiss controls](/closing-overlays#customizing-dismiss-controls)
       for details.
     
       You may enable multiple dismiss controls by passing a space-separated string.
@@ -18652,23 +18743,35 @@ You can define custom animations using `up.transition()` and
     @param {string} location
     @stable
      */
+
+    /***
+    The [current layer](/up.layer.current)'s mode which governs its appearance and behavior.
+    
+    @see layer-terminology
+    
+    @property up.layer.mode
+    @param {string} mode
+    @stable
+     */
+
+    /***
+    The [context](/context) of the [current layer](/up.layer.current).
+    
+    This is aliased as `up.context`.
+    
+    @property up.layer.context
+    @param {string} context
+      The context object.
+    
+      If no context has been set an empty object is returned.
+    @experimental
+     */
     u.delegate(api, ['accept', 'dismiss', 'isRoot', 'isOverlay', 'isFront', 'on', 'off', 'emit', 'parent', 'historyVisible', 'location', 'mode', 'context', 'element', 'contains', 'size', 'affix'], function() {
       return stack.current;
     });
     return api;
   })();
 
-
-  /***
-  TODO: Docs
-  @property up.context
-  @pram {Object} context
-   */
-
-  u.getter(up, 'context', function() {
-    return up.layer.context;
-  });
-
 }).call(this);
 
 /***
@@ -19573,7 +19676,7 @@ new page is loading.
       This is only relevant when updating a layer that is not the [frontmost layer](/up.layer.front).
     
     @param [up-context]
-      A JSON object that will be merged into the [context](/up.context)
+      A JSON object that will be merged into the [context](/context)
       of the current layer once the fragment is rendered.
     
     @param [up-keep='true']