view_component_reflex 3.1.7 → 3.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457de938235885451ab74f7c2a5136bc6e87443467f8ae7944eb27fb23f1dbdd
-  data.tar.gz: 4b6c6b6152facd010da5f74355e46a9f8db492e8b84e54563b27179f3edf7a93
+  metadata.gz: 041ef93f09303abacb6ef4385394ede9d98bc8e9491a1083eb6478af27a8ce39
+  data.tar.gz: d13347dac95081f9d3d79e3fdfee881bf51909c7a0c8fcc64f677f4d8454e6be
 SHA512:
-  metadata.gz: 300ec189d65159384a26ee644ab7fa2deb3e9609fea703f004822cbde354af444ef2c4f4ed050b3770c4b2f19b81c1f0e710be673f1f570445d41216bb8ab2b7
-  data.tar.gz: 304db5f0fa2e8a98d6cf97603e17c110faa84f82fe06cfdd675f154b69bad27841474dc7ca7a048be500d65ccf957af9545599339acb35e24a8babccbe4dc07c
+  metadata.gz: c90db4e5c4a2b9190b1cf3952569d261fdf83a373f94ec9821205f30c0b108c38f57bd352e8bd978f2183a365feeb6c2ece4f5ad8dbc25083e4a5814d14cf7ee
+  data.tar.gz: 27be6c9f4c2b1920c7b36135cb4cc3920e1ccc78cf89c39be5ac9a823f5c6d9e18e847c466dee97032031f3ae03182967e6f4c8b00e09f85ace274f5a3be0526

data/README.md

@@ -55,6 +55,22 @@ end
 <%= render(TodoComponent.with_collection(Todo.all)) %>
 ```
 
+In case you're rendering a collection of empty models, use a UUID of some sort to address the correct component instance on your page:
+
+```ruby
+class TodoComponent < ViewComponentReflex::Component
+  def initialize(todo:)
+    @todo = todo
+  end
+
+  def collection_key
+    @todo.id || SecureRandom.hex(16)
+  end
+end
+#
+<%= render(TodoComponent.with_collection((0..5).map { Todo.new })) %>
+```
+
 ## API
 
 ### permit_parameter?(initial_param, new_params)
@@ -385,6 +401,31 @@ end
 ```
 Please use a different name to be able to save them to the session.
 
+## Foo Can't Be Dumped
+
+If you are getting errors that e.g. MatchData, Singleton etc. can't be dumped, ensure that you do not set any instance variables in your components (or any class you inject into them, for that matter) that cannot be marshaled.
+
+This can be easily remedied though, by providing a list of unmarshalable instance variables and overwriting `marshal_dump` and `marshal_load` (from [https://stackoverflow.com/a/32877159/4341756](https://stackoverflow.com/a/32877159/4341756)):
+
+```rb
+class MarshalTest
+  UNMARSHALED_VARIABLES = [:@foo, :@bar]
+
+  def marshal_dump
+    instance_variables.reject{|m| UNMARSHALED_VARIABLES.include? m}.inject({}) do |vars, attr|
+      vars[attr] = instance_variable_get(attr)
+      vars
+    end
+  end
+
+  def marshal_load(vars)
+    vars.each do |attr, value|
+      instance_variable_set(attr, value) unless UNMARSHALED_VARIABLES.include?(attr)
+    end
+  end
+end
+```
+
 ## Anycable
 
 @sebyx07 provided a solution to use anycable (https://github.com/joshleblanc/view_component_reflex/issues/23#issue-721786338)

data/app/components/view_component_reflex/component.rb

@@ -201,10 +201,23 @@ module ViewComponentReflex
       [
         :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
         :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-        :@helpers, :@controller, :@request, :@tag_builder, :@state_initialized
+        :@helpers, :@controller, :@request, :@tag_builder, :@state_initialized,
+        :@_content_evaluated, :@_render_in_block
       ]
     end
 
+    def content
+      if cached_content && !@_render_in_block
+        cached_content
+      else
+        super
+      end
+    end
+
+    def cached_content
+      @__cached_content__
+    end
+
     def create_safe_state
       new_state = {}
 
@@ -213,6 +226,8 @@ module ViewComponentReflex
         new_state[k] = instance_variable_get(k)
       end
 
+      new_state[:@__cached_content__] = content
+
       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
 
@@ -13,9 +20,8 @@ module ViewComponentReflex
       end
       if primary_selector
         prevent_refresh!
-
-        controller.process(params[:action])
-        document = Nokogiri::HTML(controller.response.body)
+        
+        document = controller_document
         [primary_selector, *rest].each do |s|
           html = document.css(s)
           if html.present?
@@ -41,7 +47,7 @@ module ViewComponentReflex
       @stream = channel
     end
 
-    def refresh_component!
+    def component_document
       component.tap do |k|
         k.define_singleton_method(:initialize_component) do
           @key = element.dataset[:key]
@@ -49,14 +55,27 @@ module ViewComponentReflex
       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",
       )
     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,
@@ -96,7 +115,6 @@ module ViewComponentReflex
     end
 
     def method_missing(name, *args, &blk)
-      morph :nothing
       super unless respond_to_missing?(name)
 
       state.each do |k, v|
@@ -105,7 +123,11 @@ module ViewComponentReflex
 
       component.send(name, *args, &blk)
       
-      refresh! unless @prevent_refresh
+      if @prevent_refresh
+        morph :nothing
+      else
+        default_morph      
+      end
     end
 
     def prevent_refresh!

data/lib/view_component_reflex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 3.1.7
+  version: 3.1.12
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-06 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.28.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement