stimulus-rails 0.3.9 → 0.4.1

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,11 @@
+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("./hello_controller").then(c => application.register("hello", c.default))

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/engine.rb

@@ -2,7 +2,7 @@ module Stimulus
   class Engine < ::Rails::Engine
     initializer "stimulus.assets" do
       if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( stimulus stimulus-autoloader stimulus-importmap-autoloader )
+        Rails.application.config.assets.precompile += %w( stimulus )
       end
     end
   end

data/lib/stimulus/version.rb

@@ -1,3 +1,3 @@
 module Stimulus
-  VERSION = "0.3.9"
+  VERSION = "0.4.1"
 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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Stephenson
 - Javan Mahkmali
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,7 +26,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description:
+description: 
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -39,10 +39,14 @@ files:
 - app/assets/javascripts/stimulus-importmap-autoloader.js
 - app/assets/javascripts/stimulus.js
 - 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
@@ -53,7 +57,7 @@ licenses:
 metadata:
   homepage_uri: https://stimulus.hotwired.dev
   source_code_uri: https://github.com/hotwired/stimulus-rails
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A modest JavaScript framework for the HTML you already have.
 test_files: []

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,27 +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"
-  insert_into_file \
-    IMPORTMAP_PATH.to_s, 
-    %(  pin "@hotwired/stimulus", to: "stimulus.js"\n  pin "@hotwired/stimulus-importmap-autoloader", to: "stimulus-importmap-autoloader.js"\n  pin_all_from "app/javascript/controllers", under: "controllers"\n\n),
-    after: "Rails.application.config.importmap.draw do\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"