stimulus_reflex 3.5.0.pre2 → 3.5.0.pre3

data/lib/stimulus_reflex/broadcasters/selector_broadcaster.rb

@@ -17,9 +17,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)
             )
           else
             operations << [update.selector, :inner_html]
@@ -27,9 +25,7 @@ module StimulusReflex
               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

data/lib/stimulus_reflex/configuration.rb

@@ -14,7 +14,7 @@ module StimulusReflex
   end
 
   class Configuration
-    attr_accessor :on_failed_sanity_checks, :on_new_version_available, :on_missing_default_urls, :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})" }
 
@@ -24,6 +24,7 @@ module StimulusReflex
       @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,66 +1,32 @@
 # frozen_string_literal: true
 
-class StimulusReflex::Element < OpenStruct
-  attr_reader :attrs, :data_attrs, :inner_html, :text_content
+require "stimulus_reflex/dataset"
+require "stimulus_reflex/utils/attribute_builder"
 
-  def initialize(data = {})
-    @attrs = HashWithIndifferentAccess.new(data["attrs"] || {})
-    @inner_html = data["inner_html"]
-    @text_content = data["text_content"]
+class StimulusReflex::Element < OpenStruct
+  include StimulusReflex::AttributeBuilder
 
-    datasets = data["dataset"] || {}
-    regular_dataset = datasets["dataset"] || {}
-    @data_attrs = build_data_attrs(regular_dataset, datasets["datasetAll"] || {})
+  attr_reader :attrs, :dataset
 
-    super build_underscored(all_attributes)
+  alias_method :data_attributes, :dataset
 
-    @data_attrs.transform_keys! { |key| key.delete_prefix "data-" }
-  end
+  delegate :signed, :unsigned, :numeric, :boolean, :data_attrs, to: :dataset
 
-  def signed
-    @signed ||= ->(accessor) { GlobalID::Locator.locate_signed(dataset[accessor]) }
-  end
+  def initialize(data = {})
+    @attrs = HashWithIndifferentAccess.new(data["attrs"] || {})
+    @dataset = StimulusReflex::Dataset.new(data)
 
-  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
-
   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}" }
-
-    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
-
-  class NoIDError < StandardError
-  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/version.rb

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

data/lib/tasks/stimulus_reflex/install.rake

@@ -96,7 +96,7 @@ namespace :stimulus_reflex do
     puts
     system "bundle exec rails generate stimulus_reflex:initializer"
     system "bundle exec rails generate cable_ready:initializer"
-    system "bundle exec rails generate cable_ready:stream_from"
+    system "bundle exec rails generate cable_ready:helpers"
 
     puts
     puts "✨ Generating ApplicationReflex class and Stimulus controllers, plus an example Reflex class and controller"

data/test/broadcasters/broadcaster_test.rb

@@ -7,6 +7,5 @@ class StimulusReflex::BroadcasterTest < StimulusReflex::BroadcasterTestCase
     broadcaster = StimulusReflex::Broadcaster.new(@reflex)
 
     assert_raises(NotImplementedError) { broadcaster.broadcast }
-    assert_raises(NotImplementedError) { broadcaster.broadcast_message(subject: "Test") }
   end
 end

data/test/broadcasters/broadcaster_test_case.rb

@@ -5,6 +5,30 @@ require_relative "../test_helper"
 class StimulusReflex::BroadcasterTestCase < ActionCable::Channel::TestCase
   tests StimulusReflex::Channel
 
+  def assert_broadcast_on(stream, data, &block)
+    serialized_msg = ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
+
+    new_messages = broadcasts(stream)
+    if block
+      old_messages = new_messages
+      clear_messages(stream)
+
+      yield
+      new_messages = broadcasts(stream)
+      clear_messages(stream)
+
+      (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+    end
+
+    message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
+
+    unless message
+      puts "\n\n#{ActiveSupport::JSON.decode(new_messages.first)}\n#{data}\n\n"
+    end
+
+    assert message, "No messages sent with #{data} to #{stream}"
+  end
+
   setup do
     stub_connection(session_id: SecureRandom.uuid)
     def connection.env

data/test/broadcasters/nothing_broadcaster_test.rb

@@ -3,35 +3,27 @@
 require_relative "broadcaster_test_case"
 
 class StimulusReflex::NothingBroadcasterTest < StimulusReflex::BroadcasterTestCase
-  test "broadcasts a server message when called" do
+  test "broadcasts a nothing morph when called" do
     broadcaster = StimulusReflex::NothingBroadcaster.new(@reflex)
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "dispatchEvent" => [
-          {
-            "name" => "stimulus-reflex:server-message",
-            "detail" => {
-              "reflexId" => "666",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => :data,
-                "morph" => :nothing,
-                "serverMessage" => {
-                  "subject" => "nothing",
-                  "body" => nil
-                }
-              }
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "name" => "stimulus-reflex:morph-nothing",
+          "payload" => {},
+          "stimulusReflex" => {
+            "some" => "data",
+            "morph" => "nothing"
+          },
+          "reflexId" => "666",
+          "operation" => "dispatchEvent"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
-      broadcaster.broadcast nil, {:some => :data, "reflexId" => "666"}
+      broadcaster.broadcast nil, {some: :data}
     end
   end
 end

data/test/broadcasters/page_broadcaster_test.rb

@@ -20,22 +20,21 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "morph" => [
-          {
-            "selector" => "body",
-            "html" => "<div>New Content</div><div>Another Content</div>",
-            "payload" => {},
-            "childrenOnly" => true,
-            "permanentAttributeName" => nil,
-            "stimulusReflex" => {
-              "some" => :data,
-              "morph" => :page
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "selector" => "body",
+          "html" => "<div>New Content</div><div>Another Content</div>",
+          "payload" => {},
+          "childrenOnly" => true,
+          "permanentAttributeName" => nil,
+          "stimulusReflex" => {
+            "some" => :data,
+            "morph" => :page
+          },
+          "reflexId" => "666",
+          "operation" => "morph"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do
@@ -54,22 +53,21 @@ class StimulusReflex::PageBroadcasterTest < StimulusReflex::BroadcasterTestCase
 
     expected = {
       "cableReady" => true,
-      "operations" => {
-        "morph" => [
-          {
-            "selector" => "#foo",
-            "html" => "New Content",
-            "payload" => {},
-            "childrenOnly" => true,
-            "permanentAttributeName" => nil,
-            "stimulusReflex" => {
-              "some" => :data,
-              "morph" => :page
-            },
-            "reflexId" => "666"
-          }
-        ]
-      }
+      "operations" => [
+        {
+          "selector" => "#foo",
+          "html" => "New Content",
+          "payload" => {},
+          "childrenOnly" => true,
+          "permanentAttributeName" => nil,
+          "stimulusReflex" => {
+            "some" => :data,
+            "morph" => :page
+          },
+          "reflexId" => "666",
+          "operation" => "morph"
+        }
+      ]
     }
 
     assert_broadcast_on @reflex.stream_name, expected do

data/test/broadcasters/selector_broadcaster_test.rb

@@ -10,22 +10,21 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "morph" => [
-            {
-              "selector" => "#foo",
-              "html" => "<div>bar</div><div>baz</div>",
-              "payload" => {},
-              "childrenOnly" => true,
-              "permanentAttributeName" => nil,
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "<div>bar</div><div>baz</div>",
+            "payload" => {},
+            "childrenOnly" => true,
+            "permanentAttributeName" => nil,
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "morph"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -39,20 +38,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => '<div id="baz"><span>bar</span></div>',
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => '<div id="baz"><span>bar</span></div>',
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -66,20 +64,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -93,20 +90,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -120,20 +116,19 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "innerHtml" => [
-            {
-              "selector" => "#foo",
-              "html" => "",
-              "payload" => {},
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "",
+            "payload" => {},
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "innerHtml"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do
@@ -147,22 +142,21 @@ module StimulusReflex
 
       expected = {
         "cableReady" => true,
-        "operations" => {
-          "morph" => [
-            {
-              "selector" => "#foo",
-              "html" => "<div>bar</div><div>baz</div>",
-              "payload" => {},
-              "childrenOnly" => true,
-              "permanentAttributeName" => nil,
-              "stimulusReflex" => {
-                "some" => "data",
-                "morph" => "selector"
-              },
-              "reflexId" => "666"
-            }
-          ]
-        }
+        "operations" => [
+          {
+            "selector" => "#foo",
+            "html" => "<div>bar</div><div>baz</div>",
+            "payload" => {},
+            "childrenOnly" => true,
+            "permanentAttributeName" => nil,
+            "stimulusReflex" => {
+              "some" => "data",
+              "morph" => "selector"
+            },
+            "reflexId" => "666",
+            "operation" => "morph"
+          }
+        ]
       }
 
       assert_broadcast_on @reflex.stream_name, expected do