view_component_reflex 2.1.4 → 2.3.1

data/app/components/view_component_reflex/component.rb

@@ -1,143 +1,192 @@
-module ViewComponentReflex
-  class Component < ViewComponent::Base
-    class << self
-      def init_stimulus_reflex
-        @stimulus_reflex ||= if name.include? "::"
-          module_parent.const_set(name.split("::").last + "Reflex", Class.new(Reflex))
-        else
-          Object.const_set(name + "Reflex", Class.new(Reflex))
-        end
-        @stimulus_reflex.component_class = self
-      end
-    end
-
-    def self.stimulus_controller
-      name.chomp("Component").underscore.dasherize
-    end
-
-    def stimulus_reflex?
-      helpers.controller.instance_variable_get(:@stimulus_reflex)
-    end
-
-    def component_controller(opts_or_tag = :div, opts = {}, &blk)
-      self.class.init_stimulus_reflex
-      init_key
-
-      tag = :div
-      options = if opts_or_tag.is_a? Hash
-        opts_or_tag
-      else
-        tag = opts_or_tag
-        opts
-      end
-      options[:data] = {
-        controller: self.class.stimulus_controller,
-        key: key,
-        **(options[:data] || {})
-      }
-      content_tag tag, capture(&blk), options
-    end
-
-    def can_render_to_string?
-      omitted_from_state.empty?
-    end
-
-    # key is required if you're using state
-    # We can't initialize the session state in the initial method
-    # because it doesn't have a view_context yet
-    # This is the next best place to do it
-    def init_key
-      # we want the erb file that renders the component. `caller` gives the file name,
-      # and line number, which should be unique. We hash it to make it a nice number
-      key = caller.select { |p| p.include? ".html.erb" }[1]&.hash.to_s
-      key += collection_key.to_s if collection_key
-      @key = key
-    end
-
-    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
-      action, method = reflex.to_s.split("->")
-      if method.nil?
-        method = action
-        action = "click"
-      end
-      data_attributes = {
-        reflex: "#{action}->#{self.class.name}##{method}",
-        key: key
-      }
-      if content_or_options_with_block.is_a?(Hash)
-        merge_data_attributes(content_or_options_with_block, data_attributes)
-      else
-        merge_data_attributes(options, data_attributes)
-      end
-      content_tag(name, content_or_options_with_block, options, escape, &block)
-    end
-
-    def collection_key
-      nil
-    end
-
-    def permit_parameter?(initial_param, new_param)
-      initial_param != new_param
-    end
-
-    def omitted_from_state
-      []
-    end
-
-    def key
-      # initialize session state
-      if !stimulus_reflex? || ViewComponentReflex::Engine.state_adapter.state(request, @key).empty?
-
-        new_state = create_safe_state
-
-        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, new_state)
-        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", new_state)
-      else
-        initial_state = ViewComponentReflex::Engine.state_adapter.state(request, "#{@key}_initial")
-        ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
-          instance_value = instance_variable_get(k)
-          if permit_parameter?(initial_state[k], instance_value)
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", { k => instance_value })
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, { k => instance_value })
-          else
-            instance_variable_set(k, v)
-          end
-        end
-      end
-      @key
-    end
-
-    def safe_instance_variables
-      instance_variables - unsafe_instance_variables
-    end
-
-    private
-
-    def unsafe_instance_variables
-      [
-        :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
-        :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-        :@helpers, :@controller, :@request, :@tag_builder
-      ]
-    end
-
-    def create_safe_state
-      new_state = {}
-
-      # this will almost certainly break
-      safe_instance_variables.each do |k|
-        new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(k)
-      end
-      new_state
-    end
-
-    def merge_data_attributes(options, attributes)
-      data = options[:data]
-      if data.nil?
-        options[:data] = attributes
-      else
-        options[:data].merge! attributes
-      end
-    end
-  end
-end
+module ViewComponentReflex
+  class Component < ViewComponent::Base
+    class << self
+      def init_stimulus_reflex
+        factory = ViewComponentReflex::ReflexFactory.new(self)
+        @stimulus_reflex ||= factory.reflex
+        wire_up_callbacks if factory.new?
+      end
+
+      def reflex_base_class(new_base_class = nil)
+        if new_base_class.nil?
+          @reflex_base_class ||= ViewComponentReflex::Reflex
+        else
+          if new_base_class <= ViewComponentReflex::Reflex
+            @reflex_base_class = new_base_class
+          else
+            raise StandardError.new("The reflex base class must inherit from ViewComponentReflex::Reflex")
+          end
+        end
+      end
+
+      def queue_callback(key, args, blk)
+        callbacks(key).push({
+          args: args,
+          blk: blk
+        })
+      end
+
+      def callbacks(key)
+        @callbacks ||= {}
+        @callbacks[key] ||= []
+      end
+
+      def register_callbacks(key)
+        callbacks(key).each do |cb|
+          @stimulus_reflex.send("#{key}_reflex", *cb[:args], &cb[:blk])
+        end
+      end
+
+      def before_reflex(*args, &blk)
+        queue_callback(:before, args, blk)
+      end
+
+      def after_reflex(*args, &blk)
+        queue_callback(:after, args, blk)
+      end
+
+      def around_reflex(*args, &blk)
+        queue_callback(:around, args, blk)
+      end
+
+      def wire_up_callbacks
+        register_callbacks(:before)
+        register_callbacks(:after)
+        register_callbacks(:around)
+      end
+    end
+
+    def self.stimulus_controller
+      name.chomp("Component").underscore.dasherize
+    end
+
+    def stimulus_reflex?
+      helpers.controller.instance_variable_get(:@stimulus_reflex)
+    end
+
+    def component_controller(opts_or_tag = :div, opts = {}, &blk)
+      init_key
+
+      tag = :div
+      options = if opts_or_tag.is_a? Hash
+        opts_or_tag
+      else
+        tag = opts_or_tag
+        opts
+      end
+      options[:data] = {
+        controller: self.class.stimulus_controller,
+        key: key,
+        **(options[:data] || {})
+      }
+      content_tag tag, capture(&blk), options
+    end
+
+    def can_render_to_string?
+      omitted_from_state.empty?
+    end
+
+    # key is required if you're using state
+    # We can't initialize the session state in the initial method
+    # because it doesn't have a view_context yet
+    # This is the next best place to do it
+    def init_key
+      # we want the erb file that renders the component. `caller` gives the file name,
+      # and line number, which should be unique. We hash it to make it a nice number
+      key = caller.select { |p| p.match? /.\.html\.(haml|erb|slim)/ }[1]&.hash.to_s
+      key += collection_key.to_s if collection_key
+      @key = key
+    end
+
+    # Helper to use to create the proper reflex data attributes for an element
+    def reflex_data_attributes(reflex)
+      action, method = reflex.to_s.split("->")
+      if method.nil?
+        method = action
+        action = "click"
+      end
+
+      {
+        reflex: "#{action}->#{self.class.name}##{method}",
+        key: key
+      }
+    end
+
+    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
+      if content_or_options_with_block.is_a?(Hash)
+        merge_data_attributes(content_or_options_with_block, reflex_data_attributes(reflex))
+      else
+        merge_data_attributes(options, reflex_data_attributes(reflex))
+      end
+      content_tag(name, content_or_options_with_block, options, escape, &block)
+    end
+
+    def collection_key
+      nil
+    end
+
+    def permit_parameter?(initial_param, new_param)
+      initial_param != new_param
+    end
+
+    def omitted_from_state
+      []
+    end
+
+    def key
+      # initialize session state
+      if !stimulus_reflex? || ViewComponentReflex::Engine.state_adapter.state(request, @key).empty?
+
+        new_state = create_safe_state
+
+        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, new_state)
+        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", new_state)
+      else
+        initial_state = ViewComponentReflex::Engine.state_adapter.state(request, "#{@key}_initial")
+        ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
+          instance_value = instance_variable_get(k)
+          if permit_parameter?(initial_state[k], instance_value)
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, {k => instance_value})
+          else
+            instance_variable_set(k, v)
+          end
+        end
+      end
+      @key
+    end
+
+    def safe_instance_variables
+      instance_variables - unsafe_instance_variables
+    end
+
+    private
+
+    def unsafe_instance_variables
+      [
+        :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
+        :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
+        :@helpers, :@controller, :@request, :@tag_builder
+      ]
+    end
+
+    def create_safe_state
+      new_state = {}
+
+      # this will almost certainly break
+      safe_instance_variables.each do |k|
+        new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(k)
+      end
+      new_state
+    end
+
+    def merge_data_attributes(options, attributes)
+      data = options[:data]
+      if data.nil?
+        options[:data] = attributes
+      else
+        options[:data].merge! attributes
+      end
+    end
+  end
+end

data/lib/view_component_reflex.rb

@@ -1,9 +1,10 @@
-require "view_component_reflex/state_adapter/session"
-require "view_component_reflex/state_adapter/memory"
-require "view_component_reflex/engine"
-require "stimulus_reflex"
-require "view_component_reflex/reflex"
-
-module ViewComponentReflex
-  # Your code goes here...
-end
+require "stimulus_reflex"
+require 'view_component_reflex/reflex_factory'
+require "view_component_reflex/state_adapter/session"
+require "view_component_reflex/state_adapter/memory"
+require "view_component_reflex/reflex"
+require "view_component_reflex/engine"
+
+module ViewComponentReflex
+  # Your code goes here...
+end

data/lib/view_component_reflex/engine.rb

@@ -1,13 +1,36 @@
-module ViewComponentReflex
-  class Engine < ::Rails::Engine
-    class << self
-      mattr_accessor :state_adapter
-
-      self.state_adapter = StateAdapter::Memory
-    end
-
-    def self.configure
-      yield self if block_given?
-    end
-  end
-end
+module ViewComponentReflex
+  class Engine < ::Rails::Engine
+    class << self
+      mattr_accessor :state_adapter
+
+      self.state_adapter = StateAdapter::Memory
+    end
+
+    config.to_prepare do
+      StimulusReflex::Channel.class_eval do
+        unless instance_methods.include?(:receive_original)
+          alias_method :receive_original, :receive
+          def receive(data)
+            target = data["target"].to_s
+            reflex_name, _ = target.split("#")
+            reflex_name = reflex_name.camelize
+            component_name = reflex_name.end_with?("Reflex") ? reflex_name[0...-6] : reflex_name
+            if component_name.end_with?("Component")
+              begin
+                component_name.constantize.init_stimulus_reflex
+              rescue
+                p "Tried to initialize view_component_reflex on #{component_name}, but it's not a view_component_reflex"
+              end
+
+            end
+            receive_original(data)
+          end
+        end
+      end
+    end
+
+    def self.configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/view_component_reflex/reflex.rb

@@ -1,147 +1,147 @@
-module ViewComponentReflex
-  class Reflex < StimulusReflex::Reflex
-    include CableReady::Broadcaster
-
-    class << self
-      attr_accessor :component_class
-    end
-
-    def refresh!(primary_selector = nil, *rest)
-      save_state
-
-      if primary_selector.nil? && !component.can_render_to_string?
-        primary_selector = selector
-      end
-      if primary_selector
-        prevent_refresh!
-
-        controller.process(url_params[:action])
-        document = Nokogiri::HTML(controller.response.body)
-        [primary_selector, *rest].each do |s|
-          html = document.css(s)
-          if html.present?
-            cable_ready[channel.stream_name].morph(
-              selector: s,
-              html: html.inner_html,
-              children_only: true,
-              permanent_attribute_name: "data-reflex-permanent"
-            )
-          end
-        end
-      else
-        refresh_component!
-      end
-      cable_ready.broadcast
-    end
-
-    def refresh_component!
-      component.tap do |k|
-        k.define_singleton_method(:key) do
-          element.dataset[:key]
-        end
-      end
-      document = Nokogiri::HTML(controller.render_component_to_string(component))
-      cable_ready[channel.stream_name].morph(
-        selector: selector,
-        children_only: true,
-        html: document.css(selector).inner_html,
-        permanent_attribute_name: "data-reflex-permanent"
-      )
-    end
-
-    def refresh_all!
-      refresh!("body")
-    end
-
-    def selector
-      "[data-controller~=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]"
-    end
-
-    # SR's delegate_call_to_reflex in channel.rb
-    # uses method to gather the method parameters, but since we're abusing
-    # method_missing here, that'll always fail
-    def method(name)
-      component.method(name.to_sym)
-    end
-
-    def respond_to_missing?(name, _ = false)
-      !!name.to_proc
-    end
-
-    # this is copied out of stimulus_reflex/reflex.rb and modified
-    def morph(selectors, html = "")
-      case selectors
-      when :nothing
-        @broadcaster = StimulusReflex::NothingBroadcaster.new(self)
-      else
-        @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
-        broadcaster.morphs << [selectors, html]
-      end
-    end
-
-    def method_missing(name, *args)
-      morph :nothing
-      super unless respond_to_missing?(name)
-      state.each do |k, v|
-        component.instance_variable_set(k, v)
-      end
-      name.to_proc.call(component, *args)
-      refresh! unless @prevent_refresh
-    end
-
-    def prevent_refresh!
-      @prevent_refresh = true
-    end
-
-    private
-
-    def component_class
-      self.class.component_class
-    end
-
-    def stimulus_controller
-      component_class.stimulus_controller
-    end
-
-    def stimulate(target, data)
-      dataset = {}
-      data.each do |k, v|
-        dataset["data-#{k}"] = v.to_s
-      end
-      channel.receive({
-        "target" => target,
-        "attrs" => element.attributes.to_h.symbolize_keys,
-        "dataset" => dataset
-      })
-    end
-
-    def component
-      return @component if @component
-      @component = component_class.allocate
-      reflex = self
-      exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector, :stimulate]
-      exposed_methods.each do |meth|
-        @component.define_singleton_method(meth) do |*a|
-          reflex.send(meth, *a)
-        end
-      end
-      @component
-    end
-
-    def set_state(new_state = {})
-      ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
-    end
-
-    def state
-      ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
-    end
-
-    def save_state
-      new_state = {}
-      component.safe_instance_variables.each do |k|
-        new_state[k] = component.instance_variable_get(k)
-      end
-      set_state(new_state)
-    end
-  end
-end
+module ViewComponentReflex
+  class Reflex < StimulusReflex::Reflex
+    include CableReady::Broadcaster
+
+    class << self
+      attr_accessor :component_class
+    end
+
+    def refresh!(primary_selector = nil, *rest)
+      save_state
+
+      if primary_selector.nil? && !component.can_render_to_string?
+        primary_selector = selector
+      end
+      if primary_selector
+        prevent_refresh!
+
+        controller.process(url_params[:action])
+        document = Nokogiri::HTML(controller.response.body)
+        [primary_selector, *rest].each do |s|
+          html = document.css(s)
+          if html.present?
+            cable_ready[channel.stream_name].morph(
+              selector: s,
+              html: html.inner_html,
+              children_only: true,
+              permanent_attribute_name: "data-reflex-permanent"
+            )
+          end
+        end
+      else
+        refresh_component!
+      end
+      cable_ready.broadcast
+    end
+
+    def refresh_component!
+      component.tap do |k|
+        k.define_singleton_method(:key) do
+          element.dataset[:key]
+        end
+      end
+      document = Nokogiri::HTML(controller.render_component_to_string(component))
+      cable_ready[channel.stream_name].morph(
+        selector: selector,
+        children_only: true,
+        html: document.css(selector).inner_html,
+        permanent_attribute_name: "data-reflex-permanent"
+      )
+    end
+
+    def refresh_all!
+      refresh!("body")
+    end
+
+    def selector
+      "[data-controller~=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]"
+    end
+
+    # SR's delegate_call_to_reflex in channel.rb
+    # uses method to gather the method parameters, but since we're abusing
+    # method_missing here, that'll always fail
+    def method(name)
+      component.method(name.to_sym)
+    end
+
+    def respond_to_missing?(name, _ = false)
+      !!name.to_proc
+    end
+
+    # this is copied out of stimulus_reflex/reflex.rb and modified
+    def morph(selectors, html = "")
+      case selectors
+      when :nothing
+        @broadcaster = StimulusReflex::NothingBroadcaster.new(self)
+      else
+        @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
+        broadcaster.morphs << [selectors, html]
+      end
+    end
+
+    def method_missing(name, *args)
+      morph :nothing
+      super unless respond_to_missing?(name)
+      state.each do |k, v|
+        component.instance_variable_set(k, v)
+      end
+      name.to_proc.call(component, *args)
+      refresh! unless @prevent_refresh
+    end
+
+    def prevent_refresh!
+      @prevent_refresh = true
+    end
+
+    private
+
+    def component_class
+      self.class.component_class
+    end
+
+    def stimulus_controller
+      component_class.stimulus_controller
+    end
+
+    def stimulate(target, data)
+      dataset = {}
+      data.each do |k, v|
+        dataset["data-#{k}"] = v.to_s
+      end
+      channel.receive({
+        "target" => target,
+        "attrs" => element.attributes.to_h.symbolize_keys,
+        "dataset" => dataset
+      })
+    end
+
+    def component
+      return @component if @component
+      @component = component_class.allocate
+      reflex = self
+      exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector, :stimulate]
+      exposed_methods.each do |meth|
+        @component.define_singleton_method(meth) do |*a|
+          reflex.send(meth, *a)
+        end
+      end
+      @component
+    end
+
+    def set_state(new_state = {})
+      ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
+    end
+
+    def state
+      ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
+    end
+
+    def save_state
+      new_state = {}
+      component.safe_instance_variables.each do |k|
+        new_state[k] = component.instance_variable_get(k)
+      end
+      set_state(new_state)
+    end
+  end
+end