stimulus-rails 0.4.0 → 0.5.1

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/javascript/controllers/index_for_importmap.js

@@ -1,13 +1,5 @@
-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 { application } from "controllers/application"
 import { registerControllersFrom } from "@hotwired/stimulus-importmap-autoloader"
-const importmap = JSON.parse(document.querySelector("script[type=importmap]").text).imports
-registerControllersFrom("controllers", importmap, application)
+registerControllersFrom("controllers", application)

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

@@ -1,12 +1,7 @@
-import { Application } from "@hotwired/stimulus"
+// This file is auto-generated by ./bin/rails stimulus:manifest:update
+// Run that command whenever you add a new controller
 
-const application = Application.start()
+import { application } from "./application"
 
-// 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/stimulus_with_importmap.rb

@@ -2,11 +2,13 @@ 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)
+append_to_file "app/javascript/application.js", %(import "controllers"\n)
 
 say "Pin Stimulus"
 append_to_file "config/importmap.rb" do <<-RUBY

data/lib/install/stimulus_with_node.rb

@@ -1,19 +1,18 @@
 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/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"
 
-say "Import Stimulus controllers"
-append_to_file "app/javascript/application.js", %(import "./controllers"\n)
+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/manifest.rb

@@ -0,0 +1,23 @@
+module Stimulus::Manifest
+  extend self
+
+  def generate_from(controllers_path)
+    extract_controllers_from(controllers_path).collect do |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(/\//, "--")
+  
+      <<-JS
+
+import #{controller_class_name} from "./#{module_path}"
+application.register("#{tag_name}", #{controller_class_name})
+      JS
+    end
+  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
+  end
+end

data/lib/stimulus/version.rb

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

data/lib/tasks/stimulus_tasks.rake

@@ -1,3 +1,5 @@
+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
@@ -23,4 +25,23 @@ namespace :stimulus 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"))
+
+      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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,15 +40,19 @@ files:
 - app/assets/javascripts/stimulus.js
 - app/assets/javascripts/stimulus@2.js
 - app/assets/javascripts/stimulus@3.0.0-beta.1.js
+- app/assets/javascripts/stimulus@3.0.0-beta.2.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/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/manifest.rb
 - lib/stimulus/version.rb
 - lib/tasks/stimulus_tasks.rake
 homepage: https://stimulus.hotwired.dev

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

@@ -1,14 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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"