stimulus-rails 0.3.9 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f291e5c1c237cc6c6358da9753353f40f3f7bad4c97ace2626a2c030ec8101a
-  data.tar.gz: 14f486833999a5ba37ea05143091a0ff186cc78c998a5fc59bd37d2dfc7c7b0b
+  metadata.gz: 23f5108a2b5f7377a6148df9c993a7a637b82a34e3a13fa5e2aacca4412306eb
+  data.tar.gz: 5a7076d26e257566a2c17f60f0c19ad72623f648cf8d6390ca24cbec498f2b64
 SHA512:
-  metadata.gz: fb8ca5dcda94fbf1f68ca45aa8037c2d8b11424b35ffae3af25dd8d9973954a8abbee2369aa62e54d2e881d58640ce07d39107c75d8c12edf7f9b8b9696b835f
-  data.tar.gz: 68f78448fd30aa9ba5703ec8e20089811c4732ded2e9323c325920e68af65ab40d851022013846808b4cb50ced6e352a57b5830c9cec812cb185312a17524eab
+  metadata.gz: f45d9def4599c3b2b872b65125f2d0164d7ab3065f5fc0d179fe90d2370840bffd4056c890d2f6f6c5099ccccc72ae6b75b0c09705e32f4656366e37ff4e0c8c
+  data.tar.gz: 2d463a499ede333ea3a7ceae20d6049f2ee703f35d2c3fe8acab90fa56f37f41bf190c55ec5a169c0393afd34344716aa7a436713aa0a887f1376b7a3165a2a5

data/README.md

@@ -2,40 +2,46 @@
 
 [Stimulus](https://stimulus.hotwired.dev) is a JavaScript framework with modest ambitions. It doesn’t seek to take over your entire front-end in fact, it’s not concerned with rendering HTML at all. Instead, it’s designed to augment your HTML with just enough behavior to make it shine. Stimulus pairs beautifully with Turbo to provide a complete solution for fast, compelling applications with a minimal amount of effort. Together they form the core of [Hotwire](https://hotwired.dev).
 
-Stimulus for Rails makes it easy to use this modest framework with the asset pipeline and ES6/ESM in the browser. It relies on `importmap-rails` to make stimulus available via ESM. Make sure to install this first!
+Stimulus for Rails makes it easy to use this modest framework with both import-mapped and JavaScript-bundled apps. It relies on either `importmap-rails` to make Stimulus available via ESM or a Node-capable Rails (like via `jsbundling-rails`) to include Stimulus in the bundle. Make sure to install one of these first!
 
 
 ## Installation
 
+This gem is automatically configured for applications made with Rails 7+ (unless `--skip-hotwire` is passed to the generator). But if you're on Rails 6, you can install it manually with:
+
 1. Add the `stimulus-rails` gem to your Gemfile: `gem 'stimulus-rails'`
 2. Run `./bin/bundle install`.
 3. Run `./bin/rails stimulus:install`
 
-If using the asset pipeline to manage JavaScript, the last command will:
+The installer will automatically detect whether you're using an [import map](https://github.com/rails/importmap-rails) or [JavaScript bundler](https://github.com/rails/jsbundling-rails) to manage your application's JavaScript. If you're using an import map, the Stimulus dependencies will be pinned to the versions of the library included with this gem. If you're using Node, yarn will add the dependencies to your `package.json` file.
+
+The installer amends your JavaScript entry point at `app/javascript/application.js` to import the `app/javascript/controllers/index.js` file, which is responsible for setting up your Stimulus application and registering your controllers.
+
 
-1. Create an example controller in `app/assets/javascripts/controllers/hello_controller.js`.
-2. Append `import "@hotwired/stimulus-autoloader"` to your `app/assets/javascripts/application.js` entrypoint.
+## Usage with import map
 
-Make sure you've already installed `importmap-rails` and that it's referenced before `stimulus-rails` (or `hotwire-rails`) in your Gemfile.
+With an import-mapped application, controllers are automatically pinned and registered based on the file structure. The installer will amend your `config/importmap.rb` to configure this such that all controllers in `app/javascript/controllers` are pinned.
 
-If using Webpacker to manage JavaScript, the last command will:
+By default, your application will be setup to eager load all the controllers mentioned in your import map under "controllers". This works well together with preloading in the import map when you have a modest number of controllers.
 
-1. Import the controllers directory in the application pack.
-2. Create a controllers directory at `app/javascripts/controllers`.
-3. Create an example controller in `app/javascripts/controllers/hello_controller.js`.
-4. Install the Stimulus NPM package.
+If you have a lot of controllers, you may well want to lazy load them instead. This can be done by changing from `eagerLoadControllersFrom` to `lazyLoadControllersFrom` in your `app/javascript/controllers/index.js` file.
 
+When lazy loading, controllers are not loaded until their data-controller identifier is encountered in the DOM.
 
-## Usage
 
-With the installation done, you'll automatically have activated Stimulus through the controller autoloader. You can now easily add new Stimulus controllers that'll be loaded via ESM dynamic imports.
+## Usage with JavaScript bundler
 
-For example, a more advanced `hello_controller` could look like this:
+With an application using a JavaScript bundler, controllers need to be imported and registered directly in the index.js file. But this can be done automatically using either the Stimulus generator (`./bin/rails generate stimulus [controller]`) or the dedicated `stimulus:manifest:update` task. Either will overwrite the `controllers/index.js` file.
+
+You're encouraged to use the generator to add new controllers like so:
 
 ```javascript
+// Run "./bin/rails g stimulus hello" to create the file and update the index, then amend:
+
 // app/assets/javascripts/controllers/hello_controller.js
-import { Controller } from "stimulus"
+import { Controller } from "@hotwired/stimulus"
 
+// Connects with data-controller="hello"
 export default class extends Controller {
   static targets = [ "name", "output" ]
 
@@ -45,23 +51,6 @@ export default class extends Controller {
 }
 ```
 
-And it'll be activated and registered automatically when encountering the data-controller attribute in your DOM:
-
-```html
-<div data-controller="hello">
-  <input data-hello-target="name" type="text">
-
-  <button data-action="click->hello#greet">
-    Greet
-  </button>
-
-  <span data-hello-target="output">
-  </span>
-</div>
-```
-
-That's it!
-
 
 ## License
 

data/app/assets/javascripts/stimulus-autoloader.js

@@ -50,3 +50,5 @@ new MutationObserver((mutationsList) => {
 }).observe(document, { attributeFilter: [controllerAttribute], subtree: true, childList: true })
 
 autoloadControllersWithin(document)
+
+console.warn("stimulus-autoload.js has been deprecated in favor of stimulus-loading.js")

data/app/assets/javascripts/stimulus-importmap-autoloader.js

@@ -1,21 +1,27 @@
-import { Application } from "@hotwired/stimulus"
+// FIXME: es-module-shim won't shim the dynamic import without this explicit import
+import "@hotwired/stimulus"
 
-function registerControllersFrom(under) {
-  const paths = Object.keys(importmap).filter(path => path.match(new RegExp(`^${under}/.*_controller$`)))
-  paths.forEach(path => registerControllerFromPath(path, under))
+export function registerControllersFrom(under, application) {
+  const paths = Object.keys(parseImportmapJson())
+    .filter(path => path.match(new RegExp(`^${under}/.*_controller$`)))
+
+  paths.forEach(path => registerControllerFromPath(path, under, application))
+}
+
+export function parseImportmapJson() {
+  return JSON.parse(document.querySelector("script[type=importmap]").text).imports
 }
 
-function registerControllerFromPath(path, under) {
-  const name = path.replace(`${under}/`, "").replace("_controller", "").replace(/\//g, "--").replace(/_/g, "-")
+function registerControllerFromPath(path, under, application) {
+  const name = path
+    .replace(new RegExp(`^${under}/`), "")
+    .replace("_controller", "")
+    .replace(/\//g, "--")
+    .replace(/_/g, "-")
 
   import(path)
     .then(module => application.register(name, module.default))
     .catch(error => console.log(`Failed to register controller: ${name} (${path})`, error))
 }
 
-const application = Application.start()
-const importmap = JSON.parse(document.querySelector("script[type=importmap]").text).imports
-
-registerControllersFrom("controllers")
-
-export { application, registerControllersFrom }
+console.warn("stimulus-importmap-autoload.js has been deprecated in favor of stimulus-loading.js")

data/app/assets/javascripts/stimulus-loading.js

@@ -0,0 +1,81 @@
+// FIXME: es-module-shim won't shim the dynamic import without this explicit import
+import "@hotwired/stimulus"
+
+const controllerAttribute = "data-controller"
+const registeredControllers = {}
+
+// Eager load all controllers registered beneath the `under` path in the import map to the passed application instance.
+export function eagerLoadControllersFrom(under, application) {
+  const paths = Object.keys(parseImportmapJson()).filter(path => path.match(new RegExp(`^${under}/.*_controller$`)))
+  paths.forEach(path => registerControllerFromPath(path, under, application))
+}
+
+function parseImportmapJson() {
+  return JSON.parse(document.querySelector("script[type=importmap]").text).imports
+}
+
+function registerControllerFromPath(path, under, application) {
+  const name = path
+    .replace(new RegExp(`^${under}/`), "")
+    .replace("_controller", "")
+    .replace(/\//g, "--")
+    .replace(/_/g, "-")
+
+  import(path)
+    .then(module => registerController(name, module, application))
+    .catch(error => console.debug(`Failed to register controller: ${name} (${path})`, error))
+}
+
+
+// Lazy load controllers registered beneath the `under` path in the import map to the passed application instance.
+export function lazyLoadControllersFrom(under, application, element = document) {
+  lazyLoadExistingControllers(under, application, element)
+  lazyLoadNewControllers(under, application, element)
+}
+
+function lazyLoadExistingControllers(under, application, element) {
+  queryControllerNamesWithin(element).forEach(controllerName => loadController(controllerName, under, application))
+}
+
+function lazyLoadNewControllers(under, application, element) {
+  new MutationObserver((mutationsList) => {
+    for (const { attributeName, target, type } of mutationsList) {
+      switch (type) {
+        case "attributes": {
+          if (attributeName == controllerAttribute && target.getAttribute(controllerAttribute)) {
+            extractControllerNamesFrom(target).forEach(controllerName => loadController(controllerName, under, application))
+          }
+        }
+
+        case "childList": {
+          lazyLoadExistingControllers(under, application, target)
+        }
+      }
+    }
+  }).observe(element, { attributeFilter: [controllerAttribute], subtree: true, childList: true })
+}
+
+function queryControllerNamesWithin(element) {
+  return Array.from(element.querySelectorAll(`[${controllerAttribute}]`)).map(extractControllerNamesFrom).flat()
+}
+
+function extractControllerNamesFrom(element) {
+  return element.getAttribute(controllerAttribute).split(/\s+/).filter(content => content.length)
+}
+
+function loadController(name, under, application) {
+  import(controllerFilename(name, under))
+    .then(module => registerController(name, module, application))
+    .catch(error => console.debug(`Failed to autoload controller: ${name}`, error))
+}
+
+function controllerFilename(name, under) {
+  return `${under}/${name.replace(/--/g, "/").replace(/-/g, "_")}_controller`
+}
+
+function registerController(name, module, application) {
+  if (name in registeredControllers) return
+
+  application.register(name, module.default)
+  registeredControllers[name] = true
+}