unpoly-rails 0.51.1 → 0.52.0

data/lib/assets/javascripts/unpoly/form.coffee

@@ -60,6 +60,8 @@ up.form = (($) ->
   See the documentation for [`form[up-target]`](/form-up-target) for more
   information on how AJAX form submissions work in Unpoly.
 
+  Emits the event [`up:form:submit`](/up:form:submit).
+
   @function up.submit
   @param {Element|jQuery|string} formOrSelector
     A reference or selector for the form to submit.
@@ -154,17 +156,29 @@ up.form = (($) ->
       options.failTransition = false
       options.headers[up.protocol.config.validateHeader] = options.validate
 
-    up.feedback.start($form)
+    up.bus.whenEmitted('up:form:submit', $element: $form).then ->
+      up.feedback.start($form)
 
-    # If we can't update the location URL, fall back to a vanilla form submission.
-    unless up.browser.canPushState() || options.history == false
-      # Don't use up.browser.navigate(); It cannot deal with file inputs.
-      $form.get(0).submit()
-      return u.unresolvablePromise()
+      # If we can't update the location URL, fall back to a vanilla form submission.
+      unless up.browser.canPushState() || options.history == false
+        # Don't use up.browser.navigate(); It cannot deal with file inputs.
+        $form.get(0).submit()
+        return u.unresolvablePromise()
 
-    promise = up.replace(target, url, options)
-    u.always promise, -> up.feedback.stop($form)
-    promise
+      promise = up.replace(target, url, options)
+      u.always promise, -> up.feedback.stop($form)
+      promise
+
+  ###*
+  This event is [emitted](/up.emit) when a form is [submitted](/up.submit) through Unpoly.
+
+  @event up:form:submit
+  @param {jQuery} event.$element
+    The `<form>` element that will be submitted.
+  @param event.preventDefault()
+    Event listeners may call this method to prevent the form from being submitted.
+  @stable
+  ###
 
   ###*
   Observes form fields and runs a callback when a value changes.

data/lib/assets/javascripts/unpoly/link.coffee

@@ -103,6 +103,8 @@ up.link = (($) ->
   or [`[up-modal]`](/a-up-modal), the corresponding UJS behavior will be activated
   just as if the user had clicked on the link.
 
+  Emits the event [`up:link:follow`](/up:link:follow).
+
   \#\#\# Examples
 
   Let's say you have a link with an [`a[up-target]`](/a-up-target) attribute:
@@ -133,6 +135,17 @@ up.link = (($) ->
     variant = followVariantForLink($link)
     variant.followLink($link, options)
 
+  ###*
+  This event is [emitted](/up.emit) when a link is [followed](/up.follow) through Unpoly.
+
+  @event up:link:follow
+  @param {jQuery} event.$element
+    The link element that will be followed.
+  @param event.preventDefault()
+    Event listeners may call this method to prevent the link from being followed.
+  @stable
+  ###
+
   ###*
   @function defaultFollow
   @internal

data/lib/assets/javascripts/unpoly/protocol.coffee

@@ -22,13 +22,11 @@ in your controllers and views. If your server-side app uses another language
 or framework, you should be able to implement the protocol in a very short time.
 
 
-\#\#\# Redirect detection
+\#\#\# Redirect detection for IE11
 
-Unpoly requires an additional response header to detect redirects, which are
-otherwise undetectable for any AJAX client.
-
-After the form's action performs a redirect, the next response should include the new
-URL in the HTTP headers:
+On Internet Explorer 11, Unpoly cannot detect the final URL after a redirect.
+You can fix this edge case by delivering an additional HTTP header
+with the *last* response in a series of redirects:
 
 ```http
 X-Up-Location: /current-url
@@ -179,7 +177,7 @@ up.protocol = (($) ->
   @internal
   ###
   locationFromXhr = (xhr) ->
-    xhr.getResponseHeader(config.locationHeader)
+    xhr.getResponseHeader(config.locationHeader) || xhr.responseURL
 
   ###*
   @function up.protocol.titleFromXhr

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

@@ -459,7 +459,7 @@ up.proxy = (($) ->
 
   registerAliasForRedirect = (response) ->
     request = response.request
-    if request.url != response.url
+    if response.url && request.url != response.url
       newRequest = request.copy(
         method: response.method
         url: response.url

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

@@ -218,6 +218,9 @@ up.syntax = (($) ->
   @stable
   ###
   compiler = (selector, args...) ->
+    # Developer might still call top-level compiler registrations even when we don't boot
+    # due to an unsupported browser. In that case do no work and exit early.
+    return unless up.browser.isSupported()
     callback = args.pop()
     options = u.options(args[0])
     insertCompiler(compilers, selector, options, callback)
@@ -264,6 +267,9 @@ up.syntax = (($) ->
   @stable
   ###
   macro = (selector, args...) ->
+    # Developer might still call top-level compiler registrations even when we don't boot
+    # due to an unsupported browser. In that case do no work and exit early.
+    return unless up.browser.isSupported()
     callback = args.pop()
     options = u.options(args[0])
     if isBooting

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

@@ -1330,9 +1330,10 @@ up.util = (($) ->
   ###
   requestDataAsQuery = (data, opts) ->
     opts = options(opts, purpose: 'url')
+
     if isString(data)
-      data
-    if isFormData(data)
+      data.replace(/^\?/, '')
+    else if isFormData(data)
       # Until FormData#entries is implemented in all major browsers we must give up here.
       # However, up.form will prefer to serialize forms as arrays, so we should be good
       # in most cases. We only use FormData for forms with file inputs.
@@ -1409,6 +1410,18 @@ up.util = (($) ->
       data = [data, newPair].join('&')
     data
 
+  ###*
+  Merges the request data in `source` into `target`.
+  Will modify the passed-in `target`.
+
+  @return
+    The merged form data.
+  ###
+  mergeRequestData = (target, source) ->
+    each requestDataAsArray(source), (field) ->
+      target = appendRequestData(target, field.name, field.value)
+    target
+
   ###*
   Throws a [JavaScript error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)
   with the given message.
@@ -1729,6 +1742,7 @@ up.util = (($) ->
   requestDataAsArray: requestDataAsArray
   requestDataAsQuery: requestDataAsQuery
   appendRequestData: appendRequestData
+  mergeRequestData:  mergeRequestData
   requestDataFromForm: requestDataFromForm
   offsetParent: offsetParent
   fixedToAbsolute: fixedToAbsolute

data/lib/unpoly/rails/version.rb

@@ -4,6 +4,6 @@ module Unpoly
     # The current version of the unpoly-rails gem.
     # This version number is also used for releases of the Unpoly
     # frontend code.
-    VERSION = '0.51.1'
+    VERSION = '0.52.0'
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unpoly",
-  "version": "0.51.1",
+  "version": "0.52.0",
   "description": "Unobtrusive JavaScript framework",
   "main": "dist/unpoly.js",
   "files": [

data/spec_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    unpoly-rails (0.50.2)
+    unpoly-rails (0.51.1)
       rails (>= 3)
 
 GEM

data/spec_app/app/controllers/form_test/redirects_controller.rb

@@ -0,0 +1,17 @@
+module FormTest
+  class RedirectsController < ApplicationController
+
+    layout 'integration_test'
+
+    def new
+    end
+
+    def create
+      redirect_to target_form_test_redirect_path
+    end
+
+    def target
+    end
+
+  end
+end

data/spec_app/app/views/form_test/redirects/new.erb

@@ -0,0 +1,27 @@
+<div class="example">
+
+  <h2>Redirecting form</h2>
+
+  <%= form_tag "/form_test/redirect", method: :post, 'up-target' => '.result' do %>
+
+    <p>
+      <input type="text" name="text-param" value="text-value" />
+    </p>
+
+    <p>
+      <input type="password" name="password-param" value="password-value" />
+    </p>
+
+    <p>
+      <select name="select-param">
+        <option value="select-value">select-label</option>
+      </select>
+    </p>
+
+    <p>
+      <button type="submit">Submit</button>
+    </p>
+
+  <% end %>
+
+</div>

data/spec_app/app/views/form_test/redirects/target.erb

@@ -0,0 +1,4 @@
+<div class="example">
+  <p>Redirect target reached</p>
+  <p>URL should be <code><%= target_form_test_redirect_path %></code></p>
+</div>

data/spec_app/app/views/pages/start.erb

@@ -56,6 +56,7 @@
     </li>
     <li><%= link_to 'Form (basic)', '/form_test/basic/new' %></li>
     <li><%= link_to 'Form (upload)', '/form_test/upload/new' %></li>
+    <li><%= link_to 'Form (redirect)', '/form_test/redirect/new' %></li>
     <li><%= link_to 'Error', '/error_test/trigger' %></li>
     <li><%= link_to 'Booting with non-GET method', '/method_test/page1' %></li>
     <li><%= link_to 'Fragment update', '/replace_test/page1' %></li>

data/spec_app/config/routes.rb

@@ -15,6 +15,11 @@ Rails.application.routes.draw do
   namespace :form_test do
     resource :basic, only: [:new, :create]
     resource :upload, only: [:new, :create]
+    resource :redirect, only: [:new, :create] do
+      member do
+        get :target
+      end
+    end
   end
 
 end

data/spec_app/spec/javascripts/helpers/last_request.js.coffee

@@ -20,3 +20,5 @@ beforeEach ->
       contentType: options.contentType || 'text/html'
       responseHeaders: options.responseHeaders
       responseText: responseText
+      responseURL: options.responseURL
+

data/spec_app/spec/javascripts/up/browser_spec.js.coffee

@@ -23,6 +23,14 @@ describe 'up.browser', ->
           # No params should be left in the form
           expect($form.find('input')).not.toExist()
 
+        it 'merges params from the given URL and the { data } option', ->
+          submitForm = spyOn(up.browser, 'submitForm')
+          up.browser.navigate('/foo?param1=param1%20value', method: 'GET', data: { param2: 'param2 value' })
+          expect(submitForm).toHaveBeenCalled()
+          $form = $('form.up-page-loader')
+          expect($form).toExist()
+          expect($form.attr('action')).toMatchUrl('/foo?param1=param1%20value&param2=param2%20value')
+
       describe "for POST requests", ->
 
         it "creates a POST form, adds all { data } params a hidden fields and submits the form", ->
@@ -36,6 +44,17 @@ describe 'up.browser', ->
           expect($form.find('input[name="param1"][value="param1 value"]')).toExist()
           expect($form.find('input[name="param2"][value="param2 value"]')).toExist()
 
+        it 'merges params from the given URL and the { data } option', ->
+          submitForm = spyOn(up.browser, 'submitForm')
+          up.browser.navigate('/foo?param1=param1%20value', method: 'POST', data: { param2: 'param2 value' })
+          expect(submitForm).toHaveBeenCalled()
+          $form = $('form.up-page-loader')
+          expect($form).toExist()
+          expect($form.attr('action')).toMatchUrl('/foo')
+          expect($form.attr('method')).toEqual('POST')
+          expect($form.find('input[name="param1"][value="param1 value"]')).toExist()
+          expect($form.find('input[name="param2"][value="param2 value"]')).toExist()
+
       u.each ['PUT', 'PATCH', 'DELETE'], (method) ->
 
         describe "for #{method} requests", ->

data/spec_app/spec/javascripts/up/form_spec.js.coffee

@@ -263,6 +263,24 @@ describe 'up.form', ->
 
     describe 'up.submit', ->
 
+      it 'emits a preventable up:form:submit event', asyncSpec (next) ->
+        $form = affix('form[action="/form-target"][up-target=".response"]')
+
+        listener = jasmine.createSpy('submit listener').and.callFake (event) ->
+          event.preventDefault()
+
+        $form.on('up:form:submit', listener)
+
+        up.submit($form)
+
+        next =>
+          expect(listener).toHaveBeenCalled()
+          event = listener.calls.mostRecent().args[0]
+          expect(event.$element).toEqual($form)
+
+          # No request should be made because we prevented the event
+          expect(jasmine.Ajax.requests.count()).toEqual(0)
+
       describeCapability 'canPushState', ->
 
         beforeEach ->

data/spec_app/spec/javascripts/up/link_spec.js.coffee

@@ -6,6 +6,24 @@ describe 'up.link', ->
   
     describe 'up.follow', ->
 
+      it 'emits a preventable up:link:follow event', asyncSpec (next) ->
+        $link = affix('a[href="/destination"][up-target=".response"]')
+
+        listener = jasmine.createSpy('follow listener').and.callFake (event) ->
+          event.preventDefault()
+
+        $link.on('up:link:follow', listener)
+
+        up.follow($link)
+
+        next =>
+          expect(listener).toHaveBeenCalled()
+          event = listener.calls.mostRecent().args[0]
+          expect(event.$element).toEqual($link)
+
+          # No request should be made because we prevented the event
+          expect(jasmine.Ajax.requests.count()).toEqual(0)
+
       describeCapability 'canPushState', ->
 
         it 'loads the given link via AJAX and replaces the response in the given target', asyncSpec (next) ->

data/spec_app/spec/javascripts/up/proxy_spec.js.coffee

@@ -182,6 +182,65 @@ describe 'up.proxy', ->
               # See that the promise was not rejected due to an internal error.
               expect(result.state).toEqual('pending')
 
+
+      describe 'when the XHR object has a { responseURL } property', ->
+
+        it 'sets the { url } property on the response object', (done) ->
+          promise = up.request('/request-url#request-hash')
+
+          u.nextFrame =>
+            @respondWith
+              responseURL: '/response-url'
+
+            promise.then (response) ->
+              expect(response.request.url).toMatchUrl('/request-url')
+              expect(response.request.hash).toEqual('#request-hash')
+              expect(response.url).toMatchUrl('/response-url')
+              done()
+
+        it 'considers a redirection URL an alias for the requested URL', asyncSpec (next) ->
+          up.request('/foo')
+
+          next =>
+            expect(jasmine.Ajax.requests.count()).toEqual(1)
+            @respondWith
+              responseURL: '/bar'
+
+          next =>
+            up.request('/bar')
+
+          next =>
+            # See that the cached alias is used and no additional requests are made
+            expect(jasmine.Ajax.requests.count()).toEqual(1)
+
+        it 'does not considers a redirection URL an alias for the requested URL if the original request was never cached', asyncSpec (next) ->
+          up.request('/foo', method: 'post') # POST requests are not cached
+
+          next =>
+            expect(jasmine.Ajax.requests.count()).toEqual(1)
+            @respondWith
+              responseURL: '/bar'
+
+          next =>
+            up.request('/bar')
+
+          next =>
+            # See that an additional request was made
+            expect(jasmine.Ajax.requests.count()).toEqual(2)
+
+        it 'does not considers a redirection URL an alias for the requested URL if the response returned a non-200 status code', asyncSpec (next) ->
+          up.request('/foo')
+
+          next =>
+            expect(jasmine.Ajax.requests.count()).toEqual(1)
+            @respondWith
+              responseURL: '/bar'
+              status: 500
+
+          next =>
+            up.request('/bar')
+
+
       describe 'CSRF', ->
 
         beforeEach ->

data/spec_app/spec/javascripts/up/util_spec.js.coffee

@@ -485,6 +485,14 @@ describe 'up.util', ->
         ])
         expect(string).toEqual("foo-key=foo#{encodedSpace}value&bar-key=bar#{encodedSpace}value")
 
+      it 'returns a given query string', ->
+        string = up.util.requestDataAsQuery('foo=bar')
+        expect(string).toEqual('foo=bar')
+
+      it 'strips a leading question mark from the given query string', ->
+        string = up.util.requestDataAsQuery('?foo=bar')
+        expect(string).toEqual('foo=bar')
+
       it 'returns an empty string for an empty object', ->
         string = up.util.requestDataAsQuery({})
         expect(string).toEqual('')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unpoly-rails
 version: !ruby/object:Gem::Version
-  version: 0.51.1
+  version: 0.52.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,7 @@ files:
 - spec_app/app/controllers/css_test_controller.rb
 - spec_app/app/controllers/error_test_controller.rb
 - spec_app/app/controllers/form_test/basics_controller.rb
+- spec_app/app/controllers/form_test/redirects_controller.rb
 - spec_app/app/controllers/form_test/uploads_controller.rb
 - spec_app/app/controllers/method_test_controller.rb
 - spec_app/app/controllers/pages_controller.rb
@@ -178,6 +179,8 @@ files:
 - spec_app/app/views/error_test/trigger.erb
 - spec_app/app/views/error_test/unexpected_response.erb
 - spec_app/app/views/form_test/basics/new.erb
+- spec_app/app/views/form_test/redirects/new.erb
+- spec_app/app/views/form_test/redirects/target.erb
 - spec_app/app/views/form_test/submission_result.erb
 - spec_app/app/views/form_test/uploads/new.erb
 - spec_app/app/views/layouts/integration_test.erb