stimulus_reflex 3.5.0.pre1 → 3.5.0.pre2

data/README.md

@@ -109,10 +109,10 @@ View the [wiki](https://github.com/stimulusreflex/stimulus_reflex/wiki/Editor-Co
 ## 📦 Releasing
 
 1. Bump version number at `lib/stimulus_reflex/version.rb`
-1. Run `rake build`
-1. Run `rake release`
-1. Run `yarn publish --no-git-tag-version`
-1. Commit and push changes to the `package.json` file
+2. Run `rake build`
+3. Run `rake release`
+4. Run `yarn publish --no-git-tag-version`
+5. Commit and push changes to the `package.json` file
 
 ## 📝 License
 

data/app/channels/stimulus_reflex/channel.rb

@@ -4,11 +4,7 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
   attr_reader :reflex_data
 
   def stream_name
-    ids = connection.identifiers.map { |identifier| send(identifier).try(:id) || send(identifier) }
-    [
-      params[:channel],
-      ids.select(&:present?).join(";")
-    ].select(&:present?).join(":")
+    [params[:channel], connection.connection_identifier].join(":")
   end
 
   def subscribed
@@ -92,7 +88,7 @@ class StimulusReflex::Channel < StimulusReflex.configuration.parent_channel.cons
     elsif policy.arguments?
       reflex.process(method_name, *arguments)
     else
-      raise ArgumentError.new("wrong number of arguments (given #{arguments.inspect}, expected #{required_params.inspect}, optional #{optional_params.inspect})")
+      raise ArgumentError.new("wrong number of arguments (given #{arguments.inspect}, expected #{policy.required_params.inspect}, optional #{policy.optional_params.inspect})")
     end
   end
 

data/lib/generators/stimulus_reflex/templates/app/reflexes/application_reflex.rb.tt

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
 class ApplicationReflex < StimulusReflex::Reflex
-  # Put application-wide Reflex behavior and callbacks in this file. 
+  # Put application-wide Reflex behavior and callbacks in this file.
   #
-  # Example:
+  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
   #
-  #   # If your ActionCable connection is: `identified_by :current_user`
+  # If your ActionCable connection is: `identified_by :current_user`
   #   delegate :current_user, to: :connection
   #
-  # Learn more at: https://docs.stimulusreflex.com/rtfm/reflex-classes
+  # If you need to localize your Reflexes, you can set the I18n locale here:
+  #
+  #   before_reflex do
+  #     I18n.locale = :fr
+  #   end
+  #
+  # For code examples, considerations and caveats, see:
+  # https://docs.stimulusreflex.com/rtfm/patterns#internationalization
 end

data/lib/generators/stimulus_reflex/templates/config/initializers/stimulus_reflex.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+# The ActionCable logger is REALLY noisy, and might even impact performance.
+# Uncomment the line below to silence the ActionCable logger.
+
+# ActionCable.server.config.logger = Logger.new(nil)
+
 StimulusReflex.configure do |config|
   # Enable/disable exiting / warning when the sanity checks fail options:
   # `:exit` or `:warn` or `:ignore`
@@ -11,6 +16,11 @@ StimulusReflex.configure do |config|
 
   # config.on_new_version_available = :ignore
 
+  # Enable/disable exiting / warning when there is no default URLs specified in environment config
+  # `:warn` or `:ignore`
+
+  # config.on_missing_default_urls = :warn
+
   # Override the parent class that the StimulusReflex ActionCable channel inherits from
 
   # config.parent_channel = "ApplicationCable::Channel"

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"

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -2,23 +2,17 @@
 
 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,
@@ -28,9 +22,9 @@ module StimulusReflex
               })
             )
           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({
@@ -64,5 +58,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,13 +14,14 @@ 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, :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
       @middleware = ActionDispatch::MiddlewareStack.new

data/lib/stimulus_reflex/element.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 class StimulusReflex::Element < OpenStruct
-  attr_reader :attrs, :data_attrs
+  attr_reader :attrs, :data_attrs, :inner_html, :text_content
 
   def initialize(data = {})
     @attrs = HashWithIndifferentAccess.new(data["attrs"] || {})
+    @inner_html = data["inner_html"]
+    @text_content = data["text_content"]
+
     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
 
@@ -29,10 +33,20 @@ class StimulusReflex::Element < OpenStruct
     @dataset ||= OpenStruct.new(build_underscored(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?
+
+    "##{id}"
+  end
+
   alias_method :data_attributes, :dataset
 
   private
 
+  def all_attributes
+    @attrs.merge(@data_attrs)
+  end
+
   def build_data_attrs(dataset, dataset_all)
     dataset_all.transform_keys! { |key| "data-#{key.delete_prefix("data-").pluralize}" }
 
@@ -46,4 +60,7 @@ class StimulusReflex::Element < OpenStruct
   def build_underscored(attrs)
     attrs.merge(attrs.transform_keys(&:underscore))
   end
+
+  class NoIDError < StandardError
+  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