stimulus-rails 0.7.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa354a81d7e2305ae1f6e333ca31844b04f1bce376b9df1b502574c73725728
-  data.tar.gz: 3192954bcd22ebb74c854751646b7089092ed1066a35e778a50bb2384bc0ce30
+  metadata.gz: 0ffd052c8f30205c21d994289dc5f4938f7926db658ac93a9e6264f1ff63810f
+  data.tar.gz: bafd756e667681009804b4387a04674d8af0b8a868873978f17bfea2759196de
 SHA512:
-  metadata.gz: abde8638a567a585f5ec33a9a194da0e28c3263cabb03ca7a42e6628c91fb636a8ef9218bf82856c30acc502cfbae18d59164758254601275cbe40379be83b1c
-  data.tar.gz: 0cd6800704eea7cfaf913b02b460475b2e6e8b3e20ec28c0db28cf3e10effd9d8f60fec42442a5b28d1e91f2966e59a6cd14bed5c0f3a279a5cc0a6ef22897ca
+  metadata.gz: 9fb58d85d883bd881b1ad7a9d1478a98f57d26b41f9c844d27ffebe6020f0f7d578952e401e8057ab5555b69df63def79f8900f4b54b6115c83f25afb5080fa3
+  data.tar.gz: 386899154a67d5e79c9ca964757ba40d387367ce65309cbb704d1075d898d095f748478198eb30918af3783b9a7a6938e697b75f8bcf3f20bd014146d753f7d3

data/README.md

@@ -7,6 +7,10 @@ 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 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`.
 3. Run `./bin/rails stimulus:install`
@@ -15,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,8 @@ function controllerFilename(name, under) {
 }
 
 function registerController(name, module, application) {
-  if (name in registeredControllers) return
-
-  application.register(name, module.default)
-  registeredControllers[name] = true
+  if (!(name in registeredControllers)) {
+    application.register(name, module.default)
+    registeredControllers[name] = true
+  }
 }

data/lib/generators/stimulus/stimulus_generator.rb

@@ -4,13 +4,17 @@ class StimulusGenerator < Rails::Generators::NamedBase # :nodoc:
   source_root File.expand_path("templates", __dir__)
 
   def copy_view_files
-    @attribute = stimulus_attribute_value(name)
-    template "controller.js", "app/javascript/controllers/#{name}_controller.js"
-    rails_command "stimulus:manifest:update" if Rails.root.join("package.json").exist?
+    @attribute = stimulus_attribute_value(controller_name)
+    template "controller.js", "app/javascript/controllers/#{controller_name}_controller.js"
+    rails_command "stimulus:manifest:update" unless Rails.root.join("config/importmap.rb").exist?
   end
 
   private
-    def stimulus_attribute_value(name)
-      name.gsub(/\//, "--").gsub("_", "-")
+    def controller_name
+      name.underscore.gsub(/_controller$/, "")
+    end
+
+    def stimulus_attribute_value(controller_name)
+      controller_name.gsub(/\//, "--").gsub("_", "-")
     end
 end

data/lib/install/app/javascript/controllers/index_for_node.js

@@ -1,5 +1,6 @@
 // This file is auto-generated by ./bin/rails stimulus:manifest:update
-// Run that command whenever you add a new controller
+// Run that command whenever you add a new controller or create them with
+// ./bin/rails generate stimulus controllerName
 
 import { application } from "./application"
 

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 = "0.7.3"
+  VERSION = "1.0.4"
 end

data/lib/tasks/stimulus_tasks.rake

@@ -37,7 +37,8 @@ namespace :stimulus do
 
       File.open(Rails.root.join("app/javascript/controllers/index.js"), "w+") do |index|
         index.puts "// This file is auto-generated by ./bin/rails stimulus:manifest:update"
-        index.puts "// Run that command whenever you add a new controller"
+        index.puts "// Run that command whenever you add a new controller or create them with"
+        index.puts "// ./bin/rails generate stimulus controllerName"
         index.puts
         index.puts %(import { application } from "./application")
         index.puts manifest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,10 +10,10 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A modest JavaScript framework for the HTML you already have.