view_component_reflex 3.1.3 → 3.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c2234a9c3569075c683fba6d62938f203cc647472c092d469533adbf017271
-  data.tar.gz: 432352a437e6a3bcd4125de57e1c59dba8b852a324a1255d19ebcc1745e280f3
+  metadata.gz: 9b88985bd86d0a17dad82c4f01452e0f62a90c6b46984e9df1de0bc7242e1788
+  data.tar.gz: da3801c7566583a2325d60cab55f35c5f3bca0a6031419f05279df7d46de2a12
 SHA512:
-  metadata.gz: ccf4ee642dafb9e2aa8739dca124df3a2edfbd43bd94ff6cb8186efbc13053a8048ade26451fb64179293505ee1f25d6bab3081c81205560210bdc0a8cd4a362
-  data.tar.gz: af090c13d376712e06de6b9d0fff96389afec94a2f52224019c6a1ed1d2dc223620731ed0e9ead87bec8dd6238d1feb70069785d435b362b4de71f5285508397
+  metadata.gz: 33f8f7db2aac6d2808ad1b88eff827c0d91e8b16606a59c7dc6cab16f1b805f329162167026f0d7698556ac5fbd00b98d0ec8da720c91b0015459218e46da1fb
+  data.tar.gz: 5ff2eddfcbfbdf41c7caf47fe7577c737b59dd705affef9e56d0ae3f585c34cff2c5a11d41385c04866c4142f8119f7f7108cb3cf73da19bc3fdca3765f50fd3

data/app/components/view_component_reflex/component.rb

@@ -1,6 +1,7 @@
 module ViewComponentReflex
   class Component < ViewComponent::Base
     class_attribute :reflex_base_class, default: ViewComponentReflex::Reflex
+    attr_reader :key
 
     class << self
       def init_stimulus_reflex
@@ -55,7 +56,7 @@ module ViewComponentReflex
     end
 
     def component_controller(opts_or_tag = :div, opts = {}, &blk)
-      init_key
+      initialize_component
 
       tag = :div
       options = if opts_or_tag.is_a? Hash
@@ -77,11 +78,64 @@ module ViewComponentReflex
       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 can't truly initialize the component without the view_context,
+    # which isn't available in the `initialize` method. We require the 
+    # developer to wrap components in `component_controller`, so this is where
+    # we truly initialize the component.
+    # This method is overridden in reflex.rb when the component is re-rendered. The 
+    # override simply sets @key to element.dataset[:key]
+    # We don't want it to initialize the state again, and since we're rendering the component
+    # outside of the view, we need to skip the initialize_key method as well
+    def initialize_component
+      initialize_key
+      initialize_state
+    end
+
+    # Note to self:
+    # This has to be in the Component class because there are situations
+    # where the controller is the one rendering the component
+    # so we can't rely on the component created by the reflex
+    def initialize_state
+      return if state_initialized?
+      adapter = ViewComponentReflex::Engine.state_adapter
+      
+      # newly mounted
+      if !stimulus_reflex? || adapter.state(request, @key).empty?
+
+        new_state = create_safe_state
+
+        adapter.wrap_write_async do
+          adapter.store_state(request, @key, new_state)
+          adapter.store_state(request, "#{@key}_initial", new_state)
+        end
+
+      # updating a mounted component
+      else
+        initial_state = adapter.state(request, "#{@key}_initial")
+
+        parameters_changed = []
+        adapter.state(request, @key).each do |k, v|
+          instance_value = instance_variable_get(k)
+          if permit_parameter?(initial_state[k], instance_value)
+            parameters_changed << k
+            adapter.wrap_write_async do
+              adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
+              adapter.set_state(request, controller, @key, {k => instance_value})
+            end
+          else
+            instance_variable_set(k, v)
+          end
+        end
+        after_state_initialized(parameters_changed)
+      end
+      @state_initialized = true
+    end
+
+    def state_initialized?
+      @state_initialized
+    end
+
+    def initialize_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
       erb_file = caller.select { |p| p.match? /.\.html\.(haml|erb|slim)/ }[1]
@@ -137,44 +191,6 @@ module ViewComponentReflex
     #   # no op
     # end
 
-    def key
-      adapter = ViewComponentReflex::Engine.state_adapter
-
-      # initialize session state
-      if (!stimulus_reflex? || adapter.state(request, @key).empty?) && !@initialized_state
-
-        new_state = create_safe_state
-
-        adapter.wrap_write_async do
-          adapter.store_state(request, @key, new_state)
-          adapter.store_state(request, "#{@key}_initial", new_state)
-        end
-      elsif !@initialized_state
-        initial_state = adapter.state(request, "#{@key}_initial")
-
-        # incoming_params = safe_instance_variables.each_with_object({}) { |var, obj| obj[var] = instance_variable_get(var) }
-        # receive_params(ViewComponentReflex::Engine.state_adapter.state(request, @key), incoming_params)
-
-        parameters_changed = []
-        adapter.state(request, @key).each do |k, v|
-          instance_value = instance_variable_get(k)
-          if permit_parameter?(initial_state[k], instance_value)
-            parameters_changed << k
-            adapter.wrap_write_async do
-              adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
-              adapter.set_state(request, controller, @key, {k => instance_value})
-            end
-          else
-            instance_variable_set(k, v)
-          end
-        end
-        after_state_initialized(parameters_changed)
-      end
-
-      @initialized_state = true
-      @key
-    end
-
     def safe_instance_variables
       instance_variables - unsafe_instance_variables - omitted_from_state
     end
@@ -185,7 +201,8 @@ module ViewComponentReflex
       [
         :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
         :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-        :@helpers, :@controller, :@request, :@tag_builder, :@initialized_state
+        :@helpers, :@controller, :@request, :@tag_builder, :@state_initialized,
+        :@_content_evaluated, :@_render_in_block
       ]
     end
 
@@ -196,6 +213,7 @@ module ViewComponentReflex
       safe_instance_variables.each do |k|
         new_state[k] = instance_variable_get(k)
       end
+
       new_state
     end
 

data/lib/view_component_reflex/reflex.rb

@@ -5,6 +5,13 @@ module ViewComponentReflex
       attr_accessor :component_class
     end
 
+    # pretty sure I can't memoize this because we need
+    # to re-render every time
+    def controller_document
+      controller.process(params[:action])
+      Nokogiri::HTML(controller.response.body)
+    end
+
     def refresh!(primary_selector = nil, *rest)
       save_state
 
@@ -14,24 +21,21 @@ module ViewComponentReflex
       if primary_selector
         prevent_refresh!
 
-        controller.process(params[:action])
-        document = Nokogiri::HTML(controller.response.body)
         [primary_selector, *rest].each do |s|
-          html = document.css(s)
+          html = controller_document.css(s)
           if html.present?
             CableReady::Channels.instance[stream].morph(
               selector: s,
               html: html.inner_html,
               children_only: true,
               permanent_attribute_name: "data-reflex-permanent",
-              stimulus_reflex: stimulus_reflex_data
             )
           end
         end
       else
         refresh_component!
       end
-      CableReady::Channels.instance.broadcast
+      CableReady::Channels.instance[stream].broadcast
     end
 
     def stream
@@ -42,28 +46,41 @@ module ViewComponentReflex
       @stream = channel
     end
 
-    def refresh_component!
+    def component_document
       component.tap do |k|
-        k.define_singleton_method(:key) do
-          element.dataset[:key]
+        k.define_singleton_method(:initialize_component) do
+          @key = element.dataset[:key]
         end
       end
+
       document = Nokogiri::HTML(component.render_in(controller.view_context))
+    end
+
+    def refresh_component!
       CableReady::Channels.instance[stream].morph(
         selector: selector,
         children_only: true,
-        html: document.css(selector).inner_html,
+        html: component_document.css(selector).inner_html,
         permanent_attribute_name: "data-reflex-permanent",
-        stimulus_reflex: stimulus_reflex_data
       )
     end
 
+    def default_morph
+      save_state
+      html = if component.can_render_to_string?
+        component_document.css(selector).to_html
+      else
+        controller_document.css(selector).to_html
+      end
+      morph selector, html
+    end
+
     def stimulus_reflex_data
       {
         reflex_id: reflex_id,
-        xpath: xpath,
+        xpath_controller: xpath_controller,
+        xpath_element: xpath_element,
         target: target,
-        c_xpath: c_xpath,
         reflex_controller: reflex_controller,
         url: url,
         morph: :page,
@@ -96,25 +113,20 @@ module ViewComponentReflex
       !!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
+    def method_missing(name, *args, &blk)
       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
+
+      component.send(name, *args, &blk)
+      
+      if @prevent_refresh
+        morph :nothing
+      else
+        default_morph      
+      end
     end
 
     def prevent_refresh!
@@ -180,11 +192,23 @@ module ViewComponentReflex
     end
 
     def set_state(new_state = {})
-      ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
+      state_adapter.set_state(request, controller, key, new_state)
+    end
+
+    def key
+      element.dataset[:key]
+    end
+
+    def state_adapter
+      ViewComponentReflex::Engine.state_adapter
     end
 
     def state
-      ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
+      state_adapter.state(request, key)
+    end
+
+    def initial_state
+      state_adapter.state(request, "#{key}_initial")
     end
 
     def save_state

data/lib/view_component_reflex/state_adapter/session.rb

@@ -9,6 +9,7 @@ module ViewComponentReflex
         new_state.each do |k, v|
           state(request, key)[k] = v
         end
+        p new_state
         store = request.session.instance_variable_get("@by")
         store.commit_session request, controller.response
       end
@@ -18,6 +19,7 @@ module ViewComponentReflex
         new_state.each do |k, v|
           request.session[key][k] = v
         end
+        p new_state
       end
 
       def self.wrap_write_async

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '3.1.3'
+  VERSION = '3.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.8
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement