stimulus-rails 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64761f6c52233208ab99ba06ecc3d99a4df3ec15a43bdda8e9059714a5e1a6ee
-  data.tar.gz: 8a7416e6f82f089575a87b27fa7706cd0aa1f5ea01786aa0754cfce51e0c9d7c
+  metadata.gz: aa026a69205d5d12a6f7dfe43892b6e832ac6d7331cb87fab2e1ae6ea6fd3a1f
+  data.tar.gz: 0b4534ef0afb61a881a8e702b6ccb61e8c24fddff649992269f2b7348546a412
 SHA512:
-  metadata.gz: 929c0266cf1ed01dee781af2d228481b3e4f4164bdc09c3c9e1505ced0a40c4223fa54849ace773806d2be3df300103ed8099867735fbefa35e5288110ba799f
-  data.tar.gz: 02d4931af10963beef58c26379499486326b355e325078e24649c6ab92e0351bfbabb936fc72202df31bb10de8c9a477bf698d27df10476260fd6604ae0e192d
+  metadata.gz: 4512fadf940a7893da2ac9b906f6591a2829bca71f957d46693c5e1085480c9088877c70adb4c72e10b93a8c6f995d8525441bfcbb29677d1f47dea9e539dbfc
+  data.tar.gz: 3ba7838345956e406dc51183365e05f78e0b92b7102debb74b17a702d5e82b24e2173861f899704532ab0ab1fc06d0312e82f6969734f687d9b6a0186e2cbc0d

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

@@ -1,21 +1,21 @@
-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, importmap, application) {
+  const paths = Object.keys(importmap)
+    .filter(path => path.match(new RegExp(`^${under}/.*_controller$`)))
+
+  paths.forEach(path => registerControllerFromPath(path, under, application))
 }
 
-function registerControllerFromPath(path, under) {
-  const name = path.replace(`${under}/`, "").replace("_controller", "").replace(/\//g, "--").replace(/_/g, "-")
+function registerControllerFromPath(path, under, application) {
+  const name = path
+    .replace(`${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 }

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

@@ -0,0 +1,13 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.warnings = true
+application.debug    = false
+window.Stimulus      = application
+
+// Import and register all your controllers from the importmap under controllers/*
+import { registerControllersFrom } from "@hotwired/stimulus-importmap-autoloader"
+const importmap = JSON.parse(document.querySelector("script[type=importmap]").text).imports
+registerControllersFrom("controllers", importmap, application)

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

@@ -0,0 +1,12 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.warnings = true
+application.debug    = false
+window.Stimulus      = application
+
+// Import and register all your controllers
+import HelloController from "./hello_controller"
+application.register("hello", HelloController)

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

@@ -0,0 +1,14 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.warnings = true
+application.debug    = false
+window.Stimulus      = application
+
+// Import and register all your controllers within this directory and all subdirectories
+// Controller files must be named *_controller.js or *_controller.ts
+import { definitionsFromContext } from "@hotwired/stimulus"
+const context = require.context("controllers", true, /_controller\.(js|ts)$/)
+application.load(definitionsFromContext(context))

data/lib/install/install.rb

@@ -0,0 +1,10 @@
+if (js_entrypoint_path = Rails.root.join("app/javascript/application.js")).exist?
+  say "Appending Stimulus setup code to JavaScript entrypoint"
+  append_to_file "app/javascript/application.js", %(\nimport "controllers")
+else
+end
+
+say "Creating controllers directory"
+directory "#{__dir__}/app/javascript/controllers", "app/javascript/controllers"
+
+say "Add @hotwired/stimulus package"

data/lib/install/stimulus_with_importmap.rb

@@ -0,0 +1,17 @@
+say "Create controllers directory"
+empty_directory "app/javascript/controllers"
+copy_file "#{__dir__}/app/javascript/controllers/index_for_importmap.js",
+  "app/javascript/controllers/index.js"
+copy_file "#{__dir__}/app/javascript/controllers/hello_controller.js",
+  "app/javascript/controllers/hello_controller.js"
+
+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.js"
+pin "@hotwired/stimulus-importmap-autoloader", to: "stimulus-importmap-autoloader.js"
+pin_all_from "app/javascript/controllers", under: "controllers"
+RUBY
+end

data/lib/install/stimulus_with_node.rb

@@ -0,0 +1,19 @@
+say "Create controllers directory"
+empty_directory "app/javascript/controllers"
+
+if Rails.root.join("config/webpacker.yml").exist?
+  copy_file "#{__dir__}/app/javascript/controllers/index_for_webpacker.js",
+    "app/javascript/controllers/index.js"
+else
+  copy_file "#{__dir__}/app/javascript/controllers/index_for_node.js",
+    "app/javascript/controllers/index.js"
+end
+
+copy_file "#{__dir__}/app/javascript/controllers/hello_controller.js",
+  "app/javascript/controllers/hello_controller.js"
+
+say "Import Stimulus controllers"
+append_to_file "app/javascript/application.js", %(import "./controllers"\n)
+
+say "Install Stimulus"
+run "yarn add @hotwired/stimulus"

data/lib/stimulus/version.rb

@@ -1,3 +1,3 @@
 module Stimulus
-  VERSION = "0.3.11"
+  VERSION = "0.4.0"
 end

data/lib/tasks/stimulus_tasks.rake

@@ -3,24 +3,24 @@ def run_stimulus_install_template(path) system "#{RbConfig.ruby} ./bin/rails app
 namespace :stimulus do
   desc "Install Stimulus into the app"
   task :install do
-    if defined?(Webpacker::Engine)
-      Rake::Task["stimulus:install:webpacker"].invoke
-    elsif defined?(Importmap)
-      Rake::Task["stimulus:install:asset_pipeline"].invoke
+    if Rails.root.join("config/importmap.rb").exist?
+      Rake::Task["stimulus:install:importmap"].invoke
+    elsif Rails.root.join("package.json").exist?
+      Rake::Task["stimulus:install:node"].invoke
     else
-      puts "You must either be running Webpacker or importmap-rails to use this gem."
+      puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
     end
   end
 
   namespace :install do
-    desc "Install Stimulus on the app with the asset pipeline"
-    task :asset_pipeline do
-      run_stimulus_install_template "stimulus_with_asset_pipeline"
+    desc "Install Stimulus on an app running importmap-rails"
+    task :importmap do
+      run_stimulus_install_template "stimulus_with_importmap"
     end
 
-    desc "Install Stimulus on the app with webpacker"
-    task :webpacker do
-      run_stimulus_install_template "stimulus_with_webpacker"
+    desc "Install Stimulus on an app running node"
+    task :node do
+      run_stimulus_install_template "stimulus_with_node"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,9 +41,12 @@ files:
 - app/assets/javascripts/stimulus@2.js
 - app/assets/javascripts/stimulus@3.0.0-beta.1.js
 - lib/install/app/javascript/controllers/hello_controller.js
-- lib/install/app/javascript/controllers/index.js
-- lib/install/stimulus_with_asset_pipeline.rb
-- lib/install/stimulus_with_webpacker.rb
+- lib/install/app/javascript/controllers/index_for_importmap.js
+- lib/install/app/javascript/controllers/index_for_node.js
+- lib/install/app/javascript/controllers/index_for_webpacker.js
+- lib/install/install.rb
+- lib/install/stimulus_with_importmap.rb
+- lib/install/stimulus_with_node.rb
 - lib/stimulus-rails.rb
 - lib/stimulus/engine.rb
 - lib/stimulus/version.rb

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

@@ -1,9 +0,0 @@
-// Load all the controllers within this directory and all subdirectories. 
-// Controller files must be named *_controller.js or *_controller.ts.
-
-import { Application } from "stimulus"
-import { definitionsFromContext } from "stimulus/webpack-helpers"
-
-window.Stimulus = Application.start()
-const context = require.context("controllers", true, /_controller\.(js|ts)$/)
-Stimulus.load(definitionsFromContext(context))

data/lib/install/stimulus_with_asset_pipeline.rb

@@ -1,26 +0,0 @@
-APP_JS_ROOT = Rails.root.join("app/javascript")
-APP_JS_PATH = APP_JS_ROOT.join("application.js")
-IMPORTMAP_PATH = Rails.root.join("config/importmap.rb")
-
-if APP_JS_PATH.exist?
-  say "Import Stimulus importmap autoloader in existing app/javascript/application.js"
-  append_to_file APP_JS_PATH, %(\nimport "@hotwired/stimulus-importmap-autoloader"\n)
-else
-  say <<~INSTRUCTIONS, :red
-    You must import @hotwired/stimulus and @hotwired/stimulus-importmap-autoloader in your application.js.
-  INSTRUCTIONS
-end
-
-say "Creating controllers directory"
-copy_file "#{__dir__}/app/javascript/controllers/hello_controller.js", APP_JS_ROOT.join("controllers/hello_controller.js")
-
-if IMPORTMAP_PATH.exist?
-  say "Pin @hotwired/stimulus and @hotwired/stimulus-importmap-autoloader in config/importmap.rb"
-  append_to_file \
-    IMPORTMAP_PATH.to_s, 
-    %(pin "@hotwired/stimulus", to: "stimulus.js"\npin "@hotwired/stimulus-importmap-autoloader", to: "stimulus-importmap-autoloader.js"\npin_all_from "app/javascript/controllers", under: "controllers"\n)
-else
-  say <<~INSTRUCTIONS, :red
-    You must add @hotwired/stimulus and @hotwired/stimulus-importmap-autoloader to your importmap to reference them via ESM.
-  INSTRUCTIONS
-end

data/lib/install/stimulus_with_webpacker.rb

@@ -1,11 +0,0 @@
-say "Appending Stimulus setup code to #{Webpacker.config.source_entry_path}/application.js"
-append_to_file "#{Webpacker.config.source_entry_path}/application.js", %(\nimport "controllers")
-
-say "Creating controllers directory"
-directory "#{__dir__}/app/javascript/controllers", "#{Webpacker.config.source_path}/controllers"
-
-say "Using Stimulus NPM package"
-gsub_file "#{Webpacker.config.source_path}/controllers/hello_controller.js", /@hotwired\//, ''
-
-say "Installing all Stimulus dependencies"
-run "yarn add stimulus"