stimulus_reflex 3.5.0.pre9 → 3.5.0.pre10

data/lib/stimulus_reflex/html/document.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module StimulusReflex
+  module HTML
+    class Document
+      DEFAULT_HTML_WITHOUT_FORMAT = Nokogiri::XML::Node::SaveOptions::DEFAULT_HTML & ~Nokogiri::XML::Node::SaveOptions::FORMAT
+
+      delegate :element, to: :@document
+
+      def document_element
+        @document&.root
+      end
+
+      def outer_html
+        document_element ? document_element.to_html(save_with: DEFAULT_HTML_WITHOUT_FORMAT) : ""
+      end
+      alias_method :to_html, :outer_html
+
+      def inner_html
+        document_element ? document_element.inner_html(save_with: DEFAULT_HTML_WITHOUT_FORMAT) : ""
+      end
+
+      def initialize(html)
+        @document = parsing_class.parse(html.to_s)
+        @matches = {
+          "body" => Match.new(@document.at_css("body"))
+        }
+      end
+
+      def empty?
+        @document.content.empty?
+      end
+
+      def parsing_class
+        Nokogiri::HTML5::Document
+      end
+
+      def match(selector)
+        @matches[selector] ||= Match.new(@document.at_css(selector))
+      end
+
+      Match = Struct.new(:element) do
+        delegate :present?, to: :element
+
+        def outer_html
+          element&.to_html(save_with: DEFAULT_HTML_WITHOUT_FORMAT)
+        end
+
+        def to_html
+          element&.to_html(save_with: DEFAULT_HTML_WITHOUT_FORMAT)
+        end
+
+        def inner_html
+          element&.inner_html(save_with: DEFAULT_HTML_WITHOUT_FORMAT)
+        end
+      end
+    end
+  end
+end

data/lib/stimulus_reflex/html/document_fragment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# forzen_string_literal: true
+
+module StimulusReflex
+  module HTML
+    class DocumentFragment < Document
+      def parsing_class
+        Nokogiri
+      end
+    end
+  end
+end

data/lib/stimulus_reflex/importmap.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 pin "@rails/actioncable", to: "actioncable.esm.js", preload: true
 pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+pin "morphdom", to: "https://ga.jspm.io/npm:morphdom@2.6.1/dist/morphdom.js", preload: true
 pin "cable_ready", to: "cable_ready.min.js", preload: true
 pin "stimulus_reflex", to: "stimulus_reflex.min.js", preload: true

data/lib/stimulus_reflex/installer.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+### general utilities
+
+def fetch(step_path, file)
+  relative_path = step_path + file
+  location = template_src + relative_path
+
+  Pathname.new(location)
+end
+
+def complete_step(step)
+  create_file "tmp/stimulus_reflex_installer/#{step}", verbose: false
+end
+
+def create_or_append(path, *args, &block)
+  FileUtils.touch(path)
+  append_file(path, *args, &block)
+end
+
+def current_template
+  ENV["LOCATION"].split("/").last.gsub(".rb", "")
+end
+
+def pack_path_missing?
+  return false unless pack_path.nil?
+  halt "#{friendly_pack_path} is missing. You need a valid application pack file to proceed."
+end
+
+def halt(message)
+  say "❌ #{message}", :red
+  create_file "tmp/stimulus_reflex_installer/halt", verbose: false
+end
+
+def backup(path, delete: false)
+  if !path.exist?
+    yield
+    return
+  end
+
+  backup_path = Pathname.new("#{path}.bak")
+  old_path = path.relative_path_from(Rails.root).to_s
+  filename = path.to_path.split("/").last
+
+  if backup_path.exist?
+    if backup_path.read == path.read
+      path.delete if delete
+      yield
+      return
+    end
+    backup_path.delete
+  end
+
+  copy_file(path, backup_path, verbose: false)
+  path.delete if delete
+
+  yield
+
+  if path.read != backup_path.read
+    create_or_append(backups_path, "#{old_path}\n", verbose: false)
+  end
+  say "📦 #{old_path} backed up as #{filename}.bak"
+end
+
+def add_gem(name)
+  create_or_append(add_gem_list, "#{name}\n", verbose: false)
+  say "☑️  Added #{name} to the Gemfile"
+end
+
+def remove_gem(name)
+  create_or_append(remove_gem_list, "#{name}\n", verbose: false)
+  say "❎ Removed #{name} from Gemfile"
+end
+
+def add_package(name)
+  create_or_append(package_list, "#{name}\n", verbose: false)
+  say "☑️  Enqueued #{name} to be added to dependencies"
+end
+
+def add_dev_package(name)
+  create_or_append(dev_package_list, "#{name}\n", verbose: false)
+  say "☑️  Enqueued #{name} to be added to dev dependencies"
+end
+
+def drop_package(name)
+  create_or_append(drop_package_list, "#{name}\n", verbose: false)
+  say "❎ Enqueued #{name} to be removed from dependencies"
+end
+
+def gemfile_hash
+  Digest::MD5.hexdigest(gemfile_path.read)
+end
+
+### memoized values
+
+def sr_npm_version
+  @sr_npm_version ||= StimulusReflex::VERSION.gsub(".pre", "-pre")
+end
+
+def cr_npm_version
+  @cr_npm_version ||= CableReady::VERSION.gsub(".pre", "-pre")
+end
+
+def package_json
+  @package_json ||= Rails.root.join("package.json")
+end
+
+def entrypoint
+  @entrypoint ||= File.read("tmp/stimulus_reflex_installer/entrypoint")
+end
+
+def bundler
+  @bundler ||= File.read("tmp/stimulus_reflex_installer/bundler")
+end
+
+def network_issue_path
+  @network_issue_path ||= Rails.root.join("tmp/stimulus_reflex_installer/network_issue")
+end
+
+def config_path
+  @config_path ||= Rails.root.join(entrypoint, "config")
+end
+
+def importmap_path
+  @importmap_path ||= Rails.root.join("config/importmap.rb")
+end
+
+def friendly_importmap_path
+  @friendly_importmap_path ||= importmap_path.relative_path_from(Rails.root).to_s
+end
+
+def pack
+  @pack ||= pack_path.read
+end
+
+def friendly_pack_path
+  @friendly_pack_path ||= pack_path.relative_path_from(Rails.root).to_s
+end
+
+def pack_path
+  @pack_path ||= [
+    Rails.root.join(entrypoint, "application.js"),
+    Rails.root.join(entrypoint, "packs/application.js"),
+    Rails.root.join(entrypoint, "entrypoints/application.js")
+  ].find(&:exist?)
+end
+
+def package_list
+  @package_list ||= Rails.root.join("tmp/stimulus_reflex_installer/npm_package_list")
+end
+
+def dev_package_list
+  @dev_package_list ||= Rails.root.join("tmp/stimulus_reflex_installer/npm_dev_package_list")
+end
+
+def drop_package_list
+  @drop_package_list ||= Rails.root.join("tmp/stimulus_reflex_installer/drop_npm_package_list")
+end
+
+def template_src
+  @template_src ||= File.read("tmp/stimulus_reflex_installer/template_src")
+end
+
+def controllers_path
+  @controllers_path ||= Rails.root.join(entrypoint, "controllers")
+end
+
+def gemfile_path
+  @gemfile_path ||= Rails.root.join("Gemfile")
+end
+
+def gemfile
+  @gemfile ||= gemfile_path.read
+end
+
+def prefix
+  # standard:disable Style/RedundantStringEscape
+  @prefix ||= {
+    "vite" => "..\/",
+    "webpacker" => "",
+    "shakapacker" => "",
+    "importmap" => "",
+    "esbuild" => ".\/"
+  }[bundler]
+  # standard:enable Style/RedundantStringEscape
+end
+
+def application_record_path
+  @application_record_path ||= Rails.root.join("app/models/application_record.rb")
+end
+
+def action_cable_initializer_path
+  @action_cable_initializer_path ||= Rails.root.join("config/initializers/action_cable.rb")
+end
+
+def action_cable_initializer_working_path
+  @action_cable_initializer_working_path ||= Rails.root.join(working, "action_cable.rb")
+end
+
+def development_path
+  @development_path ||= Rails.root.join("config/environments/development.rb")
+end
+
+def development_working_path
+  @development_working_path ||= Rails.root.join(working, "development.rb")
+end
+
+def backups_path
+  @backups_path ||= Rails.root.join("tmp/stimulus_reflex_installer/backups")
+end
+
+def add_gem_list
+  @add_gem_list ||= Rails.root.join("tmp/stimulus_reflex_installer/add_gem_list")
+end
+
+def remove_gem_list
+  @remove_gem_list ||= Rails.root.join("tmp/stimulus_reflex_installer/remove_gem_list")
+end
+
+def options_path
+  @options_path ||= Rails.root.join("tmp/stimulus_reflex_installer/options")
+end
+
+def options
+  @options ||= YAML.safe_load(File.read(options_path))
+end
+
+def working
+  @working ||= Rails.root.join("tmp/stimulus_reflex_installer/working")
+end
+
+### support for development step
+
+def write_redis_recommendation(development_working, lines, index, gemfile)
+  # provide a recommendation for using redis-session-store, including commented source code
+  if !lines.index { |line| line.include?("StimulusReflex does not support :cookie_store") }
+    lines.insert index + 1, <<RUBY
+
+  # StimulusReflex does not support :cookie_store, and we recommend switching to Redis.
+  # To use `redis-session-store`, make sure to add it to your Gemfile and run `bundle install`.
+
+  # config.session_store :redis_session_store,
+  #   serializer: :json,
+  #   on_redis_down: ->(*a) { Rails.logger.error("Redis down! \#{a.inspect}") },
+  #   redis: {
+  #     expire_after: 120.minutes,
+  #     key_prefix: "session:",
+  #     url: ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" }
+  # }
+RUBY
+    development_working.write lines.join
+    # add redis-session-store to Gemfile, but comment it out
+    if !gemfile.match?(/gem ['"]redis-session-store['"]/)
+      append_file(gemfile_path, verbose: false) do
+        <<~RUBY
+
+          # StimulusReflex recommends using Redis for session storage
+          # gem "redis-session-store", "0.11.5"
+        RUBY
+      end
+      say "💡 Added redis-session-store 0.11.5 to the Gemfile, commented out"
+    end
+  end
+end
+
+def find_index(lines)
+  # accomodate devs who modify their development.rb file structure
+  if (index = lines.index { |line| line =~ /caching-dev/ })
+    index += 3
+  else
+    index = lines.index { |line| line =~ /^Rails.application.configure do/ } + 1
+  end
+  index
+end

data/lib/stimulus_reflex/open_struct_fix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Temporary fix until this PR gets merged:
 # https://github.com/ruby/ostruct/pull/37

data/lib/stimulus_reflex/reflex.rb

@@ -1,47 +1,40 @@
 # frozen_string_literal: true
 
-ClientAttributes = Struct.new(:reflex_id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, :version, :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, :version, :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 = {}
 
@@ -52,6 +45,13 @@ class StimulusReflex::Reflex
     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)
@@ -94,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
@@ -128,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.
@@ -143,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,13 +79,14 @@ class StimulusReflex::ReflexData
   def xpath_element
     data["xpathElement"]
   end
+  # END TODO remove
 
   def reflex_controller
     data["reflexController"]
   end
 
   def version
-    data["version"].gsub("-pre", ".pre")
+    data["version"].to_s.gsub("-pre", ".pre")
   end
 
   private

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,9 +11,9 @@ 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,

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

@@ -46,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
@@ -53,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,8 +1,6 @@
 # frozen_string_literal: true
 
 class StimulusReflex::SanityChecker
-  LATEST_VERSION_FORMAT = /^(\d+\.\d+\.\d+)$/
-
   class << self
     def check!
       return if ENV["SKIP_SANITY_CHECK"]
@@ -14,7 +12,6 @@ class StimulusReflex::SanityChecker
       instance = new
       instance.check_caching_enabled
       # instance.check_default_url_config
-      instance.check_new_version_available
     end
 
     private
@@ -48,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
@@ -56,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.
 
@@ -70,29 +67,6 @@ class StimulusReflex::SanityChecker
     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
@@ -101,24 +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 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 initializer_missing?
-    File.exist?(Rails.root.join("config", "initializers", "stimulus_reflex.rb")) == false
-  end
-
   def warn_and_exit(text)
     puts
     puts "Heads up! 🔥"
@@ -138,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.pre9"
+  VERSION = "3.5.0.pre10"
 end