stimulus_reflex 3.5.0.rc1 → 3.5.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9e4f16a6c108abed76ee50881ec95b7595a8182092422eaec27a9ba32cfb3b6
-  data.tar.gz: 5f463ec6bedc1462e477714599f68a9c22479114af4284de427caac9144cf71c
+  metadata.gz: cce31cfe35841f8e96b70fe52e22ee84cf6aa287562b3ab6d1d0ee318fa109ee
+  data.tar.gz: 33e86551718a90441a3110e7daf72c110ecf42fcd73105d788ec508d92a30ca9
 SHA512:
-  metadata.gz: f05665f72b18c7cd0afee54fa099ec29df4e736fa83d8ec87756a3be80be3402d74d715cafa70b41092091794d2fc4a002e6998d676574365e5b756f53eaa6a0
-  data.tar.gz: f9d044f8d60a6154aab10ed680b51da5b6afc499d35a19a4eaefb233164519f74aef05e2583fe9f6194bf4989f6894a3065f3de164658ea9691da9df0dec030d
+  metadata.gz: a56cd9fcedd2859b3d9b828dbc0fc91c59e9b773ddb983a22ce23709bc443ab4cbd25270bfda366a4594767f08f9964af4fd30475307889eb6ab10ad187828f3
+  data.tar.gz: a5f3a462fe156023852d2db3911040436034c3fe54e3716aeecad1fcf2aa0ef86484f04236f20fa75ae149a3530dad23d8935d71a8dd817da43084ce2d895c8a

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    stimulus_reflex (3.5.0.rc1)
+    stimulus_reflex (3.5.0.rc3)
       actioncable (>= 5.2, < 8)
       actionpack (>= 5.2, < 8)
       actionview (>= 5.2, < 8)
       activesupport (>= 5.2, < 8)
-      cable_ready (>= 5.0.0.rc1)
+      cable_ready (~> 5.0)
       nokogiri (~> 1.0)
       rack (>= 2, < 4)
       railties (>= 5.2, < 8)
@@ -82,26 +82,26 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     builder (3.2.4)
-    cable_ready (5.0.0.rc1)
+    cable_ready (5.0.1)
       actionpack (>= 5.2)
       actionview (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
       thread-local (>= 1.1.0)
-    concurrent-ruby (1.2.0)
+    concurrent-ruby (1.2.2)
     connection_pool (2.4.0)
     crass (1.0.6)
     date (3.3.3)
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    loofah (2.19.1)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     magic_frozen_string_literal (1.2.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
@@ -111,7 +111,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.17.0)
+    minitest (5.18.1)
     mocha (1.13.0)
     net-imap (0.3.4)
       date
@@ -123,16 +123,16 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.14.2-x86_64-darwin)
+    nokogiri (1.15.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    nokogiri (1.15.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
-    racc (1.6.2)
-    rack (2.2.6.4)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
       rack (>= 1.3)
     rails (7.0.4.2)
       actioncable (= 7.0.4.2)
@@ -148,11 +148,13 @@ GEM
       activesupport (= 7.0.4.2)
       bundler (>= 1.15.0)
       railties (= 7.0.4.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
     railties (7.0.4.2)
       actionpack (= 7.0.4.2)
       activesupport (= 7.0.4.2)
@@ -188,7 +190,7 @@ GEM
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.44.1)
       rubocop-performance (= 1.15.2)
-    thor (1.2.1)
+    thor (1.2.2)
     thread-local (1.1.0)
     timeout (0.3.2)
     tzinfo (2.0.6)
@@ -197,10 +199,11 @@ GEM
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -213,4 +216,4 @@ DEPENDENCIES
   stimulus_reflex!
 
 BUNDLED WITH
-   2.2.33
+   2.4.14

data/app/assets/javascripts/stimulus_reflex.js

@@ -608,8 +608,15 @@ class Reflex {
 
 const received = data => {
   if (!data.cableReady) return;
-  if (data.version.replace(".pre", "-pre") !== CableReady.version) {
-    if (Debug$1.enabled) console.error(`Reflex failed due to cable_ready gem/NPM package version mismatch. Package versions must match exactly.\nNote that if you are using pre-release builds, gems use the "x.y.z.preN" version format, while NPM packages use "x.y.z-preN".\n\ncable_ready gem: ${data.version}\ncable_ready NPM: ${CableReady.version}`);
+  if (data.version.replace(".pre", "-pre").replace(".rc", "-rc") !== CableReady.version) {
+    const mismatch = `CableReady failed to execute your reflex action due to a version mismatch between your gem and JavaScript version. Package versions must match exactly.\n\ncable_ready gem: ${data.version}\ncable_ready npm: ${CableReady.version}`;
+    console.error(mismatch);
+    if (Debug$1.enabled) {
+      CableReady.operations.stimulusReflexVersionMismatch({
+        text: mismatch,
+        level: "error"
+      });
+    }
     return;
   }
   let reflexOperations = [];
@@ -938,7 +945,7 @@ const extractDataAttributes = element => {
 
 var name = "stimulus_reflex";
 
-var version = "3.5.0-rc1";
+var version = "3.5.0-rc3";
 
 var description = "Build reactive applications with the Rails tooling you already know and love.";
 
@@ -988,7 +995,7 @@ var peerDependencies = {
 var dependencies = {
   "@hotwired/stimulus": "^3",
   "@rails/actioncable": "^6 || ^7",
-  cable_ready: "5.0.0-rc1"
+  cable_ready: "^5.0.0"
 };
 
 var devDependencies = {
@@ -1002,7 +1009,7 @@ var devDependencies = {
   "prettier-standard": "^16.4.1",
   rollup: "^3.19.1",
   "toastify-js": "^1.12.0",
-  vitepress: "^1.0.0-alpha.56"
+  vitepress: "^1.0.0-beta.1"
 };
 
 var packageInfo = {

data/app/assets/javascripts/stimulus_reflex.umd.js

@@ -562,8 +562,15 @@
   }
   const received = data => {
     if (!data.cableReady) return;
-    if (data.version.replace(".pre", "-pre") !== CableReady.version) {
-      if (Debug$1.enabled) console.error(`Reflex failed due to cable_ready gem/NPM package version mismatch. Package versions must match exactly.\nNote that if you are using pre-release builds, gems use the "x.y.z.preN" version format, while NPM packages use "x.y.z-preN".\n\ncable_ready gem: ${data.version}\ncable_ready NPM: ${CableReady.version}`);
+    if (data.version.replace(".pre", "-pre").replace(".rc", "-rc") !== CableReady.version) {
+      const mismatch = `CableReady failed to execute your reflex action due to a version mismatch between your gem and JavaScript version. Package versions must match exactly.\n\ncable_ready gem: ${data.version}\ncable_ready npm: ${CableReady.version}`;
+      console.error(mismatch);
+      if (Debug$1.enabled) {
+        CableReady.operations.stimulusReflexVersionMismatch({
+          text: mismatch,
+          level: "error"
+        });
+      }
       return;
     }
     let reflexOperations = [];
@@ -862,7 +869,7 @@
     return attrs;
   };
   var name = "stimulus_reflex";
-  var version = "3.5.0-rc1";
+  var version = "3.5.0-rc3";
   var description = "Build reactive applications with the Rails tooling you already know and love.";
   var keywords = [ "ruby", "rails", "websockets", "actioncable", "turbolinks", "reactive", "cable", "ujs", "ssr", "stimulus", "reflex", "stimulus_reflex", "dom", "morphdom" ];
   var homepage = "https://docs.stimulusreflex.com";
@@ -895,7 +902,7 @@
   var dependencies = {
     "@hotwired/stimulus": "^3",
     "@rails/actioncable": "^6 || ^7",
-    cable_ready: "5.0.0-rc1"
+    cable_ready: "^5.0.0"
   };
   var devDependencies = {
     "@open-wc/testing": "^3.1.7",
@@ -908,7 +915,7 @@
     "prettier-standard": "^16.4.1",
     rollup: "^3.19.1",
     "toastify-js": "^1.12.0",
-    vitepress: "^1.0.0-alpha.56"
+    vitepress: "^1.0.0-beta.1"
   };
   var packageInfo = {
     name: name,

data/app/channels/stimulus_reflex/channel.rb

@@ -27,7 +27,7 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
           reflex.logger&.error error_message
           reflex.broadcast_error data: data, error: "#{exception} #{exception.backtrace.first.split(":in ")[0] if Rails.env.development?}"
         else
-          unless exception.is_a?(StimulusReflex::Reflex::VersionMismatchError)
+          unless exception.is_a?(StimulusReflex::VersionMismatchError)
             StimulusReflex.config.logger.error error_message
           end
 

data/lib/generators/stimulus_reflex/stimulus_reflex_generator.rb

@@ -2,6 +2,7 @@
 
 require "rails/generators"
 require "stimulus_reflex/version"
+require "stimulus_reflex/installer"
 
 class StimulusReflexGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
@@ -13,33 +14,20 @@ class StimulusReflexGenerator < Rails::Generators::NamedBase
   def execute
     actions.map!(&:underscore)
 
-    cached_entrypoint = Rails.root.join("tmp/stimulus_reflex_installer/entrypoint")
-    if cached_entrypoint.exist?
-      entrypoint = File.read(cached_entrypoint)
-    else
-      entrypoint = [
-        Rails.root.join("app/javascript"),
-        Rails.root.join("app/frontend")
-      ].find(&:exist?) || "app/javascript"
-      puts "Where do JavaScript files live in your app? Our best guess is: \e[1#{entrypoint}\e[22m 🤔"
-      puts "Press enter to accept this, or type a different path."
-      print "> "
-      input = Rails.env.test? ? "tmp/app/javascript" : $stdin.gets.chomp
-      entrypoint = input unless input.blank?
-    end
+    reflex_entrypoint = Rails.env.test? ? "tmp/app/reflexes" : "app/reflexes"
+    reflex_src = "app/reflexes/%file_name%_reflex.rb.tt"
+    reflex_path = Rails.root.join(reflex_entrypoint, "#{file_name}_reflex.rb")
+
+    template(reflex_src, reflex_path) unless options[:skip_reflex]
 
     if !options[:skip_stimulus] && entrypoint.blank?
       puts "❌ You must specify a valid JavaScript entrypoint."
       exit
     end
 
-    reflex_entrypoint = Rails.env.test? ? "tmp/app/reflexes" : "app/reflexes"
-    reflex_src = "app/reflexes/%file_name%_reflex.rb.tt"
-    reflex_path = Rails.root.join(reflex_entrypoint, "#{file_name}_reflex.rb")
     stimulus_controller_src = "app/javascript/controllers/%file_name%_controller.js.tt"
     stimulus_controller_path = Rails.root.join(entrypoint, "controllers/#{file_name}_controller.js")
 
-    template(reflex_src, reflex_path) unless options[:skip_reflex]
     template(stimulus_controller_src, stimulus_controller_path) unless options[:skip_stimulus]
 
     if file_name == "example"

data/lib/generators/stimulus_reflex/templates/app/javascript/config/cable_ready.js.tt

@@ -1,4 +1,8 @@
-import consumer from '../channels/consumer'
-import CableReady from 'cable_ready'
+<%- if bundler.importmap? -%>
+import consumer from "channels/consumer"
+<%- else -%>
+import consumer from "../channels/consumer"
+<%- end -%>
+import CableReady from "cable_ready"
 
 CableReady.initialize({ consumer })

data/lib/generators/stimulus_reflex/templates/app/javascript/config/index.js.tt

@@ -1,2 +1,7 @@
-import './cable_ready'
-import './stimulus_reflex'
+<%- if bundler.importmap? -%>
+import "config/cable_ready"
+import "config/stimulus_reflex"
+<%- else -%>
+import "./cable_ready"
+import "./stimulus_reflex"
+<%- end -%>

data/lib/generators/stimulus_reflex/templates/app/javascript/config/stimulus_reflex.js.tt

@@ -1,5 +1,10 @@
+<%- if bundler.importmap? -%>
+import { application } from "controllers/application"
+import controller from "controllers/application_controller"
+<%- else -%>
 import { application } from "../controllers/application"
 import controller from "../controllers/application_controller"
+<%- end -%>
 import StimulusReflex from "stimulus_reflex"
 
 StimulusReflex.initialize(application, { controller, isolate: true })

data/lib/generators/stimulus_reflex/templates/app/javascript/controllers/%file_name%_controller.js.tt

@@ -1,7 +1,11 @@
-import ApplicationController from './application_controller'
+<%- if bundler.importmap? -%>
+import ApplicationController from "controllers/application_controller"
+<%- else -%>
+import ApplicationController from "./application_controller"
+<%- end -%>
 
 <%- if class_name == "Example" -%>
-// 
+//
 // This is the Stimulus controller for the Example Reflex.
 //
 // It corresponds to the server-side Reflex class located at /app/reflexes/example.rb

data/lib/generators/stimulus_reflex/templates/app/javascript/controllers/application.js.tt

@@ -1,11 +1,15 @@
 import { Application } from "@hotwired/stimulus"
+<%- if bundler.importmap? %>
+import consumer from "channels/consumer"
+<%- else %>
 import consumer from "../channels/consumer"
+<%- end %>
 
 const application = Application.start()
 
 // Configure Stimulus development experience
 application.debug = false
 application.consumer = consumer
-window.Stimulus   = application
+window.Stimulus = application
 
 export { application }

data/lib/generators/stimulus_reflex/templates/app/javascript/controllers/index.js.importmap.tt

@@ -1,5 +1,11 @@
-import { application } from "./application"
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
 
 // Eager load all controllers defined in the import map under controllers/**/*_controller
 import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
 eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/lib/install/config.rb

@@ -20,7 +20,7 @@ if index_path.exist?
   say "⏩ #{friendly_index_path} already exists. Skipping"
 else
   backup(index_path, delete: true) do
-    copy_file(index_src, index_path)
+    template(index_src, index_path)
   end
   say "✅ Created #{friendly_index_path}"
 end
@@ -50,22 +50,22 @@ else
 end
 
 # create entrypoint/config/cable_ready.js and make sure it's imported in application.js
-copy_file(cable_ready_src, cable_ready_path) unless cable_ready_path.exist?
+template(cable_ready_src, cable_ready_path) unless cable_ready_path.exist?
 
 # create entrypoint/config/stimulus_reflex.js and make sure it's imported in application.js
-copy_file(stimulus_reflex_src, stimulus_reflex_path) unless stimulus_reflex_path.exist?
+template(stimulus_reflex_src, stimulus_reflex_path) unless stimulus_reflex_path.exist?
 
 if stimulus_reflex_path.read.include?("StimulusReflex.debug =")
   say "⏩ Development environment options are already set in #{friendly_stimulus_reflex_path}. Skipping"
 else
-  if ["webpacker", "shakapacker"].include?(bundler)
+  if bundler.webpacker? || bundler.shakapacker?
     append_file(stimulus_reflex_path, <<~JS, verbose: false)
 
       if (process.env.RAILS_ENV === 'development') {
         StimulusReflex.debug = true
       }
     JS
-  elsif bundler == "vite"
+  elsif bundler.vite?
     append_file(stimulus_reflex_path, <<~JS, verbose: false) unless stimulus_reflex_path.read.include?("StimulusReflex.debug")
 
       if (import.meta.env.MODE === "development") {

data/lib/install/esbuild.rb

@@ -5,7 +5,7 @@ require "stimulus_reflex/installer"
 return if pack_path_missing?
 
 # verify that all critical dependencies are up to date; if not, queue for later
-lines = package_json.readlines
+lines = package_json_path.readlines
 
 if !lines.index { |line| line =~ /^\s*["']esbuild-rails["']: ["']\^1.0.3["']/ }
   add_package "esbuild-rails@^1.0.3"

data/lib/install/importmap.rb

@@ -104,12 +104,12 @@ backup(application_js_path) do
     if application_js_path.read.include?("import consumer")
       say "⏩ #{friendly_application_js_path} is present. Skipping."
     else
-      inject_into_file application_js_path, "import consumer from \"../channels/consumer\"\n", after: "import { Application } from \"@hotwired/stimulus\"\n", verbose: false
+      inject_into_file application_js_path, "import consumer from \"channels/consumer\"\n", after: "import { Application } from \"@hotwired/stimulus\"\n", verbose: false
       inject_into_file application_js_path, "application.consumer = consumer\n", after: "application.debug = false\n", verbose: false
       say "✅ #{friendly_application_js_path} has been updated to import the Action Cable consumer"
     end
   else
-    copy_file(application_js_src, application_js_path)
+    template(application_js_src, application_js_path)
     say "✅ #{friendly_application_js_path} has been created"
   end
 end

data/lib/install/mrujs.rb

@@ -17,7 +17,7 @@ if !File.exist?(mrujs_path)
 end
 
 if proceed
-  if bundler == "importmap"
+  if bundler.importmap?
 
     if !importmap_path.exist?
       halt "#{friendly_importmap_path} is missing. You need a valid importmap config file to proceed."
@@ -45,14 +45,14 @@ if proceed
     end
   else
     # queue mrujs for installation
-    if package_json.read.include?('"mrujs":')
+    if package_json_path.read.include?('"mrujs":')
       say "⏩ mrujs already present. Skipping."
     else
       add_package "mrujs@^0.10.1"
     end
 
     # queue @rails/ujs for removal
-    if package_json.read.include?('"@rails/ujs":')
+    if package_json_path.read.include?('"@rails/ujs":')
       drop_package "@rails/ujs"
     else
       say "⏩ @rails/ujs not present. Skipping."
@@ -70,10 +70,15 @@ if proceed
   index = index_path.read
   friendly_index_path = index_path.relative_path_from(Rails.root).to_s
   mrujs_pattern = /import ['"].\/mrujs['"]/
-  mrujs_import = "import '.\/mrujs'\n" # standard:disable Style/RedundantStringEscape
+
+  mrujs_import = if bundler.importmap?
+    %(import "config/mrujs"\n)
+  else
+    %(import "./mrujs"\n)
+  end
 
   if index.match?(mrujs_pattern)
-    say "⏩ mrujs alredy imported in #{friendly_index_path}. Skipping."
+    say "⏩ mrujs already imported in #{friendly_index_path}. Skipping."
   else
     append_file(index_path, mrujs_import, verbose: false)
     say "✅ mrujs imported in #{friendly_index_path}"

data/lib/install/npm_packages.rb

@@ -2,7 +2,7 @@
 
 require "stimulus_reflex/installer"
 
-lines = package_json.readlines
+lines = package_json_path.readlines
 
 if !lines.index { |line| line =~ /^\s*["']cable_ready["']: ["'].*#{cr_npm_version}["']/ }
   add_package "cable_ready@#{cr_npm_version}"

data/lib/install/shakapacker.rb

@@ -5,7 +5,7 @@ require "stimulus_reflex/installer"
 return if pack_path_missing?
 
 # verify that all critical dependencies are up to date; if not, queue for later
-lines = package_json.readlines
+lines = package_json_path.readlines
 
 if !lines.index { |line| line =~ /^\s*["']@hotwired\/stimulus-webpack-helpers["']: ["']\^1.0.1["']/ }
   add_package "@hotwired/stimulus-webpack-helpers@^1.0.1"

data/lib/install/vite.rb

@@ -5,7 +5,7 @@ require "stimulus_reflex/installer"
 return if pack_path_missing?
 
 # verify that all critical dependencies are up to date; if not, queue for later
-lines = package_json.readlines
+lines = package_json_path.readlines
 
 if !lines.index { |line| line =~ /^\s*["']stimulus-vite-helpers["']: ["']\^3["']/ }
   add_package "stimulus-vite-helpers@^3"

data/lib/install/webpacker.rb

@@ -5,7 +5,7 @@ require "stimulus_reflex/installer"
 return if pack_path_missing?
 
 # verify that all critical dependencies are up to date; if not, queue for later
-lines = package_json.readlines
+lines = package_json_path.readlines
 if !lines.index { |line| line =~ /^\s*["']webpack["']: ["']\^4.46.0["']/ }
   add_package "webpack@^4.46.0"
 else

data/lib/install/yarn.rb

@@ -2,7 +2,7 @@
 
 require "stimulus_reflex/installer"
 
-if !package_json.exist?
+if !package_json_path.exist?
   say "⏩ No package.json file found. Skipping."
 
   return
@@ -36,7 +36,7 @@ if add.present? || dev.present? || drop.present?
     json["devDependencies"].delete(package)
   end
 
-  package_json.write JSON.pretty_generate(json)
+  package_json_path.write JSON.pretty_generate(json)
 
   system "yarn install --silent"
 else
@@ -46,7 +46,7 @@ end
 if bundler == "esbuild" && json["scripts"]["build"] != "node esbuild.config.mjs"
   json["scripts"]["build:default"] = json["scripts"]["build"]
   json["scripts"]["build"] = "node esbuild.config.mjs"
-  package_json.write JSON.pretty_generate(json)
+  package_json_path.write JSON.pretty_generate(json)
   say "✅ Your yarn build script has been updated to use esbuild.config.mjs"
 else
   say "⏩ Your yarn build script is already setup. Skipping."

data/lib/stimulus_reflex/cable_readiness.rb

@@ -1,14 +1,8 @@
 # frozen_string_literal: true
 
-require "active_support/concern"
-
 module StimulusReflex
   module CableReadiness
-    extend ActiveSupport::Concern
-
-    prepended do
-      attr_reader :cable_ready
-    end
+    attr_reader :cable_ready
 
     def initialize(*args, **kwargs)
       super(*args, **kwargs)