hotwire-stimulus-rails 0.1.0

data/app/assets/javascripts/stimulus/loaders/autoloader.js

@@ -0,0 +1,21 @@
+import { Application } from "stimulus"
+
+const application = Application.start()
+
+function autoload() {
+  Array.from(document.querySelectorAll('[data-controller]')).forEach((element) => {
+    const controllerNames = element.attributes["data-controller"].value.split(" ")
+
+    controllerNames.forEach((controllerName) => {
+      let controllerFilename = `${controllerName}_controller`
+
+      import(controllerFilename).then((controllerModule) => {
+        application.register(controllerName, controllerModule.default)
+      }).catch(error => console.log(`Failed to autoload controller: ${controllerName}`))
+    })
+  })
+}
+
+autoload()
+
+window.addEventListener("turbo:load", autoload)

data/app/assets/javascripts/stimulus/loaders/preloader.js.erb

@@ -0,0 +1,20 @@
+// Experimental: Not currently exposed.
+import { Application } from "stimulus"
+
+const application = Application.start()
+
+async function preloadControllers() {
+  const imports = await fetch("<%= asset_path "importmap.json" %>").then(r => r.json()).then(json => json.imports)
+
+  for (const name in imports) {
+    if (name.startsWith("controllers/")) {
+      let controllerName = name.replace(/controllers\//, "").replace("_controller", "")
+
+      import(imports[name]).then((module) => {
+        application.register(controllerName, module.default)
+      }).catch(error => console.log(error))
+    }
+  }
+}
+
+preloadControllers()

data/app/assets/javascripts/stimulus/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ./libraries
+//= link_directory ./loaders

data/app/helpers/stimulus/stimulus_helper.rb

@@ -0,0 +1,10 @@
+module Stimulus::StimulusHelper
+  def stimulus_include_tags
+    [
+      javascript_include_tag("stimulus/libraries/es-module-shims", type: "module"),
+      tag.script(type: "importmap-shim", src: asset_path("importmap.json")),
+      javascript_include_tag("stimulus/libraries/stimulus", type: "module-shim"),
+      javascript_include_tag("stimulus/loaders/autoloader", type: "module-shim")
+    ].join("\n").html_safe
+  end
+end

data/lib/hotwire-stimulus-rails.rb

@@ -0,0 +1,5 @@
+require "stimulus/version"
+require "stimulus/engine"
+
+module Stimulus
+end

data/lib/install/app/assets/javascripts/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.element.textContent = "Hello World!"
+  }
+}

data/lib/install/app/assets/javascripts/importmap.json.erb

@@ -0,0 +1,5 @@
+{
+  "imports": { 
+    <%= importmap_list_with_stimulus_from "app/assets/javascripts/controllers", "app/assets/javascripts/libraries" %>
+  }
+}

data/lib/install/stimulus.rb

@@ -0,0 +1,16 @@
+say "Copying Stimulus JavaScript"
+directory "#{__dir__}/app/assets/javascripts", "app/assets/javascripts"
+empty_directory "app/assets/javascripts/libraries"
+
+say "Add app/javascripts to asset pipeline manifest"
+append_to_file Rails.root.join("app/assets/config/manifest.js").to_s, "//= link_tree ../javascripts\n"
+
+say "Add Stimulus include tags in application layout"
+insert_into_file Rails.root.join("app/views/layouts/application.html.erb").to_s, "\n    <%= stimulus_include_tags %>", before: /\s*<\/head>/
+
+say "Turn off development debug mode"
+comment_lines Rails.root.join("config/environments/development.rb"), /config.assets.debug = true/
+
+say "Turn off rack-mini-profiler"
+comment_lines Rails.root.join("Gemfile"), /rack-mini-profiler/
+run "bin/bundle", capture: true

data/lib/stimulus/engine.rb

@@ -0,0 +1,22 @@
+require "stimulus/importmap_helper"
+
+module Stimulus
+  class Engine < ::Rails::Engine
+    isolate_namespace Stimulus
+    config.eager_load_namespaces << Stimulus
+
+    initializer "stimulus.assets" do
+      Rails.application.config.assets.precompile += %w( importmap.json stimulus/manifest )
+    end
+
+    initializer "stimulus.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper Stimulus::Engine.helpers
+      end
+
+      Rails.application.config.assets.configure do |env|
+        env.context_class.class_eval { include Stimulus::ImportmapHelper }
+      end
+    end
+  end
+end

data/lib/stimulus/importmap_helper.rb

@@ -0,0 +1,23 @@
+module Stimulus::ImportmapHelper
+  def importmap_list_with_stimulus_from(*paths)
+    [ %("stimulus": "#{asset_path("stimulus/libraries/stimulus")}"), importmap_list_from(*paths) ].join(",\n")
+  end
+
+  def importmap_list_from(*paths)
+    Array(paths).flat_map do |path|
+      absolute_path = Rails.root.join(path)
+      dirname       = absolute_path.basename.to_s
+
+      absolute_path.children.collect do |module_filename|
+        module_name = importmap_module_name_from(module_filename)
+        %("#{module_name}": "#{asset_path("#{dirname}/#{module_filename.basename}")}")
+      end
+    end.join(",\n")
+  end
+
+  private
+    # Strip off the extension and any versioning data for an absolute module name.
+    def importmap_module_name_from(filename)
+      filename.basename.to_s.remove(filename.extname).split("@").first
+    end
+end

data/lib/stimulus/version.rb

@@ -0,0 +1,3 @@
+module Stimulus
+  VERSION = "0.1.0"
+end

data/lib/tasks/stimulus_tasks.rake

@@ -0,0 +1,6 @@
+namespace :stimulus do
+  desc "Install Stimulus into the app"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/stimulus.rb", __dir__)}"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: hotwire-stimulus-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Stephenson
+- Javan Mahkmali
+- David Heinemeier Hansson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description:
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/loaders/preloader.js.erb
+- app/assets/javascripts/stimulus/manifest.js
+- app/helpers/stimulus/stimulus_helper.rb
+- lib/hotwire-stimulus-rails.rb
+- lib/install/app/assets/javascripts/controllers/hello_controller.js
+- lib/install/app/assets/javascripts/importmap.json.erb
+- lib/install/stimulus.rb
+- lib/stimulus/engine.rb
+- lib/stimulus/importmap_helper.rb
+- lib/stimulus/version.rb
+- lib/tasks/stimulus_tasks.rake
+homepage: https://stimulus.hotwire.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://stimulus.hotwire.dev
+  source_code_uri: https://github.com/hotwired/stimulus-rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A modest JavaScript framework for the HTML you already have.
+test_files: []