stimulus_reflex 3.5.0.pre1 → 3.5.0.pre5

data/lib/stimulus_reflex/broadcasters/broadcaster.rb

@@ -26,33 +26,34 @@ module StimulusReflex
       false
     end
 
-    def broadcast_message(subject:, data: {}, error: nil)
+    def halted(data: {})
       operations << ["document", :dispatch_event]
       cable_ready.dispatch_event(
-        name: "stimulus-reflex:server-message",
-        detail: {
-          reflexId: data.delete("reflexId"),
-          payload: payload,
-          stimulus_reflex: data.merge(
-            morph: to_sym,
-            server_message: {subject: subject, body: error&.to_s}
-          )
-        }
-      )
-      cable_ready.broadcast
-    end
-
-    # abstract method to be implemented by subclasses
+        name: "stimulus-reflex:morph-halted",
+        payload: payload,
+        stimulus_reflex: data.merge(morph: to_sym)
+      ).broadcast
+    end
+
+    def error(data: {}, body: nil)
+      operations << ["document", :dispatch_event]
+      cable_ready.dispatch_event(
+        name: "stimulus-reflex:morph-error",
+        payload: payload,
+        stimulus_reflex: data.merge(morph: to_sym),
+        body: body&.to_s
+      ).broadcast
+    end
+
+    # abstract methods to be implemented by subclasses
     def broadcast(*args)
       raise NotImplementedError
     end
 
-    # abstract method to be implemented by subclasses
     def to_sym
       raise NotImplementedError
     end
 
-    # abstract method to be implemented by subclasses
     def to_s
       raise NotImplementedError
     end

data/lib/stimulus_reflex/broadcasters/nothing_broadcaster.rb

@@ -3,7 +3,12 @@
 module StimulusReflex
   class NothingBroadcaster < Broadcaster
     def broadcast(_, data)
-      broadcast_message subject: "nothing", data: data
+      operations << ["document", :dispatch_event]
+      cable_ready.dispatch_event(
+        name: "stimulus-reflex:morph-nothing",
+        payload: payload,
+        stimulus_reflex: data.merge(morph: to_sym)
+      ).broadcast
     end
 
     def nothing?

data/lib/stimulus_reflex/broadcasters/page_broadcaster.rb

@@ -19,9 +19,7 @@ module StimulusReflex
           payload: payload,
           children_only: true,
           permanent_attribute_name: permanent_attribute_name,
-          stimulus_reflex: data.merge({
-            morph: to_sym
-          })
+          stimulus_reflex: data.merge(morph: to_sym)
         )
       end
       cable_ready.broadcast

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -2,40 +2,30 @@
 
 module StimulusReflex
   class SelectorBroadcaster < Broadcaster
-    include CableReady::Identifiable
-
     def broadcast(_, data = {})
       morphs.each do |morph|
         selectors, html = morph
-        updates = selectors.is_a?(Hash) ? selectors : {selectors => html}
-        updates.each do |key, value|
-          html = reflex.render(key) if key.is_a?(ActiveRecord::Base) && value.nil?
-          html = reflex.render_collection(key) if key.is_a?(ActiveRecord::Relation) && value.nil?
-          html ||= value
-          fragment = Nokogiri::HTML.fragment(html.to_s)
-          selector = key.is_a?(ActiveRecord::Base) || key.is_a?(ActiveRecord::Relation) ? dom_id(key) : key.to_s
-          match = fragment.at_css(selector)
+        updates = create_update_collection(selectors, html)
+        updates.each do |update|
+          fragment = Nokogiri::HTML.fragment(update.html.to_s)
+          match = fragment.at_css(update.selector)
           if match.present?
-            operations << [selector, :morph]
+            operations << [update.selector, :morph]
             cable_ready.morph(
-              selector: selector,
+              selector: update.selector,
               html: match.inner_html(save_with: Broadcaster::DEFAULT_HTML_WITHOUT_FORMAT),
               payload: payload,
               children_only: true,
               permanent_attribute_name: permanent_attribute_name,
-              stimulus_reflex: data.merge({
-                morph: to_sym
-              })
+              stimulus_reflex: data.merge(morph: to_sym)
             )
           else
-            operations << [selector, :inner_html]
+            operations << [update.selector, :inner_html]
             cable_ready.inner_html(
-              selector: selector,
+              selector: update.selector,
               html: fragment.to_html,
               payload: payload,
-              stimulus_reflex: data.merge({
-                morph: to_sym
-              })
+              stimulus_reflex: data.merge(morph: to_sym)
             )
           end
         end
@@ -64,5 +54,14 @@ module StimulusReflex
     def to_s
       "Selector"
     end
+
+    private
+
+    def create_update_collection(selectors, html)
+      updates = selectors.is_a?(Hash) ? selectors : {selectors => html}
+      updates.map do |key, value|
+        StimulusReflex::Broadcasters::Update.new(key, value, reflex)
+      end
+    end
   end
 end

data/lib/stimulus_reflex/broadcasters/update.rb

@@ -0,0 +1,23 @@
+module StimulusReflex
+  module Broadcasters
+    class Update
+      include CableReady::Identifiable
+
+      def initialize(key, value, reflex)
+        @key = key
+        @value = value
+        @reflex = reflex
+      end
+
+      def selector
+        @selector ||= identifiable?(@key) ? dom_id(@key) : @key.to_s
+      end
+
+      def html
+        html = @reflex.render(@key) if @key.is_a?(ActiveRecord::Base) && @value.nil?
+        html = @reflex.render_collection(@key) if @key.is_a?(ActiveRecord::Relation) && @value.nil?
+        html || @value
+      end
+    end
+  end
+end

data/lib/stimulus_reflex/configuration.rb

@@ -14,15 +14,17 @@ module StimulusReflex
   end
 
   class Configuration
-    attr_accessor :on_failed_sanity_checks, :on_new_version_available, :parent_channel, :logging, :middleware
+    attr_accessor :on_failed_sanity_checks, :on_new_version_available, :on_missing_default_urls, :parent_channel, :logging, :logger, :middleware
 
     DEFAULT_LOGGING = proc { "[#{session_id}] #{operation_counter.magenta} #{reflex_info.green} -> #{selector.cyan} via #{mode} Morph (#{operation.yellow})" }
 
     def initialize
       @on_failed_sanity_checks = :exit
       @on_new_version_available = :ignore
+      @on_missing_default_urls = :warn
       @parent_channel = "ApplicationCable::Channel"
       @logging = DEFAULT_LOGGING
+      @logger = Rails.logger
       @middleware = ActionDispatch::MiddlewareStack.new
     end
   end

data/lib/stimulus_reflex/dataset.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "stimulus_reflex/utils/attribute_builder"
+
+class StimulusReflex::Dataset < OpenStruct
+  include StimulusReflex::AttributeBuilder
+
+  attr_accessor :attrs, :data_attrs
+
+  def initialize(data = {})
+    datasets = data["dataset"] || {}
+    regular_dataset = datasets["dataset"] || {}
+    @attrs = build_data_attrs(regular_dataset, datasets["datasetAll"] || {})
+    @data_attrs = @attrs.transform_keys { |key| key.delete_prefix "data-" }
+
+    super build_underscored(@data_attrs)
+  end
+
+  def signed
+    @signed ||= ->(accessor) { GlobalID::Locator.locate_signed(self[accessor]) }
+  end
+
+  def unsigned
+    @unsigned ||= ->(accessor) { GlobalID::Locator.locate(self[accessor]) }
+  end
+
+  def boolean
+    @boolean ||= ->(accessor) { ActiveModel::Type::Boolean.new.cast(self[accessor]) || self[accessor].blank? }
+  end
+
+  def numeric
+    @numeric ||= ->(accessor) { Float(self[accessor]) }
+  end
+end

data/lib/stimulus_reflex/element.rb

@@ -1,49 +1,32 @@
 # frozen_string_literal: true
 
+require "stimulus_reflex/dataset"
+require "stimulus_reflex/utils/attribute_builder"
+
 class StimulusReflex::Element < OpenStruct
-  attr_reader :attrs, :data_attrs
+  include StimulusReflex::AttributeBuilder
+
+  attr_reader :attrs, :dataset
+
+  alias_method :data_attributes, :dataset
+
+  delegate :signed, :unsigned, :numeric, :boolean, :data_attrs, to: :dataset
 
   def initialize(data = {})
     @attrs = HashWithIndifferentAccess.new(data["attrs"] || {})
-    datasets = data["dataset"] || {}
-    regular_dataset = datasets["dataset"] || {}
-    @data_attrs = build_data_attrs(regular_dataset, datasets["datasetAll"] || {})
-    all_attributes = @attrs.merge(@data_attrs)
-    super build_underscored(all_attributes)
-    @data_attrs.transform_keys! { |key| key.delete_prefix "data-" }
-  end
+    @dataset = StimulusReflex::Dataset.new(data)
 
-  def signed
-    @signed ||= ->(accessor) { GlobalID::Locator.locate_signed(dataset[accessor]) }
-  end
-
-  def unsigned
-    @unsigned ||= ->(accessor) { GlobalID::Locator.locate(dataset[accessor]) }
+    all_attributes = @attrs.merge(@dataset.attrs)
+    super build_underscored(all_attributes)
   end
 
   def attributes
     @attributes ||= OpenStruct.new(build_underscored(attrs))
   end
 
-  def dataset
-    @dataset ||= OpenStruct.new(build_underscored(data_attrs))
-  end
-
-  alias_method :data_attributes, :dataset
-
-  private
-
-  def build_data_attrs(dataset, dataset_all)
-    dataset_all.transform_keys! { |key| "data-#{key.delete_prefix("data-").pluralize}" }
-
-    dataset.each { |key, value| dataset_all[key]&.prepend(value) }
-
-    data_attrs = dataset.merge(dataset_all)
-
-    HashWithIndifferentAccess.new(data_attrs || {})
-  end
+  def to_dom_id
+    raise NoIDError.new "The element `morph` is called on must have a valid DOM ID" if id.blank?
 
-  def build_underscored(attrs)
-    attrs.merge(attrs.transform_keys(&:underscore))
+    "##{id}"
   end
 end

data/lib/stimulus_reflex/reflex.rb

@@ -8,14 +8,14 @@ class StimulusReflex::Reflex
   include ActionView::Helpers::TagHelper
   include CableReady::Identifiable
 
-  attr_accessor :payload
+  attr_accessor :payload, :headers
   attr_reader :cable_ready, :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, :broadcast_message, to: :broadcaster
+  delegate :broadcast, :halted, :error, to: :broadcaster
   delegate :reflex_id, :tab_id, :reflex_controller, :xpath_controller, :xpath_element, :permanent_attribute_name, to: :client_attributes
 
   def initialize(channel, url: nil, element: nil, selectors: [], method_name: nil, params: {}, client_attributes: {})
@@ -41,6 +41,7 @@ class StimulusReflex::Reflex
     @client_attributes = ClientAttributes.new(client_attributes)
     @cable_ready = StimulusReflex::CableReadyChannels.new(stream_name, reflex_id)
     @payload = {}
+    @headers = {}
     self.params
   end
 
@@ -97,6 +98,7 @@ class StimulusReflex::Reflex
 
   def controller
     @controller ||= controller_class.new.tap do |c|
+      request.headers.merge!(headers)
       c.instance_variable_set :@stimulus_reflex, true
       c.set_request! request
       c.set_response! controller_class.make_response!(request)
@@ -111,6 +113,9 @@ class StimulusReflex::Reflex
   end
 
   def render(*args)
+    options = args.extract_options!
+    (options[:locals] ||= {}).reverse_merge!(params: params)
+    args << options.reverse_merge(layout: false)
     controller_class.renderer.new(connection.env.merge("SCRIPT_NAME" => "")).render(*args)
   end
 

data/lib/stimulus_reflex/utils/attribute_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module StimulusReflex::AttributeBuilder
+  def build_data_attrs(dataset, dataset_all)
+    dataset_all.transform_keys! { |key| "data-#{key.delete_prefix("data-").pluralize}" }
+
+    dataset.each { |key, value| dataset_all[key]&.prepend(value) }
+
+    data_attrs = dataset.merge(dataset_all)
+
+    HashWithIndifferentAccess.new(data_attrs || {})
+  end
+
+  def build_underscored(attrs)
+    attrs.merge(attrs.transform_keys(&:underscore))
+  end
+end

data/lib/stimulus_reflex/utils/logger.rb

@@ -2,18 +2,22 @@
 
 module StimulusReflex
   class Logger
+    attr_reader :logger
     attr_accessor :reflex, :current_operation
 
+    delegate :debug, :info, :warn, :error, :fatal, :unknown, to: :logger
+
     def initialize(reflex)
       @reflex = reflex
       @current_operation = 1
+      @logger = StimulusReflex.config.logger
     end
 
-    def print
+    def log_all_operations
       return unless config_logging.instance_of?(Proc)
 
       reflex.broadcaster.operations.each do
-        puts instance_eval(&config_logging) + "\e[0m"
+        logger.info instance_eval(&config_logging) + "\e[0m"
         @current_operation += 1
       end
     end

data/lib/stimulus_reflex/utils/sanity_checker.rb

@@ -7,14 +7,16 @@ class StimulusReflex::SanityChecker
 
   class << self
     def check!
+      return if ENV["SKIP_SANITY_CHECK"]
       return if StimulusReflex.config.on_failed_sanity_checks == :ignore
       return if called_by_installer?
       return if called_by_generate_config?
+      return if called_by_rake?
 
       instance = new
       instance.check_caching_enabled
-      instance.check_javascript_package_version
-      instance.check_default_url_config
+      instance.check_package_versions_match
+      # instance.check_default_url_config
       instance.check_new_version_available
     end
 
@@ -29,65 +31,80 @@ class StimulusReflex::SanityChecker
     def called_by_generate_config?
       ARGV.include? "stimulus_reflex:initializer"
     end
+
+    def called_by_rake?
+      File.basename($PROGRAM_NAME) == "rake"
+    end
   end
 
   def check_caching_enabled
-    unless caching_enabled?
+    if caching_not_enabled?
       warn_and_exit <<~WARN
-        StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+        👉 StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
+
         To enable caching in development, run:
+
           rails dev:cache
       WARN
     end
 
-    unless not_null_store?
+    if using_null_store?
       warn_and_exit <<~WARN
-        StimulusReflex requires caching to be enabled. Caching allows the session to be modified during ActionCable requests.
-        But your config.cache_store is set to :null_store, so it won't work.
+        👉 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
   end
 
   def check_default_url_config
-    unless default_url_config_set?
-      warn_and_exit <<~WARN
-        StimulusReflex strongly suggests that you set default_url_options in your environment files.
-        Otherwise, ActionController and ActionMailer will default to example.com when rendering route helpers.
+    return if StimulusReflex.config.on_missing_default_urls == :ignore
+    if default_url_config_set? == false
+      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.
+
         You can set your URL options in config/environments/#{Rails.env}.rb
+
           config.action_controller.default_url_options = {host: "localhost", port: 3000}
-          config.action_mailer.default_url_options = {host: "localhost", port: 3000}
+          #{"config.action_mailer.default_url_options = {host: \"localhost\", port: 3000}\n" if defined?(ActionMailer)}
         Please update every environment with the appropriate URL. Typically, no port is necessary in production.
+
       WARN
     end
   end
 
-  def check_javascript_package_version
-    if javascript_package_version.nil?
+  def check_package_versions_match
+    if npm_version.nil?
       warn_and_exit <<~WARN
-        Can't locate the stimulus_reflex npm package.
+        👉 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
 
-    unless javascript_version_matches?
+    if package_version_mismatch?
       warn_and_exit <<~WARN
-        The stimulus_reflex npm package version (#{javascript_package_version}) does not match the Rubygem version (#{gem_version}).
+        👉 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 unless Rails.env.development?
     return if StimulusReflex.config.on_new_version_available == :ignore
-    return unless using_stable_release
+    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!
+          👉 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
@@ -97,43 +114,45 @@ class StimulusReflex::SanityChecker
         exit if StimulusReflex.config.on_new_version_available == :exit
       end
     rescue
-      puts "StimulusReflex #{StimulusReflex::VERSION} update check skipped: connection timeout"
+      puts "👉 StimulusReflex #{StimulusReflex::VERSION} update check skipped: connection timeout"
     end
   end
 
-  private
-
-  def caching_enabled?
-    Rails.application.config.action_controller.perform_caching
+  def caching_not_enabled?
+    Rails.application.config.action_controller.perform_caching == false
   end
 
-  def not_null_store?
-    Rails.application.config.cache_store != :null_store
+  def using_null_store?
+    Rails.application.config.cache_store == :null_store
   end
 
   def default_url_config_set?
-    Rails.application.config.action_controller.default_url_options
+    if defined?(ActionMailer)
+      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 javascript_version_matches?
-    javascript_package_version == gem_version
+  def package_version_mismatch?
+    npm_version != gem_version
   end
 
-  def using_stable_release
-    stable = StimulusReflex::VERSION.match?(LATEST_VERSION_FORMAT)
-    puts "StimulusReflex #{StimulusReflex::VERSION} update check skipped: pre-release build" unless stable
-    stable
+  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 javascript_package_version
-    @_js_version ||= find_javascript_package_version
+  def npm_version
+    @_npm_version ||= find_npm_version
   end
 
-  def find_javascript_package_version
+  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/))
@@ -142,7 +161,7 @@ class StimulusReflex::SanityChecker
   end
 
   def search_file(path, regex:)
-    return unless File.exist?(path)
+    return if File.exist?(path) == false
     File.foreach(path).grep(regex).first
   end
 
@@ -154,49 +173,38 @@ class StimulusReflex::SanityChecker
     Rails.root.join("yarn.lock")
   end
 
-  def initializer_path
-    @_initializer_path ||= Rails.root.join("config", "initializers", "stimulus_reflex.rb")
+  def initializer_missing?
+    File.exist?(Rails.root.join("config", "initializers", "stimulus_reflex.rb")) == false
   end
 
   def warn_and_exit(text)
-    puts "WARNING:"
+    puts
+    puts "Heads up! 🔥"
+    puts
     puts text
-    exit_with_info if StimulusReflex.config.on_failed_sanity_checks == :exit
-  end
-
-  def exit_with_info
     puts
-
-    if File.exist?(initializer_path)
-      puts <<~INFO
-        If you know what you are doing and you want to start the application anyway,
-        you can add the following directive to the StimulusReflex initializer,
-        which is located at #{initializer_path}
-
-          StimulusReflex.configure do |config|
-            config.on_failed_sanity_checks = :warn
-          end
-
-      INFO
-    else
+    if StimulusReflex.config.on_failed_sanity_checks == :exit
       puts <<~INFO
-        If you know what you are doing and you want to start the application anyway,
-        you can create a StimulusReflex initializer with the command:
-
-        bundle exec rails generate stimulus_reflex:config
+        To ignore any warnings and start the application anyway, you can set the SKIP_SANITY_CHECK environment variable:
 
-        Then open your initializer at
+          SKIP_SANITY_CHECK=true rails
 
-        #{initializer_path}
-
-        and then add the following directive:
+        To do this permanently, add the following directive to the StimulusReflex initializer:
 
           StimulusReflex.configure do |config|
             config.on_failed_sanity_checks = :warn
           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
     end
-    exit false
   end
 end

data/lib/stimulus_reflex/version.rb

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

data/lib/stimulus_reflex.rb

@@ -24,6 +24,7 @@ require "stimulus_reflex/broadcasters/broadcaster"
 require "stimulus_reflex/broadcasters/nothing_broadcaster"
 require "stimulus_reflex/broadcasters/page_broadcaster"
 require "stimulus_reflex/broadcasters/selector_broadcaster"
+require "stimulus_reflex/broadcasters/update"
 require "stimulus_reflex/policies/reflex_invocation_policy"
 require "stimulus_reflex/utils/colorize"
 require "stimulus_reflex/utils/logger"