stimulus_reflex 3.5.0.pre8 → 3.5.0.pre10

data/lib/stimulus_reflex/reflex.rb

@@ -1,50 +1,57 @@
 # frozen_string_literal: true
 
-ClientAttributes = Struct.new(:reflex_id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, :suppress_logging, keyword_init: true)
+require "stimulus_reflex/cable_readiness"
+
+# 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, :suppress_logging, keyword_init: true)
 
 class StimulusReflex::Reflex
+  class VersionMismatchError < StandardError; end
+
+  prepend StimulusReflex::CableReadiness
   include ActiveSupport::Rescuable
   include StimulusReflex::Callbacks
   include ActionView::Helpers::TagHelper
   include CableReady::Identifiable
 
   attr_accessor :payload, :headers
-  attr_reader :cable_ready, :channel, :url, :element, :selectors, :method_name, :broadcaster, :client_attributes, :logger
+  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
 
   delegate :connection, :stream_name, to: :channel
   delegate :controller_class, :flash, :session, to: :request
-  delegate :broadcast, :halted, :error, to: :broadcaster
-  delegate :reflex_id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, :suppress_logging, to: :client_attributes
+  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, :suppress_logging, to: :client_attributes
 
   def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {}, client_attributes: {})
-    if is_a? CableReady::Broadcaster
-      message = <<~MSG
-
-        #{self.class.name} includes CableReady::Broadcaster, and you need to remove it.
-        Reflexes have their own CableReady interface. You can just assume that it's present.
-        See https://docs.stimulusreflex.com/rtfm/cableready#using-cableready-inside-a-reflex-action for more details.
-
-      MSG
-      raise TypeError.new(message.strip)
-    end
-
     @channel = channel
     @url = url
     @element = element
     @selectors = selectors
     @method_name = method_name
     @params = params
-    @broadcaster = StimulusReflex::PageBroadcaster.new(self)
     @client_attributes = ClientAttributes.new(client_attributes)
+    @broadcaster = StimulusReflex::PageBroadcaster.new(self)
     @logger = suppress_logging ? nil : StimulusReflex::Logger.new(self)
-    @cable_ready = StimulusReflex::CableReadyChannels.new(stream_name, reflex_id)
     @payload = {}
     @headers = {}
+
+    if version != StimulusReflex::VERSION && StimulusReflex.config.on_failed_sanity_checks != :ignore
+      raise VersionMismatchError.new("stimulus_reflex gem / NPM package version mismatch")
+    end
+
     self.params
   end
 
+  # TODO: remove this for v4
+  def reflex_id
+    warn "Deprecation warning: reflex_id will be removed in v4. Use id instead!" if Rails.env.development?
+    id
+  end
+  # END TODO: remove
+
   def request
     @request ||= begin
       uri = URI.parse(url)
@@ -87,10 +94,10 @@ class StimulusReflex::Reflex
     when :page
       raise StandardError.new("Cannot call :page morph after :#{broadcaster.to_sym} morph") unless broadcaster.page?
     when :nothing
-      raise StandardError.new("Cannot call :nothing morph after :selector morph") if broadcaster.selector?
+      raise StandardError.new("#{broadcaster.to_sym} morph type has already been set") if broadcaster.selector?
       @broadcaster = StimulusReflex::NothingBroadcaster.new(self) unless broadcaster.nothing?
     else
-      raise StandardError.new("Cannot call :selector morph after :nothing morph") if broadcaster.nothing?
+      raise StandardError.new("#{broadcaster.to_sym} morph type has already been set") if broadcaster.nothing?
       @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
       broadcaster.append_morph(selectors, html)
     end
@@ -121,12 +128,7 @@ class StimulusReflex::Reflex
 
   # Invoke the reflex action specified by `name` and run all callbacks
   def process(name, *args)
-    reflex_invoked = false
-    result = run_callbacks(:process) {
-      public_send(name, *args).tap { reflex_invoked = true }
-    }
-    @halted ||= result == false && !reflex_invoked
-    result
+    run_callbacks(:process) { public_send(name, *args) }
   end
 
   # Indicates if the callback chain was halted via a throw(:abort) in a before_reflex callback.
@@ -136,6 +138,11 @@ class StimulusReflex::Reflex
     !!@halted
   end
 
+  # Indicates if the callback chain was halted via a throw(:forbidden) in a before_reflex callback.
+  def forbidden?
+    !!@forbidden
+  end
+
   def default_reflex
     # noop default reflex to force page reloads
   end

data/lib/stimulus_reflex/reflex_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class StimulusReflex::ReflexData
   attr_reader :data
 
@@ -49,18 +51,27 @@ class StimulusReflex::ReflexData
     Rack::Utils.parse_nested_query(data["formData"])
   end
 
+  def params
+    form_params.merge(url_params)
+  end
+
   def form_params
     form_data.deep_merge(data["params"] || {})
   end
 
-  def reflex_id
-    data["reflexId"]
+  def url_params
+    Rack::Utils.parse_nested_query(URI.parse(url).query)
+  end
+
+  def id
+    data["id"]
   end
 
   def tab_id
     data["tabId"]
   end
 
+  # TODO: remove this in v4
   def xpath_controller
     data["xpathController"]
   end
@@ -68,11 +79,16 @@ class StimulusReflex::ReflexData
   def xpath_element
     data["xpathElement"]
   end
+  # END TODO remove
 
   def reflex_controller
     data["reflexController"]
   end
 
+  def version
+    data["version"].to_s.gsub("-pre", ".pre")
+  end
+
   private
 
   def object_with_indifferent_access(object)

data/lib/stimulus_reflex/reflex_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class StimulusReflex::ReflexFactory
   class << self
     attr_reader :reflex_data
@@ -9,15 +11,16 @@ class StimulusReflex::ReflexFactory
         element: reflex_data.element,
         selectors: reflex_data.selectors,
         method_name: reflex_data.method_name,
-        params: reflex_data.form_params,
+        params: reflex_data.params,
         client_attributes: {
-          reflex_id: reflex_data.reflex_id,
+          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
+          suppress_logging: reflex_data.suppress_logging,
+          version: reflex_data.version
         })
     end
 

data/lib/stimulus_reflex/request_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StimulusReflex
   class RequestParameters
     def initialize(params:, req:, url:)

data/lib/stimulus_reflex/utils/logger.rb

@@ -27,6 +27,8 @@ module StimulusReflex
     def config_logging
       return @config_logging if @config_logging
 
+      return unless StimulusReflex.config.logging.instance_of?(Proc)
+
       StimulusReflex.config.logging.binding.eval("using StimulusReflex::Utils::Colorize")
       @config_logging = StimulusReflex.config.logging
     end
@@ -44,6 +46,15 @@ module StimulusReflex
       reflex.class.to_s + "#" + reflex.method_name
     end
 
+    def id_full
+      reflex.id
+    end
+
+    def id
+      id_full[0..7]
+    end
+
+    # TODO: remove for v4
     def reflex_id_full
       reflex.reflex_id
     end
@@ -51,6 +62,7 @@ module StimulusReflex
     def reflex_id
       reflex_id_full[0..7]
     end
+    # END TODO remove
 
     def mode
       reflex.broadcaster.to_s

data/lib/stimulus_reflex/utils/sanity_checker.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 class StimulusReflex::SanityChecker
-  LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
-  NODE_VERSION_FORMAT = /(\d+\.\d+\.\d+.*):/
-  JSON_VERSION_FORMAT = /(\d+\.\d+\.\d+.*)"/
-
   class << self
     def check!
       return if ENV["SKIP_SANITY_CHECK"]
@@ -15,9 +11,7 @@ class StimulusReflex::SanityChecker
 
       instance = new
       instance.check_caching_enabled
-      instance.check_package_versions_match
       # instance.check_default_url_config
-      instance.check_new_version_available
     end
 
     private
@@ -51,7 +45,7 @@ class StimulusReflex::SanityChecker
     if using_null_store?
       warn_and_exit <<~WARN
         👉 StimulusReflex requires caching to be enabled.
-        
+
         Caching allows the session to be modified during ActionCable requests. Your config.cache_store is set to :null_store, so it won't work.
       WARN
     end
@@ -59,7 +53,7 @@ class StimulusReflex::SanityChecker
 
   def check_default_url_config
     return if StimulusReflex.config.on_missing_default_urls == :ignore
-    if default_url_config_set? == false
+    if default_url_config_missing?
       puts <<~WARN
         👉 StimulusReflex strongly suggests that you set default_url_options in your environment files. Otherwise, ActionController #{"and ActionMailer " if defined?(ActionMailer)}will default to example.com when rendering route helpers.
 
@@ -73,51 +67,6 @@ class StimulusReflex::SanityChecker
     end
   end
 
-  def check_package_versions_match
-    if npm_version.nil?
-      warn_and_exit <<~WARN
-        👉 Can't locate the stimulus_reflex npm package.
-
-          yarn add stimulus_reflex@#{gem_version}
-
-        Either add it to your package.json as a dependency or use "yarn link stimulus_reflex" if you are doing development.
-      WARN
-    end
-
-    if package_version_mismatch?
-      warn_and_exit <<~WARN
-        👉 The stimulus_reflex npm package version (#{npm_version}) does not match the Rubygem version (#{gem_version}).
-
-        To update the stimulus_reflex npm package:
-
-          yarn upgrade stimulus_reflex@#{gem_version}
-      WARN
-    end
-  end
-
-  def check_new_version_available
-    return if StimulusReflex.config.on_new_version_available == :ignore
-    return if Rails.env.development? == false
-    return if using_preview_release?
-    begin
-      latest_version = URI.open("https://raw.githubusercontent.com/stimulusreflex/stimulus_reflex/master/LATEST", open_timeout: 1, read_timeout: 1).read.strip
-      if latest_version != StimulusReflex::VERSION
-        puts <<~WARN
-
-          👉 There is a new version of StimulusReflex available!
-          Current: #{StimulusReflex::VERSION} Latest: #{latest_version}
-
-          If you upgrade, it is very important that you update BOTH Gemfile and package.json
-          Then, run `bundle install && yarn install` to update to #{latest_version}.
-
-        WARN
-        exit if StimulusReflex.config.on_new_version_available == :exit
-      end
-    rescue
-      puts "👉 StimulusReflex #{StimulusReflex::VERSION} update check skipped: connection timeout"
-    end
-  end
-
   def caching_not_enabled?
     Rails.application.config.action_controller.perform_caching == false
   end
@@ -126,57 +75,18 @@ class StimulusReflex::SanityChecker
     Rails.application.config.cache_store == :null_store
   end
 
+  def initializer_missing?
+    File.exist?(Rails.root.join("config", "initializers", "stimulus_reflex.rb")) == false
+  end
+
   def default_url_config_set?
     if defined?(ActionMailer)
-      Rails.application.config.action_controller.default_url_options.blank? && Rails.application.config.action_mailer.default_url_options.blank?
+      Rails.application.config.action_controller.default_url_options.blank? || Rails.application.config.action_mailer.default_url_options.blank?
     else
       Rails.application.config.action_controller.default_url_options.blank?
     end
   end
 
-  def package_version_mismatch?
-    npm_version != gem_version
-  end
-
-  def using_preview_release?
-    preview = StimulusReflex::VERSION.match?(LATEST_VERSION_FORMAT) == false
-    puts "👉 StimulusReflex #{StimulusReflex::VERSION} update check skipped: pre-release build" if preview
-    preview
-  end
-
-  def gem_version
-    @_gem_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
-  end
-
-  def npm_version
-    @_npm_version ||= find_npm_version
-  end
-
-  def find_npm_version
-    if (match = search_file(package_json_path, regex: /version/))
-      match[JSON_VERSION_FORMAT, 1]
-    elsif (match = search_file(yarn_lock_path, regex: /^stimulus_reflex/))
-      match[NODE_VERSION_FORMAT, 1]
-    end
-  end
-
-  def search_file(path, regex:)
-    return if File.exist?(path) == false
-    File.foreach(path).grep(regex).first
-  end
-
-  def package_json_path
-    Rails.root.join("node_modules", "stimulus_reflex", "package.json")
-  end
-
-  def yarn_lock_path
-    Rails.root.join("yarn.lock")
-  end
-
-  def initializer_missing?
-    File.exist?(Rails.root.join("config", "initializers", "stimulus_reflex.rb")) == false
-  end
-
   def warn_and_exit(text)
     puts
     puts "Heads up! 🔥"
@@ -196,15 +106,7 @@ class StimulusReflex::SanityChecker
           end
 
       INFO
-      if initializer_missing?
-        puts <<~INFO
-          You can create a StimulusReflex initializer with the command:
-
-            bundle exec rails generate stimulus_reflex:initializer
-
-        INFO
-      end
-      exit false if Rails.env.test? == false
+      exit false unless Rails.env.test?
     end
   end
 end

data/lib/stimulus_reflex/version.rb

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

data/lib/stimulus_reflex.rb

@@ -3,7 +3,6 @@
 require "uri"
 require "open-uri"
 require "rack"
-require "rails/engine"
 require "active_support/all"
 require "action_dispatch"
 require "action_cable"
@@ -11,15 +10,19 @@ require "action_view"
 require "nokogiri"
 require "cable_ready"
 require "stimulus_reflex/version"
+require "stimulus_reflex/open_struct_fix"
 require "stimulus_reflex/cable_ready_channels"
 require "stimulus_reflex/concern_enhancer"
 require "stimulus_reflex/configuration"
 require "stimulus_reflex/callbacks"
+require "stimulus_reflex/html/document"
+require "stimulus_reflex/html/document_fragment"
 require "stimulus_reflex/request_parameters"
 require "stimulus_reflex/reflex"
 require "stimulus_reflex/reflex_data"
 require "stimulus_reflex/reflex_factory"
 require "stimulus_reflex/element"
+require "stimulus_reflex/engine"
 require "stimulus_reflex/broadcasters/broadcaster"
 require "stimulus_reflex/broadcasters/nothing_broadcaster"
 require "stimulus_reflex/broadcasters/page_broadcaster"
@@ -31,9 +34,4 @@ require "stimulus_reflex/utils/logger"
 require "stimulus_reflex/utils/sanity_checker"
 
 module StimulusReflex
-  class Engine < Rails::Engine
-    initializer "stimulus_reflex.sanity_check" do
-      SanityChecker.check! unless Rails.env.production?
-    end
-  end
 end