stimulus_reflex 3.5.0.rc3 → 3.5.3

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.rc3"
+  VERSION = "3.5.3"
 end

data/lib/stimulus_reflex.rb

@@ -3,11 +3,13 @@
 require "uri"
 require "open-uri"
 require "rack"
+require "ostruct"
 require "active_support/all"
 require "action_dispatch"
 require "action_cable"
 require "action_view"
 require "nokogiri"
+require "nokogiri/html5/inference"
 require "cable_ready"
 require "stimulus_reflex/version"
 require "stimulus_reflex/open_struct_fix"

data/lib/tasks/stimulus_reflex/stimulus_reflex.rake

@@ -53,8 +53,8 @@ end
 namespace :stimulus_reflex do
   desc "✨ Install StimulusReflex and CableReady ✨"
   task :install do
-    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"))
+    StimulusReflex::Installer.create_dir_if_not_exists(Rails.root.join("tmp/stimulus_reflex_installer/templates"))
+    StimulusReflex::Installer.create_dir_if_not_exists(Rails.root.join("tmp/stimulus_reflex_installer/working"))
 
     install_complete = Rails.root.join("tmp/stimulus_reflex_installer/complete")
 
@@ -93,8 +93,8 @@ namespace :stimulus_reflex do
     end
 
     # if there is an installation in progress, continue where we left off
-    if installer_entrypoint_path.exist?
-      entrypoint = installer_entrypoint_path.read
+    if StimulusReflex::Installer.installer_entrypoint_path.exist?
+      entrypoint = StimulusReflex::Installer.installer_entrypoint_path.read
 
       puts "✨ Resuming \e[38;5;220mStimulusReflex\e[0m and \e[38;5;220mCableReady\e[0m installation ✨"
       puts
@@ -118,18 +118,18 @@ namespace :stimulus_reflex do
       entrypoint = if options.key? "entrypoint"
         options["entrypoint"]
       else
-        auto_detect_entrypoint
+        StimulusReflex::Installer.auto_detect_entrypoint
       end
 
-      installer_entrypoint_path.write(entrypoint)
+      StimulusReflex::Installer.installer_entrypoint_path.write(entrypoint)
     end
 
     # verify their bundler before starting, unless they explicitly specified on CLI
     if !used_bundler
-      used_bundler = bundler
+      used_bundler = StimulusReflex::Installer.bundler
     end
 
-    installer_bundler_path.write(used_bundler)
+    StimulusReflex::Installer.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__))

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stimulus_reflex",
-  "version": "3.5.0-rc3",
+  "version": "3.5.3",
   "description": "Build reactive applications with the Rails tooling you already know and love.",
   "keywords": [
     "ruby",
@@ -57,18 +57,18 @@
   "dependencies": {
     "@hotwired/stimulus": "^3",
     "@rails/actioncable": "^6 || ^7",
-    "cable_ready": "^5.0.0"
+    "cable_ready": "^5.0.6"
   },
   "devDependencies": {
-    "@open-wc/testing": "^3.1.7",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-terser": "^0.4.0",
-    "@web/dev-server-esbuild": "^0.3.3",
-    "@web/dev-server-rollup": "^0.3.21",
-    "@web/test-runner": "^0.15.1",
+    "@open-wc/testing": "^4.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@web/dev-server-esbuild": "^1.0.2",
+    "@web/dev-server-rollup": "^0.6.4",
+    "@web/test-runner": "^0.19.0",
     "prettier-standard": "^16.4.1",
-    "rollup": "^3.19.1",
+    "rollup": "^4.22.4",
     "toastify-js": "^1.12.0",
     "vitepress": "^1.0.0-beta.1"
   }

data/stimulus_reflex.gemspec

@@ -37,24 +37,26 @@ 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
-  gem.add_dependency "actionpack", *rails_version
-  gem.add_dependency "actionview", *rails_version
-  gem.add_dependency "activesupport", *rails_version
-  gem.add_dependency "railties", *rails_version
+  rails_version = ">= 5.2"
+  gem.add_dependency "actioncable", rails_version
+  gem.add_dependency "actionpack", rails_version
+  gem.add_dependency "actionview", rails_version
+  gem.add_dependency "activesupport", rails_version
+  gem.add_dependency "railties", rails_version
 
   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"
+  gem.add_dependency "nokogiri-html5-inference", "~> 0.3"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "magic_frozen_string_literal", "~> 1.2"
   gem.add_development_dependency "mocha", "~> 1.13"
-  gem.add_development_dependency "rails", *rails_version
+  gem.add_development_dependency "rails", rails_version
   gem.add_development_dependency "rake", "~> 13.0"
   gem.add_development_dependency "standard", "~> 1.24"
+  gem.add_development_dependency "minitest", "5.18.1"
 end

data/web-test-runner.config.mjs

@@ -3,8 +3,22 @@ import { fromRollup } from '@web/dev-server-rollup'
 
 const json = fromRollup(rollupJson)
 
+const filteredLogs = [
+  'Lit is in dev mode. Not recommended for production! See https://lit.dev/msg/dev-mode for more information.'
+]
+
+const filterBrowserLogs = (log) => {
+  for (const arg of log.args) {
+    if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+      return false
+    }
+  }
+  return true
+}
+
 export default {
   nodeResolve: true,
+  filterBrowserLogs,
   mimeTypes: {
     '**/*.json': 'js'
   },