unpoly-rails 0.61.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100bf69b4ef6a03c11b19ca7b7ed2e7180cf739ce5df3222d8cb22cbac296a60
-  data.tar.gz: a77f9194b9026975094a1e19a52dcc83ff2e0db28332bf0c6263d0637edf5353
+  metadata.gz: 2f41bd14a88026cca1b4d98253d557b3c7f03eb9a92a079b5892dcf81c16f703
+  data.tar.gz: 1e81428e2a3ee05a77b82792f3835f55891a0b845e4fe0b05e0fafb9b3a19291
 SHA512:
-  metadata.gz: 8be34463c5f666375cd71494c5a021698f8acdccddb4889972a062e3a457941ea912328b9b5cb9d3dd40d7e50930c9d76986d607609e42ad782172d16a564561
-  data.tar.gz: 5c22c78254ba8dea5835d4628fdd07e957247618f99a0b781562113f491ba9b1b644eb667bcafb044d997967e13c405afda203373611e514da0d93d390fd5781
+  metadata.gz: 653e3343531c9254fc318dbd951d1bd5fa7a4a0f997e627f7d3dc8350a64c4471879d8ab458f9cb90abf67b466e9590b674b143a7cc331780d4663ee8ff792a6
+  data.tar.gz: 30bfba350545b36fa5201b9072bea60fe61883e86c352c21ec3d4ef6f432b7b4413bcebedf4046e50dd8731fa46e21cb79f7278ec2d51bb26d72ef579ae2aa95

data/CHANGELOG.md

@@ -5,11 +5,66 @@ Changes to this project will be documented in this file.
 
 You may browse a formatted and hyperlinked version of this file at <https://unpoly.com/changes>.
 
+1.0.1
+-----
+
+This is a maintenance release for Unpoly 1. Expect little to no additional changes for this legacy version. New features will only be added to Unpoly 2.
+
+- `up.request()` will now send Unpoly's version number as an `X-Up-Version` request header. Since `X-Up-Target` is optional in Unpoly 2, server-side integration libraries can look for `X-Up-Version` to reliably detect a fragment update for both Unpoly 1 and 2.
+- Fix a bug where the Unpoly banner would still be printed to the development console when `up.log.config.banner = false` is set. (fix by @adam12)
+
+
+1.0.0
+-----
+
+For six years Unpoly has been released under a 0.x version number. To establish the maturity and stability of the project, we're releasing today's version as 1.0.0.
+
+There are only three changes from 0.62.1:
+
+- Fix a bug where `up.util.escapeHTML()` would not escape single quotes.
+- Unpoly will no longer wait a JavaScript execution task to boot after `DOMContentLoaded`. This may improve the stability of test suites that previously interacted with the page too soon.
+- You may now disable the Unpoly banner in the development console with `up.log.config.banner = false`. (change by @hfjallemark).
+
+This is the last release of the 0.x API line. We're tracking its code in the [`1.x-stable`](https://github.com/unpoly/unpoly/tree/1.x-stable), but expect little to no changes in the future.
+
+The next release will be [Unpoly 2](https://triskweline.de/unpoly2-slides). It will include major (but mostly backwards compatible) renovations to its API, unlocking many use cases that were not possible with Unpoly 1.
+
+
+0.62.1
+------
+
+This is another maintenance release while we're finishing [the next major version of Unpoly](https://groups.google.com/forum/#!topic/unpoly/FDdVjxbjNLg).
+
+Community members were involved in every change of this release:
+
+- [`up.submit()`](/up.submit) has a new options `{ params }`. It may be used to pass extra form [parameters](/up.Params) that will be submitted in addition to the parameters from the form. (fix by @robinvdvleuten)
+- [`a[up-modal]`](/a-up-modal) will now honor an [`[up-cache]`](/a-up-target#up-cache) attribute on the same link. (fix by @adam12)
+- Prevent destructor function from being called twice if [`up.destroy()`](/up.destroy) is called twice with the same element (reported by @kratob)
+- On devices that don't show a vertical scrollbar, users can no longer scroll the underlying page while a [modal overlay](/up.modal) is open. (reported by @msurdi)
+
+
+0.62.0
+------
+
+This release backports a number of accessibility improvements from [the next major version of Unpoly](https://groups.google.com/forum/#!topic/unpoly/FDdVjxbjNLg).
+We encourage everyone to upgrade to this release in order to better support users with visual impairments.
+
+The following changes are included:
+
+- Links with an [`[up-instant]`](/a-up-instant) attribute can now be followed with the keyboard.
+- Fragments that are being [destroyed](/up.destroy) now get an [`[aria-hidden=true]`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-hidden_attribute)
+  attribute while its disappearance is being animated. When a fragment is being swapped with a new version, the old fragment version is also
+  given `[aria-hidden=true]` while it's disappearing.
+- [Modal dialogs](/up.modal) now get an [`[aria-modal=true]`](https://a11ysupport.io/tech/aria/aria-modal_attribute) attribute.
+
+The next major version of Unpoly will include additional accessibility improvements. In particular the
+new modal ("layer") implementation will implement all best practices for accessible dialogs.
+
 
 0.61.1
 ------
 
-This is a maintenance release while we're getting ready for the next major version of Unpoly.
+This is a maintenance release while we're getting ready for [the next major version of Unpoly](https://groups.google.com/forum/#!topic/unpoly/FDdVjxbjNLg).
 
 - Fix a bug where [`up.destroy()`](/up.destroy) wouldn't clean up the global jQuery cache. This is only relevant when using Unpoly together with jQuery.
 - Fields outside a <form> are now recognized when they have a matching [form] attribute (fixes #85)

data/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rack'
-gem 'therubyracer'
 gem 'sass'
 gem 'uglifier'
 gem 'coffee-script'

data/Gemfile.lock

@@ -8,11 +8,9 @@ GEM
     execjs (2.7.0)
     hike (1.2.3)
     json (1.8.2)
-    libv8 (3.16.14.11)
     multi_json (1.10.1)
     rack (1.6.0)
     rake (10.4.2)
-    ref (1.0.5)
     sass (3.4.11)
     sprockets (2.12.3)
       hike (~> 1.2)
@@ -22,9 +20,6 @@ GEM
     sprockets-standalone (1.2.1)
       rake
       sprockets (~> 2.0)
-    therubyracer (0.12.1)
-      libv8 (~> 3.16.14.0)
-      ref
     tilt (1.4.1)
     uglifier (2.7.0)
       execjs (>= 0.3.0)
@@ -38,8 +33,7 @@ DEPENDENCIES
   rack
   sass
   sprockets-standalone
-  therubyracer
   uglifier
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -31,8 +31,9 @@ Overview:
 
 Install dependencies for tests:
 
-- Install Ruby 2.1.2
+- 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`
 
@@ -50,11 +51,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 the following 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.
@@ -64,6 +63,7 @@ To prepare a new version:
 1. Edit `lib/unpoly/rails/version.rb` and bump the version number. Use [semantic versioning](http://semver.org/).
 2. Add an entry to `CHANGELOG.md`
 3. Commit and push the version bump and `CHANGELOG.md`
+4. Merge the relevant `CHANGEOG.md` entries to the `master` branch (since [unpoly.com](https://unpoly.com) builds from there)
 
 Now we can release a new version. **This requires your to be logged into Rubygems and npm**:
 
@@ -78,8 +78,9 @@ If you have done this process a few times and know what you're doing, you can ca
 
 After you have published all release channels, remember to:
 
-1. Update [unpoly.com](https://unpoly.com/) so users see the new version, CDN link and CHANGELOG.
-2. Send a message to the [E-mail group](https://groups.google.com/group/unpoly) with the title "Unpoly X.Y.Z released". You can copy the relevant CHANGELOG part from [here](http://localhost:4567/changes_google_groups).
+1. Deploy to [unpoly.com](https://unpoly.com/)
+2. Deploy to [v1.unpoly.com](https://unpoly.com/)
+3. Send a message to the [E-mail group](https://groups.google.com/group/unpoly) with the title "Unpoly X.Y.Z released". You can copy the relevant CHANGELOG part from [here](http://localhost:4567/changes_google_groups).
 
 
 Credits

data/Rakefile

@@ -99,7 +99,7 @@ namespace :publish do
 
   desc 'Release new version to all package managers'
   task :release do
-    Rake::Task['release'].invoke
+    Rake::Task['rubygems:publish'].invoke
     Rake::Task['npm:publish'].invoke
   end
 
@@ -117,6 +117,15 @@ namespace :publish do
 
 end
 
+namespace :rubygems do
+
+  task :publish do
+    puts 'Publishing to rubygems.org. If this seems to hang, enter your 2FA token.'
+    Rake::Task['release'].invoke
+  end
+
+end
+
 namespace :npm do
 
   task :bump_version do

data/dist/unpoly.js

@@ -5,7 +5,7 @@
 
 (function() {
   window.up = {
-    version: "0.61.1"
+    version: "1.0.1"
   };
 
 }).call(this);
@@ -1305,7 +1305,8 @@ to not include another library in your asset bundle.
       "&": "&",
       "<": "&lt;",
       ">": "&gt;",
-      '"': '&quot;'
+      '"': '&quot;',
+      "'": '&#x27;'
     };
 
     /***
@@ -1317,7 +1318,7 @@ to not include another library in your asset bundle.
     @stable
      */
     escapeHtml = function(string) {
-      return string.replace(/[&<>"]/g, function(char) {
+      return string.replace(/[&<>"']/g, function(char) {
         return ESCAPE_HTML_ENTITY_MAP[char];
       });
     };
@@ -2519,6 +2520,7 @@ 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
+    @param {Element} element
     @experimental
      */
     show = function(element) {
@@ -2557,8 +2559,10 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
     @param {Element} element
       The element for which to add or remove the class.
     @param {String} className
-      A boolean value to determine whether the class should be added or removed.
-    @param {String} state
+      The class which should be added or removed.
+    @param {Boolean} [newPresent]
+      Pass `true` to add the class to the element or `false` to remove it.
+    
       If omitted, the class will be added if missing and removed if present.
     @experimental
      */
@@ -2771,11 +2775,11 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
         element.className // returns 'klass'
     
     @function up.element.affix
-    @params {Element} parent
+    @param {Element} parent
       The parent to which to attach the created element.
-    @params {string} selector
+    @param {string} selector
       The CSS selector from which to create an element.
-    @params {Object} attrs
+    @param {Object} attrs
       An object of attributes to set on the created element.
     @param {Object} attrs.text
       The [text content](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent) of the created element.
@@ -3428,32 +3432,32 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
     }
 
     BodyShifter.prototype.shift = function() {
-      var anchor, body, bodyRightPadding, bodyRightShift, elementRight, elementRightShift, i, len, overflowElement, ref, results, scrollbarWidth;
-      if (!up.viewport.rootHasVerticalScrollbar()) {
-        return;
-      }
-      body = document.body;
+      var anchor, body, bodyRightPadding, bodyRightShift, elementRight, elementRightShift, i, len, overflowElement, ref, results, rootHadVerticalScrollbar, scrollbarWidth;
+      rootHadVerticalScrollbar = up.viewport.rootHasVerticalScrollbar();
       overflowElement = up.viewport.rootOverflowElement();
-      scrollbarWidth = up.viewport.scrollbarWidth();
-      bodyRightPadding = e.styleNumber(body, 'paddingRight');
-      bodyRightShift = scrollbarWidth + bodyRightPadding;
-      this.unshiftFns.push(e.setTemporaryStyle(body, {
-        paddingRight: bodyRightShift
-      }));
       this.unshiftFns.push(e.setTemporaryStyle(overflowElement, {
         overflowY: 'hidden'
       }));
-      ref = up.viewport.anchoredRight();
-      results = [];
-      for (i = 0, len = ref.length; i < len; i++) {
-        anchor = ref[i];
-        elementRight = e.styleNumber(anchor, 'right');
-        elementRightShift = scrollbarWidth + elementRight;
-        results.push(this.unshiftFns.push(e.setTemporaryStyle(anchor, {
-          right: elementRightShift
-        })));
+      if (rootHadVerticalScrollbar) {
+        body = document.body;
+        scrollbarWidth = up.viewport.scrollbarWidth();
+        bodyRightPadding = e.styleNumber(body, 'paddingRight');
+        bodyRightShift = scrollbarWidth + bodyRightPadding;
+        this.unshiftFns.push(e.setTemporaryStyle(body, {
+          paddingRight: bodyRightShift
+        }));
+        ref = up.viewport.anchoredRight();
+        results = [];
+        for (i = 0, len = ref.length; i < len; i++) {
+          anchor = ref[i];
+          elementRight = e.styleNumber(anchor, 'right');
+          elementRightShift = scrollbarWidth + elementRight;
+          results.push(this.unshiftFns.push(e.setTemporaryStyle(anchor, {
+            right: elementRightShift
+          })));
+        }
+        return results;
       }
-      return results;
     };
 
     BodyShifter.prototype.unshift = function() {
@@ -4692,8 +4696,9 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
     FollowVariant.prototype.onClick = function(event, link) {
       if (up.link.shouldProcessEvent(event, link)) {
-        if (e.matches(link, '[up-instant]')) {
-          return up.event.halt(event);
+        if (e.matches(link, '[up-instant]') && link.upInstantSupported) {
+          up.event.halt(event);
+          link.upInstantSupported = false;
         } else {
           up.event.consumeAction(event);
           return this.followLink(link);
@@ -4705,6 +4710,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
 
     FollowVariant.prototype.onMousedown = function(event, link) {
       if (up.link.shouldProcessEvent(event, link)) {
+        link.upInstantSupported = true;
         up.event.consumeAction(event);
         return this.followLink(link);
       }
@@ -5356,18 +5362,19 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
       if (u.isMissing(raw)) {
 
       } else if (raw instanceof this.constructor) {
-        return (ref = this.entries).push.apply(ref, raw.entries);
+        (ref = this.entries).push.apply(ref, raw.entries);
       } else if (u.isArray(raw)) {
-        return (ref1 = this.entries).push.apply(ref1, raw);
+        (ref1 = this.entries).push.apply(ref1, raw);
       } else if (u.isString(raw)) {
-        return this.addAllFromQuery(raw);
+        this.addAllFromQuery(raw);
       } else if (u.isFormData(raw)) {
-        return this.addAllFromFormData(raw);
+        this.addAllFromFormData(raw);
       } else if (u.isObject(raw)) {
-        return this.addAllFromObject(raw);
+        this.addAllFromObject(raw);
       } else {
-        return up.fail("Unsupport params type: %o", raw);
+        up.fail("Unsupport params type: %o", raw);
       }
+      return this;
     };
 
     Params.prototype.addAllFromObject = function(object) {
@@ -5965,6 +5972,7 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
             xhrPayload = xhrParams.toFormData();
           }
           pc = up.protocol.config;
+          xhrHeaders[pc.versionHeader] = up.version;
           if (_this.target) {
             xhrHeaders[pc.targetHeader] = _this.target;
           }
@@ -6827,13 +6835,11 @@ It complements [native `Element` methods](https://www.w3schools.com/jsref/dom_ob
         });
         isBooting = false;
         return up.event.onReady(function() {
-          return u.task(function() {
-            up.emit('up:app:boot', {
-              log: 'Booting user application'
-            });
-            return up.emit('up:app:booted', {
-              log: 'User application booted'
-            });
+          up.emit('up:app:boot', {
+            log: 'Booting user application'
+          });
+          return up.emit('up:app:booted', {
+            log: 'User application booted'
           });
         });
       } else {
@@ -6960,7 +6966,7 @@ There are some advantages to using `up.on()`:
     for [event delegation](https://davidwalsh.name/event-delegate):
     
         var form = document.querySelector('form')
-        document.addEventListener(form, 'click', 'a', function(event, link) {
+        up.on(form, 'click', 'a', function(event, link) {
           console.log("Click on a link %o within %o", link, form)
         })
     
@@ -7572,6 +7578,7 @@ an existing cookie should be deleted.
     Configures strings used in the optional [server protocol](/up.protocol).
     
     @property up.protocol.config
+    @param {String} [config.versionHeader='X-Up-Version']
     @param {String} [config.targetHeader='X-Up-Target']
     @param {String} [config.failTargetHeader='X-Up-Fail-Target']
     @param {String} [config.locationHeader='X-Up-Location']
@@ -7615,6 +7622,7 @@ an existing cookie should be deleted.
     @experimental
      */
     config = new up.Config({
+      versionHeader: 'X-Up-Version',
       targetHeader: 'X-Up-Target',
       failTargetHeader: 'X-Up-Fail-Target',
       locationHeader: 'X-Up-Location',
@@ -7697,12 +7705,15 @@ The output can be configured using the [`up.log.config`](/up.log.config) propert
       prints to the developer console.
     @param {string} [options.prefix='[UP] ']
       A string to prepend to Unpoly's logging messages so you can distinguish it from your own messages.
+    @param {boolean} [options.banner=true]
+      Print the Unpoly banner to the developer console.
     @stable
      */
     config = new up.Config({
       prefix: '[UP] ',
       enabled: sessionStore.get('enabled'),
-      collapse: false
+      collapse: false,
+      banner: true
     });
     reset = function() {
       return config.reset();
@@ -7888,6 +7899,9 @@ The output can be configured using the [`up.log.config`](/up.log.config) propert
     };
     printBanner = function() {
       var banner;
+      if (!config.banner) {
+        return;
+      }
       banner = " __ _____  ___  ___  / /_ __\n" + ("/ // / _ \\/ _ \\/ _ \\/ / // /  " + up.version + "\n") + "\\___/_//_/ .__/\\___/_/\\_. / \n" + "        / /            / /\n" + "\n";
       if (config.enabled) {
         banner += "Call `up.log.disable()` to disable logging for this session.";
@@ -7896,7 +7910,7 @@ The output can be configured using the [`up.log.config`](/up.log.config) propert
       }
       return console.log(banner);
     };
-    up.on('up:framework:booted', printBanner);
+    up.on('up:app:boot', printBanner);
     up.on('up:framework:reset', reset);
     setEnabled = function(value) {
       sessionStore.set('enabled', value);
@@ -8430,15 +8444,14 @@ or when a matching fragment is [inserted via AJAX](/up.link) later.
       var cleanables;
       cleanables = e.subtree(fragment, '.up-can-clean');
       return u.each(cleanables, function(cleanable) {
-        var destructor, destructors, i, len, results;
-        if (destructors = cleanable.upDestructors) {
-          results = [];
+        var destructor, destructors, i, len;
+        if (destructors = u.pluckKey(cleanable, 'upDestructors')) {
           for (i = 0, len = destructors.length; i < len; i++) {
             destructor = destructors[i];
-            results.push(destructor());
+            destructor();
           }
-          return results;
         }
+        return cleanable.classList.remove('up-can-clean');
       });
     };
 
@@ -10638,7 +10651,8 @@ is built from `up.fragment` functions. You may use them to extend Unpoly from yo
     @stable
      */
     markElementAsDestroying = function(element) {
-      return element.classList.add('up-destroying');
+      element.classList.add('up-destroying');
+      return element.setAttribute('aria-hidden', 'true');
     };
 
     /***
@@ -10834,7 +10848,7 @@ You can define custom animations using [`up.transition()`](/up.transition) and
     
     You can pass additional options:
     
-        up.animate('warning', '.fade-in', {
+        up.animate('.warning', 'fade-in', {
           delay: 1000,
           duration: 250,
           easing: 'linear'
@@ -13051,6 +13065,9 @@ open dialogs with sub-forms, etc. all without losing form state.
       If set to `'auto'` (default), Unpoly will try to find a match in the form's layer.
     @param {string} [options.failLayer='auto']
       The name of the layer that ought to be updated if the server sends a non-200 status code.
+    @param {Object|FormData|string|Array|up.Params} [options.params]
+      Extra form [parameters](/up.Params) that will be submitted in addition to
+      the parameters from the form.
     @return {Promise}
       A promise for the successful form submission.
     @stable
@@ -13100,7 +13117,7 @@ open dialogs with sub-forms, etc. all without losing form state.
       if (options.failLayer == null) {
         options.failLayer = form.getAttribute('up-fail-layer');
       }
-      options.params = up.Params.fromForm(form);
+      options.params = up.Params.fromForm(form).addAll(options.params);
       options = u.merge(options, up.motion.animateOptions(options, form));
       if (options.validate) {
         options.headers || (options.headers = {});
@@ -13822,6 +13839,15 @@ open dialogs with sub-forms, etc. all without losing form state.
     
         <input name="query" up-observe="showSuggestions(value)">
     
+    Note that the parameter name in the markup must be called `value` or it will not work.
+    The parameter name can be called whatever you want in the JavaScript, however.
+        
+    Also note that the function must be declared on the `window` object to work, like so:
+        
+        window.showSuggestions = function(selectedValue) {
+          console.log(`Called showSuggestions() with ${selectedValue}`);
+        }
+    
     \#\#\# Callback context
     
     The script given to `[up-observe]` runs with the following context:
@@ -14807,6 +14833,7 @@ or function.
       var closeElement, contentElement, dialogStyles, html, modalElement;
       html = templateHtml();
       state.modalElement = modalElement = e.createFromHtml(html);
+      modalElement.setAttribute('aria-modal', 'true');
       modalElement.setAttribute('up-flavor', state.flavor);
       if (u.isPresent(state.position)) {
         modalElement.setAttribute('up-position', state.position);
@@ -15028,6 +15055,9 @@ or function.
       if (options.failLayer == null) {
         options.failLayer = (ref12 = link.getAttribute('up-fail-layer')) != null ? ref12 : 'auto';
       }
+      if (options.cache == null) {
+        options.cache = e.booleanAttr(link, 'up-cache');
+      }
       animateOptions = up.motion.animateOptions(options, link, {
         duration: flavorDefault('openDuration', options.flavor),
         easing: flavorDefault('openEasing', options.flavor)