stimulus-rails 0.2.4 → 0.6.0

data/lib/generators/stimulus/USAGE

@@ -0,0 +1,15 @@
+Description:
+============
+    Generates a new Stimulus controller at the passed path. If running under node,
+    it'll also call the stimulus:manifest:update task to update the controllers/index.js.
+
+Examples:
+=========
+    bin/rails generate stimulus chat
+
+    creates: app/javascript/controllers/chat_controller.js
+
+
+    bin/rails generate stimulus nested/chat
+
+    creates: app/javascript/controllers/nested/chat_controller.js

data/lib/generators/stimulus/stimulus_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators/named_base"
+
+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?
+  end
+
+  private
+    def stimulus_attribute_value(name)
+      name.gsub(/\//, "--")
+    end
+end

data/lib/generators/stimulus/templates/controller.js.tt

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+// Connects to data-controller="<%= @attribute %>"
+export default class extends Controller {
+  connect() {
+  }
+}

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

@@ -0,0 +1,10 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.warnings = true
+application.debug    = false
+window.Stimulus      = application
+
+export { application }

data/lib/install/app/{assets/javascripts → javascript}/controllers/hello_controller.js

@@ -1,4 +1,4 @@
-import { Controller } from "stimulus"
+import { Controller } from "@hotwired/stimulus"
 
 export default class extends Controller {
   connect() {

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

@@ -0,0 +1,5 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+import { registerControllersFrom } from "@hotwired/stimulus-importmap-autoloader"
+registerControllersFrom("controllers", application)

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

@@ -0,0 +1,7 @@
+// This file is auto-generated by ./bin/rails stimulus:manifest:update
+// Run that command whenever you add a new controller
+
+import { application } from "./application"
+
+import HelloController from "./hello_controller"
+application.register("hello", HelloController)

data/lib/install/stimulus_with_importmap.rb

@@ -0,0 +1,19 @@
+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/application.js",
+  "app/javascript/controllers/application.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,18 @@
+say "Create controllers directory"
+empty_directory "app/javascript/controllers"
+copy_file "#{__dir__}/app/javascript/controllers/index_for_node.js",
+  "app/javascript/controllers/index.js"
+copy_file "#{__dir__}/app/javascript/controllers/application.js",
+  "app/javascript/controllers/application.js"
+copy_file "#{__dir__}/app/javascript/controllers/hello_controller.js",
+  "app/javascript/controllers/hello_controller.js"
+
+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
+end
+
+say "Install Stimulus"
+run "yarn add @hotwired/stimulus"

data/lib/stimulus/engine.rb

@@ -1,24 +1,8 @@
-require "stimulus/importmap_helper"
-
 module Stimulus
   class Engine < ::Rails::Engine
-    config.autoload_once_paths = %w( #{root}/app/helpers )
-
     initializer "stimulus.assets" do
       if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( importmap.json stimulus/manifest )
-      end
-    end
-
-    initializer "stimulus.helpers" do
-      ActiveSupport.on_load(:action_controller_base) do
-        helper Stimulus::StimulusHelper
-      end
-
-      if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.configure do |env|
-          env.context_class.class_eval { include Stimulus::ImportmapHelper }
-        end
+        Rails.application.config.assets.precompile += %w( stimulus )
       end
     end
   end

data/lib/stimulus/manifest.rb

@@ -0,0 +1,27 @@
+module Stimulus::Manifest
+  extend self
+
+  def generate_from(controllers_path)
+    extract_controllers_from(controllers_path).collect do |controller_path|
+      import_and_register_controller(controllers_path, controller_path)
+    end
+  end
+
+  def import_and_register_controller(controllers_path, controller_path)
+    module_path = controller_path.relative_path_from(controllers_path).to_s.remove(".js")
+    controller_class_name = module_path.camelize.gsub(/::/, "__")
+    tag_name = module_path.remove("_controller").gsub(/_/, "-").gsub(/\//, "--")
+
+    <<-JS
+
+import #{controller_class_name} from "./#{module_path}"
+application.register("#{tag_name}", #{controller_class_name})
+    JS
+  end
+
+  def extract_controllers_from(directory)
+    (directory.children.select { |e| e.to_s =~ /_controller.js$/ } +
+      directory.children.select(&:directory?).collect { |d| extract_controllers_from(d) }
+    ).flatten.sort
+  end
+end

data/lib/stimulus/version.rb

@@ -1,3 +1,3 @@
 module Stimulus
-  VERSION = "0.2.4"
+  VERSION = "0.6.0"
 end

data/lib/tasks/stimulus_tasks.rake

@@ -1,24 +1,47 @@
+require "stimulus/manifest"
+
 def run_stimulus_install_template(path) system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/#{path}.rb",  __dir__)}" end
 
 namespace :stimulus do
   desc "Install Stimulus into the app"
   task :install do
-    if defined?(Webpacker::Engine)
-      Rake::Task["stimulus:install:webpacker"].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
-      Rake::Task["stimulus:install:asset_pipeline"].invoke
+      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 an app running node"
+    task :node do
+      run_stimulus_install_template "stimulus_with_node"
     end
+  end
+
+  namespace :manifest do
+    task :display do
+      puts Stimulus::Manifest.generate_from(Rails.root.join("app/javascript/controllers"))
+    end
+
+    task :update do
+      manifest =
+        Stimulus::Manifest.generate_from(Rails.root.join("app/javascript/controllers"))
 
-    desc "Install Stimulus on the app with webpacker"
-    task :webpacker do
-      run_stimulus_install_template "stimulus_with_webpacker"
+      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
+        index.puts %(import { application } from "./application")
+        index.puts manifest
+      end
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Sam Stephenson
 - Javan Mahkmali
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2021-09-24 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: []
@@ -35,31 +35,30 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/stimulus/libraries/es-module-shims.js
-- app/assets/javascripts/stimulus/libraries/es-module-shims@0.7.1.js
-- app/assets/javascripts/stimulus/libraries/stimulus.js
-- app/assets/javascripts/stimulus/libraries/stimulus@2.js
-- app/assets/javascripts/stimulus/loaders/autoloader.js
-- app/assets/javascripts/stimulus/manifest.js
-- app/helpers/stimulus/stimulus_helper.rb
-- lib/install/app/assets/javascripts/controllers/hello_controller.js
-- lib/install/app/assets/javascripts/controllers/index.js
-- lib/install/app/assets/javascripts/importmap.json.erb
-- lib/install/application.js
-- lib/install/stimulus_with_asset_pipeline.rb
-- lib/install/stimulus_with_webpacker.rb
+- app/assets/javascripts/stimulus-autoloader.js
+- app/assets/javascripts/stimulus-importmap-autoloader.js
+- app/assets/javascripts/stimulus.js
+- lib/generators/stimulus/USAGE
+- lib/generators/stimulus/stimulus_generator.rb
+- lib/generators/stimulus/templates/controller.js.tt
+- lib/install/app/javascript/controllers/application.js
+- lib/install/app/javascript/controllers/hello_controller.js
+- lib/install/app/javascript/controllers/index_for_importmap.js
+- lib/install/app/javascript/controllers/index_for_node.js
+- lib/install/stimulus_with_importmap.rb
+- lib/install/stimulus_with_node.rb
 - lib/stimulus-rails.rb
 - lib/stimulus/engine.rb
-- lib/stimulus/importmap_helper.rb
+- lib/stimulus/manifest.rb
 - lib/stimulus/version.rb
 - lib/tasks/stimulus_tasks.rake
-homepage: https://stimulus.hotwire.dev
+homepage: https://stimulus.hotwired.dev
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://stimulus.hotwire.dev
+  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
@@ -75,7 +74,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/app/assets/javascripts/stimulus/libraries/es-module-shims.js

@@ -1 +0,0 @@
-//= require ./es-module-shims@0.7.1.js