view_component_reflex 3.1.6 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4b72c7ca04feca0612b84925248838aa817e75618cbde750f23b60ad6c7802
-  data.tar.gz: b9bc83b05e5ff725eb95df9771832d7c28fdd0ab010dd9f27b75ab19c319ce28
+  metadata.gz: 457de938235885451ab74f7c2a5136bc6e87443467f8ae7944eb27fb23f1dbdd
+  data.tar.gz: 4b6c6b6152facd010da5f74355e46a9f8db492e8b84e54563b27179f3edf7a93
 SHA512:
-  metadata.gz: 864da0ee540160df39dfd03970ab52ac8bdfadc4df15eb173aeb301be5e3d507999bb6e4e96bb4095b2245caea8fe0969eebac006a6f5247be9fb2785c105fb1
-  data.tar.gz: 993c5c58f8dd8a927cb953f9bb89aa54bd997b9bcb41d07a0a39db7ccc9c71d8faf79cbaf1cf76513b50c5207fe7ef56e268b86ef6c7301d549d99e7b69ec270
+  metadata.gz: 300ec189d65159384a26ee644ab7fa2deb3e9609fea703f004822cbde354af444ef2c4f4ed050b3770c4b2f19b81c1f0e710be673f1f570445d41216bb8ab2b7
+  data.tar.gz: 304db5f0fa2e8a98d6cf97603e17c110faa84f82fe06cfdd675f154b69bad27841474dc7ca7a048be500d65ccf957af9545599339acb35e24a8babccbe4dc07c

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,7 @@ 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
       ]
     end
 
@@ -196,6 +212,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.rb

@@ -1,5 +1,4 @@
 require "stimulus_reflex"
-require "view_component_reflex/null_broadcaster"
 require 'view_component_reflex/reflex_factory'
 require "view_component_reflex/state_adapter/base"
 require "view_component_reflex/state_adapter/session"

data/lib/view_component_reflex/reflex.rb

@@ -24,7 +24,6 @@ module ViewComponentReflex
               html: html.inner_html,
               children_only: true,
               permanent_attribute_name: "data-reflex-permanent",
-              stimulus_reflex: stimulus_reflex_data
             )
           end
         end
@@ -44,17 +43,17 @@ module ViewComponentReflex
 
     def refresh_component!
       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))
       CableReady::Channels.instance[stream].morph(
         selector: selector,
         children_only: true,
         html: document.css(selector).inner_html,
         permanent_attribute_name: "data-reflex-permanent",
-        stimulus_reflex: stimulus_reflex_data
       )
     end
 
@@ -96,22 +95,10 @@ 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)
-      when :null
-        @broadcaster = NullBroadcaster.new(self)
-      else
-        @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
-        broadcaster.morphs << [selectors, html]
-      end
-    end
-
     def method_missing(name, *args, &blk)
-      morph :null
+      morph :nothing
       super unless respond_to_missing?(name)
+
       state.each do |k, v|
         component.instance_variable_set(k, v)
       end
@@ -184,11 +171,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/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '3.1.6'
+  VERSION = '3.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.1.7
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,7 +85,6 @@ files:
 - app/components/view_component_reflex/component.rb
 - lib/view_component_reflex.rb
 - lib/view_component_reflex/engine.rb
-- lib/view_component_reflex/null_broadcaster.rb
 - lib/view_component_reflex/reflex.rb
 - lib/view_component_reflex/reflex_factory.rb
 - lib/view_component_reflex/state_adapter/base.rb

data/lib/view_component_reflex/null_broadcaster.rb

@@ -1,19 +0,0 @@
-module ViewComponentReflex
-    class NullBroadcaster < StimulusReflex::Broadcaster
-      def broadcast(_, data)
-        nil
-      end
-  
-      def nothing?
-        true
-      end
-  
-      def to_sym
-        :nothing
-      end
-  
-      def to_s
-        "Nothing"
-      end
-    end
-  end