stimulus-rails 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f5108a2b5f7377a6148df9c993a7a637b82a34e3a13fa5e2aacca4412306eb
-  data.tar.gz: 5a7076d26e257566a2c17f60f0c19ad72623f648cf8d6390ca24cbec498f2b64
+  metadata.gz: 79e7cd48f25a99d585cf5a257256a1d52d26d131e7cdb7a7de81135752e19ca3
+  data.tar.gz: bead4bdbef70c56d7343755884185eb399d93b0718f37b9988163a74aad9fe81
 SHA512:
-  metadata.gz: f45d9def4599c3b2b872b65125f2d0164d7ab3065f5fc0d179fe90d2370840bffd4056c890d2f6f6c5099ccccc72ae6b75b0c09705e32f4656366e37ff4e0c8c
-  data.tar.gz: 2d463a499ede333ea3a7ceae20d6049f2ee703f35d2c3fe8acab90fa56f37f41bf190c55ec5a169c0393afd34344716aa7a436713aa0a887f1376b7a3165a2a5
+  metadata.gz: 83eb18cb343693c7535aa193fe16251b69a29196225c019672404ea02a45280296f6d5c2c163923e5fee4611ea12493d48040a9b1872f00d89cc0955e9677970
+  data.tar.gz: 4056db548e949647e7a7d66ba5e8759bb8e0a17f74f2fb4e8e23ddbb41d6d8eab5e729e430a07351554d893c756cc07cf0e15b71d236afb0bc0e23838f8b67df

data/README.md

@@ -7,7 +7,9 @@ Stimulus for Rails makes it easy to use this modest framework with both import-m
 
 ## 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:
+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 with the installer or manually:
+
+### Installing with installer
 
 1. Add the `stimulus-rails` gem to your Gemfile: `gem 'stimulus-rails'`
 2. Run `./bin/bundle install`.
@@ -17,6 +19,89 @@ The installer will automatically detect whether you're using an [import map](htt
 
 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.
 
+### Installing manually
+
+Note that we recommend running the installer as described above. But the following is helpful if you encounter errors while running the installer (e.g., if there are conflicts with existing files) or if you just like doing stuff manually. Follow the instructions for import map *or* JavaScript bundler, depending on your setup.
+
+1. Add the `stimulus-rails` gem to your Gemfile: `gem 'stimulus-rails'`
+2. Run `./bin/bundle install`.
+
+#### With import map
+
+3. Create `app/javascript/controllers/index.js` and load your controllers like this:
+```javascript
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+```
+
+4. Create `app/javascript/controllers/application.js` with the following content:
+```javascript
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }
+```
+
+5. Add the following line to `app/javascript/application.js` to import all your controllers:
+```javascript
+import "controllers"
+```
+
+6. Finally, Pin Stimulus and controllers in `config/importmap.rb` by adding:
+```ruby
+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
+pin_all_from "app/javascript/controllers", under: "controllers"
+
+```
+
+#### With JavaScript bundler
+
+3. Create `app/javascript/controllers/index.js` and load your controllers.
+
+Make sure to change `HelloController` to an actual controller and repeat for every controller you have or use the command mentioned in the comments below:
+```javascript
+// This file is auto-generated by ./bin/rails stimulus:manifest:update
+// Run that command whenever you add a new controller or create them with
+// ./bin/rails generate stimulus controllerName
+
+import { application } from "./application"
+
+import HelloController from "./hello_controller"
+application.register("hello", HelloController)
+```
+
+4. Create `app/javascript/controllers/application.js` with the following content:
+```javascript
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }
+```
+
+5. Add the following line to `app/javascript/application.js` to import all your controllers:
+```javascript
+import "controllers"
+```
+
+6. Finally, add the Stimulus package to yarn:
+```bash
+yarn add @hotwired/stimulus
+```
+
 
 ## Usage with import map
 

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

@@ -19,7 +19,7 @@ function extractControllerNamesFrom(element) {
 function loadController(name) {
   import(controllerFilename(name))
     .then(module => registerController(name, module))
-    .catch(error => console.log(`Failed to autoload controller: ${name}`, error))
+    .catch(error => console.error(`Failed to autoload controller: ${name}`, error))
 }
 
 function controllerFilename(name) {

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

@@ -21,7 +21,7 @@ function registerControllerFromPath(path, under, application) {
 
   import(path)
     .then(module => application.register(name, module.default))
-    .catch(error => console.log(`Failed to register controller: ${name} (${path})`, error))
+    .catch(error => console.error(`Failed to register controller: ${name} (${path})`, error))
 }
 
 console.warn("stimulus-importmap-autoload.js has been deprecated in favor of stimulus-loading.js")

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

@@ -21,9 +21,11 @@ function registerControllerFromPath(path, under, application) {
     .replace(/\//g, "--")
     .replace(/_/g, "-")
 
-  import(path)
-    .then(module => registerController(name, module, application))
-    .catch(error => console.debug(`Failed to register controller: ${name} (${path})`, error))
+  if (!(name in registeredControllers)) {
+    import(path)
+      .then(module => registerController(name, module, application))
+      .catch(error => console.error(`Failed to register controller: ${name} (${path})`, error))
+  }
 }
 
 
@@ -64,9 +66,11 @@ function extractControllerNamesFrom(element) {
 }
 
 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))
+  if (!(name in registeredControllers)) {
+    import(controllerFilename(name, under))
+      .then(module => registerController(name, module, application))
+      .catch(error => console.error(`Failed to autoload controller: ${name}`, error))
+  }
 }
 
 function controllerFilename(name, under) {
@@ -74,8 +78,6 @@ function controllerFilename(name, under) {
 }
 
 function registerController(name, module, application) {
-  if (name in registeredControllers) return
-
   application.register(name, module.default)
   registeredControllers[name] = true
 }

data/lib/install/stimulus_with_importmap.rb

@@ -11,9 +11,12 @@ say "Import Stimulus controllers"
 append_to_file "app/javascript/application.js", %(import "controllers"\n)
 
 say "Pin Stimulus"
-append_to_file "config/importmap.rb" do <<-RUBY
-pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
-pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
-pin_all_from "app/javascript/controllers", under: "controllers"
-RUBY
-end
+say %(Appending: pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true")
+append_to_file "config/importmap.rb", %(pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true\n)
+
+say %(Appending: pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true)
+append_to_file "config/importmap.rb", %(pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true\n)
+
+say "Pin all controllers"
+say %(Appending: pin_all_from "app/javascript/controllers", under: "controllers")
+append_to_file "config/importmap.rb", %(pin_all_from "app/javascript/controllers", under: "controllers"\n)

data/lib/install/stimulus_with_node.rb

@@ -11,7 +11,7 @@ if (Rails.root.join("app/javascript/application.js")).exist?
   say "Import Stimulus controllers"
   append_to_file "app/javascript/application.js", %(import "./controllers"\n)
 else
-  say %(You must import "./controllers" in your JavaScript entrypoint), :red
+  say %(Couldn't find "app/javascript/application.js".\nYou must import "./controllers" in your JavaScript entrypoint file), :red
 end
 
 say "Install Stimulus"

data/lib/stimulus/version.rb

@@ -1,3 +1,3 @@
 module Stimulus
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties