stimulus_reflex 3.5.0.rc2 → 3.5.0.rc4

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
@@ -13,7 +13,7 @@ add = package_list.exist? ? package_list.readlines.map(&:chomp) : []
 dev = dev_package_list.exist? ? dev_package_list.readlines.map(&:chomp) : []
 drop = drop_package_list.exist? ? drop_package_list.readlines.map(&:chomp) : []
 
-json = JSON.parse(package_json.read)
+json = JSON.parse(package_json_path.read)
 
 if add.present? || dev.present? || drop.present?
 
@@ -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)

data/lib/stimulus_reflex/installer.rb

@@ -101,24 +101,105 @@ def cr_npm_version
   @cr_npm_version ||= CableReady::VERSION.gsub(".pre", "-pre").gsub(".rc", "-rc")
 end
 
-def package_json
-  @package_json ||= Rails.root.join("package.json")
+def package_json_path
+  @package_json_path ||= Rails.root.join("package.json")
+end
+
+def installer_entrypoint_path
+  create_dir_for_file_if_not_exists("tmp/stimulus_reflex_installer/entrypoint")
 end
 
 def entrypoint
-  @entrypoint ||= File.read("tmp/stimulus_reflex_installer/entrypoint")
+  path = installer_entrypoint_path
+  @entrypoint ||= File.exist?(path) ? File.read(path) : auto_detect_entrypoint
+end
+
+def auto_detect_entrypoint
+  entrypoint = [
+    "app/javascript",
+    "app/frontend",
+    "app/client",
+    "app/webpack"
+  ].find { |path| File.exist?(Rails.root.join(path)) } || "app/javascript"
+
+  puts
+  puts "Where do JavaScript files live in your app? Our best guess is: \e[1m#{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?
+
+  File.write(installer_entrypoint_path, entrypoint)
+
+  entrypoint
+end
+
+def installer_bundler_path
+  create_dir_for_file_if_not_exists("tmp/stimulus_reflex_installer/bundler")
 end
 
 def bundler
-  @bundler ||= File.read("tmp/stimulus_reflex_installer/bundler")
+  path = installer_bundler_path
+  @bundler ||= File.exist?(path) ? File.read(path) : auto_detect_bundler
+
+  @bundler.inquiry
+end
+
+def auto_detect_bundler
+  # auto-detect build tool based on existing packages and configuration
+  if importmap_path.exist?
+    bundler = "importmap"
+  elsif package_json_path.exist?
+    package_json = package_json_path.read
+
+    bundler = "webpacker" if package_json.include?('"@rails/webpacker":')
+    bundler = "esbuild" if package_json.include?('"esbuild":')
+    bundler = "vite" if package_json.include?('"vite":')
+    bundler = "shakapacker" if package_json.include?('"shakapacker":')
+
+    if !bundler
+      puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use StimulusReflex."
+      exit
+    end
+  else
+    puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use StimulusReflex."
+    exit
+  end
+
+  puts
+  puts "It looks like you're using \e[1m#{bundler}\e[22m as your bundler. Is that correct? (Y/n)"
+  print "> "
+
+  input = $stdin.gets.chomp
+
+  if input.downcase == "n"
+    puts
+    puts "StimulusReflex installation supports: esbuild, webpacker, vite, shakapacker and importmap."
+    puts "Please run \e[1;94mrails stimulus_reflex:install [bundler]\e[0m to install StimulusReflex and CableReady."
+    exit
+  end
+
+  File.write(installer_bundler_path, bundler)
+
+  bundler
 end
 
-def network_issue_path
-  @network_issue_path ||= Rails.root.join("tmp/stimulus_reflex_installer/network_issue")
+def create_dir_if_not_exists(dir_path)
+  FileUtils.mkdir_p(dir_path)
+
+  Pathname.new(dir_path)
+end
+
+def create_dir_for_file_if_not_exists(file_path)
+  dir_path = File.dirname(file_path)
+  create_dir_if_not_exists(dir_path)
+
+  Pathname.new(file_path)
 end
 
 def config_path
-  @config_path ||= Rails.root.join(entrypoint, "config")
+  @config_path ||= create_dir_if_not_exists(Rails.root.join(entrypoint, "config"))
 end
 
 def importmap_path

data/lib/stimulus_reflex/reflex.rb

@@ -3,20 +3,6 @@
 require "stimulus_reflex/cable_readiness"
 require "stimulus_reflex/version_checker"
 
-# TODO remove xpath_controller and xpath_element for v4
-ClientAttributes = Struct.new(
-  :id,
-  :tab_id,
-  :reflex_controller,
-  :xpath_controller,
-  :xpath_element,
-  :permanent_attribute_name,
-  :version,
-  :npm_version,
-  :suppress_logging,
-  keyword_init: true
-)
-
 class StimulusReflex::Reflex
   prepend StimulusReflex::CableReadiness
   include StimulusReflex::VersionChecker
@@ -26,32 +12,27 @@ class StimulusReflex::Reflex
   include CableReady::Identifiable
 
   attr_accessor :payload, :headers
-  attr_reader :channel, :url, :element, :selectors, :method_name, :broadcaster, :client_attributes, :logger
-
-  alias_method :action_name, :method_name # for compatibility with controller libraries like Pundit that expect an action name
+  attr_reader :channel, :reflex_data, :broadcaster
 
   delegate :connection, :stream_name, to: :channel
   delegate :controller_class, :flash, :session, to: :request
   delegate :broadcast, :broadcast_halt, :broadcast_forbid, :broadcast_error, to: :broadcaster
+
   # TODO remove xpath_controller and xpath_element for v4
-  delegate :id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, :version, :npm_version, :suppress_logging, to: :client_attributes
+  delegate :url, :element, :selectors, :method_name, :id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, :version, :npm_version, :suppress_logging, to: :reflex_data
+  # END TODO: remove
 
-  def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {}, client_attributes: {})
+  alias_method :action_name, :method_name # for compatibility with controller libraries like Pundit that expect an action name
+  alias_method :data, :reflex_data
+
+  def initialize(channel, reflex_data:)
     @channel = channel
-    @url = url
-    @element = element
-    @selectors = selectors
-    @method_name = method_name
-    @params = params
-    @client_attributes = ClientAttributes.new(client_attributes)
+    @reflex_data = reflex_data
     @broadcaster = StimulusReflex::PageBroadcaster.new(self)
-    @logger = suppress_logging ? nil : StimulusReflex::Logger.new(self)
     @payload = {}
     @headers = {}
 
     check_version!
-
-    self.params
   end
 
   # TODO: remove this for v4
@@ -61,6 +42,10 @@ class StimulusReflex::Reflex
   end
   # END TODO: remove
 
+  def logger
+    @logger ||= StimulusReflex::Logger.new(self) unless suppress_logging
+  end
+
   def request
     @request ||= begin
       uri = URI.parse(url)
@@ -91,7 +76,7 @@ class StimulusReflex::Reflex
       req = ActionDispatch::Request.new(env)
 
       # fetch path params (controller, action, ...) and apply them
-      request_params = StimulusReflex::RequestParameters.new(params: @params, req: req, url: url)
+      request_params = StimulusReflex::RequestParameters.new(params: reflex_data.params, req: req, url: url)
       req = request_params.apply!
 
       req

data/lib/stimulus_reflex/reflex_data.rb

@@ -4,7 +4,7 @@ class StimulusReflex::ReflexData
   attr_reader :data
 
   def initialize(data)
-    @data = data
+    @data = data.deep_merge(data.deep_transform_keys { |k| k.to_s.underscore }).with_indifferent_access
   end
 
   def reflex_name
@@ -14,13 +14,13 @@ class StimulusReflex::ReflexData
   end
 
   def selectors
-    selectors = (data["selectors"] || []).select(&:present?)
-    selectors = data["selectors"] = ["body"] if selectors.blank?
+    selectors = (data[:selectors] || []).select(&:present?)
+    selectors = data[:selectors] = ["body"] if selectors.blank?
     selectors
   end
 
   def target
-    data["target"].to_s
+    data[:target].to_s
   end
 
   def method_name
@@ -28,11 +28,11 @@ class StimulusReflex::ReflexData
   end
 
   def arguments
-    (data["args"] || []).map { |arg| object_with_indifferent_access arg } || []
+    (data[:args] || []).map { |arg| object_with_indifferent_access arg } || []
   end
 
   def url
-    data["url"].to_s
+    data[:url].to_s
   end
 
   def element
@@ -40,15 +40,15 @@ class StimulusReflex::ReflexData
   end
 
   def permanent_attribute_name
-    data["permanentAttributeName"]
+    data[:permanent_attribute_name]
   end
 
   def suppress_logging
-    data["suppressLogging"]
+    data[:suppress_logging]
   end
 
   def form_data
-    Rack::Utils.parse_nested_query(data["formData"])
+    Rack::Utils.parse_nested_query(data[:form_data])
   end
 
   def params
@@ -56,7 +56,7 @@ class StimulusReflex::ReflexData
   end
 
   def form_params
-    form_data.deep_merge(data["params"] || {})
+    form_data.deep_merge(data[:params] || {})
   end
 
   def url_params
@@ -64,33 +64,33 @@ class StimulusReflex::ReflexData
   end
 
   def id
-    data["id"]
+    data[:id]
   end
 
   def tab_id
-    data["tabId"]
+    data[:tab_id]
   end
 
   # TODO: remove this in v4
   def xpath_controller
-    data["xpathController"]
+    data[:xpath_controller]
   end
 
   def xpath_element
-    data["xpathElement"]
+    data[:xpath_element]
   end
   # END TODO remove
 
   def reflex_controller
-    data["reflexController"]
+    data[:reflex_controller]
   end
 
   def npm_version
-    data["version"].to_s
+    data[:version].to_s
   end
 
   def version
-    data["version"].to_s.gsub("-pre", ".pre").gsub("-rc", ".rc")
+    npm_version.gsub("-pre", ".pre").gsub("-rc", ".rc")
   end
 
   private

data/lib/stimulus_reflex/reflex_factory.rb

@@ -1,36 +1,59 @@
 # frozen_string_literal: true
 
 class StimulusReflex::ReflexFactory
-  class << self
-    attr_reader :reflex_data
-
-    def create_reflex_from_data(channel, reflex_data)
-      @reflex_data = reflex_data
-      reflex_class.new(channel,
-        url: reflex_data.url,
-        element: reflex_data.element,
-        selectors: reflex_data.selectors,
-        method_name: reflex_data.method_name,
-        params: reflex_data.params,
-        client_attributes: {
-          id: reflex_data.id,
-          tab_id: reflex_data.tab_id,
-          xpath_controller: reflex_data.xpath_controller,
-          xpath_element: reflex_data.xpath_element,
-          reflex_controller: reflex_data.reflex_controller,
-          permanent_attribute_name: reflex_data.permanent_attribute_name,
-          suppress_logging: reflex_data.suppress_logging,
-          version: reflex_data.version,
-          npm_version: reflex_data.npm_version
-        })
+  attr_reader :channel, :data
+
+  delegate :reflex_name, :method_name, to: :data
+
+  def initialize(channel, data)
+    @channel = channel
+    @data = StimulusReflex::ReflexData.new(data)
+  end
+
+  def call
+    verify_method_name!
+    reflex_class.new(channel, reflex_data: data)
+  end
+
+  private
+
+  def verify_method_name!
+    return if default_reflex?
+
+    argument_error = ArgumentError.new("Reflex method '#{method_name}' is not defined on class '#{reflex_name}' or on any of its ancestors")
+
+    if reflex_method.nil?
+      raise argument_error
     end
 
-    def reflex_class
-      reflex_data.reflex_name.constantize.tap { |klass| raise ArgumentError.new("#{reflex_name} is not a StimulusReflex::Reflex") unless is_reflex?(klass) }
+    if !safe_ancestors.include?(reflex_method.owner)
+      raise argument_error
     end
+  end
 
-    def is_reflex?(klass)
-      klass.ancestors.include? StimulusReflex::Reflex
+  def reflex_class
+    @reflex_class ||= reflex_name.constantize.tap do |klass|
+      unless klass.ancestors.include?(StimulusReflex::Reflex)
+        raise ArgumentError.new("#{reflex_name} is not a StimulusReflex::Reflex")
+      end
     end
   end
+
+  def reflex_method
+    if reflex_class.public_instance_methods.include?(method_name.to_sym)
+      reflex_class.public_instance_method(method_name)
+    end
+  end
+
+  def default_reflex?
+    method_name == "default_reflex" && reflex_method.owner == ::StimulusReflex::Reflex
+  end
+
+  def safe_ancestors
+    # We want to include every class and module up to the `StimulusReflex::Reflex` class,
+    # but not the StimulusReflex::Reflex itself
+    reflex_class_index = reflex_class.ancestors.index(StimulusReflex::Reflex) - 1
+
+    reflex_class.ancestors.to(reflex_class_index)
+  end
 end

data/lib/stimulus_reflex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusReflex
-  VERSION = "3.5.0.rc2"
+  VERSION = "3.5.0.rc4"
 end

data/lib/tasks/stimulus_reflex/stimulus_reflex.rake

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "stimulus_reflex/installer"
+
 SR_STEPS = {
   "action_cable" => "Action Cable",
   "webpacker" => "Install StimulusReflex using Webpacker",
@@ -51,17 +53,18 @@ end
 namespace :stimulus_reflex do
   desc "✨ Install StimulusReflex and CableReady ✨"
   task :install do
-    FileUtils.mkdir_p(Rails.root.join("tmp/stimulus_reflex_installer/templates"))
-    FileUtils.mkdir_p(Rails.root.join("tmp/stimulus_reflex_installer/working"))
+    create_dir_if_not_exists(Rails.root.join("tmp/stimulus_reflex_installer/templates"))
+    create_dir_if_not_exists(Rails.root.join("tmp/stimulus_reflex_installer/working"))
+
     install_complete = Rails.root.join("tmp/stimulus_reflex_installer/complete")
 
-    bundler = nil
+    used_bundler = nil
     options = {}
 
     ARGV.each do |arg|
       # make sure we have a valid build tool specified, or proceed to automatic detection
       if ["webpacker", "esbuild", "vite", "shakapacker", "importmap"].include?(arg)
-        bundler = arg
+        used_bundler = arg
       else
         kv = arg.split("=")
         if kv.length == 2
@@ -90,9 +93,9 @@ namespace :stimulus_reflex do
     end
 
     # if there is an installation in progress, continue where we left off
-    cached_entrypoint = Rails.root.join("tmp/stimulus_reflex_installer/entrypoint")
-    if cached_entrypoint.exist?
-      entrypoint = File.read(cached_entrypoint)
+    if installer_entrypoint_path.exist?
+      entrypoint = installer_entrypoint_path.read
+
       puts "✨ Resuming \e[38;5;220mStimulusReflex\e[0m and \e[38;5;220mCableReady\e[0m installation ✨"
       puts
       puts "If you have any setup issues, please consult \e[4;97mhttps://docs.stimulusreflex.com/hello-world/setup\e[0m"
@@ -106,69 +109,35 @@ namespace :stimulus_reflex do
       puts
       puts "If you have any setup issues, please consult \e[4;97mhttps://docs.stimulusreflex.com/hello-world/setup\e[0m"
       puts "or get help on Discord: \e[4;97mhttps://discord.gg/stimulus-reflex\e[0m. \e[38;5;196mWe are here for you.\e[0m 💙"
+
       if Rails.root.join(".git").exist?
         puts
         puts "We recommend running \e[1;94mgit commit\e[0m before proceeding. A diff will be generated at the end."
       end
 
-      if options.key? "entrypoint"
-        entrypoint = options["entrypoint"]
+      entrypoint = if options.key? "entrypoint"
+        options["entrypoint"]
       else
-        entrypoint = [
-          "app/javascript",
-          "app/frontend"
-        ].find { |path| File.exist?(Rails.root.join(path)) } || "app/javascript"
-
-        puts
-        puts "Where do JavaScript files live in your app? Our best guess is: \e[1m#{entrypoint}\e[22m 🤔"
-        puts "Press enter to accept this, or type a different path."
-        print "> "
-        input = $stdin.gets.chomp
-        entrypoint = input unless input.blank?
+        auto_detect_entrypoint
       end
-      File.write(cached_entrypoint, entrypoint)
+
+      installer_entrypoint_path.write(entrypoint)
     end
 
     # verify their bundler before starting, unless they explicitly specified on CLI
-    if !bundler
-      # auto-detect build tool based on existing packages and configuration
-      if Rails.root.join("config/importmap.rb").exist?
-        bundler = "importmap"
-      elsif Rails.root.join("package.json").exist?
-        package_json = File.read(Rails.root.join("package.json"))
-        bundler = "webpacker" if package_json.include?('"@rails/webpacker":')
-        bundler = "esbuild" if package_json.include?('"esbuild":')
-        bundler = "vite" if package_json.include?('"vite":')
-        bundler = "shakapacker" if package_json.include?('"shakapacker":')
-        if !bundler
-          puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use StimulusReflex."
-          exit
-        end
-      else
-        puts "❌ You must be using a node-based bundler such as esbuild, webpacker, vite or shakapacker (package.json) or importmap (config/importmap.rb) to use StimulusReflex."
-        exit
-      end
-
-      puts
-      puts "It looks like you're using \e[1m#{bundler}\e[22m as your bundler. Is that correct? (Y/n)"
-      print "> "
-      input = $stdin.gets.chomp
-      if input.downcase == "n"
-        puts
-        puts "StimulusReflex installation supports: esbuild, webpacker, vite, shakapacker and importmap."
-        puts "Please run \e[1;94mrails stimulus_reflex:install [bundler]\e[0m to install StimulusReflex and CableReady."
-        exit
-      end
+    if !used_bundler
+      used_bundler = bundler
     end
 
-    File.write("tmp/stimulus_reflex_installer/bundler", bundler)
+    installer_bundler_path.write(used_bundler)
+
     FileUtils.touch("tmp/stimulus_reflex_installer/backups")
     File.write("tmp/stimulus_reflex_installer/template_src", File.expand_path("../../generators/stimulus_reflex/templates/", __dir__))
 
     `bin/spring stop` if defined?(Spring)
 
     # do the things
-    SR_BUNDLERS[bundler].each do |template|
+    SR_BUNDLERS[used_bundler].each do |template|
       run_install_template(template, trace: !!options["trace"])
     end
 

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.5.0-rc2",
+  "version": "3.5.0-rc4",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -57,7 +57,7 @@
   "dependencies": {
     "@hotwired/stimulus": "^3",
     "@rails/actioncable": "^6 || ^7",
-    "cable_ready": "5.0.0-rc2"
+    "cable_ready": "^5.0.0"
   },
   "devDependencies": {
     "@open-wc/testing": "^3.1.7",
@@ -70,6 +70,6 @@
     "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"
   }
 }

data/stimulus_reflex.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |gem|
     "[A-Z]*"
   ]
 
-  gem.required_ruby_version = ">= 2.7.0"
+  gem.required_ruby_version = ">= 3.0.0"
 
   rails_version = [">= 5.2", "< 8"]
   gem.add_dependency "actioncable", *rails_version
@@ -46,7 +46,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "activesupport", *rails_version
   gem.add_dependency "railties", *rails_version
 
-  gem.add_dependency "cable_ready", ">= 5.0.0.rc2"
+  gem.add_dependency "cable_ready", "~> 5.0"
   gem.add_dependency "nokogiri", "~> 1.0"
   gem.add_dependency "rack", ">= 2", "< 4"
   gem.add_dependency "redis", ">= 4.0", "< 6.0"