Merge pull request #28617 from javan/rails-ujs/fix-npm-package

Restore rails-ujs.js UMD module support

14 files changed, 146 insertions, 105 deletions

diff --git a/actionview/Rakefile b/actionview/Rakefile
index 00ab92129d..4adcc723b1 100644
--- a/actionview/Rakefile
+++ b/actionview/Rakefile
@@ -1,10 +1,13 @@
 require "rake/testtask"
 require "fileutils"
+require "open3"
+
+dir = File.dirname(__FILE__)
 
 desc "Default Task"
 task default: :test
 
-task package: "assets:compile"
+task package: %w( assets:compile assets:verify )
 
 # Run the unit tests
 
@@ -84,8 +87,46 @@ namespace :assets do
   desc "Compile Action View assets"
   task :compile do
     require "blade"
+    require "sprockets"
+    require "sprockets/export"
     Blade.build
   end
+
+  desc "Verify compiled Action Cable assets"
+  task :verify do
+    file = "lib/assets/compiled/rails-ujs.js"
+    pathname = Pathname.new("#{dir}/#{file}")
+
+    print "[verify] #{file} exists "
+    if pathname.exist?
+      puts "[OK]"
+    else
+      $stderr.puts "[FAIL]"
+      fail
+    end
+
+    print "[verify] #{file} is a UMD module "
+    if pathname.read =~ /module\.exports.*define\.amd/m
+      puts "[OK]"
+    else
+      $stderr.puts "[FAIL]"
+      fail
+    end
+
+    print "[verify] #{dir} can be required as a module "
+    js = <<-JS
+      window = { Event: class {} }
+      class Element {}
+      require('#{dir}')
+    JS
+    stdout, stderr, status = Open3.capture3("node", "--print", js)
+    if status.success?
+      puts "[OK]"
+    else
+      $stderr.puts "[FAIL]\n#{stderr}"
+      fail
+    end
+  end
 end
 
 task :lines do
diff --git a/actionview/app/assets/javascripts/config.coffee b/actionview/app/assets/javascripts/config.coffee
deleted file mode 100644
index a93325e903..0000000000
--- a/actionview/app/assets/javascripts/config.coffee
+++ /dev/null
@@ -1,34 +0,0 @@
-#= export Rails
-
-@Rails =
-  # Link elements bound by rails-ujs
-  linkClickSelector: 'a[data-confirm], a[data-method], a[data-remote]:not([disabled]), a[data-disable-with], a[data-disable]'
-
-  # Button elements bound by rails-ujs
-  buttonClickSelector:
-    selector: 'button[data-remote]:not([form]), button[data-confirm]:not([form])'
-    exclude: 'form button'
-
-  # Select elements bound by rails-ujs
-  inputChangeSelector: 'select[data-remote], input[data-remote], textarea[data-remote]'
-
-  # Form elements bound by rails-ujs
-  formSubmitSelector: 'form'
-
-  # Form input elements bound by rails-ujs
-  formInputClickSelector: 'form input[type=submit], form input[type=image], form button[type=submit], form button:not([type]), input[type=submit][form], input[type=image][form], button[type=submit][form], button[form]:not([type])'
-
-  # Form input elements disabled during form submission
-  formDisableSelector: 'input[data-disable-with]:enabled, button[data-disable-with]:enabled, textarea[data-disable-with]:enabled, input[data-disable]:enabled, button[data-disable]:enabled, textarea[data-disable]:enabled'
-
-  # Form input elements re-enabled after form submission
-  formEnableSelector: 'input[data-disable-with]:disabled, button[data-disable-with]:disabled, textarea[data-disable-with]:disabled, input[data-disable]:disabled, button[data-disable]:disabled, textarea[data-disable]:disabled'
-
-  # Form file input elements
-  fileInputSelector: 'input[name][type=file]:not([disabled])'
-
-  # Link onClick disable selector with possible reenable after remote submission
-  linkDisableSelector: 'a[data-disable-with], a[data-disable]'
-
-  # Button onClick disable selector with possible reenable after remote submission
-  buttonDisableSelector: 'button[data-remote][data-disable-with], button[data-remote][data-disable]'
diff --git a/actionview/app/assets/javascripts/rails-ujs.coffee b/actionview/app/assets/javascripts/rails-ujs.coffee
index 0c47e1bc60..bd6e9bb881 100644
--- a/actionview/app/assets/javascripts/rails-ujs.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs.coffee
@@ -1,80 +1,39 @@
-#
-# Unobtrusive JavaScript
-# https://github.com/rails/rails/blob/master/actionview/app/assets/javascripts
-#
-# Released under the MIT license
-#
-#= require ./config
-#= require_tree ./utils
-#= require_tree ./features
+#= require ./rails-ujs/BANNER
+#= export Rails
+#= require_self
+#= require_tree ./rails-ujs/utils
+#= require_tree ./rails-ujs/features
+#= require ./rails-ujs/start
 
-{
-  fire, delegate
-  getData, $
-  refreshCSRFTokens, CSRFProtection
-  enableElement, disableElement, handleDisabledElement
-  handleConfirm
-  handleRemote, formSubmitButtonClick, handleMetaClick
-  handleMethod
-} = Rails
+@Rails =
+  # Link elements bound by rails-ujs
+  linkClickSelector: 'a[data-confirm], a[data-method], a[data-remote]:not([disabled]), a[data-disable-with], a[data-disable]'
 
-# For backward compatibility
-if jQuery? and not jQuery.rails
-  jQuery.rails = Rails
-  jQuery.ajaxPrefilter (options, originalOptions, xhr) ->
-    CSRFProtection(xhr) unless options.crossDomain
+  # Button elements bound by rails-ujs
+  buttonClickSelector:
+    selector: 'button[data-remote]:not([form]), button[data-confirm]:not([form])'
+    exclude: 'form button'
 
-Rails.start = ->
-  # Cut down on the number of issues from people inadvertently including
-  # rails-ujs twice by detecting and raising an error when it happens.
-  throw new Error('rails-ujs has already been loaded!') if window._rails_loaded
+  # Select elements bound by rails-ujs
+  inputChangeSelector: 'select[data-remote], input[data-remote], textarea[data-remote]'
 
-  # This event works the same as the load event, except that it fires every
-  # time the page is loaded.
-  # See https://github.com/rails/jquery-ujs/issues/357
-  # See https://developer.mozilla.org/en-US/docs/Using_Firefox_1.5_caching
-  window.addEventListener 'pageshow', ->
-    $(Rails.formEnableSelector).forEach (el) ->
-      enableElement(el) if getData(el, 'ujs:disabled')
-    $(Rails.linkDisableSelector).forEach (el) ->
-      enableElement(el) if getData(el, 'ujs:disabled')
+  # Form elements bound by rails-ujs
+  formSubmitSelector: 'form'
 
-  delegate document, Rails.linkDisableSelector, 'ajax:complete', enableElement
-  delegate document, Rails.linkDisableSelector, 'ajax:stopped', enableElement
-  delegate document, Rails.buttonDisableSelector, 'ajax:complete', enableElement
-  delegate document, Rails.buttonDisableSelector, 'ajax:stopped', enableElement
+  # Form input elements bound by rails-ujs
+  formInputClickSelector: 'form input[type=submit], form input[type=image], form button[type=submit], form button:not([type]), input[type=submit][form], input[type=image][form], button[type=submit][form], button[form]:not([type])'
 
-  delegate document, Rails.linkClickSelector, 'click', handleDisabledElement
-  delegate document, Rails.linkClickSelector, 'click', handleConfirm
-  delegate document, Rails.linkClickSelector, 'click', handleMetaClick
-  delegate document, Rails.linkClickSelector, 'click', disableElement
-  delegate document, Rails.linkClickSelector, 'click', handleRemote
-  delegate document, Rails.linkClickSelector, 'click', handleMethod
+  # Form input elements disabled during form submission
+  formDisableSelector: 'input[data-disable-with]:enabled, button[data-disable-with]:enabled, textarea[data-disable-with]:enabled, input[data-disable]:enabled, button[data-disable]:enabled, textarea[data-disable]:enabled'
 
-  delegate document, Rails.buttonClickSelector, 'click', handleDisabledElement
-  delegate document, Rails.buttonClickSelector, 'click', handleConfirm
-  delegate document, Rails.buttonClickSelector, 'click', disableElement
-  delegate document, Rails.buttonClickSelector, 'click', handleRemote
+  # Form input elements re-enabled after form submission
+  formEnableSelector: 'input[data-disable-with]:disabled, button[data-disable-with]:disabled, textarea[data-disable-with]:disabled, input[data-disable]:disabled, button[data-disable]:disabled, textarea[data-disable]:disabled'
 
-  delegate document, Rails.inputChangeSelector, 'change', handleDisabledElement
-  delegate document, Rails.inputChangeSelector, 'change', handleConfirm
-  delegate document, Rails.inputChangeSelector, 'change', handleRemote
+  # Form file input elements
+  fileInputSelector: 'input[name][type=file]:not([disabled])'
 
-  delegate document, Rails.formSubmitSelector, 'submit', handleDisabledElement
-  delegate document, Rails.formSubmitSelector, 'submit', handleConfirm
-  delegate document, Rails.formSubmitSelector, 'submit', handleRemote
-  # Normal mode submit
-  # Slight timeout so that the submit button gets properly serialized
-  delegate document, Rails.formSubmitSelector, 'submit', (e) -> setTimeout((-> disableElement(e)), 13)
-  delegate document, Rails.formSubmitSelector, 'ajax:send', disableElement
-  delegate document, Rails.formSubmitSelector, 'ajax:complete', enableElement
+  # Link onClick disable selector with possible reenable after remote submission
+  linkDisableSelector: 'a[data-disable-with], a[data-disable]'
 
-  delegate document, Rails.formInputClickSelector, 'click', handleDisabledElement
-  delegate document, Rails.formInputClickSelector, 'click', handleConfirm
-  delegate document, Rails.formInputClickSelector, 'click', formSubmitButtonClick
-
-  document.addEventListener('DOMContentLoaded', refreshCSRFTokens)
-  window._rails_loaded = true
-
-if window.Rails is Rails and fire(document, 'rails:attachBindings')
-  Rails.start()
+  # Button onClick disable selector with possible reenable after remote submission
+  buttonDisableSelector: 'button[data-remote][data-disable-with], button[data-remote][data-disable]'
diff --git a/actionview/app/assets/javascripts/rails-ujs/BANNER.js b/actionview/app/assets/javascripts/rails-ujs/BANNER.js
new file mode 100644
index 0000000000..47ecd66003
--- /dev/null
+++ b/actionview/app/assets/javascripts/rails-ujs/BANNER.js
@@ -0,0 +1,5 @@
+/*
+Unobtrusive JavaScript
+https://github.com/rails/rails/blob/master/actionview/app/assets/javascripts
+Released under the MIT license
+ */
diff --git a/actionview/app/assets/javascripts/features/confirm.coffee b/actionview/app/assets/javascripts/rails-ujs/features/confirm.coffee
index 72b5aaa218..72b5aaa218 100644
--- a/actionview/app/assets/javascripts/features/confirm.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/features/confirm.coffee
diff --git a/actionview/app/assets/javascripts/features/disable.coffee b/actionview/app/assets/javascripts/rails-ujs/features/disable.coffee
index 90aa3bdf0e..90aa3bdf0e 100644
--- a/actionview/app/assets/javascripts/features/disable.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/features/disable.coffee
diff --git a/actionview/app/assets/javascripts/features/method.coffee b/actionview/app/assets/javascripts/rails-ujs/features/method.coffee
index d04d9414dd..d04d9414dd 100644
--- a/actionview/app/assets/javascripts/features/method.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/features/method.coffee
diff --git a/actionview/app/assets/javascripts/features/remote.coffee b/actionview/app/assets/javascripts/rails-ujs/features/remote.coffee
index 852587042c..852587042c 100644
--- a/actionview/app/assets/javascripts/features/remote.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/features/remote.coffee
diff --git a/actionview/app/assets/javascripts/rails-ujs/start.coffee b/actionview/app/assets/javascripts/rails-ujs/start.coffee
new file mode 100644
index 0000000000..5746a22287
--- /dev/null
+++ b/actionview/app/assets/javascripts/rails-ujs/start.coffee
@@ -0,0 +1,70 @@
+{
+  fire, delegate
+  getData, $
+  refreshCSRFTokens, CSRFProtection
+  enableElement, disableElement, handleDisabledElement
+  handleConfirm
+  handleRemote, formSubmitButtonClick, handleMetaClick
+  handleMethod
+} = Rails
+
+# For backward compatibility
+if jQuery? and not jQuery.rails
+  jQuery.rails = Rails
+  jQuery.ajaxPrefilter (options, originalOptions, xhr) ->
+    CSRFProtection(xhr) unless options.crossDomain
+
+Rails.start = ->
+  # Cut down on the number of issues from people inadvertently including
+  # rails-ujs twice by detecting and raising an error when it happens.
+  throw new Error('rails-ujs has already been loaded!') if window._rails_loaded
+
+  # This event works the same as the load event, except that it fires every
+  # time the page is loaded.
+  # See https://github.com/rails/jquery-ujs/issues/357
+  # See https://developer.mozilla.org/en-US/docs/Using_Firefox_1.5_caching
+  window.addEventListener 'pageshow', ->
+    $(Rails.formEnableSelector).forEach (el) ->
+      enableElement(el) if getData(el, 'ujs:disabled')
+    $(Rails.linkDisableSelector).forEach (el) ->
+      enableElement(el) if getData(el, 'ujs:disabled')
+
+  delegate document, Rails.linkDisableSelector, 'ajax:complete', enableElement
+  delegate document, Rails.linkDisableSelector, 'ajax:stopped', enableElement
+  delegate document, Rails.buttonDisableSelector, 'ajax:complete', enableElement
+  delegate document, Rails.buttonDisableSelector, 'ajax:stopped', enableElement
+
+  delegate document, Rails.linkClickSelector, 'click', handleDisabledElement
+  delegate document, Rails.linkClickSelector, 'click', handleConfirm
+  delegate document, Rails.linkClickSelector, 'click', handleMetaClick
+  delegate document, Rails.linkClickSelector, 'click', disableElement
+  delegate document, Rails.linkClickSelector, 'click', handleRemote
+  delegate document, Rails.linkClickSelector, 'click', handleMethod
+
+  delegate document, Rails.buttonClickSelector, 'click', handleDisabledElement
+  delegate document, Rails.buttonClickSelector, 'click', handleConfirm
+  delegate document, Rails.buttonClickSelector, 'click', disableElement
+  delegate document, Rails.buttonClickSelector, 'click', handleRemote
+
+  delegate document, Rails.inputChangeSelector, 'change', handleDisabledElement
+  delegate document, Rails.inputChangeSelector, 'change', handleConfirm
+  delegate document, Rails.inputChangeSelector, 'change', handleRemote
+
+  delegate document, Rails.formSubmitSelector, 'submit', handleDisabledElement
+  delegate document, Rails.formSubmitSelector, 'submit', handleConfirm
+  delegate document, Rails.formSubmitSelector, 'submit', handleRemote
+  # Normal mode submit
+  # Slight timeout so that the submit button gets properly serialized
+  delegate document, Rails.formSubmitSelector, 'submit', (e) -> setTimeout((-> disableElement(e)), 13)
+  delegate document, Rails.formSubmitSelector, 'ajax:send', disableElement
+  delegate document, Rails.formSubmitSelector, 'ajax:complete', enableElement
+
+  delegate document, Rails.formInputClickSelector, 'click', handleDisabledElement
+  delegate document, Rails.formInputClickSelector, 'click', handleConfirm
+  delegate document, Rails.formInputClickSelector, 'click', formSubmitButtonClick
+
+  document.addEventListener('DOMContentLoaded', refreshCSRFTokens)
+  window._rails_loaded = true
+
+if window.Rails is Rails and fire(document, 'rails:attachBindings')
+  Rails.start()
diff --git a/actionview/app/assets/javascripts/utils/ajax.coffee b/actionview/app/assets/javascripts/rails-ujs/utils/ajax.coffee
index 9af515beda..9af515beda 100644
--- a/actionview/app/assets/javascripts/utils/ajax.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/utils/ajax.coffee
diff --git a/actionview/app/assets/javascripts/utils/csrf.coffee b/actionview/app/assets/javascripts/rails-ujs/utils/csrf.coffee
index 4eb5ebb414..4eb5ebb414 100644
--- a/actionview/app/assets/javascripts/utils/csrf.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/utils/csrf.coffee
diff --git a/actionview/app/assets/javascripts/utils/dom.coffee b/actionview/app/assets/javascripts/rails-ujs/utils/dom.coffee
index 6bef618147..6bef618147 100644
--- a/actionview/app/assets/javascripts/utils/dom.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/utils/dom.coffee
diff --git a/actionview/app/assets/javascripts/utils/event.coffee b/actionview/app/assets/javascripts/rails-ujs/utils/event.coffee
index 8d3ff007ea..8d3ff007ea 100644
--- a/actionview/app/assets/javascripts/utils/event.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/utils/event.coffee
diff --git a/actionview/app/assets/javascripts/utils/form.coffee b/actionview/app/assets/javascripts/rails-ujs/utils/form.coffee
index 5fa337b518..5fa337b518 100644
--- a/actionview/app/assets/javascripts/utils/form.coffee
+++ b/actionview/app/assets/javascripts/rails-ujs/utils/form.coffee